Tizen Native API
|
Functions | |
Evas_Object * | elm_icon_add (Evas_Object *parent) |
Adds a new icon object to the parent. | |
void | elm_icon_thumb_set (Evas_Object *obj, const char *file, const char *group) |
Sets the file that is used, but uses a generated thumbnail. | |
Eina_Bool | elm_icon_standard_set (Evas_Object *obj, const char *name) |
Sets the icon by icon standard names. | |
const char * | elm_icon_standard_get (const Evas_Object *obj) |
Gets the icon name set by icon standard names. | |
void | elm_icon_order_lookup_set (Evas_Object *obj, Elm_Icon_Lookup_Order order) |
Sets the icon lookup order used by elm_icon_standard_set(). | |
Elm_Icon_Lookup_Order | elm_icon_order_lookup_get (const Evas_Object *obj) |
Gets the icon lookup order. |
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 context.
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 is fetched.
This widget inherits from the mapping 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:
Various calls on the icon's API are marked as deprecated, as they just wrap the image counterpart functions. Use the ones we mentioned for each case of deprecation here. Eventually, the deprecated ones are discarded (next major release).
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):
"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 mapping :
"thumb,done"
- elm_icon_thumb_set() has completed with success ("thumb,error"
- elm_icon_thumb_set() has failed (Enumeration that defines the lookup order used by elm_icon_standard_set(). Should look for icons in the theme, FDO paths, or both.
Evas_Object* elm_icon_add | ( | Evas_Object * | parent | ) |
Adds a new icon object to the parent.
[in] | parent | The parent object |
NULL
if it cannot be createdElm_Icon_Lookup_Order elm_icon_order_lookup_get | ( | const Evas_Object * | obj | ) |
Gets the icon lookup order.
[in] | obj | The icon object |
void elm_icon_order_lookup_set | ( | Evas_Object * | obj, |
Elm_Icon_Lookup_Order | order | ||
) |
Sets the icon lookup order used by elm_icon_standard_set().
[in] | obj | The icon object |
[in] | order | The icon lookup order (can be one of ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO, or ELM_ICON_LOOKUP_THEME) |
const char* elm_icon_standard_get | ( | const Evas_Object * | obj | ) |
Gets the icon name set by icon standard names.
NULL
.[in] | obj | The icon object |
Eina_Bool elm_icon_standard_set | ( | Evas_Object * | obj, |
const char * | name | ||
) |
Sets the icon by icon standard names.
[in] | obj | The icon object |
[in] | name | The icon name |
EINA_TRUE
= success, EINA_FALSE
= error)void elm_icon_thumb_set | ( | Evas_Object * | obj, |
const char * | file, | ||
const char * | group | ||
) |
Sets the file that is used, but uses a generated thumbnail.
[in] | obj | The icon object |
[in] | file | The path to the file that is used as an icon image |
[in] | group | The group that the icon belongs to |