Macro to be used after the elm_main() function

Convenient macro for elm_object_part_content_get.

Since :

2.3.1

See also:

elm_object_part_content_get

Convenient macro for elm_object_part_content_set.

Since :

2.3.1

See also:

elm_object_part_content_set

Convenient macro for elm_object_part_content_unset.

Since :

2.3.1

See also:

elm_object_part_content_unset

Convenient macro for elm_object_domain_part_text_translatable_set.

Since :

2.3.1

See also:

elm_object_domain_part_text_translatable_set

Convenient macro for elm_object_domain_translatable_part_text_set.

Since :

2.3.1

See also:

elm_object_domain_translatable_part_text_set

Convenient macro for elm_object_item_part_content_get.

Since :

2.3.1

See also:

elm_object_item_part_content_get

Convenient macro for elm_object_item_part_content_set.

Since :

2.3.1

See also:

elm_object_item_part_content_set

Convenient macro for elm_object_item_part_content_unset.

Since :

2.3.1

See also:

elm_object_item_part_content_unset

Convenient macro for elm_object_item_domain_part_text_translatable_set.

Since :

2.3.1

See also:

elm_object_item_domain_part_text_translatable_set

Convenient macro for elm_object_item_domain_translatable_part_text_set.

Since :

2.3.1

See also:

elm_object_item_domain_translatable_part_text_set

Convenient macro for elm_object_item_domain_part_text_translatable_set.

Since :

2.3.1

See also:

elm_object_item_domain_part_text_translatable_set

Convenient macro for elm_object_item_part_text_get.

Since :

2.3.1

See also:

elm_object_item_part_text_get

Sets the macro label of an object item.

Since :

2.3.1

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

See also:

elm_object_item_domain_translatable_part_text_set

Convenient macro for elm_object_item_translatable_part_text_get.

Since :

2.3.1

See also:

elm_object_item_translatable_part_text_get

Convenient macro for elm_object_item_domain_translatable_part_text_set.

Since :

2.3.1

See also:

elm_object_item_domain_translatable_part_text_set

Convenient macro for elm_object_domain_part_text_translatable_set.

Since :

2.3.1

See also:

elm_object_domain_part_text_translatable_set

Convenient macro for elm_object_part_text_get.

Since :

2.3.1

See also:

elm_object_part_text_get

Convenient macro for elm_object_part_text_set.

Since :

2.3.1

See also:

elm_object_part_text_set

Convenient macro for elm_object_domain_translatable_part_text_set.

Since :

2.3.1

See also:

elm_object_domain_translatable_part_text_set

Convenient macro for elm_object_translatable_part_text_get.

Since :

2.3.1

See also:

elm_object_translatable_part_text_get

Convenient macro for elm_object_domain_translatable_part_text_set.

Since :

2.3.1

See also:

elm_object_domain_translatable_part_text_set

Function prototype definition for callbacks on input events happening on Elementary widgets. data receives the user data pointer passed to elm_object_event_callback_add(). src is a pointer to the widget on which the input event took place. type gets the type of this event and event_info, the struct with details on this event

It is the Elm_Object_Item Signal Callback functions' prototype definition. data is going to have the auxiliary data pointer at the time of the callback registration. it is a pointer to Elm_Object_Item that has the edje object from where the signal comes. emission identifies the exact signal's emission string and source identifies the exact signal's source.

Since (EFL) :

1.8

Since :

2.3.1

See also:

elm_object_item_signal_callback_add()

Enumeration that defines a couple of standard Evas_Object layers to be used with evas_object_layer_set().

Remarks:

Whenever extending with new values, try to keep some padding to siblings so that 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 the focus object visualization is
ELM_OBJECT_LAYER_TOOLTIP	Where to show tooltips
ELM_OBJECT_LAYER_CURSOR	Where to show cursors
ELM_OBJECT_LAYER_LAST	The last layer known by Elementary

Enumeration of Elm Object Select mode.

Enumerator:

ELM_OBJECT_SELECT_MODE_DEFAULT	Default select mode
ELM_OBJECT_SELECT_MODE_ALWAYS	Always select mode
ELM_OBJECT_SELECT_MODE_NONE	No select mode
ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY	No select mode with no finger size rule

Enumeration that defines the policy identifiers.

Enumerator:

ELM_POLICY_QUIT	Under which circumstances the application should quit automatically. See also: Elm_Policy_Quit
ELM_POLICY_EXIT	Defines the 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

Enumeration that defines the 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

Enumeration that defines the 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

Enumeration that defines the 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 hidden, regardless of the config settings

Asks to exit Elementary's main loop.

Since :

2.3.1

Remarks:

If this call is issued, it flags the main loop to cease processing and returns back to its parent function (usually your elm_main() function). This does not mean that the main loop instantly quits. So your ecore callbacks(timer, animator, event, job, and etc.) have chances to be called even after elm_exit().

Just after a request to close the window comes, the main loop is left.

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

See also:

elm_init()

Initializes Elementary.

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

Since :

2.3.1

Remarks:

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.

Parameters:

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

Returns:

The init counter value

See also:

elm_shutdown()

Changes the language of the current application.

Since :

2.3.1

Remarks:

The lang passed must be the full name of the locale to use, for example "en_US.utf8" or "es_ES@euro".

For more complex cases, like having formatted strings that need translation, widgets also emit a "language,changed" signal that the user can listen to, in order to manually translate the text.

Parameters:

[in]

lang

The language to set, must be the full name of the locale

Sets the text to read out when in the accessibility mode.

Since :

2.3.1

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

Gets the disabled state of an Elementary object.

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

Since :

2.3.1

Parameters:

[in]

obj

The Elementary object to operate on

Returns:

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

Sets the disabled state of an Elementary object.

Since :

2.3.1

Remarks:

Elementary objects can be disabled, in which state they won't receive input and, in general, get 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 your interface.

This sets the state for the widget, either disabling it or enabling it back.

Parameters:

[in]	obj	The Elementary object to operate on
[in]	disabled	If EINA_TRUE that state is disabled, otherwise EINA_FALSE if it is enabled

Marks the part text to be transltable.

Since (EFL) :

1.8

Since :

2.3.1

Remarks:

Once you mark the part text to be translatable, the text is translated internally regardless of elm_object_part_text_set() and elm_object_domain_translatable_part_text_set(). In other cases, if you set the Elementary policy that all text should be translatable by 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	If EINA_TRUE the part text is translated internally, otherwise EINA_FALSE

See also:

elm_object_domain_part_text_translatable_set()

elm_object_part_text_set()

elm_policy()

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

Since (EFL) :

1.8

Since :

2.3.1

Remarks:

The string to set as text must be the original one. Do not pass the return of gettext() here. Elementary translates the string internally and sets it on the object using elm_object_part_text_set(), also stores the original string so that it can be automatically translated when the language is changed with elm_language_set().

The domain is also stored to find the translation in the correct catalog. It can be NULL, in which case it uses whatever domain is set by the application with textdomain(). This is useful in case you are building a library on top of Elementary that has its own translatable strings, that should not be mixed with those of programs using the library.

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

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

Since :

2.3.1

Remarks:

Every widget in an Elementary interface is set to receive focus, with elm_object_focus_allow_set(), 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 that had an event callback set, with this call, are 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 means that the event is not processed, so the propagation goes on.
• The event_info pointer passed to func contains the event's structure and, if you OR its event_flags inner value to EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary has already handled it, thus killing the event's propagation.

Your event callback is 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 adds event callbacks per type on general Evas objects (no event propagation infrastructure taken into account).

Not to be confused with elm_object_signal_callback_add(), which adds 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.

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	The data to pass into func

See also:

elm_object_event_callback_del()

Removes an event callback from a widget.

This function removes a callback, previously attached to the event emission by the obj. The parameters func and data must match exactly those passed to a previous call to elm_object_event_callback_add(). The data pointer that is passed to this call is returned.

Since :

2.3.1

Parameters:

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

Returns:

A data pointer

Sets the text to read out when in the accessibility mode.

Since :

2.3.1

Parameters:

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

Gets the accessible object of the object item.

Since (EFL) :

1.8

Since :

2.3.1

Parameters:

[in]

item

The elementary object item

Returns:

The accessible object of the object item, otherwise NULL for any error

Gets the highlight order.

Since (EFL) :

1.8

Since :

2.3.1

Parameters:

[in]

item

The container object item

Returns:

The order of objects to pass highlight

Sets the highlight order.

Since (EFL) :

1.8

Since :

2.3.1

Parameters:

[in]	item	The container object item
[in]	objs	The order of objects to pass highlight

Unsets the highlight order.

Since (EFL) :

1.8

Since :

2.3.1

Parameters:

[in]

item

The container object item

Registers the object item as an accessible object.

Since (EFL) :

1.8

Since :

2.3.1

Parameters:

[in]

item

The elementary object item

Returns:

The accessible object of the object item, otherwise NULL for any error

Unregisters the accessible object of the object item.

Since (EFL) :

1.8

Since :

2.3.1

Parameters:

[in]

item

The elementary object item

Gets whether the (custom) cursor for a given item is being searched in its theme or is only relying on the rendering engine.

Since :

2.3.1

Parameters:

[in]

it

The object item

Returns:

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

See also:

elm_object_item_cursor_engine_only_set()

Sets whether the (custom)cursor for a given item should be searched in its theme or should only rely on the rendering engine.

Since :

2.3.1

Remarks:

This call is of use only if you've set a custom cursor for items using elm_object_item_cursor_set().

By default, cursors are only looked for from those provided by the rendering engine.

Parameters:

[in]	it	The item with custom (custom) cursor already set on it
[in]	engine_only	If EINA_TRUE cursors are looked for only from those provided by the rendering engine, otherwise EINA_FALSE to have them searched on the widget's theme as well

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

Since :

2.3.1

Parameters:

[in]

it

The item with the custom cursor set

Returns:

The cursor type's name, otherwise NULL if no custom cursors are set to it (and on errors)

See also:

elm_object_cursor_get()

elm_object_item_cursor_set()

elm_object_item_cursor_unset()

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

Since :

2.3.1

Remarks:

This function is analogous to 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 the item cursors have precedence over widget cursors, so a mouse over an item with custom cursor set always shows that cursor.

If this function is called twice for an object, a previously set cursor is unset on the second call.

Parameters:

[in]	it	The item to customize the cursor on
[in]	cursor	The cursor type's name

See also:

elm_object_cursor_set()

elm_object_item_cursor_get()

elm_object_item_cursor_unset()

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

Since :

2.3.1

Parameters:

[in]

it

The item with the custom cursor set

Returns:

style The cursor style in use
If the object does not have a cursor set, then NULL is returned.

See also:

elm_object_item_cursor_style_set()

Sets a different style for a given custom cursor set of an item.

Since :

2.3.1

Remarks:

This function only makes sense when one is using custom mouse cursor decorations defined in a theme file, which can have, a given cursor name/type and alternate styles on it. It is analogous to elm_object_cursor_style_set(), but here it applies only to item objects.

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]	it	The item with the custom cursor set
[in]	style	The theme style to use (e.g. "default", "transparent", etc)

See also:

elm_object_item_cursor_engine_only_set()

elm_object_item_cursor_style_get()

Unsets any custom mouse pointer/cursor decoration set to be shown, when the mouse pointer is over the given item, thus making it show the default cursor again.

Since :

2.3.1

Remarks:

Use this call to undo any custom settings on this item's cursor decoration, bringing it back to defaults (no custom style set).

Parameters:

[in]

it

The item

See also:

elm_object_cursor_unset()

elm_object_item_cursor_set()

Gets the data associated with an object item.

Since :

2.3.1

Remarks:

Every elm_object_item supports this API.

Parameters:

[in]

it

The Elementary object item

Returns:

The data associated with it

Sets the data associated with an object item.

Since :

2.3.1

Remarks:

Every elm_object_item supports this API.

Parameters:

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

Deletes the given item.

Since :

2.3.1

Parameters:

[in]

it

The item to be deleted

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

Since :

2.3.1

Remarks:

This function receives these parameters:

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

Every elm_object_item supports this API.

Parameters:

[in]	it	The item to set the callback on
[in]	del_cb	The function called

See also:

elm_object_item_del()

Marks the part text to be translatable.

Since (EFL) :

1.8

Since :

2.3.1

Remarks:

Once you mark the part text to be translatable, the text is translated internally regardless of elm_object_item_part_text_set() and elm_object_item_domain_translatable_part_text_set(). In another case, if you set the Elementary policy that all text should be translatable by default, you can set the part text to not be translated by calling this API.

Parameters:

[in]	it	The object item containing the text part
[in]	part	The part name of the translatable text
[in]	domain	The translation domain to use
[in]	translatable	If EINA_TRUE, the part text is translated internally, otherwise EINA_FALSE

See also:

elm_object_item_domain_translatable_part_text_set()

elm_object_item_part_text_set()

elm_policy()

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

Since (EFL) :

1.8

Since :

2.3.1

Remarks:

The string to set as text must be the original one. Do not pass the return of gettext() here. Elementary translates the string internally and sets 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 is stored along with it to find the translation in the correct catalog. It can be NULL, in which case it uses whatever domain is set by the application with textdomain(). This is useful in case you are building a library on top of Elementary that should have its own translatable strings, that should not be mixed with those of programs using the library.

Parameters:

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

Gets the content of an object item.

Since :

2.3.1

Remarks:

Elementary object items may have many contents.

Parameters:

[in]	it	The Elementary object item
[in]	part	The content part name to unset (NULL for the default content)

Returns:

The content of the object item, otherwise NULL for any error

Sets the content of an object item.

This sets a new object to an item as a content object. If any object is already set as a content object in the same part, this previous object is deleted automatically.

Since :

2.3.1

Remarks:

Elementary object items may have many contents.

Parameters:

[in]	it	The Elementary object item
[in]	part	The content part name to set (NULL for the default content)
[in]	content	The new content of the object item

Unsets the content of an object item.

Since :

2.3.1

Remarks:

Elementary object items may have many contents.

Parameters:

[in]	it	The Elementary object item
[in]	part	The content part name to unset (NULL for the default content)

Returns:

EINA_TRUE if succeed, otherwise EINA_FALSE.

Gets the label of an object item.

Since :

2.3.1

Remarks:

Elementary object items may have many labels.

Parameters:

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

Returns:

The text of the label, otherwise NULL for any error

Sets the label of an object item.

Since :

2.3.1

Remarks:

Elementary object items may have many labels.

Parameters:

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

Adds a callback for a signal emitted by the object item, edje object.

This function connects a callback function to a signal emitted by the edje object of the object item. Globs can occur in either the emission or source name.

Since (EFL) :

1.8

Since :

2.3.1

Parameters:

[in]	it	The elementary object item
[in]	emission	The signal name
[in]	source	The signal source
[in]	func	The callback function to be executed when the signal is emitted
[in]	data	A pointer to the data to pass to the callback function

Removes a signal-triggered callback from the object item, edje object.

This function removes the last callback, previously attached to a signal emitted by an underlying Edje object of it, whose parameters emission, source, and func match exactly with those passed to a previous call to elm_object_item_signal_callback_add(). The data pointer that is passed to this call is returned.

Since (EFL) :

1.8

Since :

2.3.1

Parameters:

[in]	it	The elementary object item
[in]	emission	The signal name
[in]	source	The signal source
[in]	func	The callback function to be executed when the signal is emitted

Returns:

The data pointer of the signal callback, otherwise NULL on errors

See also:

elm_object_item_signal_callback_add()

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

This function sends a signal to the edje object of the obj item. An edje program can respond to a signal by specifying matching 'signal' and 'source' fields.

Since :

2.3.1

Parameters:

[in]	it	The Elementary object item
[in]	emission	The signal name
[in]	source	The signal source

Gets the style of an object item.

Since :

2.3.1

Parameters:

[in]

it

The Elementary object item

Returns:

The style of the object item

Sets the style of an object item.

Since :

2.3.1

Parameters:

[in]	it	The Elementary object item
[in]	part	The style of the object item

Returns the track object of the item.

This gets a rectangle object that represents the object item's internal object. If you want to check the geometry and visibility of the item, you can call the evas apis, such as evas_object_geometry_get() and evas_object_visible_get(), to the track object. Note that all of the widget items may/may not have the internal object so this API may return NULL if the widget item doesn't have it. Additionally, the widget item is managed/controlled by the widget, the widget item could be changed(moved, resized even deleted) anytime by its own widget's decision. So dont' change the track object and don't keep the track object on your side as far as possible, but get the track object the moment you need to refer. Otherwise, you need to add some callbacks to the track object to track it's attributes changes.

Since (EFL) :

1.8

Since :

2.3.1

Remarks:

After using the track object, call elm_object_item_untrack() paired to elm_object_item_track() without fail to free the track object properly. Don't delete the track object.

Parameters:

[in]

it

The Elementary Object Item to be tracked

Returns:

The track object

See also:

elm_object_item_untrack()

elm_object_item_track_get()

Gets the track object reference count.

This gets the reference count for the track object. Whenever you call elm_object_item_track(), the reference count is increased by one. Similarly, the reference count is decreased again when you call the elm_object_item_untrack(). Unless the reference count reaches to zero, the track object won't be deleted. So be sure to call elm_object_item_untrack() paired to the elm_object_item_track() call count.

Since (EFL) :

1.8

Since :

2.3.1

Parameters:

[in]

it

The Elementary Object Item that returned the track object

Returns:

The track object reference count

See also:

elm_object_item_track()

elm_object_item_track_get()

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

Since (EFL) :

1.8

Since :

2.3.1

Remarks:

When setting translated strings, the function elm_object_item_part_text_get() returns the translation returned by gettext(). To get the original string use this function.

Parameters:

[in]	it	The object item
[in]	part	The name of the part that is set

Returns:

The original, untranslated string

Retrieves the track object of the item.

This retrieves the track object that is returned from elm_object_item_track().

Since (EFL) :

1.8

Since :

2.3.1

Parameters:

[in]

it

The Elementary Object Item that returned the track object

See also:

elm_object_item_track()

elm_object_item_track_get()

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

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

Since :

2.3.1

Remarks:

Every elm_object_item supports this API.

Parameters:

[in]

it

The Elementary object item

Returns:

The widget object

Gets a named object from the children.

This function searches the children (or recursively children of children and so on) of the given obj object looking for a child with the name of name. If the child is found the object is returned, or NULL is returned. You can set the name of an object with evas_object_name_set(). If the name is not unique within the child objects (or the tree is recurse or is greater than 0) then it is undefined as to which child of that name is returned, so ensure that the name is unique amongst children. If recurse is set to -1 it recurses without limit.

Since :

2.3.1

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 to look at one level of children and so on)

Returns:

The found object of that name, otherwise NULL if none are found

Gets the orientation mode of a given widget.

Since (EFL) :

1.8

Since :

2.3.1

Parameters:

[in]

obj

The Elementary widget to query for its orientation mode

Returns:

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

See also:

elm_object_orientation_mode_disabled_set()

Disables the orientation mode of a given widget.

Since (EFL) :

1.8

Since :

2.3.1

Remarks:

Orientation mode is used for widgets to change their styles or to send signals whenever its 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 applies a style that is readied for the current degree, otherwise, it sends signals to its own edje to change its states if the style is not readied.

Parameters:

[in]	obj	The Elementary object to operate in the orientation mode
[in]	disabled	If EINA_TRUE the state is disabled, otherwise EINA_FALSE if it is enabled

Gets the content at a part of a given container widget.

Since :

2.3.1

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:

The content of the object at the given part, otherwise NULL in case of an error

See also:

elm_object_part_content_set()

Sets the content at a part of a given container widget.

Since :

2.3.1

Remarks:

All widgets deriving from elm-container-class may hold child objects as content at given parts. This sets new content to a given part. If any object is already set as a content object in the same part, the previous object is deleted automatically with this call. If you wish to preserve it, issue elm_object_part_content_unset() on it first.

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

See also:

elm_object_part_content_set()

Unsets the content at a part of a given container widget.

Since :

2.3.1

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:

The content of the object at the given part, otherwise NULL in case of an error

See also:

elm_object_part_content_set()

Gets the text of an object.

Since :

2.3.1

Remarks:

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

Parameters:

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

Returns:

The text of the part, otherwise NULL for any error

Sets the text of an object.

Since :

2.3.1

Remarks:

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

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

Adds a callback for a signal emitted by the widget edje object.

This function connects a callback function to a signal emitted by the edje object of the obj. Globs can occur in either the emission or source name.

Since :

2.3.1

Parameters:

[in]	obj	The object
[in]	emission	The signal name
[in]	source	The signal source
[in]	func	The callback function to be executed when the signal is emitted
[in]	data	A pointer to the data to pass to the callback function

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

This function removes the last callback, previously attached to a signal emitted by an underlying Edje object of obj, whose parameters emission, source, and func match exactly with those passed to a previous call to elm_object_signal_callback_add(). The data pointer that is passed to this call is returned.

Since :

2.3.1

Parameters:

[in]	obj	The object handle
[in]	emission	The signal name
[in]	source	The signal source
[in]	func	The callback function to be executed when the signal is emitted

Returns:

The data pointer of the signal callback, otherwise NULL in case of an error

Sends a signal to the widget edje object.

This function sends a signal to the edje object of the obj. An edje program can respond to a signal by specifying matching 'signal' and 'source' fields.

Since :

2.3.1

Parameters:

[in]	obj	The object
[in]	emission	The signal name
[in]	source	The signal source

Gets the original string set as translatable for an object.

Since (EFL) :

1.8

Since :

2.3.1

Remarks:

When setting translated strings, the function elm_object_part_text_get() returns 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 is set

Returns:

The original, untranslated string

See also:

elm_object_translatable_part_text_set()

Gets the policy value for the given policy identifier.

Since :

2.3.1

Parameters:

[in]

policy

The policy identifier, as in Elm_Policy

Returns:

The currently set policy value for that identifier
It is 0 if the policy passed is invalid.

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

Since :

2.3.1

Remarks:

Elementary policies define an applications' behavior, somehow. These behaviors are divided into policy groups (see Elm_Policy enumeration). This call emits the Ecore event ELM_EVENT_POLICY_CHANGED, which can be hooked with handlers. An Elm_Event_Policy_Changed struct is passed, after that.

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

Parameters:

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

Returns:

EINA_TRUE on success, otherwise EINA_FALSE on error

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

Since :

2.3.1

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

Parameters:

[in]

exe

The executable path

Returns:

The exectuable path

Since :

2.3.1

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

Parameters:

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

Returns:

The return value from main function

Since :

2.3.1

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

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

Returns:

EINA_TRUE if succeed, otherwise EINA_FALSE

Since :

2.3.1

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

Parameters:

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

Returns:

The init counter value

Since :

2.3.1

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

Returns:

EINA_TRUE if mode is on, otherwise EINA_FALSE.

Since :

2.3.1

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

Parameters:

[in]

ql_on

The quicklaunch mode to be set.

Since :

2.3.1

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

Parameters:

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

Returns:

EINA_TRUE if succeed, otherwise EINA_FALSE.

Since :

2.3.1

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

Since :

2.3.1

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

Returns:

The init counter value

Since :

2.3.1

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

Parameters:

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

Returns:

The init counter value

Since :

2.3.1

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

Returns:

The init counter value

Since :

2.3.1

Runs Elementary's main loop.

Since :

2.3.1

Remarks:

This call should be issued just after all initialization is completed. This function returns until elm_exit() is called. It keeps looping, running the main (event/processing) loop for Elementary.

See also:

elm_init()

Shuts down Elementary.

Since :

2.3.1

Remarks:

This should be called at the end of your application, just before it ceases to do any more processing. This cleans up any permanent resources that your application may have allocated via Elementary that would otherwise persist.

elm_shutdown() iterates the 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().

Returns:

The init counter value

See also:

elm_init()