Tizen Native API
|
Functions | |
int | elm_init (int argc, char **argv) |
Initializes Elementary. | |
int | elm_shutdown (void) |
Shuts down Elementary. | |
void | elm_run (void) |
Runs Elementary's main loop. | |
void | elm_exit (void) |
Asks to exit Elementary's main loop. | |
void | elm_quicklaunch_mode_set (Eina_Bool ql_on) |
Exposed symbol used only by macros and should not be used by apps. | |
Eina_Bool | elm_quicklaunch_mode_get (void) |
Exposed symbol used only by macros and should not be used by apps. | |
int | elm_quicklaunch_init (int argc, char **argv) |
Exposed symbol used only by macros and should not be used by apps. | |
int | elm_quicklaunch_sub_init (int argc, char **argv) |
Exposed symbol used only by macros and should not be used by apps. | |
int | elm_quicklaunch_sub_shutdown (void) |
Exposed symbol used only by macros and should not be used by apps. | |
int | elm_quicklaunch_shutdown (void) |
Exposed symbol used only by macros and should not be used by apps. | |
void | elm_quicklaunch_seed (void) |
Exposed symbol used only by macros and should not be used by apps. | |
Eina_Bool | elm_quicklaunch_prepare (int argc, char **argv) |
Exposed symbol used only by macros and should not be used by apps. | |
Eina_Bool | elm_quicklaunch_fork (int argc, char **argv, char *cwd, void(*postfork_func)(void *data), void *postfork_data) |
Exposed symbol used only by macros and should not be used by apps. | |
void | elm_quicklaunch_cleanup (void) |
Exposed symbol used only by macros and should not be used by apps. | |
int | elm_quicklaunch_fallback (int argc, char **argv) |
Exposed symbol used only by macros and should not be used by apps. | |
char * | elm_quicklaunch_exe_path_get (const char *exe) |
Exposed symbol used only by macros and should not be used by apps. | |
Eina_Bool | elm_policy_set (unsigned int policy, int value) |
Sets a new policy's value (for a given policy group/identifier). | |
int | elm_policy_get (unsigned int policy) |
Gets the policy value for the given policy identifier. | |
void | elm_language_set (const char *lang) |
Changes the language of the current application. | |
void | elm_object_part_text_set (Evas_Object *obj, const char *part, const char *text) |
Sets the text of an object. | |
const char * | elm_object_part_text_get (const Evas_Object *obj, const char *part) |
Gets the text of an object. | |
void | elm_object_domain_translatable_part_text_set (Evas_Object *obj, const char *part, const char *domain, const char *text) |
Sets the text for an object's part, marking it translatable. | |
const char * | elm_object_translatable_part_text_get (const Evas_Object *obj, const char *part) |
Gets the original string set as translatable for an object. | |
void | elm_object_domain_part_text_translatable_set (Evas_Object *obj, const char *part, const char *domain, Eina_Bool translatable) |
Marks the part text to be transltable. | |
void | elm_object_part_content_set (Evas_Object *obj, const char *part, Evas_Object *content) |
Sets the content at a part of a given container widget. | |
Evas_Object * | elm_object_part_content_get (const Evas_Object *obj, const char *part) |
Gets the content at a part of a given container widget. | |
Evas_Object * | elm_object_part_content_unset (Evas_Object *obj, const char *part) |
Unsets the content at a part of a given container widget. | |
void | elm_object_access_info_set (Evas_Object *obj, const char *txt) |
Sets the text to read out when in the accessibility mode. | |
Evas_Object * | elm_object_name_find (const Evas_Object *obj, const char *name, int recurse) |
Gets a named object from the children. | |
void | elm_object_disabled_set (Evas_Object *obj, Eina_Bool disabled) |
Sets the disabled state of an Elementary object. | |
Eina_Bool | elm_object_disabled_get (const Evas_Object *obj) |
Gets the disabled state of an Elementary object. | |
void | elm_object_signal_emit (Evas_Object *obj, const char *emission, const char *source) |
Sends a signal to the widget edje object. | |
void | elm_object_signal_callback_add (Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) |
Adds a callback for a signal emitted by the widget edje object. | |
void * | elm_object_signal_callback_del (Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) |
Removes a signal-triggered callback from a widget edje object. | |
void | elm_object_event_callback_add (Evas_Object *obj, Elm_Event_Cb func, const void *data) |
Adds a callback for input events (key up, key down, mouse wheel) on a given Elementary widget. | |
void * | elm_object_event_callback_del (Evas_Object *obj, Elm_Event_Cb func, const void *data) |
Removes an event callback from a widget. | |
void | elm_object_orientation_mode_disabled_set (Evas_Object *obj, Eina_Bool disabled) |
Disables the orientation mode of a given widget. | |
Eina_Bool | elm_object_orientation_mode_disabled_get (const Evas_Object *obj) |
Gets the orientation mode of a given widget. | |
Evas_Object * | elm_object_item_widget_get (const Elm_Object_Item *it) |
Gets the widget object's handle which contains a given item. | |
void | elm_object_item_part_content_set (Elm_Object_Item *it, const char *part, Evas_Object *content) |
Sets the content of an object item. | |
Evas_Object * | elm_object_item_part_content_get (const Elm_Object_Item *it, const char *part) |
Gets the content of an object item. | |
Evas_Object * | elm_object_item_part_content_unset (Elm_Object_Item *it, const char *part) |
Unsets the content of an object item. | |
void | elm_object_item_part_text_set (Elm_Object_Item *it, const char *part, const char *label) |
Sets the label of an object item. | |
const char * | elm_object_item_part_text_get (const Elm_Object_Item *it, const char *part) |
Gets the label of an object item. | |
void | elm_object_item_domain_translatable_part_text_set (Elm_Object_Item *it, const char *part, const char *domain, const char *text) |
Sets the text for an object item's part, marking it as translatable. | |
const char * | elm_object_item_translatable_part_text_get (const Elm_Object_Item *it, const char *part) |
Gets the original string set as translatable for an object item. | |
void | elm_object_item_domain_part_text_translatable_set (Elm_Object_Item *it, const char *part, const char *domain, Eina_Bool translatable) |
Marks the part text to be translatable. | |
void | elm_object_item_access_info_set (Elm_Object_Item *it, const char *txt) |
Sets the text to read out when in the accessibility mode. | |
Evas_Object * | elm_object_item_access_register (Elm_Object_Item *item) |
Registers the object item as an accessible object. | |
void | elm_object_item_access_unregister (Elm_Object_Item *item) |
Unregisters the accessible object of the object item. | |
Evas_Object * | elm_object_item_access_object_get (const Elm_Object_Item *item) |
Gets the accessible object of the object item. | |
void | elm_object_item_access_order_set (Elm_Object_Item *item, Eina_List *objs) |
Sets the highlight order. | |
const Eina_List * | elm_object_item_access_order_get (const Elm_Object_Item *item) |
Gets the highlight order. | |
void | elm_object_item_access_order_unset (Elm_Object_Item *item) |
Unsets the highlight order. | |
void * | elm_object_item_data_get (const Elm_Object_Item *it) |
Gets the data associated with an object item. | |
void | elm_object_item_data_set (Elm_Object_Item *it, void *data) |
Sets the data associated with an object item. | |
void | elm_object_item_signal_emit (Elm_Object_Item *it, const char *emission, const char *source) |
Sends a signal to the edje object of the widget item. | |
void | elm_object_item_signal_callback_add (Elm_Object_Item *it, const char *emission, const char *source, Elm_Object_Item_Signal_Cb func, void *data) |
Adds a callback for a signal emitted by the object item, edje object. | |
void * | elm_object_item_signal_callback_del (Elm_Object_Item *it, const char *emission, const char *source, Elm_Object_Item_Signal_Cb func) |
Removes a signal-triggered callback from the object item, edje object. | |
void | elm_object_item_del_cb_set (Elm_Object_Item *it, Evas_Smart_Cb del_cb) |
Sets the function to be called when an item from the widget is freed. | |
void | elm_object_item_del (Elm_Object_Item *it) |
Deletes the given item. | |
void | elm_object_item_tooltip_text_set (Elm_Object_Item *it, const char *text) |
Sets the text to be shown in a given object item's tooltips. | |
Eina_Bool | elm_object_item_tooltip_window_mode_set (Elm_Object_Item *it, Eina_Bool disable) |
Disables the size restrictions on an object's tooltip. | |
Eina_Bool | elm_object_item_tooltip_window_mode_get (const Elm_Object_Item *it) |
Retrieves the size restriction state of an object's tooltip. | |
void | elm_object_item_tooltip_content_cb_set (Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) |
Sets the content to be shown in the tooltip item. | |
void | elm_object_item_tooltip_unset (Elm_Object_Item *it) |
Unsets the tooltip from the item. | |
void | elm_object_item_tooltip_style_set (Elm_Object_Item *it, const char *style) |
Sets a different style for this item tooltip. | |
const char * | elm_object_item_tooltip_style_get (const Elm_Object_Item *it) |
Gets the style for this item tooltip. | |
void | elm_object_item_cursor_set (Elm_Object_Item *it, const char *cursor) |
Sets the type of mouse pointer/cursor decoration to be shown, when the mouse pointer is over the given item. | |
const char * | elm_object_item_cursor_get (const Elm_Object_Item *it) |
Gets the type of mouse pointer/cursor decoration set to be shown, when the mouse pointer is over the given item. | |
void | elm_object_item_cursor_unset (Elm_Object_Item *it) |
Unsets any custom mouse pointer/cursor decoration set to be shown, when the mouse pointer is over the given item, thus making it show the default cursor again. | |
void | elm_object_item_cursor_style_set (Elm_Object_Item *it, const char *style) |
Sets a different style for a given custom cursor set of an item. | |
const char * | elm_object_item_cursor_style_get (const Elm_Object_Item *it) |
Get the current style set for a given item's custom cursor. | |
void | elm_object_item_cursor_engine_only_set (Elm_Object_Item *it, Eina_Bool engine_only) |
Sets whether the (custom)cursor for a given item should be searched in its theme or should only rely on the rendering engine. | |
Eina_Bool | elm_object_item_cursor_engine_only_get (const Elm_Object_Item *it) |
Gets whether the (custom) cursor for a given item is being searched in its theme or is only relying on the rendering engine. | |
Evas_Object * | elm_object_item_track (Elm_Object_Item *it) |
Returns the track object of the item. | |
void | elm_object_item_untrack (Elm_Object_Item *it) |
Retrieves the track object of the item. | |
int | elm_object_item_track_get (const Elm_Object_Item *it) |
Gets the track object reference count. | |
void | elm_object_item_style_set (Elm_Object_Item *it, const char *part) |
Sets the style of an object item. | |
const char * | elm_object_item_style_get (Elm_Object_Item *it) |
Gets the style of an object item. | |
Typedefs | |
typedef struct _Elm_Event_Policy_Changed | Elm_Event_Policy_Changed |
The structure type containing data on the event when an Elementary policy has changed. | |
typedef struct _Elm_Object_Item | Elm_Object_Item |
An Elementary Object item handle. | |
typedef Eina_Bool(* | Elm_Event_Cb )(void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info) |
typedef void(* | Elm_Object_Item_Signal_Cb )(void *data, Elm_Object_Item *it, const char *emission, const char *source) |
It is the Elm_Object_Item Signal Callback functions' prototype definition. data is going to have the auxiliary data pointer at the time of the callback registration. it is a pointer to Elm_Object_Item that has the edje object from where the signal comes. emission identifies the exact signal's emission string and source identifies the exact signal's source. | |
Defines | |
#define | ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv); } |
#define | elm_object_text_set(obj, text) elm_object_part_text_set((obj), NULL, (text)) |
Convenient macro for elm_object_part_text_set. | |
#define | elm_object_text_get(obj) elm_object_part_text_get((obj), NULL) |
Convenient macro for elm_object_part_text_get. | |
#define | elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_part_text_set((obj), NULL, (domain), (text)) |
Convenient macro for elm_object_domain_translatable_part_text_set. | |
#define | elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_part_text_set((obj), NULL, NULL, (text)) |
Convenient macro for elm_object_domain_translatable_part_text_set. | |
#define | elm_object_translatable_part_text_set(obj, part, text) elm_object_domain_translatable_part_text_set((obj), (part), NULL, (text)) |
Convenient macro for elm_object_domain_translatable_part_text_set. | |
#define | elm_object_translatable_text_get(obj) elm_object_translatable_part_text_get((obj), NULL) |
Convenient macro for elm_object_translatable_part_text_get. | |
#define | elm_object_part_text_translatable_set(obj, part, translatable) elm_object_domain_part_text_translatable_set((obj), (part), NULL, (translatable)) |
Convenient macro for elm_object_domain_part_text_translatable_set. | |
#define | elm_object_domain_text_translatable_set(obj, domain, translatable) elm_object_domain_part_text_translatable_set((obj), NULL, (domain), (translatable)) |
Convenient macro for elm_object_domain_part_text_translatable_set. | |
#define | elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content)) |
Convenient macro for elm_object_part_content_set. | |
#define | elm_object_content_get(obj) elm_object_part_content_get((obj), NULL) |
Convenient macro for elm_object_part_content_get. | |
#define | elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL) |
Convenient macro for elm_object_part_content_unset. | |
#define | elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content)) |
Convenient macro for elm_object_item_part_content_set. | |
#define | elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL) |
Convenient macro for elm_object_item_part_content_get. | |
#define | elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL) |
Convenient macro for elm_object_item_part_content_unset. | |
#define | elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label)) |
Sets the macro label of an object item. | |
#define | elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL) |
Convenient macro for elm_object_item_part_text_get. | |
#define | elm_object_item_domain_translatable_text_set(it, domain, text) elm_object_item_domain_translatable_part_text_set((it), NULL, (domain), (text)) |
Convenient macro for elm_object_item_domain_translatable_part_text_set. | |
#define | elm_object_item_translatable_text_set(it, text) elm_object_item_domain_translatable_part_text_set((it), NULL, NULL, (text)) |
Convenient macro for elm_object_item_domain_translatable_part_text_set. | |
#define | elm_object_item_translatable_part_text_set(it, part, text) elm_object_item_domain_translatable_part_text_set((it), (part), NULL, (text)) |
Convenient macro for elm_object_item_domain_translatable_part_text_set. | |
#define | elm_object_item_translatable_text_get(it) elm_object_item_translatable_part_text_get((it), NULL) |
Convenient macro for elm_object_item_translatable_part_text_get. | |
#define | elm_object_item_part_text_translatable_set(it, part, translatable) elm_object_item_domain_part_text_translatable_set((it), (part), NULL, (translatable)) |
Convenient macro for elm_object_item_domain_part_text_translatable_set. | |
#define | elm_object_item_domain_text_translatable_set(it, domain, translatable) elm_object_item_domain_part_text_translatable_set((it), NULL, (domain), (translatable)) |
Convenient macro for elm_object_item_domain_part_text_translatable_set. |
General Elementary API. Functions that don't relate to Elementary objects specifically.
These are documented functions that init/shutdown the library, that apply to generic Elementary objects, that deal with configuration, etc.
#define ELM_MAIN | ( | ) | int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv); } |
Macro to be used after the elm_main() function
#define elm_object_content_get | ( | obj | ) | elm_object_part_content_get((obj), NULL) |
#define elm_object_content_set | ( | obj, | |
content | |||
) | elm_object_part_content_set((obj), NULL, (content)) |
#define elm_object_content_unset | ( | obj | ) | elm_object_part_content_unset((obj), NULL) |
Convenient macro for elm_object_part_content_unset.
#define elm_object_domain_text_translatable_set | ( | obj, | |
domain, | |||
translatable | |||
) | elm_object_domain_part_text_translatable_set((obj), NULL, (domain), (translatable)) |
Convenient macro for elm_object_domain_part_text_translatable_set.
#define elm_object_domain_translatable_text_set | ( | obj, | |
domain, | |||
text | |||
) | elm_object_domain_translatable_part_text_set((obj), NULL, (domain), (text)) |
Convenient macro for elm_object_domain_translatable_part_text_set.
#define elm_object_item_content_get | ( | it | ) | elm_object_item_part_content_get((it), NULL) |
Convenient macro for elm_object_item_part_content_get.
#define elm_object_item_content_set | ( | it, | |
content | |||
) | elm_object_item_part_content_set((it), NULL, (content)) |
Convenient macro for elm_object_item_part_content_set.
#define elm_object_item_content_unset | ( | it | ) | elm_object_item_part_content_unset((it), NULL) |
Convenient macro for elm_object_item_part_content_unset.
#define elm_object_item_domain_text_translatable_set | ( | it, | |
domain, | |||
translatable | |||
) | elm_object_item_domain_part_text_translatable_set((it), NULL, (domain), (translatable)) |
Convenient macro for elm_object_item_domain_part_text_translatable_set.
#define elm_object_item_domain_translatable_text_set | ( | it, | |
domain, | |||
text | |||
) | elm_object_item_domain_translatable_part_text_set((it), NULL, (domain), (text)) |
Convenient macro for elm_object_item_domain_translatable_part_text_set.
#define elm_object_item_part_text_translatable_set | ( | it, | |
part, | |||
translatable | |||
) | elm_object_item_domain_part_text_translatable_set((it), (part), NULL, (translatable)) |
Convenient macro for elm_object_item_domain_part_text_translatable_set.
#define elm_object_item_text_get | ( | it | ) | elm_object_item_part_text_get((it), NULL) |
Convenient macro for elm_object_item_part_text_get.
#define elm_object_item_text_set | ( | it, | |
label | |||
) | elm_object_item_part_text_set((it), NULL, (label)) |
Sets the macro label of an object item.
[in] | it | The Elementary object item |
[in] | label | The new text of the label |
#define elm_object_item_translatable_part_text_set | ( | it, | |
part, | |||
text | |||
) | elm_object_item_domain_translatable_part_text_set((it), (part), NULL, (text)) |
Convenient macro for elm_object_item_domain_translatable_part_text_set.
#define elm_object_item_translatable_text_get | ( | it | ) | elm_object_item_translatable_part_text_get((it), NULL) |
Convenient macro for elm_object_item_translatable_part_text_get.
#define elm_object_item_translatable_text_set | ( | it, | |
text | |||
) | elm_object_item_domain_translatable_part_text_set((it), NULL, NULL, (text)) |
Convenient macro for elm_object_item_domain_translatable_part_text_set.
#define elm_object_part_text_translatable_set | ( | obj, | |
part, | |||
translatable | |||
) | elm_object_domain_part_text_translatable_set((obj), (part), NULL, (translatable)) |
Convenient macro for elm_object_domain_part_text_translatable_set.
#define elm_object_text_get | ( | obj | ) | elm_object_part_text_get((obj), NULL) |
#define elm_object_text_set | ( | obj, | |
text | |||
) | elm_object_part_text_set((obj), NULL, (text)) |
#define elm_object_translatable_part_text_set | ( | obj, | |
part, | |||
text | |||
) | elm_object_domain_translatable_part_text_set((obj), (part), NULL, (text)) |
Convenient macro for elm_object_domain_translatable_part_text_set.
#define elm_object_translatable_text_get | ( | obj | ) | elm_object_translatable_part_text_get((obj), NULL) |
Convenient macro for elm_object_translatable_part_text_get.
#define elm_object_translatable_text_set | ( | obj, | |
text | |||
) | elm_object_domain_translatable_part_text_set((obj), NULL, NULL, (text)) |
Convenient macro for elm_object_domain_translatable_part_text_set.
typedef Eina_Bool(* Elm_Event_Cb)(void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info) |
Function prototype definition for callbacks on input events happening on Elementary widgets. data receives the user data pointer passed to elm_object_event_callback_add(). src is a pointer to the widget on which the input event took place. type gets the type of this event and event_info, the struct with details on this event
It is the Elm_Object_Item Signal Callback functions' prototype definition. data is going to have the auxiliary data pointer at the time of the callback registration. it is a pointer to Elm_Object_Item that has the edje object from where the signal comes. emission identifies the exact signal's emission string and source identifies the exact signal's source.
enum Elm_Object_Layer |
Enumeration that defines a couple of standard Evas_Object layers to be used with evas_object_layer_set().
enum Elm_Policy |
Enumeration that defines the policy identifiers.
ELM_POLICY_QUIT |
Under which circumstances the application should quit automatically.
|
ELM_POLICY_EXIT |
Defines the elm_exit() behaviour.
|
ELM_POLICY_THROTTLE |
Defines how throttling should work
|
enum Elm_Policy_Exit |
Enumeration that defines the possible values for the ELM_POLICY_EXIT policy.
ELM_POLICY_EXIT_NONE |
Just quit the main loop on elm_exit() |
ELM_POLICY_EXIT_WINDOWS_DEL |
Delete all the windows after quitting the main loop |
enum Elm_Policy_Quit |
Enumeration that defines the possible values for the ELM_POLICY_QUIT policy.
enum Elm_Policy_Throttle |
Enumeration that defines the possible values for the ELM_POLICY_THROTTLE policy.
void elm_exit | ( | void | ) |
Asks to exit Elementary's main loop.
int elm_init | ( | int | argc, |
char ** | argv | ||
) |
Initializes Elementary.
This function initializes Elementary and increments a counter of the number of calls to it. It returns the new counter's value.
EAPI_MAIN
symbol in front of its type declaration is advisable). The ELM_MAIN() call should be placed just after it.[in] | argc | The system's argument count value |
[in] | argv | The system's pointer to the array of argument strings |
void elm_language_set | ( | const char * | lang | ) |
Changes the language of the current application.
"language,changed"
signal that the user can listen to, in order to manually translate the text.[in] | lang | The language to set, must be the full name of the locale |
void elm_object_access_info_set | ( | Evas_Object * | obj, |
const char * | txt | ||
) |
Sets the text to read out when in the accessibility mode.
[in] | obj | The object which is to be described |
[in] | txt | The text that describes the widget to people with poor or no vision |
Eina_Bool elm_object_disabled_get | ( | const Evas_Object * | obj | ) |
Gets the disabled state of an Elementary object.
This gets the state of the widget, which might be enabled or disabled.
[in] | obj | The Elementary object to operate on |
EINA_TRUE
if the widget is disabled, otherwise EINA_FALSE
if it's enabled (or on errors) void elm_object_disabled_set | ( | Evas_Object * | obj, |
Eina_Bool | disabled | ||
) |
Sets the disabled state of an Elementary object.
[in] | obj | The Elementary object to operate on |
[in] | disabled | If EINA_TRUE that state is disabled, otherwise EINA_FALSE if it is enabled |
void elm_object_domain_part_text_translatable_set | ( | Evas_Object * | obj, |
const char * | part, | ||
const char * | domain, | ||
Eina_Bool | translatable | ||
) |
Marks the part text to be transltable.
[in] | obj | The object containing the text part |
[in] | part | The part name of the translatable text |
[in] | domain | The translation domain to use |
[in] | translatable | If EINA_TRUE the part text is translated internally, otherwise EINA_FALSE |
void elm_object_domain_translatable_part_text_set | ( | Evas_Object * | obj, |
const char * | part, | ||
const char * | domain, | ||
const char * | text | ||
) |
Sets the text for an object's part, marking it translatable.
NULL
, in which case it uses whatever domain is set by the application with textdomain(). This is useful in case you are building a library on top of Elementary that has its own translatable strings, that should not be mixed with those of programs using the library.[in] | obj | The object containing the text part |
[in] | part | The name of the part to set |
[in] | domain | The translation domain to use |
[in] | text | The original, non-translated text to set |
void elm_object_event_callback_add | ( | Evas_Object * | obj, |
Elm_Event_Cb | func, | ||
const void * | data | ||
) |
Adds a callback for input events (key up, key down, mouse wheel) on a given Elementary widget.
EINA_TRUE
on func. EINA_FALSE
means that the event is not processed, so the propagation goes on.func
contains the event's structure and, if you OR its event_flags inner value to EVAS_EVENT_FLAG_ON_HOLD
, you're telling Elementary has already handled it, thus killing the event's propagation.[in] | obj | The widget to add an event callback on |
[in] | func | The callback function to be executed when the event happens |
[in] | data | The data to pass into func |
void* elm_object_event_callback_del | ( | Evas_Object * | obj, |
Elm_Event_Cb | func, | ||
const void * | data | ||
) |
Removes an event callback from a widget.
This function removes a callback, previously attached to the event emission by the obj. The parameters func and data must match exactly those passed to a previous call to elm_object_event_callback_add(). The data pointer that is passed to this call is returned.
[in] | obj | The object |
[in] | func | The callback function to be executed when the event is emitted |
[in] | data | The data to pass to the callback function |
void elm_object_item_access_info_set | ( | Elm_Object_Item * | it, |
const char * | txt | ||
) |
Sets the text to read out when in the accessibility mode.
[in] | it | The object item which is to be described |
[in] | txt | The text that describes the widget to people with poor or no vision |
Evas_Object* elm_object_item_access_object_get | ( | const Elm_Object_Item * | item | ) |
Gets the accessible object of the object item.
[in] | item | The elementary object item |
NULL
for any error const Eina_List* elm_object_item_access_order_get | ( | const Elm_Object_Item * | item | ) |
Gets the highlight order.
[in] | item | The container object item |
void elm_object_item_access_order_set | ( | Elm_Object_Item * | item, |
Eina_List * | objs | ||
) |
Sets the highlight order.
[in] | item | The container object item |
[in] | objs | The order of objects to pass highlight |
void elm_object_item_access_order_unset | ( | Elm_Object_Item * | item | ) |
Unsets the highlight order.
[in] | item | The container object item |
Registers the object item as an accessible object.
[in] | item | The elementary object item |
NULL
for any error void elm_object_item_access_unregister | ( | Elm_Object_Item * | item | ) |
Unregisters the accessible object of the object item.
[in] | item | The elementary object item |
Eina_Bool elm_object_item_cursor_engine_only_get | ( | const Elm_Object_Item * | it | ) |
Gets whether the (custom) cursor for a given item is being searched in its theme or is only relying on the rendering engine.
[in] | it | The object item |
EINA_TRUE
, if cursors are being looked for only from those provided by the rendering engine, otherwise EINA_FALSE
if they are being searched on the widget's theme as well.void elm_object_item_cursor_engine_only_set | ( | Elm_Object_Item * | it, |
Eina_Bool | engine_only | ||
) |
Sets whether the (custom)cursor for a given item should be searched in its theme or should only rely on the rendering engine.
[in] | it | The item with custom (custom) cursor already set on it |
[in] | engine_only | If EINA_TRUE cursors are looked for only from those provided by the rendering engine, otherwise EINA_FALSE to have them searched on the widget's theme as well |
const char* elm_object_item_cursor_get | ( | const Elm_Object_Item * | it | ) |
Gets the type of mouse pointer/cursor decoration set to be shown, when the mouse pointer is over the given item.
[in] | it | The item with the custom cursor set |
NULL
if no custom cursors are set to it (and on errors)void elm_object_item_cursor_set | ( | Elm_Object_Item * | it, |
const char * | cursor | ||
) |
Sets the type of mouse pointer/cursor decoration to be shown, when the mouse pointer is over the given item.
[in] | it | The item to customize the cursor on |
[in] | cursor | The cursor type's name |
const char* elm_object_item_cursor_style_get | ( | const Elm_Object_Item * | it | ) |
Get the current style set for a given item's custom cursor.
[in] | it | The item with the custom cursor set |
NULL
is returned.void elm_object_item_cursor_style_set | ( | Elm_Object_Item * | it, |
const char * | style | ||
) |
Sets a different style for a given custom cursor set of an item.
[in] | it | The item with the custom cursor set |
[in] | style | The theme style to use (e.g. "default" , "transparent" , etc) |
void elm_object_item_cursor_unset | ( | Elm_Object_Item * | it | ) |
Unsets any custom mouse pointer/cursor decoration set to be shown, when the mouse pointer is over the given item, thus making it show the default cursor again.
[in] | it | The item |
void* elm_object_item_data_get | ( | const Elm_Object_Item * | it | ) |
Gets the data associated with an object item.
[in] | it | The Elementary object item |
void elm_object_item_data_set | ( | Elm_Object_Item * | it, |
void * | data | ||
) |
Sets the data associated with an object item.
[in] | it | The Elementary object item |
[in] | data | The data to be associated with it |
void elm_object_item_del | ( | Elm_Object_Item * | it | ) |
Deletes the given item.
[in] | it | The item to be deleted |
void elm_object_item_del_cb_set | ( | Elm_Object_Item * | it, |
Evas_Smart_Cb | del_cb | ||
) |
Sets the function to be called when an item from the widget is freed.
[in] | it | The item to set the callback on |
[in] | del_cb | The function called |
void elm_object_item_domain_part_text_translatable_set | ( | Elm_Object_Item * | it, |
const char * | part, | ||
const char * | domain, | ||
Eina_Bool | translatable | ||
) |
Marks the part text to be translatable.
[in] | it | The object item containing the text part |
[in] | part | The part name of the translatable text |
[in] | domain | The translation domain to use |
[in] | translatable | If EINA_TRUE , the part text is translated internally, otherwise EINA_FALSE |
void elm_object_item_domain_translatable_part_text_set | ( | Elm_Object_Item * | it, |
const char * | part, | ||
const char * | domain, | ||
const char * | text | ||
) |
Sets the text for an object item's part, marking it as translatable.
NULL
, in which case it uses whatever domain is set by the application with textdomain(). This is useful in case you are building a library on top of Elementary that should have its own translatable strings, that should not be mixed with those of programs using the library.[in] | it | The object item containing the text part |
[in] | part | The name of the part to set |
[in] | domain | The translation domain to use |
[in] | text | The original, non-translated text to set |
Evas_Object* elm_object_item_part_content_get | ( | const Elm_Object_Item * | it, |
const char * | part | ||
) |
Gets the content of an object item.
[in] | it | The Elementary object item |
[in] | part | The content part name to unset (NULL for the default content) |
NULL
for any error void elm_object_item_part_content_set | ( | Elm_Object_Item * | it, |
const char * | part, | ||
Evas_Object * | content | ||
) |
Sets the content of an object item.
This sets a new object to an item as a content object. If any object is already set as a content object in the same part, this previous object is deleted automatically.
[in] | it | The Elementary object item |
[in] | part | The content part name to set (NULL for the default content) |
[in] | content | The new content of the object item |
Evas_Object* elm_object_item_part_content_unset | ( | Elm_Object_Item * | it, |
const char * | part | ||
) |
Unsets the content of an object item.
[in] | it | The Elementary object item |
[in] | part | The content part name to unset (NULL for the default content) |
const char* elm_object_item_part_text_get | ( | const Elm_Object_Item * | it, |
const char * | part | ||
) |
Gets the label of an object item.
[in] | it | The Elementary object item |
[in] | part | The text part name to get (NULL for the default label) |
NULL
for any error void elm_object_item_part_text_set | ( | Elm_Object_Item * | it, |
const char * | part, | ||
const char * | label | ||
) |
Sets the label of an object item.
[in] | it | The Elementary object item |
[in] | part | The text part name to set (NULL for the default label) |
[in] | label | The new text of the label |
void elm_object_item_signal_callback_add | ( | Elm_Object_Item * | it, |
const char * | emission, | ||
const char * | source, | ||
Elm_Object_Item_Signal_Cb | func, | ||
void * | data | ||
) |
Adds a callback for a signal emitted by the object item, edje object.
This function connects a callback function to a signal emitted by the edje object of the object item. Globs can occur in either the emission or source name.
[in] | it | The elementary object item |
[in] | emission | The signal name |
[in] | source | The signal source |
[in] | func | The callback function to be executed when the signal is emitted |
[in] | data | A pointer to the data to pass to the callback function |
void* elm_object_item_signal_callback_del | ( | Elm_Object_Item * | it, |
const char * | emission, | ||
const char * | source, | ||
Elm_Object_Item_Signal_Cb | func | ||
) |
Removes a signal-triggered callback from the object item, edje object.
This function removes the last callback, previously attached to a signal emitted by an underlying Edje object of it, whose parameters emission, source, and func
match exactly with those passed to a previous call to elm_object_item_signal_callback_add(). The data pointer that is passed to this call is returned.
[in] | it | The elementary object item |
[in] | emission | The signal name |
[in] | source | The signal source |
[in] | func | The callback function to be executed when the signal is emitted |
NULL
on errorsvoid elm_object_item_signal_emit | ( | Elm_Object_Item * | it, |
const char * | emission, | ||
const char * | source | ||
) |
Sends a signal to the edje object of the widget item.
This function sends a signal to the edje object of the obj item. An edje program can respond to a signal by specifying matching 'signal' and 'source' fields.
[in] | it | The Elementary object item |
[in] | emission | The signal name |
[in] | source | The signal source |
const char* elm_object_item_style_get | ( | Elm_Object_Item * | it | ) |
Gets the style of an object item.
[in] | it | The Elementary object item |
void elm_object_item_style_set | ( | Elm_Object_Item * | it, |
const char * | part | ||
) |
Sets the style of an object item.
[in] | it | The Elementary object item |
[in] | part | The style of the object item |
void elm_object_item_tooltip_content_cb_set | ( | Elm_Object_Item * | it, |
Elm_Tooltip_Item_Content_Cb | func, | ||
const void * | data, | ||
Evas_Smart_Cb | del_cb | ||
) |
Sets the content to be shown in the tooltip item.
[in] | it | The object item being attached as a tooltip |
[in] | func | The function used to create the tooltip contents |
[in] | data | The data to provide to func as callback data/context |
[in] | del_cb | Called when data is not needed anymore, either when another callback replaces func, the tooltip is unset with elm_object_item_tooltip_unset() or the owner it dies. This callback receives as the given data as the first parameter and event_info is the item. |
const char* elm_object_item_tooltip_style_get | ( | const Elm_Object_Item * | it | ) |
Gets the style for this item tooltip.
[in] | it | The object item with the tooltip already set |
NULL
is returned.void elm_object_item_tooltip_style_set | ( | Elm_Object_Item * | it, |
const char * | style | ||
) |
Sets a different style for this item tooltip.
[in] | it | The object item with the tooltip already set |
[in] | style | The theme style to use (default, transparent, ...) |
void elm_object_item_tooltip_text_set | ( | Elm_Object_Item * | it, |
const char * | text | ||
) |
Sets the text to be shown in a given object item's tooltips.
[in] | it | The target item |
[in] | text | The text to set in the content |
void elm_object_item_tooltip_unset | ( | Elm_Object_Item * | it | ) |
Unsets the tooltip from the item.
This removes the tooltip from the item. The callback provided as del_cb to elm_object_item_tooltip_content_cb_set() is called to notify that it is not used anymore.
[in] | it | The object item from which to remove previously set tooltip |
Eina_Bool elm_object_item_tooltip_window_mode_get | ( | const Elm_Object_Item * | it | ) |
Retrieves the size restriction state of an object's tooltip.
This function returns whether a tooltip is allowed to expand beyond its parent window's canvas. It is instead limited only by the size of the display.
[in] | it | The tooltip's anchor object |
EINA_TRUE
if the size restrictions are disabled, otherwise EINA_FALSE
Eina_Bool elm_object_item_tooltip_window_mode_set | ( | Elm_Object_Item * | it, |
Eina_Bool | disable | ||
) |
Disables the size restrictions on an object's tooltip.
This function allows a tooltip to expand beyond its parent window's canvas. It is instead limited only by the size of the display.
[in] | it | The tooltip's anchor object |
[in] | disable | If EINA_TRUE size restrictions are disabled, otherwise EINA_FALSE |
EINA_TRUE
on success, EINA_FALSE
on failure Returns the track object of the item.
This gets a rectangle object that represents the object item's internal object. If you want to check the geometry and visibility of the item, you can call the evas apis, such as evas_object_geometry_get() and evas_object_visible_get(), to the track object. Note that all of the widget items may/may not have the internal object so this API may return NULL
if the widget item doesn't have it. Additionally, the widget item is managed/controlled by the widget, the widget item could be changed(moved, resized even deleted) anytime by its own widget's decision. So dont' change the track object and don't keep the track object on your side as far as possible, but get the track object the moment you need to refer. Otherwise, you need to add some callbacks to the track object to track it's attributes changes.
[in] | it | The Elementary Object Item to be tracked |
int elm_object_item_track_get | ( | const Elm_Object_Item * | it | ) |
Gets the track object reference count.
This gets the reference count for the track object. Whenever you call elm_object_item_track(), the reference count is increased by one. Similarly, the reference count is decreased again when you call the elm_object_item_untrack(). Unless the reference count reaches to zero, the track object won't be deleted. So be sure to call elm_object_item_untrack() paired to the elm_object_item_track() call count.
[in] | it | The Elementary Object Item that returned the track object |
const char* elm_object_item_translatable_part_text_get | ( | const Elm_Object_Item * | it, |
const char * | part | ||
) |
Gets the original string set as translatable for an object item.
[in] | it | The object item |
[in] | part | The name of the part that is set |
void elm_object_item_untrack | ( | Elm_Object_Item * | it | ) |
Retrieves the track object of the item.
This retrieves the track object that is returned from elm_object_item_track().
[in] | it | The Elementary Object Item that returned the track object |
Evas_Object* elm_object_item_widget_get | ( | const Elm_Object_Item * | it | ) |
Gets the widget object's handle which contains a given item.
This returns the widget object itself to which an item belongs.
[in] | it | The Elementary object item |
Evas_Object* elm_object_name_find | ( | const Evas_Object * | obj, |
const char * | name, | ||
int | recurse | ||
) |
Gets a named object from the children.
This function searches the children (or recursively children of children and so on) of the given obj object looking for a child with the name of name. If the child is found the object is returned, or NULL
is returned. You can set the name of an object with evas_object_name_set(). If the name is not unique within the child objects (or the tree is recurse or is greater than 0
) then it is undefined as to which child of that name is returned, so ensure that the name is unique amongst children. If recurse is set to -1
it recurses without limit.
[in] | obj | The parent object whose children to look at |
[in] | name | The name of the child to find |
[in] | recurse | Set to the maximum number of levels to recurse (0 == none, 1 is only to look at one level of children and so on) |
NULL
if none are found Eina_Bool elm_object_orientation_mode_disabled_get | ( | const Evas_Object * | obj | ) |
Gets the orientation mode of a given widget.
[in] | obj | The Elementary widget to query for its orientation mode |
EINA_TRUE
, if the orientation mode is disabled, otherwise EINA_FALSE
if the orientation mode is enabled (or on errors)void elm_object_orientation_mode_disabled_set | ( | Evas_Object * | obj, |
Eina_Bool | disabled | ||
) |
Disables the orientation mode of a given widget.
[in] | obj | The Elementary object to operate in the orientation mode |
[in] | disabled | If EINA_TRUE the state is disabled, otherwise EINA_FALSE if it is enabled |
Evas_Object* elm_object_part_content_get | ( | const Evas_Object * | obj, |
const char * | part | ||
) |
Gets the content at a part of a given container widget.
[in] | obj | The Elementary container widget |
[in] | part | The container's part name to get (some might accept NULL for the default part) |
NULL
in case of an errorvoid elm_object_part_content_set | ( | Evas_Object * | obj, |
const char * | part, | ||
Evas_Object * | content | ||
) |
Sets the content at a part of a given container widget.
[in] | obj | The Elementary container widget |
[in] | part | The container's part name to set (some might accept NULL for the default part) |
[in] | content | The new content for that part |
Evas_Object* elm_object_part_content_unset | ( | Evas_Object * | obj, |
const char * | part | ||
) |
Unsets the content at a part of a given container widget.
[in] | obj | The Elementary container widget |
[in] | part | The container's part name to unset (some might accept NULL for the default part) |
NULL
in case of an errorconst char* elm_object_part_text_get | ( | const Evas_Object * | obj, |
const char * | part | ||
) |
Gets the text of an object.
[in] | obj | The Elementary object |
[in] | part | The text part name to get (NULL for the default part) |
NULL
for any error void elm_object_part_text_set | ( | Evas_Object * | obj, |
const char * | part, | ||
const char * | text | ||
) |
Sets the text of an object.
[in] | obj | The Elementary object |
[in] | part | The text part name to set (NULL for the default part) |
[in] | text | The new text of the part |
void elm_object_signal_callback_add | ( | Evas_Object * | obj, |
const char * | emission, | ||
const char * | source, | ||
Edje_Signal_Cb | func, | ||
void * | data | ||
) |
Adds a callback for a signal emitted by the widget edje object.
This function connects a callback function to a signal emitted by the edje object of the obj. Globs can occur in either the emission or source name.
[in] | obj | The object |
[in] | emission | The signal name |
[in] | source | The signal source |
[in] | func | The callback function to be executed when the signal is emitted |
[in] | data | A pointer to the data to pass to the callback function |
void* elm_object_signal_callback_del | ( | Evas_Object * | obj, |
const char * | emission, | ||
const char * | source, | ||
Edje_Signal_Cb | func | ||
) |
Removes a signal-triggered callback from a widget edje object.
This function removes the last callback, previously attached to a signal emitted by an underlying Edje object of obj, whose parameters emission, source, and func
match exactly with those passed to a previous call to elm_object_signal_callback_add(). The data pointer that is passed to this call is returned.
[in] | obj | The object handle |
[in] | emission | The signal name |
[in] | source | The signal source |
[in] | func | The callback function to be executed when the signal is emitted |
NULL
in case of an error void elm_object_signal_emit | ( | Evas_Object * | obj, |
const char * | emission, | ||
const char * | source | ||
) |
Sends a signal to the widget edje object.
This function sends a signal to the edje object of the obj. An edje program can respond to a signal by specifying matching 'signal' and 'source' fields.
[in] | obj | The object |
[in] | emission | The signal name |
[in] | source | The signal source |
const char* elm_object_translatable_part_text_get | ( | const Evas_Object * | obj, |
const char * | part | ||
) |
Gets the original string set as translatable for an object.
[in] | obj | The object |
[in] | part | The name of the part that is set |
int elm_policy_get | ( | unsigned int | policy | ) |
Gets the policy value for the given policy identifier.
[in] | policy | The policy identifier, as in Elm_Policy |
0
if the policy passed is invalid. Eina_Bool elm_policy_set | ( | unsigned int | policy, |
int | value | ||
) |
Sets a new policy's value (for a given policy group/identifier).
[in] | policy | The policy identifier, as in Elm_Policy |
[in] | value | The policy value, which depends on the identifier |
EINA_TRUE
on success, otherwise EINA_FALSE
on error void elm_quicklaunch_cleanup | ( | void | ) |
Exposed symbol used only by macros and should not be used by apps.
char* elm_quicklaunch_exe_path_get | ( | const char * | exe | ) |
Exposed symbol used only by macros and should not be used by apps.
[in] | exe | The executable path |
int elm_quicklaunch_fallback | ( | int | argc, |
char ** | argv | ||
) |
Exposed symbol used only by macros and should not be used by apps.
[in] | argc | The system's argument count value |
[in] | argv | The system's pointer to the array of argument strings |
Eina_Bool elm_quicklaunch_fork | ( | int | argc, |
char ** | argv, | ||
char * | cwd, | ||
void(*)(void *data) | postfork_func, | ||
void * | postfork_data | ||
) |
Exposed symbol used only by macros and should not be used by apps.
[in] | argc | The system's argument count value |
[in] | argv | The system's pointer to the array of argument strings |
[in] | cwd | The current working directory |
[in] | postfork_func | The function will be called after fork |
[in] | postfork_data | The used data for postfork_func |
int elm_quicklaunch_init | ( | int | argc, |
char ** | argv | ||
) |
Exposed symbol used only by macros and should not be used by apps.
[in] | argc | The system's argument count value |
[in] | argv | The system's pointer to the array of argument strings |
Eina_Bool elm_quicklaunch_mode_get | ( | void | ) |
Exposed symbol used only by macros and should not be used by apps.
void elm_quicklaunch_mode_set | ( | Eina_Bool | ql_on | ) |
Exposed symbol used only by macros and should not be used by apps.
[in] | ql_on | The quicklaunch mode to be set. |
Eina_Bool elm_quicklaunch_prepare | ( | int | argc, |
char ** | argv | ||
) |
Exposed symbol used only by macros and should not be used by apps.
[in] | argc | The system's argument count value |
[in] | argv | The system's pointer to the array of argument strings |
void elm_quicklaunch_seed | ( | void | ) |
Exposed symbol used only by macros and should not be used by apps.
int elm_quicklaunch_shutdown | ( | void | ) |
Exposed symbol used only by macros and should not be used by apps.
int elm_quicklaunch_sub_init | ( | int | argc, |
char ** | argv | ||
) |
Exposed symbol used only by macros and should not be used by apps.
[in] | argc | The system's argument count value |
[in] | argv | The system's pointer to the array of argument strings |
int elm_quicklaunch_sub_shutdown | ( | void | ) |
Exposed symbol used only by macros and should not be used by apps.
void elm_run | ( | void | ) |
Runs Elementary's main loop.
int elm_shutdown | ( | void | ) |
Shuts down Elementary.