icon Module

Widget description

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)

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

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 Image:

• "thumb,done" - Setting thumb has completed with success
• "thumb,error" - Setting thumb has failed

Enumerations

Icon lookup modes

efl.elementary.icon.ELM_ICON_LOOKUP_FDO_THEME

freedesktop, theme

efl.elementary.icon.ELM_ICON_LOOKUP_THEME_FDO

theme, freedesktop

efl.elementary.icon.ELM_ICON_LOOKUP_FDO

freedesktop

efl.elementary.icon.ELM_ICON_LOOKUP_THEME

theme

Icon type

efl.elementary.icon.ELM_ICON_NONE

No icon

efl.elementary.icon.ELM_ICON_FILE

Icon is a file

efl.elementary.icon.ELM_ICON_STANDARD

Icon is set with standards name

class efl.elementary.icon.Icon

Bases: efl.elementary.image.Image

This is the class that actually implements the widget.

callback_thumb_done_add()

Setting thumb has completed with success.

callback_thumb_error_add()

Setting thumb has failed.

order_lookup

The icon lookup order used by standard.

Type :Icon lookup modes

standard

The icon standards name.

For example, freedesktop.org defines standard icon names such as “home”, “network”, etc. There can be different icon sets to match those icon keys. The name given as parameter is one of these “keys”, and will be used to look in the freedesktop.org paths and elementary theme. One can change the lookup order with order_lookup.

If name is not found in any of the expected locations and it is the absolute path of an image file, this image will be used.

Note

The icon image set can be changed by file.

See also

file

Type :string Raises RuntimeWarning:  when setting the standard name fails. Return bool:For 1.7 compatibility standard_set() returns a bool value that tells whether setting the standard name was succesful or not.

Changed in version 1.8: Raises RuntimeWarning when setting the standard name fails, instead of returning a bool.

thumb

Set the file (and edje group) that will be used, but use a generated thumbnail.

This functions like file but requires the Ethumb library support to be enabled successfully with efl.elementary.need.need_ethumb(). When set the file indicated has a thumbnail generated and cached on disk for future use or will directly use an existing cached thumbnail if it is valid.

Type :string file or tuple(string file, string group)