General Elementary API. More...
Data Structures | |
| struct | _Elm_Event_Policy_Changed |
| Data on the event when an Elementary policy has changed. More... | |
| struct | _Elm_Event_Atspi_Bridge_State_Changed |
| Data on event when atspi bridge state is changed. More... | |
Macros | |
| #define | ELM_MAIN() int main(int argc, char **argv) { int ret__; _elm_startup_time = ecore_time_unix_get(); elm_init(argc, argv); ret__ = elm_main(argc, argv); elm_shutdown(); return ret__; } |
| macro to be used after the elm_main() function | |
| #define | __EFL_UI_IS_REQUIRED |
| #define | elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label)) |
| Macro to set a label of an object item. More... | |
Typedefs | |
| typedef struct _Elm_Event_Policy_Changed | Elm_Event_Policy_Changed |
| Data on the event when an Elementary policy has changed. | |
| typedef struct _Elm_Event_Atspi_Bridge_State_Changed | Elm_Event_Atspi_Bridge_State_Changed |
| Data on event when atspi bridge state is changed. More... | |
| 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. More... | |
| typedef enum _Elm_Process_State | Elm_Process_State |
| typedef Eo | Elm_Object_Item |
| An Elementary Object item handle. | |
| typedef void(* | Elm_Object_Item_Signal_Cb) (void *data, Elm_Object_Item *it, const char *emission, const char *source) |
| Elm_Object_Item Signal Callback functions' prototype definition. More... | |
| typedef Eo | Elm_Widget_Item |
| An Elementary widget item handle. More... | |
Functions | |
| EINA_DEPRECATED void | elm_object_domain_translatable_text_part_set (Evas_Object *obj, const char *part, const char *domain, const char *text) |
| Set the text for an object's part, marking it as translatable. More... | |
| EINA_DEPRECATED const char * | elm_object_translatable_text_part_get (const Evas_Object *obj, const char *part) |
| Get the original string set as translatable for an object. More... | |
| int | elm_init (int argc, char **argv) |
| Initialize Elementary. More... | |
| int | elm_shutdown (void) |
| Shut down Elementary. More... | |
| void | elm_run (void) |
| Run Elementary's main loop. More... | |
| void | elm_exit (void) |
| Ask to exit Elementary's main loop. More... | |
| 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, const char *cwd) |
| Exposed symbol used only by macros and should not be used by apps. | |
| Eina_Bool | efl_quicklaunch_prepare (int argc, char **argv, const char *cwd) |
| Exposed symbol used only by macros and should not be used by apps. | |
| int | 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, const char *cwd) |
| Exposed symbol used only by macros and should not be used by apps. | |
| Eina_Bool | elm_policy_set (unsigned int policy, int value) |
| Set a new policy's value (for a given policy group/identifier). More... | |
| int | elm_policy_get (unsigned int policy) |
| Get the policy value for given policy identifier. More... | |
| void | elm_language_set (const char *lang) |
| Change the language of the current application. More... | |
| Elm_Process_State | elm_process_state_get (void) |
| The state of the process as a whole. More... | |
| void | elm_object_part_text_set (Evas_Object *obj, const char *part, const char *text) |
| Set a text of an object. More... | |
| const char * | elm_object_part_text_get (const Evas_Object *obj, const char *part) |
| Get a text of an object. More... | |
| void | elm_object_domain_translatable_part_text_set (Evas_Object *obj, const char *part, const char *domain, const char *text) |
| Set the text for an object's part, marking it as translatable. More... | |
| const char * | elm_object_translatable_part_text_get (const Evas_Object *obj, const char *part) |
| Get the original string set as translatable for an object. More... | |
| void | elm_object_domain_part_text_translatable_set (Evas_Object *obj, const char *part, const char *domain, Eina_Bool translatable) |
| Mark the part text to be translatable or not. More... | |
| void | elm_object_part_content_set (Evas_Object *obj, const char *part, Evas_Object *content) |
| Set the content on part of a given container widget. More... | |
| Evas_Object * | elm_object_part_content_get (const Evas_Object *obj, const char *part) |
| Get the content on a part of a given container widget. More... | |
| Evas_Object * | elm_object_part_content_unset (Evas_Object *obj, const char *part) |
| Unset the content on a part of a given container widget. More... | |
| void | elm_object_access_info_set (Evas_Object *obj, const char *txt) |
| Set the text to read out when in accessibility mode. More... | |
| const char * | elm_object_access_info_get (Evas_Object *obj) |
| Get the text to read out when in accessibility mode. More... | |
| Evas_Object * | elm_object_name_find (const Evas_Object *obj, const char *name, int recurse) |
| Get a named object from the children. More... | |
| void | elm_object_disabled_set (Evas_Object *obj, Eina_Bool disabled) |
| Set the disabled state of an Elementary object. More... | |
| Eina_Bool | elm_object_disabled_get (const Evas_Object *obj) |
| Get the disabled state of an Elementary object. More... | |
| void | elm_object_signal_emit (Evas_Object *obj, const char *emission, const char *source) |
| Send a signal to the widget edje object. More... | |
| void | elm_object_signal_callback_add (Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) |
| Add a callback for a signal emitted by widget edje object. More... | |
| void * | elm_object_signal_callback_del (Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) |
| Remove a signal-triggered callback from a widget edje object. More... | |
| void | elm_object_event_callback_add (Evas_Object *obj, Elm_Event_Cb func, const void *data) |
| Add a callback for input events (key up, key down, mouse wheel) on a given Elementary widget. More... | |
| void * | elm_object_event_callback_del (Evas_Object *obj, Elm_Event_Cb func, const void *data) |
| Remove an event callback from a widget. More... | |
| void | elm_object_orientation_mode_disabled_set (Evas_Object *obj, Eina_Bool disabled) |
| Disable the orientation mode of a given widget. More... | |
| Eina_Bool | elm_object_orientation_mode_disabled_get (const Evas_Object *obj) |
| Get the orientation mode of a given widget. More... | |
| void * | elm_object_item_data_get (const Elm_Object_Item *it) |
| Get the data associated with an object item. More... | |
| void | elm_object_item_data_set (Elm_Object_Item *it, void *data) |
| Set the data associated with an object item. More... | |
| void | elm_object_item_del (Elm_Object_Item *obj) |
| Delete the given item. | |
| Eina_Bool | elm_object_item_tooltip_window_mode_set (Elm_Widget_Item *obj, Eina_Bool disable) |
| Control size restriction state of an object's tooltip. More... | |
| Eina_Bool | elm_object_item_tooltip_window_mode_get (const Elm_Widget_Item *obj) |
| Control size restriction state of an object's tooltip. More... | |
| void | elm_object_item_tooltip_style_set (Elm_Widget_Item *obj, const char *style) |
| Control a different style for this item tooltip. More... | |
| const char * | elm_object_item_tooltip_style_get (const Elm_Widget_Item *obj) |
| Control a different style for this item tooltip. More... | |
| void | elm_object_item_cursor_set (Elm_Widget_Item *obj, const char *cursor) |
| Control the type of mouse pointer/cursor decoration to be shown, when the mouse pointer is over the given item. More... | |
| const char * | elm_object_item_cursor_get (const Elm_Widget_Item *obj) |
| Control the type of mouse pointer/cursor decoration to be shown, when the mouse pointer is over the given item. More... | |
| void | elm_object_item_cursor_style_set (Elm_Widget_Item *obj, const char *style) |
Control a different style for a given custom cursor set for an item. More... | |
| const char * | elm_object_item_cursor_style_get (const Elm_Widget_Item *obj) |
Control a different style for a given custom cursor set for an item. More... | |
| void | elm_object_item_cursor_engine_only_set (Elm_Widget_Item *obj, Eina_Bool engine_only) |
| Control if the (custom)cursor for a given item should be searched in its theme, also, or should only rely on the rendering engine. More... | |
| Eina_Bool | elm_object_item_cursor_engine_only_get (const Elm_Widget_Item *obj) |
| Control if the (custom)cursor for a given item should be searched in its theme, also, or should only rely on the rendering engine. More... | |
| void | elm_object_item_part_content_set (Elm_Widget_Item *obj, const char *part, Efl_Canvas_Object *content) |
| Control a content of an object item. More... | |
| Efl_Canvas_Object * | elm_object_item_part_content_get (const Elm_Widget_Item *obj, const char *part) |
| Control a content of an object item. More... | |
| void | elm_object_item_part_text_set (Elm_Widget_Item *obj, const char *part, const char *label) |
| Control a label of an object item. More... | |
| const char * | elm_object_item_part_text_get (const Elm_Widget_Item *obj, const char *part) |
| Control a label of an object item. More... | |
| void | elm_object_item_focus_set (Elm_Widget_Item *obj, Eina_Bool focused) |
| Control the object item focused. More... | |
| Eina_Bool | elm_object_item_focus_get (const Elm_Widget_Item *obj) |
| Control the object item focused. More... | |
| void | elm_object_item_style_set (Elm_Widget_Item *obj, const char *style) |
| Control the style of an object item. More... | |
| const char * | elm_object_item_style_get (const Elm_Widget_Item *obj) |
| Control the style of an object item. More... | |
| void | elm_object_item_disabled_set (Elm_Widget_Item *obj, Eina_Bool disable) |
| Control the disabled state of a widget item. More... | |
| Eina_Bool | elm_object_item_disabled_get (const Elm_Widget_Item *obj) |
| Control the disabled state of a widget item. More... | |
| const Eina_List * | elm_object_item_access_order_get (Elm_Widget_Item *obj) |
| Get highlight order. More... | |
| void | elm_object_item_access_order_set (Elm_Widget_Item *obj, Eina_List *objs) |
| Set highlight order. More... | |
| Efl_Canvas_Object * | elm_object_item_widget_get (const Elm_Widget_Item *obj) |
| Get the widget object's handle which contains a given item. More... | |
| void | elm_object_item_tooltip_text_set (Elm_Widget_Item *obj, const char *text) |
| Set the text to be shown in a given object item's tooltips. More... | |
| void | elm_object_item_tooltip_unset (Elm_Widget_Item *obj) |
| Unset tooltip from item. More... | |
| void | elm_object_item_cursor_unset (Elm_Widget_Item *obj) |
| Unset 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. More... | |
| Efl_Canvas_Object * | elm_object_item_part_content_unset (Elm_Widget_Item *obj, const char *part) |
| Unset a content of an object item. More... | |
| void | elm_object_item_signal_callback_add (Elm_Widget_Item *obj, const char *emission, const char *source, Elm_Object_Item_Signal_Cb func, void *data) |
| Add a callback for a signal emitted by object item edje. More... | |
| void * | elm_object_item_signal_callback_del (Elm_Widget_Item *obj, const char *emission, const char *source, Elm_Object_Item_Signal_Cb func) |
| Remove a signal-triggered callback from a object item edje object. More... | |
| void | elm_object_item_signal_emit (Elm_Widget_Item *obj, const char *emission, const char *source) |
| Send a signal to the edje object of the widget item. More... | |
| void | elm_object_item_access_info_set (Elm_Widget_Item *obj, const char *txt) |
| Set the text to read out when in accessibility mode. More... | |
| Efl_Canvas_Object * | elm_object_item_access_object_get (const Elm_Widget_Item *obj) |
| Get an accessible object of the object item. More... | |
| void | elm_object_item_domain_translatable_part_text_set (Elm_Widget_Item *obj, const char *part, const char *domain, const char *label) |
| Set the text for an object item's part, marking it as translatable. More... | |
| const char * | elm_object_item_translatable_part_text_get (const Elm_Widget_Item *obj, const char *part) |
| Get the original string set as translatable for an object item. More... | |
| void | elm_object_item_domain_part_text_translatable_set (Elm_Widget_Item *obj, const char *part, const char *domain, Eina_Bool translatable) |
| Mark the part text to be translatable or not. More... | |
| Efl_Canvas_Object * | elm_object_item_track (Elm_Widget_Item *obj) |
| This returns track object of the item. More... | |
| void | elm_object_item_untrack (Elm_Widget_Item *obj) |
| This retrieve the track object of the item. More... | |
| int | elm_object_item_track_get (const Elm_Widget_Item *obj) |
| Get the track object reference count. More... | |
| void | elm_object_item_del_cb_set (Elm_Widget_Item *obj, Evas_Smart_Cb del_cb) |
| Set the function to be called when an item from the widget is freed. More... | |
| void | elm_object_item_tooltip_content_cb_set (Elm_Widget_Item *obj, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) |
| Set the content to be shown in the tooltip item. More... | |
| Efl_Canvas_Object * | elm_object_item_access_register (Elm_Widget_Item *obj) |
| Register object item as an accessible object. More... | |
| void | elm_object_item_access_unregister (Elm_Widget_Item *obj) |
| Unregister accessible object of the object item. More... | |
| void | elm_object_item_access_order_unset (Elm_Widget_Item *obj) |
| Unset highlight order. More... | |
| Efl_Canvas_Object * | elm_object_item_focus_next_object_get (const Elm_Widget_Item *obj, Elm_Focus_Direction dir) |
| Get the next object with specific focus direction. More... | |
| void | elm_object_item_focus_next_object_set (Elm_Widget_Item *obj, Efl_Canvas_Object *next, Elm_Focus_Direction dir) |
| Set the next object with specific focus direction. More... | |
| Elm_Widget_Item * | elm_object_item_focus_next_item_get (const Elm_Widget_Item *obj, Elm_Focus_Direction dir) |
| Get the next object item with specific focus direction. More... | |
| void | elm_object_item_focus_next_item_set (Elm_Widget_Item *obj, Elm_Widget_Item *next_item, Elm_Focus_Direction dir) |
| Set the next object item with specific focus direction. More... | |
Variables | |
| EAPI Elm_Version * | elm_version |
| Elementary Version Information. | |
| int | ELM_ECORE_EVENT_ETHUMB_CONNECT |
| int | ELM_EVENT_CONFIG_ALL_CHANGED |
| Emitted when the application has reconfigured elementary settings due to an external configuration tool asking it to. | |
| int | ELM_EVENT_POLICY_CHANGED |
| Emitted when any Elementary's policy value is changed. | |
| int | ELM_EVENT_PROCESS_BACKGROUND |
| Emitted when nothing is visible and the process as a whole should go into a background state. More... | |
| int | ELM_EVENT_PROCESS_FOREGROUND |
| Emitted when going from nothing being visible to at least one window being visible. More... | |
| int | ELM_EVENT_ATSPI_BRIDGE_STATE_CHANGED |
| Emitted when atspi bridge state is changed. More... | |
| double | _elm_startup_time |
General Elementary API.
Functions that don't relate to Elementary objects specifically.
Here are documented functions which init/shutdown the library, that apply to generic Elementary objects, that deal with configuration, et cetera.
This example contemplates some of these functions.
| #define elm_object_item_text_set | ( | it, | |
| label | |||
| ) | elm_object_item_part_text_set((it), NULL, (label)) |
Macro to set a label of an object item.
| it | The Elementary object item. |
| label | The new text of the label. |
Data on event when atspi bridge state is changed.
| 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 will receive the user data pointer passed to elm_object_event_callback_add(). src will be a pointer to the widget on which the input event took place. type will get the type of this event and event_info, the struct with details on this event.
| Elm_Object_Item_Signal_Cb |
Elm_Object_Item Signal Callback functions' prototype definition.
data will have the auxiliary data pointer at the time the callback registration. it will be a pointer the Elm_Object_Item that have the edje object where the signal comes from. emission will identify the exact signal's emission string and source the exact signal's source one.
An Elementary widget item handle.
This is a sub component of an Elementary widget and it is the same as Elementary object item, Elm_Object_Item. Common functions for Elementary widget item are provided on this page. Each Elementary widget also provides its own functions to use Elementary widget item. For more details about how Elementary widget item is used with Elementary widget, please refer each Elementary widget's documents.
Possible values for the selection policy of some widgets.
Input panel (virtual keyboard) layout types.
Type of input panel (virtual keyboard) to use - this is a hint and may not provide exactly what is desired.
| enum Elm_Input_Panel_Lang |
| enum Elm_Autocapital_Type |
Autocapitalization Types.
Choose method of auto-capitalization.
"Return" Key types on the input panel (virtual keyboard).
| enum Elm_Input_Hints |
Enumeration that defines the types of Input Hints.
| enum Elm_Policy |
Policy identifiers.
| Enumerator | |
|---|---|
| ELM_POLICY_QUIT | under which circumstances the application should quit automatically. See also ELM_POLICY_QUIT. |
| ELM_POLICY_EXIT | defines elm_exit() behaviour. See also ELM_POLICY_EXIT.
|
| ELM_POLICY_THROTTLE | defines how throttling should work. See also ELM_POLICY_THROTTLE
|
| ELM_POLICY_LAST | Sentinel value to indicate last enum field during iteration. |
| enum Elm_Policy_Quit |
Possible values for the ELM_POLICY_QUIT policy.
| enum Elm_Policy_Exit |
Possible values for the ELM_POLICY_EXIT policy.
| Enumerator | |
|---|---|
| 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_Throttle |
Possible values for the ELM_POLICY_THROTTLE policy.
Possible values for the multi-selection policy of some widgets.
| enum Elm_Wrap_Type |
Line wrapping types.
Type of word or character wrapping to use.
See also elm_entry_line_wrap_set, elm_popup_content_text_wrap_type_set, elm_label_line_wrap_set.
| enum Elm_Text_Format |
| enum Elm_Cnp_Mode |
| enum Elm_List_Mode |
Set list's resizing behavior, transverse axis scrolling and items cropping.
See each mode's description for more details.
Values here don't work as bitmasks – only one can be chosen at a time.
| Enumerator | |
|---|---|
| ELM_LIST_COMPRESS | The list won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zeroed dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. |
| ELM_LIST_SCROLL | Default value. This is the same as ELM_LIST_COMPRESS, with the exception that if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction. |
| ELM_LIST_LIMIT | Sets a minimum size hint on the list object, so that containers may respect it (and resize itself to fit the child properly). More specifically, a minimum size hint will be set for its transverse axis, so that the largest item in that direction fits well. This is naturally bound by the list object's maximum size hints, set externally. |
| ELM_LIST_EXPAND | Besides setting a minimum size on the transverse axis, just like on ELM_LIST_LIMIT, the list will set a minimum size on the longitudinal axis, trying to reserve space to all its children to be visible at a time. . This is naturally bound by the list object's maximum size hints, set externally. |
| ELM_LIST_LAST | Indicates error if returned by elm_list_mode_get(). |
| enum Elm_Focus_Direction |
| enum Elm_Object_Layer |
Defines couple of standard Evas_Object layers to be used with evas_object_layer_set().
| enum Elm_Softcursor_Mode |
| EINA_DEPRECATED void elm_object_domain_translatable_text_part_set | ( | Evas_Object * | obj, |
| const char * | part, | ||
| const char * | domain, | ||
| const char * | text | ||
| ) |
Set the text for an object's part, marking it as translatable.
The string to set as text must be the original one. Do not pass the return of gettext() here. Elementary will translate the string internally and set it on the object using elm_object_part_text_set(), also storing the original string so that it can be automatically translated when the language is changed with elm_language_set().
The domain will be stored along to find the translation in the correct catalog. It can be NULL, in which case it will use whatever domain was set by the application with textdomain(). This is useful in case you are building a library on top of Elementary that will have its own translatable strings, that should not be mixed with those of programs using the library.
| obj | The object containing the text part |
| part | The name of the part to set |
| domain | The translation domain to use |
| text | The original, non-translated text to set |
References elm_object_domain_translatable_part_text_set().
| EINA_DEPRECATED const char * elm_object_translatable_text_part_get | ( | const Evas_Object * | obj, |
| const char * | part | ||
| ) |
Get the original string set as translatable for an object.
When setting translated strings, the function elm_object_part_text_get() will return the translation returned by gettext(). To get the original string use this function.
| obj | The object |
| part | The name of the part that was set |
References elm_object_translatable_part_text_get().
| int elm_init | ( | int | argc, |
| char ** | argv | ||
| ) |
Initialize Elementary.
| [in] | argc | System's argument count value |
| [in] | argv | System's pointer to array of argument strings |
This function initializes Elementary and increments a counter of the number of calls to it. It returns the new counter's value.
ELM_MAIN() macro. There is no need to use this if you use this macro (which is highly advisable). An elm_main() should contain the entry point code for your application, having the same prototype as elm_init(), and not being static (putting the EAPI_MAIN symbol in front of its type declaration is advisable). The ELM_MAIN() call should be placed just after it.Example:
See the full example.
References ecore_event_handler_add(), ECORE_EVENT_LOCALE_CHANGED, ECORE_EVENT_MEMORY_STATE, ecore_event_type_new(), EINA_SAFETY_ON_FALSE_GOTO, EINA_SAFETY_ON_FALSE_RETURN_VAL, eina_stringshare_add(), ELM_CNP_EVENT_SELECTION_CHANGED, ELM_EVENT_ATSPI_BRIDGE_STATE_CHANGED, elm_quicklaunch_init(), and elm_quicklaunch_sub_init().
| int elm_shutdown | ( | void | ) |
Shut down Elementary.
This should be called at the end of your application, just before it ceases to do any more processing. This will clean up any permanent resources your application may have allocated via Elementary that would otherwise persist.
References ecore_event_handler_del(), ecore_main_loop_iterate(), eina_stringshare_del(), elm_quicklaunch_shutdown(), and elm_quicklaunch_sub_shutdown().
| void elm_run | ( | void | ) |
Run Elementary's main loop.
This call should be issued just after all initialization is completed. This function will not return until elm_exit() is called. It will keep looping, running the main (event/processing) loop for Elementary.
This function should be called once only from the same thread that initted elementary, (elm_init(), eina_init(), ...) and should never be nested. Never call it from within an instance of itself.
References ecore_main_loop_begin().
| void elm_exit | ( | void | ) |
Ask to exit Elementary's main loop.
If this call is issued, it will flag the main loop to cease processing and return back to its parent function (usually your elm_main() function). This does not mean the main loop instantly quits. So your ecore callbacks(timer, animator, event, job, and etc.) have chances to be called even after elm_exit().
References efl_exit().
| Eina_Bool elm_policy_set | ( | unsigned int | policy, |
| int | value | ||
| ) |
Set a new policy's value (for a given policy group/identifier).
| policy | policy identifier, as in Elm_Policy. |
| value | policy value, which depends on the identifier |
EINA_TRUE on success or EINA_FALSE, on error.Elementary policies define applications' behavior, somehow. These behaviors are divided in policy groups (see Elm_Policy enumeration). This call will emit the Ecore event ELM_EVENT_POLICY_CHANGED, which can be hooked at with handlers. An Elm_Event_Policy_Changed struct will be passed, then.
References EINA_FALSE, EINA_TRUE, ELM_POLICY_EXIT, ELM_POLICY_EXIT_WINDOWS_DEL, and ELM_POLICY_LAST.
| int elm_policy_get | ( | unsigned int | policy | ) |
Get the policy value for given policy identifier.
| policy | policy identifier, as in Elm_Policy. |
0 if policy passed is invalid. References ELM_POLICY_LAST.
| void elm_language_set | ( | const char * | lang | ) |
Change the language of the current application.
The lang passed must be the full name of the locale to use, for example "en_US.utf8" or "es_ES@euro".
Changing language with this function will make Elementary run through all its widgets, translating strings set with elm_object_domain_translatable_part_text_set(). This way, an entire UI can have its language changed without having to restart the program.
For more complex cases, like having formatted strings that need translation, widgets will also emit a "language,changed" signal that the user can listen to and manually translate the text.
| lang | Language to set, must be the full name of the locale |
References edje_language_set(), and evas_language_reinit().
| Elm_Process_State elm_process_state_get | ( | void | ) |
The state of the process as a whole.
The process may logically be some runnable state. a "foreground" application runs as normal and may be user-visible or "active" in some way. A background application is not user-visible or otherwise important and likely should release resources and not wake up often or process much.
| void elm_object_part_text_set | ( | Evas_Object * | obj, |
| const char * | part, | ||
| const char * | text | ||
| ) |
Set a text of an object.
| obj | The Elementary object |
| part | The text part name to set (NULL for the default part) |
| text | The new text of the part |
References EINA_SAFETY_ON_NULL_RETURN.
| const char * elm_object_part_text_get | ( | const Evas_Object * | obj, |
| const char * | part | ||
| ) |
Get a text of an object.
| obj | The Elementary object |
| part | The text part name to get (NULL for the default part) |
References EINA_SAFETY_ON_NULL_RETURN_VAL.
| void elm_object_domain_translatable_part_text_set | ( | Evas_Object * | obj, |
| const char * | part, | ||
| const char * | domain, | ||
| const char * | text | ||
| ) |
Set the text for an object's part, marking it as translatable.
The string to set as text must be the original one. Do not pass the return of gettext() here. Elementary will translate the string internally and set it on the object using elm_object_part_text_set(), also storing the original string so that it can be automatically translated when the language is changed with elm_language_set().
The domain will be stored along to find the translation in the correct catalog. It can be NULL, in which case it will use whatever domain was set by the application with textdomain(). This is useful in case you are building a library on top of Elementary that will have its own translatable strings, that should not be mixed with those of programs using the library.
| obj | The object containing the text part |
| part | The name of the part to set |
| domain | The translation domain to use |
| text | The original, non-translated text to set |
References EINA_SAFETY_ON_NULL_RETURN, and EINA_TRUE.
Referenced by elm_object_domain_translatable_text_part_set().
| const char * elm_object_translatable_part_text_get | ( | const Evas_Object * | obj, |
| const char * | part | ||
| ) |
Get the original string set as translatable for an object.
When setting translated strings, the function elm_object_part_text_get() will return the translation returned by gettext(). To get the original string use this function.
| obj | The object |
| part | The name of the part that was set |
References EINA_SAFETY_ON_NULL_RETURN_VAL, and EINA_TRUE.
Referenced by elm_object_translatable_text_part_get().
| void elm_object_domain_part_text_translatable_set | ( | Evas_Object * | obj, |
| const char * | part, | ||
| const char * | domain, | ||
| Eina_Bool | translatable | ||
| ) |
Mark the part text to be translatable or not.
Once you mark the part text to be translatable, the text will be translated internally regardless of elm_object_part_text_set() and elm_object_domain_translatable_part_text_set(). In other case, if you set the Elementary policy that all text will be translatable in default, you can set the part text to not be translated by calling this API.
| obj | The object containing the text part |
| part | The part name of the translatable text |
| domain | The translation domain to use |
| translatable | EINA_TRUE, the part text will be translated internally. EINA_FALSE, otherwise. |
References EINA_SAFETY_ON_NULL_RETURN.
| void elm_object_part_content_set | ( | Evas_Object * | obj, |
| const char * | part, | ||
| Evas_Object * | content | ||
| ) |
Set the content on part of a given container widget.
| obj | The Elementary container widget |
| part | The container's part name to set (some might accept NULL for the default part) |
| content | The new content for that part |
All widgets deriving from the The Elementary Container Class may hold child objects as content at given parts. This sets new content to a given part. If any object was already set as a content object in the same part, the previous object will be deleted automatically with this call. If the content is NULL, this call will just delete the previous object. If the If you wish to preserve it, issue elm_object_part_content_unset() on it first.
References EINA_SAFETY_ON_NULL_RETURN.
| Evas_Object * elm_object_part_content_get | ( | const Evas_Object * | obj, |
| const char * | part | ||
| ) |
Get the content on a part of a given container widget.
| obj | The Elementary container widget |
| part | The container's part name to get (some might accept NULL for the default part) |
NULL, on errorsReferences EINA_SAFETY_ON_NULL_RETURN_VAL.
| Evas_Object * elm_object_part_content_unset | ( | Evas_Object * | obj, |
| const char * | part | ||
| ) |
Unset the content on a part of a given container widget.
| obj | The Elementary container widget |
| part | The container's part name to unset (some might accept NULL for the default part) |
NULL, on errorsReferences EINA_SAFETY_ON_NULL_RETURN_VAL.
| void elm_object_access_info_set | ( | Evas_Object * | obj, |
| const char * | txt | ||
| ) |
Set the text to read out when in accessibility mode.
| obj | The object which is to be described |
| txt | The text that describes the widget to people with poor or no vision |
| const char * elm_object_access_info_get | ( | Evas_Object * | obj | ) |
Get the text to read out when in accessibility mode.
| obj | The object which is to be described |
| Evas_Object * elm_object_name_find | ( | const Evas_Object * | obj, |
| const char * | name, | ||
| int | recurse | ||
| ) |
Get a named object from the children.
| obj | The parent object whose children to look at |
| name | The name of the child to find |
| recurse | Set to the maximum number of levels to recurse (0 == none, 1 is only look at 1 level of children etc.) |
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 is greater than 0) then it is undefined as to which child of that name is returned, so ensure the name is unique amongst children. If recurse is set to -1 it will recurse without limit.
| void elm_object_disabled_set | ( | Evas_Object * | obj, |
| Eina_Bool | disabled | ||
| ) |
Set the disabled state of an Elementary object.
| obj | The Elementary object to operate on |
| disabled | The state to put in in: EINA_TRUE for disabled, EINA_FALSE for enabled |
Elementary objects can be disabled, in which state they won't receive input and, in general, will be themed differently from their normal state, usually greyed out. Useful for contexts where you don't want your users to interact with some of the parts of you interface.
This sets the state for the widget, either disabling it or enabling it back.
References EINA_SAFETY_ON_NULL_RETURN.
| Eina_Bool elm_object_disabled_get | ( | const Evas_Object * | obj | ) |
Get the disabled state of an Elementary object.
| obj | The Elementary object to operate on |
EINA_TRUE, if the widget is disabled, EINA_FALSE if it's enabled (or on errors)This gets the state of the widget, which might be enabled or disabled.
References EINA_FALSE, and EINA_SAFETY_ON_NULL_RETURN_VAL.
| void elm_object_signal_emit | ( | Evas_Object * | obj, |
| const char * | emission, | ||
| const char * | source | ||
| ) |
Send 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.
| obj | The object |
| emission | The signal's name. |
| source | The signal's source. |
References EINA_SAFETY_ON_NULL_RETURN.
| void elm_object_signal_callback_add | ( | Evas_Object * | obj, |
| const char * | emission, | ||
| const char * | source, | ||
| Edje_Signal_Cb | func, | ||
| void * | data | ||
| ) |
Add a callback for a signal emitted by 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.
| obj | The object |
| emission | The signal's name. |
| source | The signal's source. |
| func | The callback function to be executed when the signal is emitted. |
| data | A pointer to data to pass to the callback function. |
References EINA_SAFETY_ON_NULL_RETURN.
| void * elm_object_signal_callback_del | ( | Evas_Object * | obj, |
| const char * | emission, | ||
| const char * | source, | ||
| Edje_Signal_Cb | func | ||
| ) |
Remove a signal-triggered callback from a widget edje object.
| obj | The object handle |
| emission | The signal's name. |
| source | The signal's source. |
| func | The callback function to be executed when the signal is emitted. |
NULL, on errors.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 was passed to this call will be returned.
References EINA_SAFETY_ON_NULL_RETURN_VAL.
| void elm_object_event_callback_add | ( | Evas_Object * | obj, |
| Elm_Event_Cb | func, | ||
| const void * | data | ||
| ) |
Add a callback for input events (key up, key down, mouse wheel) on a given Elementary widget.
| obj | The widget to add an event callback on |
| func | The callback function to be executed when the event happens |
| data | Data to pass in to func |
Every widget in an Elementary interface set to receive focus, with elm_object_focus_allow_set(), will propagate all of its key up, key down and mouse wheel input events up to its parent object, and so on. All of the focusable ones in this chain which had an event callback set, with this call, will be able to treat those events. There are two ways of making the propagation of these event upwards in the tree of widgets to cease:
EINA_TRUE on func. EINA_FALSE will mean the event was not processed, so the propagation will go on.event_info pointer passed to func will contain the event's structure and, if you OR its event_flags inner value to EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary one has already handled it, thus killing the event's propagation, too.obj has consumed the event already.evas_object_event_callback_add(), which will add event callbacks per type on general Evas objects (no event propagation infrastructure taken in account).elm_object_signal_callback_add(), which will add callbacks to signals coming from a widget's theme, not input events.edje_object_signal_callback_add(), which does the same as elm_object_signal_callback_add(), but directly on an Edje object.evas_object_smart_callback_add(), which adds callbacks to smart objects' smart events, and not input events.References EINA_SAFETY_ON_NULL_RETURN.
| void * elm_object_event_callback_del | ( | Evas_Object * | obj, |
| Elm_Event_Cb | func, | ||
| const void * | data | ||
| ) |
Remove an event callback from a widget.
This function removes a callback, previously attached to 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 was passed to this call will be returned.
| obj | The object |
| func | The callback function to be executed when the event is emitted. |
| data | Data to pass in to the callback function. |
References EINA_SAFETY_ON_NULL_RETURN_VAL.
| void elm_object_orientation_mode_disabled_set | ( | Evas_Object * | obj, |
| Eina_Bool | disabled | ||
| ) |
Disable the orientation mode of a given widget.
Orientation Mode is used for widgets to change it's styles or to send signals whenever it's window degree is changed. If the orientation mode is enabled and the widget has different looks and styles for the window degree(0, 90, 180, 270), it will apply a style that is readied for the current degree, otherwise, it will send signals to it's own edje to change it's states if the style doesn't be readied.
| obj | The Elementary object to operate on orientation mode. |
| disabled | The state to put in in: EINA_TRUE for disabled, EINA_FALSE for enabled. |
| Eina_Bool elm_object_orientation_mode_disabled_get | ( | const Evas_Object * | obj | ) |
Get the orientation mode of a given widget.
| obj | The Elementary widget to query for its orientation mode. |
EINA_TRUE, if the orientation mode is disabled, EINA_FALSE if the orientation mode is enabled (or on errors) References EINA_FALSE, and EINA_TRUE.
| void * elm_object_item_data_get | ( | const Elm_Object_Item * | it | ) |
Get the data associated with an object item.
| it | The Elementary object item |
it | void elm_object_item_data_set | ( | Elm_Object_Item * | it, |
| void * | data | ||
| ) |
Set the data associated with an object item.
| it | The Elementary object item |
| data | The data to be associated with it |
| Eina_Bool elm_object_item_tooltip_window_mode_set | ( | Elm_Widget_Item * | obj, |
| Eina_Bool | disable | ||
| ) |
Control 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 will instead be limited only by the size of the display.
| [in] | obj | The object. |
| [in] | disable | If true, size restrictions are disabled |
false on failure, true on success | Eina_Bool elm_object_item_tooltip_window_mode_get | ( | const Elm_Widget_Item * | obj | ) |
Control 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 will instead be limited only by the size of the display.
| [in] | obj | The object. |
true, size restrictions are disabled | void elm_object_item_tooltip_style_set | ( | Elm_Widget_Item * | obj, |
| const char * | style | ||
| ) |
Control a different style for this item tooltip.
See: elm_object_tooltip_style_set() for more details.
| [in] | obj | The object. |
| [in] | style | The theme style used/to use (default, transparent, ...) |
| const char * elm_object_item_tooltip_style_get | ( | const Elm_Widget_Item * | obj | ) |
Control a different style for this item tooltip.
See: elm_object_tooltip_style_set() for more details.
| [in] | obj | The object. |
| void elm_object_item_cursor_set | ( | Elm_Widget_Item * | obj, |
| const char * | cursor | ||
| ) |
Control the type of mouse pointer/cursor decoration to be shown, when the mouse pointer is over the given item.
This function works analogously as elm_object_cursor_set(), but here the cursor's changing area is restricted to the item's area, and not the whole widget's. Note that that item cursors have precedence over widget cursors, so that a mouse over an item with custom cursor set will always show that cursor.
If this function is called twice for an object, a previously set cursor will be unset on the second call.
| [in] | obj | The object. |
| [in] | cursor | The cursor type's name |
| const char * elm_object_item_cursor_get | ( | const Elm_Widget_Item * | obj | ) |
Control the type of mouse pointer/cursor decoration to be shown, when the mouse pointer is over the given item.
This function works analogously as elm_object_cursor_set(), but here the cursor's changing area is restricted to the item's area, and not the whole widget's. Note that that item cursors have precedence over widget cursors, so that a mouse over an item with custom cursor set will always show that cursor.
If this function is called twice for an object, a previously set cursor will be unset on the second call.
| [in] | obj | The object. |
| void elm_object_item_cursor_style_set | ( | Elm_Widget_Item * | obj, |
| const char * | style | ||
| ) |
Control a different style for a given custom cursor set for an item.
This function only makes sense when one is using custom mouse cursor decorations defined in a theme file, which can have, given a cursor name/type, alternate styles on it. It works analogously as elm_object_cursor_style_set(), but here applies only to item objects.
| [in] | obj | The object. |
| [in] | style | The theme style to use/in use (e.g. $"default", $"transparent", etc) |
| const char * elm_object_item_cursor_style_get | ( | const Elm_Widget_Item * | obj | ) |
Control a different style for a given custom cursor set for an item.
This function only makes sense when one is using custom mouse cursor decorations defined in a theme file, which can have, given a cursor name/type, alternate styles on it. It works analogously as elm_object_cursor_style_set(), but here applies only to item objects.
| [in] | obj | The object. |
| void elm_object_item_cursor_engine_only_set | ( | Elm_Widget_Item * | obj, |
| Eina_Bool | engine_only | ||
| ) |
Control if the (custom)cursor for a given item should be searched in its theme, also, or should only rely on the rendering engine.
| [in] | obj | The object. |
| [in] | engine_only | Use true to have cursors looked for only on those provided by the rendering engine, false to have them searched on the widget's theme, as well. |
| Eina_Bool elm_object_item_cursor_engine_only_get | ( | const Elm_Widget_Item * | obj | ) |
Control if the (custom)cursor for a given item should be searched in its theme, also, or should only rely on the rendering engine.
| [in] | obj | The object. |
true to have cursors looked for only on those provided by the rendering engine, false to have them searched on the widget's theme, as well. | void elm_object_item_part_content_set | ( | Elm_Widget_Item * | obj, |
| const char * | part, | ||
| Efl_Canvas_Object * | content | ||
| ) |
Control a content of an object item.
This sets a new object to an item as a content object. If any object was already set as a content object in the same part, previous object will be deleted automatically.
| [in] | obj | The object. |
| [in] | part | The content part name (NULL for the default content) |
| [in] | content | The content of the object item |
| Efl_Canvas_Object * elm_object_item_part_content_get | ( | const Elm_Widget_Item * | obj, |
| const char * | part | ||
| ) |
Control a content of an object item.
This sets a new object to an item as a content object. If any object was already set as a content object in the same part, previous object will be deleted automatically.
| [in] | obj | The object. |
| [in] | part | The content part name (NULL for the default content) |
| void elm_object_item_part_text_set | ( | Elm_Widget_Item * | obj, |
| const char * | part, | ||
| const char * | label | ||
| ) |
Control a label of an object item.
| [in] | obj | The object. |
| [in] | part | The text part name (NULL for the default label) |
| [in] | label | Text of the label |
| const char * elm_object_item_part_text_get | ( | const Elm_Widget_Item * | obj, |
| const char * | part | ||
| ) |
Control a label of an object item.
| [in] | obj | The object. |
| [in] | part | The text part name (NULL for the default label) |
| void elm_object_item_focus_set | ( | Elm_Widget_Item * | obj, |
| Eina_Bool | focused | ||
| ) |
Control the object item focused.
| [in] | obj | The object. |
| [in] | focused | The focused state |
| Eina_Bool elm_object_item_focus_get | ( | const Elm_Widget_Item * | obj | ) |
Control the object item focused.
| [in] | obj | The object. |
| void elm_object_item_style_set | ( | Elm_Widget_Item * | obj, |
| const char * | style | ||
| ) |
Control the style of an object item.
| [in] | obj | The object. |
| [in] | style | The style of object item |
| const char * elm_object_item_style_get | ( | const Elm_Widget_Item * | obj | ) |
Control the style of an object item.
| [in] | obj | The object. |
| void elm_object_item_disabled_set | ( | Elm_Widget_Item * | obj, |
| Eina_Bool | disable | ||
| ) |
Control the disabled state of a widget item.
Elementary object item can be disabled, in which state they won't receive input and, in general, will be themed differently from their normal state, usually greyed out. Useful for contexts where you don't want your users to interact with some of the parts of you interface.
This sets the state for the widget item, either disabling it or enabling it back.
| [in] | obj | The object. |
| [in] | disable | true, if the widget item is disabled, false if it's enabled (or on errors) |
| Eina_Bool elm_object_item_disabled_get | ( | const Elm_Widget_Item * | obj | ) |
Control the disabled state of a widget item.
Elementary object item can be disabled, in which state they won't receive input and, in general, will be themed differently from their normal state, usually greyed out. Useful for contexts where you don't want your users to interact with some of the parts of you interface.
This sets the state for the widget item, either disabling it or enabling it back.
| [in] | obj | The object. |
true, if the widget item is disabled, false if it's enabled (or on errors) | const Eina_List * elm_object_item_access_order_get | ( | Elm_Widget_Item * | obj | ) |
Get highlight order.
| [in] | obj | The object. |
| void elm_object_item_access_order_set | ( | Elm_Widget_Item * | obj, |
| Eina_List * | objs | ||
| ) |
Set highlight order.
| [in] | obj | The object. |
| [in] | objs | Order of objects to pass highlight |
| Efl_Canvas_Object * elm_object_item_widget_get | ( | const Elm_Widget_Item * | obj | ) |
Get the widget object's handle which contains a given item.
| [in] | obj | The object. |
| void elm_object_item_tooltip_text_set | ( | Elm_Widget_Item * | obj, |
| const char * | text | ||
| ) |
Set the text to be shown in a given object item's tooltips.
Setup the text as tooltip to object. The item can have only one tooltip, so any previous tooltip data - set with this function or elm_object_item_tooltip_content_cb_set - is removed.
See: elm_object_tooltip_text_set() for more details.
| [in] | obj | The object. |
| [in] | text | The text to set in the content. |
| void elm_object_item_tooltip_unset | ( | Elm_Widget_Item * | obj | ) |
Unset tooltip from item.
Remove tooltip from item. The callback provided as del_cb to elm_object_item_tooltip_content_cb_set will be called to notify it is not used anymore.
See: elm_object_tooltip_unset() for more details. See: elm_object_item_tooltip_content_cb_set
| [in] | obj | The object. |
| void elm_object_item_cursor_unset | ( | Elm_Widget_Item * | obj | ) |
Unset 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.
Use this call to undo any custom settings on this item's cursor decoration, bringing it back to defaults (no custom style set).
See: elm_object_cursor_unset() See: elm_object_item_cursor_set
| [in] | obj | The object. |
| Efl_Canvas_Object * elm_object_item_part_content_unset | ( | Elm_Widget_Item * | obj, |
| const char * | part | ||
| ) |
Unset a content of an object item.
| [in] | obj | The object. |
| [in] | part | The content part name to unset (NULL for the default content) |
| void elm_object_item_signal_callback_add | ( | Elm_Widget_Item * | obj, |
| const char * | emission, | ||
| const char * | source, | ||
| Elm_Object_Item_Signal_Cb | func, | ||
| void * | data | ||
| ) |
Add a callback for a signal emitted by object item edje.
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] | obj | The object. |
| [in] | emission | The signal's name. |
| [in] | source | The signal's source. |
| [in] | func | The callback function to be executed when the signal is emitted. |
| [in] | data | A pointer to data to pass to the callback function. |
| void * elm_object_item_signal_callback_del | ( | Elm_Widget_Item * | obj, |
| const char * | emission, | ||
| const char * | source, | ||
| Elm_Object_Item_Signal_Cb | func | ||
| ) |
Remove a signal-triggered callback from a 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 was passed to this call will be returned.
See: elm_object_item_signal_callback_add
| [in] | obj | The object. |
| [in] | emission | The signal's name. |
| [in] | source | The signal's source. |
| [in] | func | The callback function to be executed when the signal is emitted. |
NULL, on errors.| void elm_object_item_signal_emit | ( | Elm_Widget_Item * | obj, |
| const char * | emission, | ||
| const char * | source | ||
| ) |
Send 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. Don't use this unless you want to also handle resetting of part states to default on every unrealize in case of genlist/gengrid.
| [in] | obj | The object. |
| [in] | emission | The signal's name. |
| [in] | source | The signal's source. |
| void elm_object_item_access_info_set | ( | Elm_Widget_Item * | obj, |
| const char * | txt | ||
| ) |
Set the text to read out when in accessibility mode.
| [in] | obj | The object. |
| [in] | txt | The text that describes the widget to people with poor or no vision |
| Efl_Canvas_Object * elm_object_item_access_object_get | ( | const Elm_Widget_Item * | obj | ) |
Get an accessible object of the object item.
| [in] | obj | The object. |
| void elm_object_item_domain_translatable_part_text_set | ( | Elm_Widget_Item * | obj, |
| const char * | part, | ||
| const char * | domain, | ||
| const char * | label | ||
| ) |
Set the text for an object item's part, marking it as translatable.
The string to set as text must be the original one. Do not pass the return of gettext() here. Elementary will translate the string internally and set it on the object item using elm_object_item_part_text_set, also storing the original string so that it can be automatically translated when the language is changed with elm_language_set(). The domain will be stored along to find the translation in the correct catalog. It can be NULL, in which case it will use whatever domain was set by the application with textdomain(). This is useful in case you are building a library on top of Elementary that will have its own translatable strings, that should not be mixed with those of programs using the library.
| [in] | obj | The object. |
| [in] | part | The name of the part to set |
| [in] | domain | The translation domain to use |
| [in] | label | The original, non-translated text to set |
| const char * elm_object_item_translatable_part_text_get | ( | const Elm_Widget_Item * | obj, |
| const char * | part | ||
| ) |
Get the original string set as translatable for an object item.
When setting translated strings, the function elm_object_item_part_text_get will return the translation returned by gettext(). To get the original string use this function.
| [in] | obj | The object. |
| [in] | part | The name of the part that was set |
| void elm_object_item_domain_part_text_translatable_set | ( | Elm_Widget_Item * | obj, |
| const char * | part, | ||
| const char * | domain, | ||
| Eina_Bool | translatable | ||
| ) |
Mark the part text to be translatable or not.
Once you mark the part text to be translatable, the text will be translated internally regardless of elm_object_item_part_text_set and elm_object_item_domain_translatable_part_text_set. In other case, if you set the Elementary policy that all text will be translatable in default, you can set the part text to not be translated by calling this API.
See: elm_object_item_domain_translatable_part_text_set See: elm_object_item_part_text_set See: elm_policy()
| [in] | obj | The object. |
| [in] | part | The part name of the translatable text |
| [in] | domain | The translation domain to use |
| [in] | translatable | true, the part text will be translated internally. false, otherwise. |
| Efl_Canvas_Object * elm_object_item_track | ( | Elm_Widget_Item * | obj | ) |
This returns track object of the item.
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 it's own widget's decision. So please don't change the track object as well as don't keep the track object in your side as possible but get the track object at the moment you need to refer. Otherwise, you need to add some callbacks to the track object to track it's attributes changes.See: elm_object_item_untrack See: elm_object_item_track_get
| [in] | obj | The object. |
| void elm_object_item_untrack | ( | Elm_Widget_Item * | obj | ) |
This retrieve the track object of the item.
See: elm_object_item_track See: elm_object_item_track_get
| [in] | obj | The object. |
| int elm_object_item_track_get | ( | const Elm_Widget_Item * | obj | ) |
Get the track object reference count.
See: elm_object_item_track See: elm_object_item_track_get
| [in] | obj | The object. |
| void elm_object_item_del_cb_set | ( | Elm_Widget_Item * | obj, |
| Evas_Smart_Cb | del_cb | ||
| ) |
Set the function to be called when an item from the widget is freed.
| [in] | obj | The object. |
| [in] | del_cb | The function called |
| void elm_object_item_tooltip_content_cb_set | ( | Elm_Widget_Item * | obj, |
| Elm_Tooltip_Item_Content_Cb | func, | ||
| const void * | data, | ||
| Evas_Smart_Cb | del_cb | ||
| ) |
Set the content to be shown in the tooltip item.
Setup the tooltip to item. The item can have only one tooltip, so any previous tooltip data is removed. func(with data) will be called every time that need show the tooltip and it should return a valid Evas_Object. This object is then managed fully by tooltip system and is deleted when the tooltip is gone.
See: elm_object_tooltip_content_cb_set() for more details.
| [in] | obj | The object. |
| [in] | func | The function used to create the tooltip contents. |
| [in] | data | What 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 item dies. This callback receives as the first parameter the given data, and event_info is the item. |
| Efl_Canvas_Object * elm_object_item_access_register | ( | Elm_Widget_Item * | obj | ) |
Register object item as an accessible object.
| [in] | obj | The object. |
| void elm_object_item_access_unregister | ( | Elm_Widget_Item * | obj | ) |
Unregister accessible object of the object item.
| void elm_object_item_access_order_unset | ( | Elm_Widget_Item * | obj | ) |
Unset highlight order.
| Efl_Canvas_Object * elm_object_item_focus_next_object_get | ( | const Elm_Widget_Item * | obj, |
| Elm_Focus_Direction | dir | ||
| ) |
Get the next object with specific focus direction.
| [in] | obj | The object. |
| [in] | dir | Focus direction |
| void elm_object_item_focus_next_object_set | ( | Elm_Widget_Item * | obj, |
| Efl_Canvas_Object * | next, | ||
| Elm_Focus_Direction | dir | ||
| ) |
Set the next object with specific focus direction.
| [in] | obj | The object. |
| [in] | next | Focus next object |
| [in] | dir | Focus direction |
| Elm_Widget_Item * elm_object_item_focus_next_item_get | ( | const Elm_Widget_Item * | obj, |
| Elm_Focus_Direction | dir | ||
| ) |
Get the next object item with specific focus direction.
| [in] | obj | The object. |
| [in] | dir | Focus direction |
| void elm_object_item_focus_next_item_set | ( | Elm_Widget_Item * | obj, |
| Elm_Widget_Item * | next_item, | ||
| Elm_Focus_Direction | dir | ||
| ) |
Set the next object item with specific focus direction.
| [in] | obj | The object. |
| [in] | next_item | Focus next object item |
| [in] | dir | Focus direction |
|
extern |
Emitted when nothing is visible and the process as a whole should go into a background state.
Referenced by elm_quicklaunch_init(), and elm_quicklaunch_shutdown().
|
extern |
Emitted when going from nothing being visible to at least one window being visible.
Referenced by elm_quicklaunch_init(), and elm_quicklaunch_shutdown().
|
extern |