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
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 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”.
These are names for icons that were first intended to be used in toolbars, but can be used in many other places too:
These are names for icons that were designed to be used in menus (but again, you can use them anywhere else):
And these are names for some media player specific icons:
Icon lookup modes¶
- class efl.elementary.Icon(Object parent, *args, **kwargs)¶
This is the class that actually implements the widget.
efl.evas.Object) – The parent object
**kwargs – All the remaining keyword arguments are interpreted as properties of the instance
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
namegiven 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
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.
The icon image set can be changed by
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 successful or not.
Changed in version 1.8: Raises RuntimeWarning when setting the standard name fails, instead of returning a bool.
Set the file (and edje group) that will be used, but use a generated thumbnail.
This functions like
filebut 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.
- thumb_set(filename, group=None)¶