macro to be used after the elm_main() function

Convenient macro for elm_object_part_content_get.

Since :

2.3

See also:

elm_object_part_content_get

Convenient macro for elm_object_part_content_set.

Since :

2.3

See also:

elm_object_part_content_set

Convenient macro for elm_object_part_content_unset.

Since :

2.3

See also:

elm_object_part_content_unset

Convenient macro for elm_object_domain_part_text_translatable_set.

Since :

2.3

See also:

elm_object_domain_part_text_translatable_set

Convenient macro for elm_object_domain_translatable_part_text_set.

Since :

2.3

See also:

elm_object_domain_translatable_part_text_set

Convenient macro for elm_object_item_part_content_get.

Since :

2.3

See also:

elm_object_item_part_content_get

Convenient macro for elm_object_item_part_content_set.

Since :

2.3

See also:

elm_object_item_part_content_set

Convenient macro for elm_object_item_part_content_unset.

Since :

2.3

See also:

elm_object_item_part_content_unset

Convenient macro for elm_object_item_domain_part_text_translatable_set.

Since :

2.3

See also:

elm_object_item_domain_part_text_translatable_set

Convenient macro for elm_object_item_domain_translatable_part_text_set.

Since :

2.3

See also:

elm_object_item_domain_translatable_part_text_set

Convenient macro for elm_object_item_domain_part_text_translatable_set.

Since :

2.3

See also:

elm_object_item_domain_part_text_translatable_set

Convenient macro for elm_object_item_part_text_get.

Since :

2.3

See also:

elm_object_item_part_text_get

Sets the macro label of an object item.

Since :

2.3

Remarks:

Elementary object items may have many labels.

Parameters:

[in]	it	The Elementary object item
[in]	label	The new text of the label

Convenient macro for elm_object_item_domain_translatable_part_text_set.

Since :

2.3

See also:

elm_object_item_domain_translatable_part_text_set

Convenient macro for elm_object_item_translatable_part_text_get.

Since :

2.3

See also:

elm_object_item_translatable_part_text_get

Convenient macro for elm_object_item_domain_translatable_part_text_set.

Since :

2.3

See also:

elm_object_item_domain_translatable_part_text_set

Convenient macro for elm_object_domain_part_text_translatable_set.

Since :

2.3

See also:

elm_object_domain_part_text_translatable_set

Convenient macro for elm_object_part_text_get.

Since :

2.3

See also:

elm_object_part_text_get

Convenient macro for elm_object_part_text_set.

Since :

2.3

See also:

elm_object_part_text_set

Convenient macro for elm_object_domain_translatable_part_text_set.

Since :

2.3

See also:

elm_object_domain_translatable_part_text_set

Convenient macro for elm_object_translatable_part_text_get.

Since :

2.3

See also:

elm_object_translatable_part_text_get

Convenient macro for elm_object_domain_translatable_part_text_set.

Since :

2.3

See also:

elm_object_domain_translatable_part_text_set

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.

Data on the event when an Elementary policy has changed

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

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

Possible values for the #ELM_OBJECT_MULTI_SELECT_MODE policy.

Since (EFL) :

1.8

Enumerator:

ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT	default multiple select mode
ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL	disallow mutiple selection when clicked without control key pressed
ELM_OBJECT_MULTI_SELECT_MODE_MAX	canary value: any value greater or equal to ELM_OBJECT_MULTI_SELECT_MODE_MAX is forbidden.

Possible values for the #ELM_OBJECT_SELECT_MODE policy.

Since (EFL) :

1.7

Enumerator:

ELM_OBJECT_SELECT_MODE_DEFAULT	default select mode. Once an item is selected, it would stay highlighted and not going to call selected callback again even it was clicked. Items can get focus.
ELM_OBJECT_SELECT_MODE_ALWAYS	always select mode. Item selected callbacks will be called every time for click events, even after the item was already selected. Items can get focus.
ELM_OBJECT_SELECT_MODE_NONE	no select mode. Items will never be highlighted and selected but the size will be adjusted by the finger size configuration. Items can't get focus.
ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY	no select mode with no finger size rule. Items will never be highlighted and selected and ignore the finger size. So the item size can be reduced below than the finger size configuration. Items can't get focus.
ELM_OBJECT_SELECT_MODE_MAX	canary value: any value greater or equal to ELM_OBJECT_SELECT_MODE_MAX is forbidden.

Policy identifiers.

Enumerator:

ELM_POLICY_QUIT	under which circumstances the application should quit automatically. See also: Elm_Policy_Quit.
ELM_POLICY_EXIT	defines elm_exit() behaviour. See also: Elm_Policy_Exit. Since (EFL) : 1.8
ELM_POLICY_THROTTLE	defines how throttling should work See also: Elm_Policy_Throttle Since (EFL) : 1.8

Possible values for the ELM_POLICY_EXIT policy.

Since (EFL) :

1.8

Enumerator:

ELM_POLICY_EXIT_NONE	just quit the main loop on elm_exit()
ELM_POLICY_EXIT_WINDOWS_DEL	delete all the windows after quitting the main loop

Possible values for the ELM_POLICY_QUIT policy

Enumerator:

ELM_POLICY_QUIT_NONE	never quit the application automatically
ELM_POLICY_QUIT_LAST_WINDOW_CLOSED	quit when the application's last window is closed

Possible values for the ELM_POLICY_THROTTLE policy.

Since (EFL) :

1.8

Enumerator:

ELM_POLICY_THROTTLE_CONFIG	do whatever elementary config is configured to do
ELM_POLICY_THROTTLE_HIDDEN_ALWAYS	always throttle when all windows are no longer visible
ELM_POLICY_THROTTLE_NEVER	never throttle when windows are all hidden, regardless of config settings

Ask to exit Elementary's main loop.

Since :

2.3

Remarks:

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.

Remarks:

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

Initialize Elementary.

Since :

2.3

Parameters:

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

Returns:

The init counter value.

Remarks:

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.

See also:

elm_shutdown().

Change the language of the current application.

Since :

2.3

Remarks:

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:

[in]

lang

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

Set the text to read out when in accessibility mode.

Since :

2.3

Parameters:

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

Get the disabled state of an Elementary object.

Since :

2.3

Parameters:

[in]

obj

The Elementary object to operate on

Returns:

EINA_TRUE, if the widget is disabled, EINA_FALSE if it's enabled (or on errors)

Remarks:

This gets the state of the widget, which might be enabled or disabled.

Set the disabled state of an Elementary object.

Since :

2.3

Parameters:

[in]	obj	The Elementary object to operate on
[in]	disabled	The state to put in in: EINA_TRUE for disabled, EINA_FALSE for enabled

Remarks:

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.

Mark the part text to be translatable or not.

Since :

2.3

Remarks:

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:

[in]	obj	The object containing the text part
[in]	part	The part name of the translatable text
[in]	domain	The translation domain to use
[in]	translatable	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

Set the text for an object's part, marking it as translatable.

Since :

2.3

Remarks:

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:

[in]	obj	The object containing the text part
[in]	part	The name of the part to set
[in]	domain	The translation domain to use
[in]	text	The original, non-translated text to set

Since (EFL) :

1.8

Add a callback for input events (key up, key down, mouse wheel) on a given Elementary widget.

Since :

2.3

Parameters:

[in]	obj	The widget to add an event callback on
[in]	func	The callback function to be executed when the event happens
[in]	data	Data to pass in to func

Remarks:

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.

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

Remove an event callback from a widget.

Since :

2.3

Remarks:

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:

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

Returns:

The data pointer

Set the text to read out when in accessibility mode

Since :

2.3

Parameters:

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

Get an accessible object of the object item.

Since (EFL) :

1.8

Since :

2.3

Parameters:

[in]

obj

The elm widget item object

Get highlight order.

Since (EFL) :

1.8

Since :

2.3

Parameters:

[in]

obj

The elm widget item object

Set highlight order.

Since (EFL) :

1.8

Since :

2.3

Parameters:

[in]	obj	The elm widget item object
[in]	objs	Order of objects to pass highlight

Unset highlight order.

Since (EFL) :

1.8

Since :

2.3

Parameters:

[in]

obj

The elm widget item object

Register object item as an accessible object.

Since (EFL) :

1.8

Since :

2.3

Parameters:

[in]

obj

The elm widget item object

Unregister accessible object of the object item.

Since (EFL) :

1.8

Since :

2.3

Parameters:

[in]

obj

The elm widget item object

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

Since :

2.3

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

Parameters:

[in]

obj

The elm widget item object

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

Since :

2.3

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 elm widget item object
[in]	engine_only	No description supplied.

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

Since :

2.3

See also:

elm_object_cursor_get()

elm_object_item_cursor_set()

elm_object_item_cursor_unset()

Parameters:

[in]

obj

The elm widget item object

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

Since :

2.3

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]	obj	The elm widget item object
[in]	cursor	the cursor type's name

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

Since :

2.3

See also:

elm_object_item_cursor_style_set() for more details

Parameters:

[in]

obj

The elm widget item object

Set a different style for a given custom cursor set for an item.

Since :

2.3

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]	obj	The elm widget item object
[in]	style	the theme style to use/in use (e.g. "default", "transparent", etc)

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

Since :

2.3

Parameters:

[in]

obj

The elm widget item object

Get the data associated with an object item.

Since :

2.3

Parameters:

[in]

it

The Elementary object item

Returns:

The data associated with it

Remarks:

Every elm_object_item supports this API

Set the data associated with an object item.

Since :

2.3

Parameters:

[in]	it	The Elementary object item
[in]	data	The data to be associated with it

Remarks:

Every elm_object_item supports this API

Delete the given item.

Since :

2.3

Parameters:

[in]

obj

The elm widget item object

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

Since :

2.3

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]	obj	The elm widget item object
[in]	del_cb	The function called

Mark the part text to be translatable or not.

Since :

2.3

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

1.8

Parameters:

[in]	obj	The elm widget item object
[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.

Set the text for an object item's part, marking it as translatable.

Since :

2.3

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

1.8

Parameters:

[in]	obj	The elm widget item 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

Get a content of an object item

Since :

2.3

Returns:

content of the object item or NULL for any error

Note:

Elementary object items may have many contents

Parameters:

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

Set a content of an object item

Since :

2.3

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]	obj	The elm widget item object
[in]	part	The content part name (NULL for the default content)
[in]	content	The content of the object item

Unset a content of an object item

Since :

2.3

Note:

Elementary object items may have many contents

Parameters:

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

Get a label of an object item

Since :

2.3

Note:

Elementary object items may have many labels

Parameters:

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

Set a label of an object item

Since :

2.3

Note:

Elementary object items may have many labels

Parameters:

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

Add a callback for a signal emitted by object item edje.

Since :

2.3

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

1.8

Parameters:

[in]	obj	The elm widget item 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.

Remove a signal-triggered callback from a object item edje object.

Since :

2.3

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

1.8

Parameters:

[in]	obj	The elm widget item 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.

Send a signal to the edje object of the widget item.

Since :

2.3

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]	obj	The elm widget item object
[in]	emission	The signal's name.
[in]	source	The signal's source.

Get the style of an object item

Since :

2.3

Since (EFL) :

1.9

Parameters:

[in]

obj

The elm widget item object

Set a style of an object item

Since :

2.3

Since (EFL) :

1.9

Parameters:

[in]	obj	The elm widget item object
[in]	style	The style of object item

Set the content to be shown in the tooltip item.

Since :

2.3

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]	obj	The elm widget item 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.

Get the style for this item tooltip.

Since :

2.3

See also:

elm_object_tooltip_style_get() for more details.

elm_object_item_tooltip_style_set()

Parameters:

[in]

obj

The elm widget item object

Sets a different style for this item tooltip.

Since :

2.3

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]	obj	The elm widget item object
[in]	style	the theme style used/to use (default, transparent, ...)

Set the text to be shown in a given object item's tooltips.

Since :

2.3

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]	obj	The elm widget item object
[in]	text	The text to set in the content.

Unset tooltip from item.

Since :

2.3

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

Parameters:

[in]

obj

The elm widget item object

Get size restriction state of an object's tooltip.

Since :

2.3

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 elm widget item object

Disable size restrictions on an object's tooltip.

Since :

2.3

This function allows a tooltip to expand beyond its parent window's canvas. It will instead be limited only by the size of the display.

Parameters:

[in]	obj	The elm widget item object
[in]	disable	If EINA_TRUE, size restrictions are disabled

This returns track object of the item.

Since :

2.3

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

1.8

Parameters:

[in]

obj

The elm widget item object

Get the track object reference count.

Since :

2.3

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

1.8

Parameters:

[in]

obj

The elm widget item object

Get the original string set as translatable for an object item.

Since :

2.3

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

1.8

Parameters:

[in]	obj	The elm widget item object
[in]	part	The name of the part that was set

This retrieve the track object of the item.

Since :

2.3

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

1.8

Parameters:

[in]

obj

The elm widget item object

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

Since :

2.3

Note:

This returns the widget object itself that an item belongs to.

Every elm_object_item supports this API

Parameters:

[in]

obj

The elm widget item object

Get a named object from the children.

Since :

2.3

Parameters:

[in]	obj	The parent object whose children to look at
[in]	name	The name of the child to find
[in]	recurse	Set to the maximum number of levels to recurse (0 == none, 1 is only look at 1 level of children etc.)

Returns:

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

Remarks:

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.

Get the orientation mode of a given widget.

Since :

2.3

Parameters:

[in]

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

Disable the orientation mode of a given widget.

Since :

2.3

Remarks:

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:

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

Since (EFL) :

1.8

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

Since :

2.3

Parameters:

[in]	obj	The Elementary container widget
[in]	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

Set the content on part of a given container widget.

Since :

2.3

Parameters:

[in]	obj	The Elementary container widget
[in]	part	The container's part name to set (some might accept NULL for the default part)
[in]	content	The new content for that part

Remarks:

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

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

Since :

2.3

Parameters:

[in]	obj	The Elementary container widget
[in]	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

Get a text of an object.

Since :

2.3

Parameters:

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

Returns:

text of the part or NULL for any error

Remarks:

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

Set a text of an object.

Since :

2.3

Parameters:

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

Remarks:

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

Add a callback for a signal emitted by widget edje object.

Since :

2.3

Remarks:

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:

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

Remove a signal-triggered callback from a widget edje object.

Since :

2.3

Parameters:

[in]	obj	The object handle
[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.

Remarks:

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.

Send a signal to the widget edje object.

Since :

2.3

Remarks:

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:

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

Get the original string set as translatable for an object.

Since :

2.3

Remarks:

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:

[in]	obj	The object
[in]	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

Get the policy value for given policy identifier.

Since :

2.3

Parameters:

[in]

policy

policy identifier, as in Elm_Policy.

Returns:

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

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

Since :

2.3

Parameters:

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

Returns:

EINA_TRUE on success or EINA_FALSE, on error.

Remarks:

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.

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

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

Since :

2.3

Deprecated:

Deprecated since Tizen 2.4 application should not use this function

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

Since :

2.3

Parameters:

[in]	exe	The executable path.
[in]	cwd	The current working directory.

Deprecated:

Deprecated since Tizen 2.4 application should not use this function

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

Since :

2.3

Parameters:

[in]	argc	The system's argument count value.
[in]	argv	The system's pointer to the array of argument strings.

Deprecated:

Deprecated since Tizen 2.4 application should not use this function

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

Since :

2.3

Parameters:

[in]	argc	The system's argument count value.
[in]	argv	The system's pointer to the array of argument strings.
[in]	cwd	The current working directory.
[in]	postfork_func	The function will be called after fork.
[in]	postfork_data	The used data for postfork_func.

Deprecated:

Deprecated since Tizen 2.4 application should not use this function

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

Since :

2.3

Parameters:

[in]	argc	The system's argument count value.
[in]	argv	The system's pointer to the array of argument strings.

Deprecated:

Deprecated since Tizen 2.4 application should not use this function

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

Since :

2.3

Deprecated:

Deprecated since Tizen 2.4 application should not use this function

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

Since :

2.3

Parameters:

[in]

ql_on

The quicklaunch mode to be set.

Deprecated:

Deprecated since Tizen 2.4 application should not use this function

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

Since :

2.3

Parameters:

[in]	argc	The system's argument count value.
[in]	argv	The system's pointer to the array of argument strings.
[in]	cwd	The current working directory.

Deprecated:

Deprecated since Tizen 2.4 application should not use this function

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

Since :

2.3

Deprecated:

Deprecated since Tizen 2.4 application should not use this function

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

Since :

2.3

Deprecated:

Deprecated since Tizen 2.4 application should not use this function

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

Since :

2.3

Parameters:

[in]	argc	The system's argument count value.
[in]	argv	The system's pointer to the array of argument strings.

Deprecated:

Deprecated since Tizen 2.4 application should not use this function

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

Since :

2.3

Deprecated:

Deprecated since Tizen 2.4 application should not use this function

Run Elementary's main loop.

Since :

2.3

Remarks:

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

Shut down Elementary.

Since :

2.3

Returns:

The init counter value.

Remarks:

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

Remarks:

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