General Elementary API. 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	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 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 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...

Enumerations
enum	Elm_Object_Layer { ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, ELM_OBJECT_LAYER_DEFAULT = 0, ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, ELM_OBJECT_LAYER_LAST }
	Defines couple of standard Evas_Object layers to be used with evas_object_layer_set(). 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	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...

EOAPI void	elm_wdg_item_tooltip_style_set (const char *style)
	Sets a different style for this item tooltip. More...

EOAPI const char *	elm_wdg_item_tooltip_style_get (void)
	Get the style for this item tooltip. More...

EOAPI void	elm_wdg_item_cursor_set (const char *cursor)
	Set the type of mouse pointer/cursor decoration to be shown, when the mouse pointer is over the given item. More...

EOAPI const char *	elm_wdg_item_cursor_get (void)
	Get the type of mouse pointer/cursor decoration set to be shown, when the mouse pointer is over the given item. More...

EOAPI void	elm_wdg_item_cursor_style_set (const char *style)
	Set a different style for a given custom cursor set for an item. More...

EOAPI const char *	elm_wdg_item_cursor_style_get (void)
	Get the current style set for a given item's custom cursor. More...

EOAPI void	elm_wdg_item_cursor_engine_only_set (Eina_Bool engine_only)
	Set if the (custom)cursor for a given item should be searched in its theme, also, or should only rely on the rendering engine. More...

EOAPI Eina_Bool	elm_wdg_item_cursor_engine_only_get (void)
	Get if the (custom) cursor for a given item is being searched in its theme, also, or is only relying on the rendering engine. More...

EOAPI void	elm_wdg_item_part_content_set (const char part, Evas_Object content)
	Set a content of an object item. More...

EOAPI Evas_Object *	elm_wdg_item_part_content_get (const char *part)
	Get a content of an object item. More...

EOAPI void	elm_wdg_item_part_text_set (const char part, const char label)
	Set a label of an object item. More...

EOAPI const char *	elm_wdg_item_part_text_get (const char *part)
	Get a label of an object item. More...

EOAPI void	elm_wdg_item_style_set (const char *style)
	Set a style of an object item. More...

EOAPI const char *	elm_wdg_item_style_get (void)
	Get the style of an object item. More...

EOAPI const Eina_List *	elm_wdg_item_access_order_get (void)
	Get highlight order. More...

EOAPI void	elm_wdg_item_access_order_set (Eina_List *objs)
	Set highlight order. More...

EOAPI Evas_Object *	elm_wdg_item_widget_get (void)
	Get the widget object's handle which contains a given item. More...

EOAPI void	elm_wdg_item_del (void)
	Delete the given item.

EOAPI void	elm_wdg_item_tooltip_text_set (const char *text)
	Set the text to be shown in a given object item's tooltips. More...

EOAPI void	elm_wdg_item_tooltip_unset (void)
	Unset tooltip from item. More...

EOAPI void	elm_wdg_item_cursor_unset (void)
	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...

EOAPI Evas_Object *	elm_wdg_item_part_content_unset (const char *part)
	Unset a content of an object item. More...

EOAPI void	elm_wdg_item_signal_callback_add (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...

EOAPI void *	elm_wdg_item_signal_callback_del (const char emission, const char source, Elm_Object_Item_Signal_Cb func)
	Remove a signal-triggered callback from a object item edje object. More...

EOAPI void	elm_wdg_item_signal_emit (const char emission, const char source)
	Send a signal to the edje object of the widget item. More...

EOAPI void	elm_wdg_item_access_info_set (const char *txt)
	Set the text to read out when in accessibility mode. More...

EOAPI Evas_Object *	elm_wdg_item_access_object_get (void)
	Get an accessible object of the object item. More...

EOAPI void	elm_wdg_item_domain_translatable_part_text_set (const char part, const char domain, const char *label)
	Set the text for an object item's part, marking it as translatable. More...

EOAPI const char *	elm_wdg_item_translatable_part_text_get (const char *part)
	Get the original string set as translatable for an object item. More...

EOAPI void	elm_wdg_item_domain_part_text_translatable_set (const char part, const char domain, Eina_Bool translatable)
	Mark the part text to be translatable or not. More...

EOAPI Evas_Object *	elm_wdg_item_track (void)
	This returns track object of the item. More...

EOAPI void	elm_wdg_item_untrack (void)
	This retrieve the track object of the item. More...

EOAPI int	elm_wdg_item_track_get (void)
	Get the track object reference count. More...

EOAPI void	elm_wdg_item_del_cb_set (Evas_Smart_Cb del_cb)
	Set the function to be called when an item from the widget is freed. More...

EOAPI void	elm_wdg_item_tooltip_content_cb_set (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...

EOAPI Evas_Object *	elm_wdg_item_access_register (void)
	Register object item as an accessible object. More...

EOAPI void	elm_wdg_item_access_unregister (void)
	Unregister accessible object of the object item. More...

EOAPI void	elm_wdg_item_access_order_unset (void)
	Unset highlight order. More...

void	elm_object_item_tooltip_style_set (Elm_Widget_Item obj, const char style)
	Sets a different style for this item tooltip. More...

const char *	elm_object_item_tooltip_style_get (const Elm_Widget_Item *obj)
	Get the style for this item tooltip. More...

void	elm_object_item_cursor_set (Elm_Widget_Item obj, const char cursor)
	Set 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)
	Get the type of mouse pointer/cursor decoration set 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)
	Set 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)
	Get the current style set for a given item's custom cursor. More...

void	elm_object_item_cursor_engine_only_set (Elm_Widget_Item *obj, Eina_Bool engine_only)
	Set 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)
	Get if the (custom) cursor for a given item is being searched in its theme, also, or is only relying on the rendering engine. More...

void	elm_object_item_part_content_set (Elm_Widget_Item obj, const char part, Evas_Object *content)
	Set a content of an object item. More...

Evas_Object *	elm_object_item_part_content_get (const Elm_Widget_Item obj, const char part)
	Get a content of an object item. More...

void	elm_object_item_part_text_set (Elm_Widget_Item obj, const char part, const char *label)
	Set a label of an object item. More...

const char *	elm_object_item_part_text_get (const Elm_Widget_Item obj, const char part)
	Get a label of an object item. More...

void	elm_object_item_style_set (Elm_Widget_Item obj, const char style)
	Set a style of an object item. More...

const char *	elm_object_item_style_get (const Elm_Widget_Item *obj)
	Get the style of an object 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...

Evas_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_del (Elm_Widget_Item *obj)
	Delete the given item.

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...

Evas_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...

Evas_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...

Evas_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...

Evas_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...

Variables
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...

Detailed Description

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.

Macro Definition Documentation

#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.

Parameters

it	The Elementary object item.
label	The new text of the label.

Note: Elementary object items may have many labels.

Examples:: popup_example_03.c, segment_control_example.c, and web_example_02.c.

Typedef Documentation

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.

See also: elm_object_item_signal_callback_add()

Since: 1.8

Enumeration Type Documentation

enum Elm_Object_Layer

Defines couple of standard Evas_Object layers to be used with evas_object_layer_set().

Note: whenever extending with new values, try to keep some padding to siblings so there is room for further extensions.

Enumerator
ELM_OBJECT_LAYER_BACKGROUND	where to place backgrounds
ELM_OBJECT_LAYER_DEFAULT	Evas_Object default layer (and thus for Elementary)
ELM_OBJECT_LAYER_FOCUS	where focus object visualization is
ELM_OBJECT_LAYER_TOOLTIP	where to show tooltips
ELM_OBJECT_LAYER_CURSOR	where to show cursors
ELM_OBJECT_LAYER_LAST	last layer known by Elementary

Function Documentation

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().

See also: elm_init() for an example. There, just after a request to close the window comes, the main loop will be left.

Note: By using the appropriate #ELM_POLICY_QUIT on your Elementary applications, you'll be able to get this function called automatically for you.

Examples:: button_example_00.c, efl_thread_4.c, efl_thread_5.c, fileselector_example.c, glview_example_01.c, progressbar_example.c, and win_example.c.

References elm_policy_get().

int elm_init	(	int	argc,
		char **	argv
	)

Initialize Elementary.

Parameters

[in]	argc	System's argument count value
[in]	argv	System's pointer to array of argument strings

Returns: The init counter value.

This function initializes Elementary and increments a counter of the number of calls to it. It returns the new counter's value.

Warning: This call is exported only for use by the 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:

1 ELM_MAIN()

See the full example.

See also: elm_shutdown().

References elm_quicklaunch_init(), and elm_quicklaunch_sub_init().

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.

Parameters

lang	Language to set, must be the full name of the locale

const char* elm_object_access_info_get ( Evas_Object * obj )

Get the text to read out when in accessibility mode.

Parameters

obj	The object which is to be described

Returns: The text that describes the widget to people with poor or no vision

Since: 1.14

void elm_object_access_info_set	(	Evas_Object *	obj,
		const char *	txt
	)

Set the text to read out when in accessibility mode.

Parameters

obj	The object which is to be described
txt	The text that describes the widget to people with poor or no vision

Eina_Bool elm_object_disabled_get ( const Evas_Object * obj )

Get the disabled state of an Elementary object.

Parameters

obj	The Elementary object to operate on

Returns: 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.

void elm_object_disabled_set	(	Evas_Object *	obj,
		Eina_Bool	disabled
	)

Set the disabled state of an Elementary object.

Parameters

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.

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.

Parameters

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.

See also: elm_object_domain_translatable_part_text_set(); elm_object_part_text_set(); elm_policy()

Since: 1.8

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.

Parameters

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

Since: 1.8

Referenced by elm_object_domain_translatable_text_part_set().

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.

Parameters

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

Deprecated:: Use elm_object_domain_translatable_part_text_set() instead.

References elm_object_domain_translatable_part_text_set().

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.

Parameters

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:

Just return EINA_TRUE on func. EINA_FALSE will mean the event was not processed, so the propagation will go on.
The 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.

Note: Your event callback will be issued on those events taking place only if no other child widget of obj has consumed the event already.; Not to be confused with evas_object_event_callback_add(), which will add event callbacks per type on general Evas objects (no event propagation infrastructure taken in account).; Not to be confused with elm_object_signal_callback_add(), which will add callbacks to signals coming from a widget's theme, not input events.; Not to be confused with edje_object_signal_callback_add(), which does the same as elm_object_signal_callback_add(), but directly on an Edje object.; Not to be confused with evas_object_smart_callback_add(), which adds callbacks to smart objects' smart events, and not input events.

See also: elm_object_event_callback_del()

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.

Parameters

obj	The object
func	The callback function to be executed when the event is emitted.
data	Data to pass in to the callback function.

Returns: The data pointer

void elm_object_item_access_info_set	(	Elm_Widget_Item *	obj,
		const char *	txt
	)

Set the text to read out when in accessibility mode.

Parameters

[in] txt The text that describes the widget to people with poor or no vision

References elm_wdg_item_access_info_set().

Evas_Object* elm_object_item_access_object_get ( const Elm_Widget_Item * obj )

Get an accessible object of the object item.

Since: 1.8

References elm_wdg_item_access_object_get().

const Eina_List* elm_object_item_access_order_get ( Elm_Widget_Item * obj )

Get highlight order.

Since: 1.8

References elm_wdg_item_access_order_get().

void elm_object_item_access_order_set	(	Elm_Widget_Item *	obj,
		Eina_List *	objs
	)

Set highlight order.

Since: 1.8

Parameters

[in] objs Order of objects to pass highlight

References elm_wdg_item_access_order_set().

void elm_object_item_access_order_unset ( Elm_Widget_Item * obj )

Unset highlight order.

Since: 1.8

References elm_wdg_item_access_order_unset().

Evas_Object* elm_object_item_access_register ( Elm_Widget_Item * obj )

Register object item as an accessible object.

Since: 1.8

References elm_wdg_item_access_register().

void elm_object_item_access_unregister ( Elm_Widget_Item * obj )

Unregister accessible object of the object item.

Since: 1.8

References elm_wdg_item_access_unregister().

Eina_Bool elm_object_item_cursor_engine_only_get ( const Elm_Widget_Item * obj )

Get if the (custom) cursor for a given item is being searched in its theme, also, or is only relying on the rendering engine.

Returns: EINA_TRUE, if cursors are being looked for only on those provided by the rendering engine, EINA_FALSE if they are being searched on the widget's theme, as well.

See also: elm_object_item_cursor_engine_only_set(), for more details

References elm_wdg_item_cursor_engine_only_get().

void elm_object_item_cursor_engine_only_set	(	Elm_Widget_Item *	obj,
		Eina_Bool	engine_only
	)

Set if the (custom)cursor for a given item should be searched in its theme, also, or should only rely on the rendering engine.

Note: This call is of use only if you've set a custom cursor for items, with elm_object_item_cursor_set().; By default, cursors will only be looked for between those provided by the rendering engine.

Parameters

[in] engine_only Use EINA_TRUE to have cursors looked for only on those provided by the rendering engine, EINA_FALSE to have them searched on the widget's theme, as well.

References elm_wdg_item_cursor_engine_only_set().

const char* elm_object_item_cursor_get ( const Elm_Widget_Item * obj )

Get the type of mouse pointer/cursor decoration set to be shown, when the mouse pointer is over the given item.

See also: elm_object_cursor_get(); elm_object_item_cursor_set(); elm_object_item_cursor_unset()

References elm_wdg_item_cursor_get().

void elm_object_item_cursor_set	(	Elm_Widget_Item *	obj,
		const char *	cursor
	)

Set 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.

See also: elm_object_cursor_set(); elm_object_item_cursor_get(); elm_object_item_cursor_unset()

Parameters

[in] cursor the cursor type's name

References elm_wdg_item_cursor_set().

const char* elm_object_item_cursor_style_get ( const Elm_Widget_Item * obj )

Get the current style set for a given item's custom cursor.

See also: elm_object_item_cursor_style_set() for more details

References elm_wdg_item_cursor_style_get().

void elm_object_item_cursor_style_set	(	Elm_Widget_Item *	obj,
		const char *	style
	)

Set 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.

Warning: Before you set a cursor style you should have defined a custom cursor previously on the item, with elm_object_item_cursor_set()

See also: elm_object_item_cursor_engine_only_set(); elm_object_item_cursor_style_get()

Parameters

[in] style the theme style to use/in use (e.g. "default", "transparent", etc)

References elm_wdg_item_cursor_style_set().

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 also: elm_object_cursor_unset(); elm_object_item_cursor_set()

References elm_wdg_item_cursor_unset().

void* elm_object_item_data_get ( const Elm_Object_Item * it )

Get the data associated with an object item.

Parameters

it	The Elementary object item

Returns: The data associated with it

Note: Every elm_object_item supports this API

Examples:: entry_example.c, gengrid_example.c, genlist_example_05.c, index_example_01.c, index_example_02.c, and slideshow_example.c.

void elm_object_item_data_set	(	Elm_Object_Item *	it,
		void *	data
	)

Set the data associated with an object item.

Parameters

it	The Elementary object item
data	The data to be associated with `it`

Note: Every elm_object_item supports this API

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.

That function will receive these parameters:

void * item data
Evas_Object * widget object
Elm_Object_Item * widget item

Note: Every elm_object_item supports this API

See also: elm_object_item_del()

Parameters

[in] del_cb The function called

References elm_wdg_item_del_cb_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 also: elm_object_item_domain_translatable_part_text_set(); elm_object_item_part_text_set(); elm_policy()

Since: 1.8

Parameters

[in]	part	The part name of the translatable text
[in]	domain	The translation domain to use
[in]	translatable	`EINA_TRUE`, the part text will be translated internally. `EINA_FALSE`, otherwise.

References elm_wdg_item_domain_part_text_translatable_set().

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.

Since: 1.8

Parameters

[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

References elm_wdg_item_domain_translatable_part_text_set().

Evas_Object* elm_object_item_part_content_get	(	const Elm_Widget_Item *	obj,
		const char *	part
	)

Get a content of an object item.

Returns: content of the object item or NULL for any error

Note: Elementary object items may have many contents

Parameters

[in] part The content part name (NULL for the default content)

References elm_wdg_item_part_content_get().

void elm_object_item_part_content_set	(	Elm_Widget_Item *	obj,
		const char *	part,
		Evas_Object *	content
	)

Set 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.

Note: Elementary object items may have many contents

Parameters

[in]	part	The content part name (NULL for the default content)
[in]	content	The content of the object item

References elm_wdg_item_part_content_set().

Evas_Object* elm_object_item_part_content_unset	(	Elm_Widget_Item *	obj,
		const char *	part
	)

Unset a content of an object item.

Note: Elementary object items may have many contents

Parameters

[in] part The content part name to unset (NULL for the default content)

References elm_wdg_item_part_content_unset().

const char* elm_object_item_part_text_get	(	const Elm_Widget_Item *	obj,
		const char *	part
	)

Get a label of an object item.

Note: Elementary object items may have many labels

Parameters

[in] part The text part name (NULL for the default label)

References elm_wdg_item_part_text_get().

void elm_object_item_part_text_set	(	Elm_Widget_Item *	obj,
		const char *	part,
		const char *	label
	)

Set a label of an object item.

Note: Elementary object items may have many labels

Parameters

[in]	part	The text part name (NULL for the default label)
[in]	label	Text of the label

References elm_wdg_item_part_text_set().

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.

Since: 1.8

Parameters

[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.

References elm_wdg_item_signal_callback_add().

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 also: elm_object_item_signal_callback_add()

Since: 1.8

Parameters

[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.

References elm_wdg_item_signal_callback_del().

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.

Parameters

[in]	emission	The signal's name.
[in]	source	The signal's source.

References elm_wdg_item_signal_emit().

const char* elm_object_item_style_get ( const Elm_Widget_Item * obj )

Get the style of an object item.

Since: 1.9

References elm_wdg_item_style_get().

void elm_object_item_style_set	(	Elm_Widget_Item *	obj,
		const char *	style
	)

Set a style of an object item.

Since: 1.9

Parameters

[in] style The style of object item

References elm_wdg_item_style_set().

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 also: elm_object_tooltip_content_cb_set() for more details.

Parameters

[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.

References elm_wdg_item_tooltip_content_cb_set().

const char* elm_object_item_tooltip_style_get ( const Elm_Widget_Item * obj )

Get the style for this item tooltip.

See also: elm_object_tooltip_style_get() for more details.; elm_object_item_tooltip_style_set()

References elm_wdg_item_tooltip_style_get().

void elm_object_item_tooltip_style_set	(	Elm_Widget_Item *	obj,
		const char *	style
	)

Sets a different style for this item tooltip.

Note: before you set a style you should define a tooltip with elm_object_item_tooltip_content_cb_set() or elm_object_item_tooltip_text_set()

See also: elm_object_tooltip_style_set() for more details.

Parameters

[in] style the theme style used/to use (default, transparent, ...)

References elm_wdg_item_tooltip_style_set().

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 also: elm_object_tooltip_text_set() for more details.

Parameters

[in] text The text to set in the content.

References elm_wdg_item_tooltip_text_set().

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 also: elm_object_tooltip_unset() for more details.; elm_object_item_tooltip_content_cb_set()

References elm_wdg_item_tooltip_unset().

Evas_Object* elm_object_item_track ( Elm_Widget_Item * obj )

This returns track object of the item.

Note: This gets a rectangle object that represents the object item's internal object. If you wanna check the geometry, visibility of the item, you can call the evas apis such as evas_object_geometry_get(), 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 it's own widget's decision. So please dont' 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.

Warning: After use the track object, please call the elm_object_item_untrack() paired to elm_object_item_track() definitely to free the track object properly. Don't delete the track object.

See also: elm_object_item_untrack(); elm_object_item_track_get()

Since: 1.8

References elm_wdg_item_track().

int elm_object_item_track_get ( const Elm_Widget_Item * obj )

Get the track object reference count.

Note: This gets the reference count for the track object. Whenever you call the elm_object_item_track(), the reference count will be increased by one. Likely the referece count will be 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 please be sure to call elm_object_item_untrack() paired to the elm_object_item_track() call count.

See also: elm_object_item_track(); elm_object_item_track_get()

Since: 1.8

References elm_wdg_item_track_get().

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.

Since: 1.8

Parameters

[in] part The name of the part that was set

References elm_wdg_item_translatable_part_text_get().

void elm_object_item_untrack ( Elm_Widget_Item * obj )

This retrieve the track object of the item.

Note: This retrieves the track object that was returned from elm_object_item_track().

See also: elm_object_item_track(); elm_object_item_track_get()

Since: 1.8

References elm_wdg_item_untrack().

Evas_Object* elm_object_item_widget_get ( const Elm_Widget_Item * obj )

Get the widget object's handle which contains a given item.

Note: This returns the widget object itself that an item belongs to.; Every elm_object_item supports this API

References elm_wdg_item_widget_get().

Evas_Object* elm_object_name_find	(	const Evas_Object *	obj,
		const char *	name,
		int	recurse
	)

Get a named object from the children.

Parameters

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.)

Returns: The found object of that name, or NULL if none is found

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.

Eina_Bool elm_object_orientation_mode_disabled_get ( const Evas_Object * obj )

Get the orientation mode of a given widget.

Parameters

obj	The Elementary widget to query for its orientation mode.

Returns: EINA_TRUE, if the orientation mode is disabled, EINA_FALSE if the orientation mode is enabled (or on errors)

See also: elm_object_orientation_mode_disabled_set()

Since: 1.8

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.

Parameters

obj	The Elementary object to operate on orientation mode.
disabled	The state to put in in: `EINA_TRUE` for disabled, `EINA_FALSE` for enabled.

Since: 1.8

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.

Parameters

obj	The Elementary container widget
part	The container's part name to get (some might accept `NULL` for the default part)

Returns: content of the object at the given part or NULL, on errors

See also: elm_object_part_content_set() for more details

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.

Parameters

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.

See also: elm_object_part_content_get()

Evas_Object* elm_object_part_content_unset	(	Evas_Object *	obj,
		const char *	part
	)

Unset the content on a part of a given container widget.

Parameters

obj	The Elementary container widget
part	The container's part name to unset (some might accept `NULL` for the default part)

Returns: content of the object at the given part or NULL, on errors

See also: elm_object_part_content_set() for more details

const char* elm_object_part_text_get	(	const Evas_Object *	obj,
		const char *	part
	)

Get a text of an object.

Parameters

obj	The Elementary object
part	The text part name to get (NULL for the default part)

Returns: text of the part or NULL for any error

Note: Elementary objects may have many text parts (e.g. Action Slider)

void elm_object_part_text_set	(	Evas_Object *	obj,
		const char *	part,
		const char *	text
	)

Set a text of an object.

Parameters

obj	The Elementary object
part	The text part name to set (NULL for the default part)
text	The new text of the part

Note: Elementary objects may have many text parts (e.g. Action Slider)

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.

Parameters

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.

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.

Parameters

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.

Returns: The data pointer of the signal callback or 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.

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.

Parameters

obj	The object
emission	The signal's name.
source	The signal's source.

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.

Parameters

obj	The object
part	The name of the part that was set

Returns: The original, untranslated string

See also: elm_object_translatable_part_text_set()

Since: 1.8

Referenced by elm_object_translatable_text_part_get().

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.

Parameters

obj	The object
part	The name of the part that was set

Returns: The original, untranslated string

Deprecated:: Use elm_object_translatable_part_text_get() instead.

References elm_object_translatable_part_text_get().

int elm_policy_get ( unsigned int policy )

Get the policy value for given policy identifier.

Parameters

policy policy identifier, as in #Elm_Policy.

Returns: The currently set policy value, for that identifier. Will be 0 if policy passed is invalid.

Referenced by elm_exit().

Eina_Bool elm_policy_set	(	unsigned int	policy,
		int	value
	)

Set a new policy's value (for a given policy group/identifier).

Parameters

policy	policy identifier, as in Elm_Policy.
value	policy value, which depends on the identifier

Returns: 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.

Note: Currently, we have only one policy identifier/group (#ELM_POLICY_QUIT), which has two possible values.

Examples:: actionslider_example_01.c, bg_example_01.c, bg_example_02.c, bg_example_03.c, box_example_02.c, bubble_example_01.c, button_example_00.c, button_example_01.c, calendar_example_01.c, calendar_example_02.c, calendar_example_03.c, calendar_example_04.c, calendar_example_05.c, calendar_example_06.c, check_example_01.c, clock_example.c, codegen_example.c, colorselector_example_01.c, conformant_example_01.c, conformant_example_02.c, ctxpopup_example_01.c, datetime_example.c, dayselector_example.c, diskselector_example_01.c, diskselector_example_02.c, efl_thread_3.c, efl_thread_4.c, efl_thread_5.c, efl_thread_6.c, efl_thread_win32_1.c, efl_thread_win32_2.c, efl_thread_win32_3.c, efl_thread_win32_4.c, entry_example.c, fileselector_button_example.c, fileselector_entry_example.c, fileselector_example.c, flip_example_01.c, flipselector_example.c, frame_example_01.c, general_funcs_example.c, gengrid_example.c, genlist_example_01.c, genlist_example_02.c, genlist_example_03.c, genlist_example_04.c, genlist_example_05.c, glview_example_01.c, hover_example_01.c, hoversel_example_01.c, icon_example_01.c, image_example_01.c, index_example_01.c, index_example_02.c, inwin_example.c, label_example_01.c, layout_example_01.c, layout_example_02.c, layout_example_03.c, list_example_01.c, list_example_02.c, list_example_03.c, location_example_01.c, map_example_01.c, map_example_02.c, map_example_03.c, mapbuf_example.c, menu_example_01.c, naviframe_example.c, notify_example_01.c, panel_example_01.c, panes_example.c, photocam_example_01.c, popup_example_01.c, popup_example_02.c, popup_example_03.c, prefs_example_01.c, prefs_example_02.c, prefs_example_03.c, radio_example_01.c, scroller_example_01.c, segment_control_example.c, separator_example_01.c, slider_example.c, slideshow_example.c, spinner_example.c, table_example_01.c, table_example_02.c, theme_example_01.c, theme_example_02.c, thumb_example_01.c, toolbar_example_01.c, toolbar_example_02.c, toolbar_example_03.c, track_example_01.c, transit_example_01.c, transit_example_02.c, transit_example_03.c, transit_example_04.c, and web_example_02.c.

References _Elm_Event_Policy_Changed::new_value, and _Elm_Event_Policy_Changed::old_value.

Elm_Process_State elm_process_state_get ( void )

The state of the process as a whole.

Since: 1.12 Get the process state as a while

Returns: The current process state

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.

Since: 1.12

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.

See also: elm_init() for an example

Examples:: actionslider_example_01.c, bg_example_01.c, bg_example_02.c, bg_example_03.c, box_example_02.c, bubble_example_01.c, button_example_00.c, button_example_01.c, calendar_example_01.c, calendar_example_02.c, calendar_example_03.c, calendar_example_04.c, calendar_example_05.c, calendar_example_06.c, check_example_01.c, clock_example.c, codegen_example.c, colorselector_example_01.c, conformant_example_01.c, conformant_example_02.c, ctxpopup_example_01.c, datetime_example.c, dayselector_example.c, diskselector_example_01.c, diskselector_example_02.c, efl_thread_1.c, efl_thread_2.c, efl_thread_3.c, efl_thread_4.c, efl_thread_5.c, efl_thread_6.c, efl_thread_win32_1.c, efl_thread_win32_2.c, efl_thread_win32_3.c, efl_thread_win32_4.c, entry_example.c, fileselector_button_example.c, fileselector_entry_example.c, fileselector_example.c, flip_example_01.c, flipselector_example.c, frame_example_01.c, general_funcs_example.c, gengrid_example.c, genlist_example_01.c, genlist_example_02.c, genlist_example_03.c, genlist_example_04.c, genlist_example_05.c, glview_example_01.c, hover_example_01.c, hoversel_example_01.c, icon_example_01.c, image_example_01.c, index_example_01.c, index_example_02.c, inwin_example.c, label_example_01.c, layout_example_01.c, layout_example_02.c, layout_example_03.c, list_example_01.c, list_example_02.c, list_example_03.c, location_example_01.c, map_example_01.c, map_example_02.c, map_example_03.c, mapbuf_example.c, menu_example_01.c, naviframe_example.c, notify_example_01.c, panel_example_01.c, panes_example.c, photocam_example_01.c, popup_example_01.c, popup_example_02.c, popup_example_03.c, prefs_example_01.c, prefs_example_02.c, prefs_example_03.c, progressbar_example.c, radio_example_01.c, scroller_example_01.c, segment_control_example.c, separator_example_01.c, slider_example.c, slideshow_example.c, spinner_example.c, table_example_01.c, table_example_02.c, theme_example_01.c, theme_example_02.c, thumb_example_01.c, toolbar_example_01.c, toolbar_example_02.c, toolbar_example_03.c, track_example_01.c, transit_example_01.c, transit_example_02.c, transit_example_03.c, transit_example_04.c, web_example_02.c, and win_example.c.

int elm_shutdown ( void )

Shut down Elementary.

Returns: The init counter value.

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.

See also: elm_init() for an example

Note: elm_shutdown() will iterate main loop until all ecore_evas are freed. There is a possibility to call your ecore callbacks(timer, animator, event, job, and etc.) in elm_shutdown()

References elm_quicklaunch_shutdown(), and elm_quicklaunch_sub_shutdown().

EOAPI void elm_wdg_item_access_info_set ( const char * txt )

Set the text to read out when in accessibility mode.

Parameters

[in] txt The text that describes the widget to people with poor or no vision

Referenced by elm_object_item_access_info_set().

EOAPI Evas_Object* elm_wdg_item_access_object_get ( void )

Get an accessible object of the object item.

Since: 1.8

Referenced by elm_object_item_access_object_get().

EOAPI const Eina_List* elm_wdg_item_access_order_get ( void )

Get highlight order.

Since: 1.8

Referenced by elm_object_item_access_order_get().

EOAPI void elm_wdg_item_access_order_set ( Eina_List * objs )

Set highlight order.

Since: 1.8

Parameters

[in] objs Order of objects to pass highlight

Referenced by elm_object_item_access_order_set().

EOAPI void elm_wdg_item_access_order_unset ( void )

Unset highlight order.

Since: 1.8

Referenced by elm_object_item_access_order_unset().

EOAPI Evas_Object* elm_wdg_item_access_register ( void )

Register object item as an accessible object.

Since: 1.8

Referenced by elm_object_item_access_register().

EOAPI void elm_wdg_item_access_unregister ( void )

Unregister accessible object of the object item.

Since: 1.8

Referenced by elm_object_item_access_unregister().

EOAPI Eina_Bool elm_wdg_item_cursor_engine_only_get ( void )

Get if the (custom) cursor for a given item is being searched in its theme, also, or is only relying on the rendering engine.

Returns: EINA_TRUE, if cursors are being looked for only on those provided by the rendering engine, EINA_FALSE if they are being searched on the widget's theme, as well.

See also: elm_object_item_cursor_engine_only_set(), for more details

Referenced by elm_gengrid_item_cursor_engine_only_get(), elm_genlist_item_cursor_engine_only_get(), and elm_object_item_cursor_engine_only_get().

EOAPI void elm_wdg_item_cursor_engine_only_set ( Eina_Bool engine_only )

Set if the (custom)cursor for a given item should be searched in its theme, also, or should only rely on the rendering engine.

Note: This call is of use only if you've set a custom cursor for items, with elm_object_item_cursor_set().; By default, cursors will only be looked for between those provided by the rendering engine.

Parameters

[in] engine_only Use EINA_TRUE to have cursors looked for only on those provided by the rendering engine, EINA_FALSE to have them searched on the widget's theme, as well.

Referenced by elm_gengrid_item_cursor_engine_only_set(), elm_genlist_item_cursor_engine_only_set(), and elm_object_item_cursor_engine_only_set().

EOAPI const char* elm_wdg_item_cursor_get ( void )

Get the type of mouse pointer/cursor decoration set to be shown, when the mouse pointer is over the given item.

See also: elm_object_cursor_get(); elm_object_item_cursor_set(); elm_object_item_cursor_unset()

Referenced by elm_gengrid_item_cursor_get(), elm_genlist_item_cursor_get(), and elm_object_item_cursor_get().

EOAPI void elm_wdg_item_cursor_set ( const char * cursor )

Set 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.

See also: elm_object_cursor_set(); elm_object_item_cursor_get(); elm_object_item_cursor_unset()

Parameters

[in] cursor the cursor type's name

Referenced by elm_gengrid_item_cursor_set(), elm_genlist_item_cursor_set(), and elm_object_item_cursor_set().

EOAPI const char* elm_wdg_item_cursor_style_get ( void )

Get the current style set for a given item's custom cursor.

See also: elm_object_item_cursor_style_set() for more details

Referenced by elm_gengrid_item_cursor_style_get(), elm_genlist_item_cursor_style_get(), and elm_object_item_cursor_style_get().

EOAPI void elm_wdg_item_cursor_style_set ( const char * style )

Set 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.

Warning: Before you set a cursor style you should have defined a custom cursor previously on the item, with elm_object_item_cursor_set()

See also: elm_object_item_cursor_engine_only_set(); elm_object_item_cursor_style_get()

Parameters

[in] style the theme style to use/in use (e.g. "default", "transparent", etc)

Referenced by elm_gengrid_item_cursor_style_set(), elm_genlist_item_cursor_style_set(), and elm_object_item_cursor_style_set().

EOAPI void elm_wdg_item_cursor_unset ( void )

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 also: elm_object_cursor_unset(); elm_object_item_cursor_set()

Referenced by elm_gengrid_item_cursor_unset(), elm_genlist_item_cursor_unset(), and elm_object_item_cursor_unset().

EOAPI void elm_wdg_item_del_cb_set ( Evas_Smart_Cb del_cb )

Set the function to be called when an item from the widget is freed.

That function will receive these parameters:

void * item data
Evas_Object * widget object
Elm_Object_Item * widget item

Note: Every elm_object_item supports this API

See also: elm_object_item_del()

Parameters

[in] del_cb The function called

Referenced by elm_object_item_del_cb_set().

EOAPI void elm_wdg_item_domain_part_text_translatable_set	(	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 also: elm_object_item_domain_translatable_part_text_set(); elm_object_item_part_text_set(); elm_policy()

Since: 1.8

Parameters

[in]	part	The part name of the translatable text
[in]	domain	The translation domain to use
[in]	translatable	`EINA_TRUE`, the part text will be translated internally. `EINA_FALSE`, otherwise.

Referenced by elm_object_item_domain_part_text_translatable_set().

EOAPI void elm_wdg_item_domain_translatable_part_text_set	(	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.

Since: 1.8

Parameters

[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

Referenced by elm_object_item_domain_translatable_part_text_set().

EOAPI Evas_Object* elm_wdg_item_part_content_get ( const char * part )

Get a content of an object item.

Returns: content of the object item or NULL for any error

Note: Elementary object items may have many contents

Parameters

[in] part The content part name (NULL for the default content)

Referenced by elm_object_item_part_content_get().

EOAPI void elm_wdg_item_part_content_set	(	const char *	part,
		Evas_Object *	content
	)

Set 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.

Note: Elementary object items may have many contents

Parameters

[in]	part	The content part name (NULL for the default content)
[in]	content	The content of the object item

Referenced by elm_object_item_part_content_set().

EOAPI Evas_Object* elm_wdg_item_part_content_unset ( const char * part )

Unset a content of an object item.

Note: Elementary object items may have many contents

Parameters

[in] part The content part name to unset (NULL for the default content)

Referenced by elm_object_item_part_content_unset().

EOAPI const char* elm_wdg_item_part_text_get ( const char * part )

Get a label of an object item.

Note: Elementary object items may have many labels

Parameters

[in] part The text part name (NULL for the default label)

Referenced by elm_object_item_part_text_get().

EOAPI void elm_wdg_item_part_text_set	(	const char *	part,
		const char *	label
	)

Set a label of an object item.

Note: Elementary object items may have many labels

Parameters

[in]	part	The text part name (NULL for the default label)
[in]	label	Text of the label

Referenced by elm_object_item_part_text_set().

EOAPI void elm_wdg_item_signal_callback_add	(	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.

Since: 1.8

Parameters

[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.

Referenced by elm_object_item_signal_callback_add().

EOAPI void* elm_wdg_item_signal_callback_del	(	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 also: elm_object_item_signal_callback_add()

Since: 1.8

Parameters

[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.

Referenced by elm_object_item_signal_callback_del().

EOAPI void elm_wdg_item_signal_emit	(	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.

Parameters

[in]	emission	The signal's name.
[in]	source	The signal's source.

Referenced by elm_object_item_signal_emit().

EOAPI const char* elm_wdg_item_style_get ( void )

Get the style of an object item.

Since: 1.9

Referenced by elm_object_item_style_get().

EOAPI void elm_wdg_item_style_set ( const char * style )

Set a style of an object item.

Since: 1.9

Parameters

[in] style The style of object item

Referenced by elm_object_item_style_set().

EOAPI void elm_wdg_item_tooltip_content_cb_set	(	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 also: elm_object_tooltip_content_cb_set() for more details.

Parameters

[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.

Referenced by elm_gengrid_item_tooltip_content_cb_set(), elm_genlist_item_tooltip_content_cb_set(), and elm_object_item_tooltip_content_cb_set().

EOAPI const char* elm_wdg_item_tooltip_style_get ( void )

Get the style for this item tooltip.

See also: elm_object_tooltip_style_get() for more details.; elm_object_item_tooltip_style_set()

Referenced by elm_gengrid_item_tooltip_style_get(), elm_genlist_item_tooltip_style_get(), and elm_object_item_tooltip_style_get().

EOAPI void elm_wdg_item_tooltip_style_set ( const char * style )

Sets a different style for this item tooltip.

Note: before you set a style you should define a tooltip with elm_object_item_tooltip_content_cb_set() or elm_object_item_tooltip_text_set()

See also: elm_object_tooltip_style_set() for more details.

Parameters

[in] style the theme style used/to use (default, transparent, ...)

Referenced by elm_gengrid_item_tooltip_style_set(), elm_genlist_item_tooltip_style_set(), and elm_object_item_tooltip_style_set().

EOAPI void elm_wdg_item_tooltip_text_set ( 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 also: elm_object_tooltip_text_set() for more details.

Parameters

[in] text The text to set in the content.

Referenced by elm_gengrid_item_tooltip_text_set(), elm_genlist_item_tooltip_text_set(), and elm_object_item_tooltip_text_set().

EOAPI void elm_wdg_item_tooltip_unset ( void )

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 also: elm_object_tooltip_unset() for more details.; elm_object_item_tooltip_content_cb_set()

Referenced by elm_gengrid_item_tooltip_unset(), elm_genlist_item_tooltip_unset(), and elm_object_item_tooltip_unset().

EOAPI Evas_Object* elm_wdg_item_track ( void )

This returns track object of the item.

Note: This gets a rectangle object that represents the object item's internal object. If you wanna check the geometry, visibility of the item, you can call the evas apis such as evas_object_geometry_get(), 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 it's own widget's decision. So please dont' 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.

Warning: After use the track object, please call the elm_object_item_untrack() paired to elm_object_item_track() definitely to free the track object properly. Don't delete the track object.

See also: elm_object_item_untrack(); elm_object_item_track_get()

Since: 1.8

Referenced by elm_object_item_track().

EOAPI int elm_wdg_item_track_get ( void )

Get the track object reference count.

Note: This gets the reference count for the track object. Whenever you call the elm_object_item_track(), the reference count will be increased by one. Likely the referece count will be 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 please be sure to call elm_object_item_untrack() paired to the elm_object_item_track() call count.

See also: elm_object_item_track(); elm_object_item_track_get()

Since: 1.8

Referenced by elm_object_item_track_get().

EOAPI const char* elm_wdg_item_translatable_part_text_get ( 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.

Since: 1.8

Parameters

[in] part The name of the part that was set

Referenced by elm_object_item_translatable_part_text_get().

EOAPI void elm_wdg_item_untrack ( void )

This retrieve the track object of the item.

Note: This retrieves the track object that was returned from elm_object_item_track().

See also: elm_object_item_track(); elm_object_item_track_get()

Since: 1.8

Referenced by elm_object_item_untrack().

EOAPI Evas_Object* elm_wdg_item_widget_get ( void )

Get the widget object's handle which contains a given item.

Note: This returns the widget object itself that an item belongs to.; Every elm_object_item supports this API

Referenced by elm_object_item_widget_get().

Variable Documentation

int ELM_EVENT_PROCESS_BACKGROUND

Emitted when nothing is visible and the process as a whole should go into a background state.

Since: 1.12

int ELM_EVENT_PROCESS_FOREGROUND

Emitted when going from nothing being visible to at least one window being visible.

Since: 1.12

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation