efl/legacy/elementary/src/lib/elm_icon.eo

113 lines
3.3 KiB
Plaintext

class Elm_Icon (Elm_Image)
{
eo_prefix: elm_obj_icon;
properties {
order_lookup {
set {
/*@
Sets the icon lookup order used by elm_icon_standard_set().
@see elm_icon_order_lookup_get()
@see Elm_Icon_Lookup_Order
@ingroup Icon */
}
get {
/*@
Get the icon lookup order.
@return The icon lookup order
@see elm_icon_order_lookup_set()
@see Elm_Icon_Lookup_Order
@ingroup Icon */
}
values {
Elm_Icon_Lookup_Order 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) */
}
}
standard {
set {
/*@
Set the icon by icon standards names.
@return (@c EINA_TRUE = success, @c EINA_FALSE = error)
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 @p 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 elm_icon_order_lookup_set().
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 by this function can be changed by
elm_image_file_set().
@note This function does not accept relative icon path.
@see elm_icon_standard_get()
@see elm_image_file_set()
@ingroup Icon */
return: bool;
}
get {
/*@
Get the icon name set by icon standard names.
@return The icon name
If the icon image was set using elm_image_file_set() instead of
elm_icon_standard_set(), then this function will return @c NULL.
@see elm_icon_standard_set()
@ingroup Icon */
}
values {
const(char)* name; /*@ The icon name */
}
}
thumb {
set {
/*@
Set the file that will be used, but use a generated thumbnail.
This functions like elm_image_file_set() but requires the Ethumb library
support to be enabled successfully with elm_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.
@see elm_image_file_set()
@ingroup Icon */
}
values {
const(char)* file; /*@ The path to file that will be used as icon image */
const(char)* group; /*@ The group that the icon belongs to an edje file */
}
}
}
implements {
class.constructor;
Eo.Base.constructor;
Evas.Object_Smart.add;
Evas.Object_Smart.del;
Elm_Widget.theme_apply;
Elm_Image.memfile.set;
Elm_Image.sizing_eval;
Elm_Image.file.set;
}
events {
thumb,done;
thumb,error;
}
}