macro to be used after the elm_main() function

Examples:

actionslider_example_01.c, bg_cxx_example_01.cc, 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_cxx_example_05.cc, 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, combobox_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, 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_cxx_example_01.cc, 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_cxx_example_01.cc, 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_data_example.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.

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.

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.

How the focus region should be calculated (not related to input focus).

An Elementary Object item handle.

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 (EFL) :

1.8

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.

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

Exposed symbol used only by macros and should not be used by apps

Delete elementary color class.

This function deletes any values at the process level for the specified color class.

Note:

Deleting the color class will revert it to the values defined in the theme file.

Parameters:

[in]

color_class

The name of color class.

Since :

3.0

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.

Since :

2.3

Examples:

button_example_00.c, efl_thread_3.c, efl_thread_4.c, efl_thread_5.c, fileselector_example.c, glview_example_01.c, progressbar_example.c, and win_example.c.

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:

ELM_MAIN()

See the full example.

See also:

elm_shutdown().

Since :

2.3

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

Since :

2.3

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 (EFL) :

1.14

Since :

3.0

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

Since :

2.3

Delete all color classes for the Elementary widget item.

This function deletes any color classes defined for the Elementary widget item. Clearing color classes will revert the color of all parts to the values defined by elm_color_class_set() or the theme file.

Parameters:

[in]

obj

The Elementary widget.

Since :

3.0

Delete the color class for the Elementary widget.

Deleting the color class will revert it to the values defined by elm_color_class_set() or the theme file.

Parameters:

[in]	obj	The Elementary widget.
[in]	color_class	The name of color class.

Since :

3.0

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.

Since :

2.3

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.

Since :

2.3

Examples:

general_funcs_example.c, gengrid_example.c, inwin_example.c, slideshow_example.c, and web_example_02.c.

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 (EFL) :

1.8

Since :

2.3

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 (EFL) :

1.8

Since :

2.3

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.

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

Since :

2.3

Examples:

flipselector_example.c.

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

Since :

2.3

Set the text to read out when in accessibility mode.

Parameters:

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

Since :

2.3

Get an accessible object of the object item.

Parameters:

[in]

obj

The object.

Returns:

Accessible object of the object item or NULL for any error

Since (EFL) :

1.8

Since :

2.3

Get highlight order.

Parameters:

[in]

obj

The object.

Returns:

List of evas canvas objects

Since (EFL) :

1.8

Since :

2.3

Set highlight order.

Parameters:

[in]	obj	The object.
[in]	objs	Order of objects to pass highlight

Since (EFL) :

1.8

Since :

2.3

Unset highlight order

Since (EFL) :

1.8

Since :

2.3

Register object item as an accessible object.

Parameters:

[in]

obj

The object.

Returns:

Accessible object of the object item or NULL for any error

Since (EFL) :

1.8

Since :

2.3

Unregister accessible object of the object item.

Since (EFL) :

1.8

Since :

2.3

Delete all color classes for the Elementary widget item.

This function deletes any color classes defined for the Elementary widget item. Clearing color classes will revert the color of all parts to the values defined by elm_color_class_set() or the theme file.]]

Parameters:

[in]

it

The Elementary widget item.

Since :

3.0

Delete the color class for the Elementary widget item.

Deleting the color class will revert it to the values defined by elm_color_class_set() or the theme file.

Parameters:

[in]	it	The Elementary widget item.
[in]	color_class	The name of color class.

Since :

3.0

Control 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]

obj

The object.

Returns:

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.

Since :

2.3

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

Since :

2.3

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.

Parameters:

[in]

obj

The object.

Returns:

The cursor type's name

Since :

2.3

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.

Parameters:

[in]	obj	The object.
[in]	cursor	The cursor type's name

Since :

2.3

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.

Warning:

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

Parameters:

[in]

obj

The object.

Returns:

The theme style to use/in use (e.g. $"default", $"transparent", etc)

Since :

2.3

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.

Warning:

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

Parameters:

[in]	obj	The object.
[in]	style	The theme style to use/in use (e.g. $"default", $"transparent", etc)

Since :

2.3

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

Parameters:

[in]

obj

The object.

Since :

2.3

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

Since :

2.3

Examples:

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

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

Since :

2.3

Delete the given item.

Since :

2.3

Examples:

diskselector_example_02.c, flipselector_example.c, genlist_example_05.c, index_example_01.c, list_example_03.c, menu_cxx_example_01.cc, menu_example_01.c, segment_control_example.c, and web_example_02.c.

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

Note:

Every elm_object_item supports this API

Parameters:

[in]	obj	The object.
[in]	del_cb	The function called

Since :

2.3

Examples:

diskselector_example_02.c, hoversel_example_01.c, index_example_01.c, list_example_03.c, and web_example_02.c.

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.

Parameters:

[in]

obj

The object.

Returns:

true, if the widget item is disabled, false if it's enabled (or on errors)

Since :

2.3

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.

Parameters:

[in]	obj	The object.
[in]	disable	true, if the widget item is disabled, false if it's enabled (or on errors)

Since :

2.3

Examples:

ctxpopup_example_01.c, gengrid_example.c, genlist_example_04.c, list_example_03.c, menu_example_01.c, and toolbar_example_01.c.

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

Parameters:

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

Since (EFL) :

1.8

Since :

2.3

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.

Parameters:

[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

Since (EFL) :

1.8

Since :

2.3

Control the object item focused.

Parameters:

[in]

obj

The object.

Returns:

The focused state

Since (EFL) :

1.10

Since :

3.0

Get the next object item with specific focus direction.

Parameters:

[in]	obj	The object.
[in]	dir	Focus direction

Returns:

Focus next object item

Since (EFL) :

1.16

Since :

3.0

Set the next object item with specific focus direction.

Parameters:

[in]	obj	The object.
[in]	next_item	Focus next object item
[in]	dir	Focus direction

Since (EFL) :

1.16

Since :

3.0

Get the next object with specific focus direction.

Parameters:

[in]	obj	The object.
[in]	dir	Focus direction

Returns:

Focus next object

Since (EFL) :

1.16

Since :

3.0

Set the next object with specific focus direction.

Parameters:

[in]	obj	The object.
[in]	next	Focus next object
[in]	dir	Focus direction

Since (EFL) :

1.16

Since :

3.0

Control the object item focused.

Parameters:

[in]	obj	The object.
[in]	focused	The focused state

Since (EFL) :

1.10

Since :

3.0

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.

Parameters:

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

Returns:

The content of the object item

Since :

2.3

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.

Parameters:

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

Since :

2.3

Unset a content of an object item.

Note:

Elementary object items may have many contents

Parameters:

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

Returns:

Content object

Since :

2.3

Control a label of an object item.

Note:

Elementary object items may have many labels

Parameters:

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

Returns:

Text of the label

Since :

2.3

Control a label of an object item.

Note:

Elementary object items may have many labels

Parameters:

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

Since :

2.3

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.

Parameters:

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

Since (EFL) :

1.8

Since :

2.3

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

Parameters:

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

Returns:

The data pointer of the signal callback or NULL, on errors.

Since (EFL) :

1.8

Since :

2.3

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.

Parameters:

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

Since :

2.3

Control the style of an object item.

Parameters:

[in]

obj

The object.

Returns:

The style of object item

Since (EFL) :

1.9

Since :

2.3

Control the style of an object item.

Parameters:

[in]	obj	The object.
[in]	style	The style of object item

Since (EFL) :

1.9

Since :

2.3

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.

Parameters:

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

Since :

2.3

Control 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: elm_object_tooltip_style_set() for more details.

Parameters:

[in]

obj

The object.

Returns:

The theme style used/to use (default, transparent, ...)

Since :

2.3

Control 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: elm_object_tooltip_style_set() for more details.

Parameters:

[in]	obj	The object.
[in]	style	The theme style used/to use (default, transparent, ...)

Since :

2.3

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.

Parameters:

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

Since :

2.3

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

Parameters:

[in]

obj

The object.

Since :

2.3

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.

Parameters:

[in]

obj

The object.

Returns:

If true, size restrictions are disabled

Since :

2.3

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.

Parameters:

[in]	obj	The object.
[in]	disable	If true, size restrictions are disabled

Returns:

false on failure, true on success

Since :

2.3

This returns track object of the item.

Note:

This gets a rectangle object that represents the object item's internal object. If you want to 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: elm_object_item_untrack See: elm_object_item_track_get

Parameters:

[in]

obj

The object.

Returns:

The track object

Since (EFL) :

1.8

Since :

2.3

Examples:

track_example_01.c.

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 reference 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: elm_object_item_track See: elm_object_item_track_get

Parameters:

[in]

obj

The object.

Returns:

Track object reference count

Since (EFL) :

1.8

Since :

2.3

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.

Parameters:

[in]	obj	The object.
[in]	part	The name of the part that was set

Returns:

The original, untranslated string

Since (EFL) :

1.8

Since :

2.3

This retrieve the track object of the item.

Note:

This retrieves the track object that was returned from elm_object_item_track.

See: elm_object_item_track See: elm_object_item_track_get

Parameters:

[in]

obj

The object.

Since (EFL) :

1.8

Since :

2.3

Examples:

track_example_01.c.

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

Note:

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

Parameters:

[in]

obj

The object.

Returns:

The widget object

Since :

2.3

Examples:

genlist_example_05.c.

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.

Since :

2.3

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 (EFL) :

1.8

Since :

2.3

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 (EFL) :

1.8

Since :

2.3

Registers a part of an object as an access object.

Parameters:

obj	The object
part	The object's part name to register

Since :

4.0

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

Since :

2.3

Examples:

layout_example_02.c.

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

Since :

2.3

Examples:

bg_example_03.c, bubble_example_01.c, button_example_01.c, check_example_01.c, entry_example.c, fileselector_button_example.c, fileselector_entry_example.c, flip_example_01.c, hover_example_01.c, hoversel_example_01.c, inwin_example.c, layout_example_01.c, layout_example_02.c, layout_example_03.c, panes_example.c, popup_example_02.c, popup_example_03.c, progressbar_example.c, radio_example_01.c, slider_example.c, transit_example_03.c, transit_example_04.c, and web_example_02.c.

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

Since :

2.3

Examples:

layout_example_01.c.

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)

Since :

2.3

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)

Since :

2.3

Examples:

actionslider_example_01.c, bubble_example_01.c, combobox_example_01.c, layout_example_01.c, layout_example_03.c, mapbuf_example.c, popup_example_01.c, popup_example_02.c, and popup_example_03.c.

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.

Since :

2.3

Examples:

layout_example_02.c, and layout_example_03.c.

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.

Since :

2.3

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.

Since :

2.3

Examples:

layout_example_03.c.

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 (EFL) :

1.8

Since :

2.3

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.

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.

Since :

2.3

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.

Since :

2.3

Examples:

actionslider_example_01.c, bg_cxx_example_01.cc, bg_example_01.c, bg_example_02.c, bg_example_03.c, box_example_02.c, bubble_example_01.c, button_cxx_example_00.cc, button_cxx_example_01.cc, button_example_00.c, button_example_01.c, calendar_cxx_example_01.cc, calendar_cxx_example_02.cc, calendar_cxx_example_03.cc, calendar_cxx_example_04.cc, calendar_cxx_example_05.cc, 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_cxx_example.cc, clock_example.c, codegen_example.c, colorselector_example_01.c, combobox_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, 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_cxx_example_01.cc, 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_cxx_example_01.cc, 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_cxx_example_01.cc, radio_example_01.c, scroller_example_01.c, segment_control_example.c, separator_example_01.c, slider_cxx_example.cc, slider_example.c, slideshow_example.c, spinner_example.c, table_cxx_example_01.cc, table_cxx_example_02.cc, 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.

The state of the process as a whole.

Since (EFL) :

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 (EFL) :

1.12

Deprecated:

Deprecated since 2.4 Exposed symbol used only by macros and should not be used by apps

Since :

2.3

Deprecated:

Deprecated since 2.4 Exposed symbol used only by macros and should not be used by apps

Since :

2.3

Deprecated:

Deprecated since 2.4 Exposed symbol used only by macros and should not be used by apps

Since :

2.3

Deprecated:

Deprecated since 2.4 Exposed symbol used only by macros and should not be used by apps

Since :

2.3

Deprecated:

Deprecated since 2.4 Exposed symbol used only by macros and should not be used by apps

Since :

2.3

Deprecated:

Deprecated since 2.4 Exposed symbol used only by macros and should not be used by apps

Since :

2.3

Deprecated:

Deprecated since 2.4 Exposed symbol used only by macros and should not be used by apps

Since :

2.3

Deprecated:

Deprecated since 2.4 Exposed symbol used only by macros and should not be used by apps

Since :

2.3

Deprecated:

Deprecated since 2.4 Exposed symbol used only by macros and should not be used by apps

Since :

2.3

Deprecated:

Deprecated since 2.4 Exposed symbol used only by macros and should not be used by apps

Since :

2.3

Deprecated:

Deprecated since 2.4 Exposed symbol used only by macros and should not be used by apps

Since :

2.3

Deprecated:

Deprecated since 2.4 Exposed symbol used only by macros and should not be used by apps

Since :

2.3

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.

See also:

elm_init() for an example

Since :

2.3

Examples:

actionslider_example_01.c, bg_cxx_example_01.cc, 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_cxx_example_05.cc, 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, combobox_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, 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_cxx_example_01.cc, 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_cxx_example_01.cc, 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.

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

Since :

2.3

Since :

3.0

Emitted when the application has reconfigured elementary settings due to an external configuration tool asking it to.

Since :

3.0

Emitted when any Elementary's policy value is changed.

Since :

3.0

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

Since (EFL) :

1.12

Since :

3.0

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

Since (EFL) :

1.12

Since :

3.0