An icon object is used to display standard icon images ("delete", "edit", "arrows", etc.) or images coming from a custom file (PNG, JPG, EDJE, etc.), on icon contexts.

The icon image requested can be in the Elementary theme in use, or in the freedesktop.org theme paths. It's possible to set the order of preference from where an image will be fetched.

This widget inherits from the Image one, so that all the functions acting on it also work for icon objects.

You should be using an icon, instead of an image, whenever one of the following apply:

• you need a thumbnail version of an original image
• you need freedesktop.org provided icon images
• you need theme provided icon images (Edje groups)

Various calls on the icon's API are marked as deprecated, as they just wrap the image counterpart functions. Use the ones we point you to, for each case of deprecation here, instead -- eventually the deprecated ones will be discarded (next major release).

Default images provided by Elementary's default theme are described below.

These are names that follow (more or less) the Freedesktop icon naming specification. Use of these names are preferred, at least if you want to give your user the ability to use other themes. All these icons can be seen in the elementary_test application, the test is called "Icon Standard".

• "folder" (since 1.13)
• "user-home" (since 1.13)
• "user-trash" (since 1.13)

• "view-close" (since 1.13)
• "view-refresh" (since 1.13)

• "window-close" (since 1.13)

• "document-close" (since 1.13)
• "document-edit" (since 1.13)

• "dialog-info" (since 1.13)
• "dialog-close" (since 1.13)

• "arrow-up" (since 1.13)
• "arrow-down" (since 1.13)
• "arrow-left" (since 1.13)
• "arrow-right" (since 1.13)
• "arrow-up-left" (since 1.13)
• "arrow-up-right" (since 1.13)
• "arrow-down-left" (since 1.13)
• "arrow-down-right" (since 1.13)

• "edit-delete" (since 1.13)

• "application-chat" (since 1.13)
• "application-clock" (since 1.13)

• "media-seek-forward" (since 1.13)
• "media-seek-backward" (since 1.13)
• "media-skip-forward" (since 1.13)
• "media-skip-backward" (since 1.13)
• "media-playback-pause" (since 1.13)
• "media-playback-start" (since 1.13)
• "media-playback-stop" (since 1.13)
• "media-eject" (since 1.13)

• "audio-volume" (since 1.13)
• "audio-volume-muted" (since 1.13)

These are names for icons that were first intended to be used in toolbars, but can be used in many other places too:

• "home"
• "close"
• "apps"
• "arrow_up"
• "arrow_down"
• "arrow_left"
• "arrow_right"
• "chat"
• "clock"
• "delete"
• "edit"
• "refresh"
• "folder"
• "file"

These are names for icons that were designed to be used in menus (but again, you can use them anywhere else):

• "menu/home"
• "menu/close"
• "menu/apps"
• "menu/arrow_up"
• "menu/arrow_down"
• "menu/arrow_left"
• "menu/arrow_right"
• "menu/chat"
• "menu/clock"
• "menu/delete"
• "menu/edit"
• "menu/refresh"
• "menu/folder"
• "menu/file"

And these are names for some media player specific icons:

• "media_player/forward"
• "media_player/info"
• "media_player/next"
• "media_player/pause"
• "media_player/play"
• "media_player/prev"
• "media_player/rewind"
• "media_player/stop"

This widget emits the following signals, besides the ones sent from Elm_Image:

• "thumb,done" - elm_icon_thumb_set() has completed with success (since 1.7)
• "thumb,error" - elm_icon_thumb_set() has failed (since 1.7)

Elementary icon objects support the following API calls:

• elm_object_signal_emit()
• elm_object_signal_callback_add()
• elm_object_signal_callback_del() for emitting and listening to signals on the object, when the internal image comes from an Edje object. This behavior was added unintentionally, though, and is deprecated. Expect it to be dropped on future releases.

An example of usage for this API follows:

• Icon example

Enumeration Type Documentation

Function Documentation