General Elementary API. Functions that don't relate to Elementary objects specifically.

Here are documented functions which init/shutdown the library, that apply to generic Elementary objects, that deal with configuration, et cetera.

Functions
int	elm_init (int argc, char **argv)
int	elm_shutdown (void)
void	elm_run (void)
void	elm_exit (void)
EINA_DEPRECATED void	elm_quicklaunch_mode_set (Eina_Bool ql_on)
EINA_DEPRECATED Eina_Bool	elm_quicklaunch_mode_get (void)
EINA_DEPRECATED int	elm_quicklaunch_init (int argc, char **argv)
EINA_DEPRECATED int	elm_quicklaunch_sub_init (int argc, char **argv)
EINA_DEPRECATED int	elm_quicklaunch_sub_shutdown (void)
EINA_DEPRECATED int	elm_quicklaunch_shutdown (void)
EINA_DEPRECATED void	elm_quicklaunch_seed (void)
EINA_DEPRECATED Eina_Bool	elm_quicklaunch_prepare (int argc, char *argv, const char cwd)
EINA_DEPRECATED Eina_Bool	elm_quicklaunch_fork (int argc, char *argv, char cwd, void(postfork_func)(void data), void *postfork_data)
EINA_DEPRECATED void	elm_quicklaunch_cleanup (void)
EINA_DEPRECATED int	elm_quicklaunch_fallback (int argc, char **argv)
EINA_DEPRECATED char *	elm_quicklaunch_exe_path_get (const char exe, const char cwd)
Eina_Bool	elm_policy_set (unsigned int policy, int value)
int	elm_policy_get (unsigned int policy)
void	elm_language_set (const char *lang)
Elm_Process_State	elm_process_state_get (void)
void	elm_object_part_text_set (Evas_Object obj, const char part, const char *text)
const char *	elm_object_part_text_get (const Evas_Object obj, const char part)
void	elm_object_domain_translatable_part_text_set (Evas_Object obj, const char part, const char domain, const char text)
const char *	elm_object_translatable_part_text_get (const Evas_Object obj, const char part)
void	elm_object_domain_part_text_translatable_set (Evas_Object obj, const char part, const char *domain, Eina_Bool translatable)
void	elm_object_part_content_set (Evas_Object obj, const char part, Evas_Object *content)
Evas_Object *	elm_object_part_content_get (const Evas_Object obj, const char part)
Evas_Object *	elm_object_part_content_unset (Evas_Object obj, const char part)
void	elm_object_access_info_set (Evas_Object obj, const char txt)
const char *	elm_object_access_info_get (Evas_Object *obj)
Evas_Object *	elm_object_name_find (const Evas_Object obj, const char name, int recurse)
void	elm_object_disabled_set (Evas_Object *obj, Eina_Bool disabled)
Eina_Bool	elm_object_disabled_get (const Evas_Object *obj)
void	elm_object_signal_emit (Evas_Object obj, const char emission, const char *source)
void	elm_object_signal_callback_add (Evas_Object obj, const char emission, const char source, Edje_Signal_Cb func, void data)
void *	elm_object_signal_callback_del (Evas_Object obj, const char emission, const char *source, Edje_Signal_Cb func)
void	elm_object_event_callback_add (Evas_Object obj, Elm_Event_Cb func, const void data)
void *	elm_object_event_callback_del (Evas_Object obj, Elm_Event_Cb func, const void data)
void	elm_object_orientation_mode_disabled_set (Evas_Object *obj, Eina_Bool disabled)
Eina_Bool	elm_object_orientation_mode_disabled_get (const Evas_Object *obj)
Evas_Object *	elm_object_part_access_register (Evas_Object obj, const char part)
	Registers a part of an object as an access object.
Evas_Object *	elm_object_part_access_object_get (const Evas_Object obj, const char part)
	Get the access object which is registered to part.
Eina_Bool	elm_color_class_color_set (const char *color_class, int r, int g, int b, int a)
	Set the color of color class for the Elementary widgets.
Eina_Bool	elm_color_class_color_get (const char color_class, int r, int g, int b, int *a)
	Get the color of color class for the Elementary widgets.
Eina_Bool	elm_color_class_color2_set (const char *color_class, int r, int g, int b, int a)
	Set the second color of color class for the Elementary widgets.
Eina_Bool	elm_color_class_color2_get (const char color_class, int r, int g, int b, int *a)
	Get the second color of color class for the Elementary widgets.
Eina_Bool	elm_color_class_color3_set (const char *color_class, int r, int g, int b, int a)
	Set the third color of color class for the Elementary widgets.
Eina_Bool	elm_color_class_color3_get (const char color_class, int r, int g, int b, int *a)
	Get the third color of color class for the Elementary widgets.
void	elm_color_class_del (const char *color_class)
	Delete elementary color class.
Eina_Bool	elm_object_color_class_color_set (Evas_Object obj, const char color_class, int r, int g, int b, int a)
	Set the color of color class for a given widget.
Eina_Bool	elm_object_color_class_color_get (Evas_Object obj, const char color_class, int r, int g, int b, int a)
	Get the color of color class for a given widget.
Eina_Bool	elm_object_color_class_color2_set (Evas_Object obj, const char color_class, int r, int g, int b, int a)
	Set the second color of color class for a given widget.
Eina_Bool	elm_object_color_class_color2_get (Evas_Object obj, const char color_class, int r, int g, int b, int a)
	Get the second color of color class for a given widget.
Eina_Bool	elm_object_color_class_color3_set (Evas_Object obj, const char color_class, int r, int g, int b, int a)
	Set the third color of color class for a given widget.
Eina_Bool	elm_object_color_class_color3_get (Evas_Object obj, const char color_class, int r, int g, int b, int a)
	Get the third color of color class for a given widget.
void	elm_object_color_class_del (Evas_Object obj, const char color_class)
	Delete the color class for the Elementary widget.
void	elm_object_color_class_clear (Evas_Object *obj)
	Delete all color classes for the Elementary widget item.
void *	elm_object_item_data_get (const Elm_Object_Item *it)
void	elm_object_item_data_set (Elm_Object_Item it, void data)
Typedefs
typedef Eina_Bool(*	Elm_Event_Cb )(void data, Evas_Object obj, Evas_Object src, Evas_Callback_Type type, void event_info)
typedef Eo	Elm_Object_Item
typedef void(*	Elm_Object_Item_Signal_Cb )(void data, Elm_Object_Item it, const char emission, const char source)
Defines
#define	ELM_MAIN() int main(int argc, char **argv) { int ret; _elm_startup_time = ecore_time_unix_get(); elm_init(argc, argv); ret = elm_main(argc, argv); elm_shutdown(); return ret; }
#define	elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))

Define Documentation

#define ELM_MAIN ( ) int main(int argc, char **argv) { int ret; _elm_startup_time = ecore_time_unix_get(); elm_init(argc, argv); ret = elm_main(argc, argv); elm_shutdown(); return ret; }

macro to be used after the elm_main() function

#define elm_object_item_text_set	(	it,
		label
	)	elm_object_item_part_text_set((it), NULL, (label))

Macro to set a label of an object item.

Parameters:

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

Note:: Elementary object items may have many labels.

Typedef Documentation

typedef Eina_Bool(* Elm_Event_Cb)(void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info)

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

Elm_Object_Item

An Elementary Object item handle.

Elm_Object_Item_Signal_Cb

Elm_Object_Item Signal Callback functions' prototype definition. data will have the auxiliary data pointer at the time the callback registration. it will be a pointer the Elm_Object_Item that have the edje object where the signal comes from. emission will identify the exact signal's emission string and source the exact signal's source one.

See also:: elm_object_item_signal_callback_add()

Since (EFL) :: 1.8

Enumeration Type Documentation

enum Elm_Object_Layer

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

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

Enumerator:

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

Function Documentation

Eina_Bool elm_color_class_color2_get	(	const char *	color_class,
		int *	r,
		int *	g,
		int *	b,
		int *	a
	)

Get the second color of color class for the Elementary widgets.

The second color is commonly used for outline of text.

Note:: These color values are expected to be premultiplied by a.

Parameters:

[in]	color_class	The name of color class.
[in]	r	The intensity of the red color.
[in]	g	The intensity of the green color.
[in]	b	The intensity of the blue color.
[in]	a	The alpha value.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise

Since (EFL) :: 1.19

Since :: 3.0

Eina_Bool elm_color_class_color2_set	(	const char *	color_class,
		int	r,
		int	g,
		int	b,
		int	a
	)

Set the second color of color class for the Elementary widgets.

The second color is commonly used for outline of text.

Note:: These color values are expected to be premultiplied by a.

Parameters:

[in]	color_class	The name of color class.
[in]	r	The intensity of the red color.
[in]	g	The intensity of the green color.
[in]	b	The intensity of the blue color.
[in]	a	The alpha value.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise

Since (EFL) :: 1.19

Since :: 3.0

Eina_Bool elm_color_class_color3_get	(	const char *	color_class,
		int *	r,
		int *	g,
		int *	b,
		int *	a
	)

Get the third color of color class for the Elementary widgets.

The third color is commonly used for shadow of text.

Note:: These color values are expected to be premultiplied by a.

Parameters:

[in]	color_class	The name of color class.
[in]	r	The intensity of the red color.
[in]	g	The intensity of the green color.
[in]	b	The intensity of the blue color.
[in]	a	The alpha value.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise

Since (EFL) :: 1.19

Since :: 3.0

Eina_Bool elm_color_class_color3_set	(	const char *	color_class,
		int	r,
		int	g,
		int	b,
		int	a
	)

Set the third color of color class for the Elementary widgets.

The third color is commonly used for shadow of text.

Note:: These color values are expected to be premultiplied by a.

Parameters:

[in]	color_class	The name of color class.
[in]	r	The intensity of the red color.
[in]	g	The intensity of the green color.
[in]	b	The intensity of the blue color.
[in]	a	The alpha value.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise

Since (EFL) :: 1.19

Since :: 3.0

Eina_Bool elm_color_class_color_get	(	const char *	color_class,
		int *	r,
		int *	g,
		int *	b,
		int *	a
	)

Get the color of color class for the Elementary widgets.

Note:: These color values are expected to be premultiplied by a.

Parameters:

[in]	color_class	The name of color class.
[in]	r	The intensity of the red color.
[in]	g	The intensity of the green color.
[in]	b	The intensity of the blue color.
[in]	a	The alpha value.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise

Since (EFL) :: 1.19

Since :: 3.0

Eina_Bool elm_color_class_color_set	(	const char *	color_class,
		int	r,
		int	g,
		int	b,
		int	a
	)

Set the color of color class for the Elementary widgets.

Note:: These color values are expected to be premultiplied by a.

Parameters:

[in]	color_class	The name of color class.
[in]	r	The intensity of the red color.
[in]	g	The intensity of the green color.
[in]	b	The intensity of the blue color.
[in]	a	The alpha value.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise

Since (EFL) :: 1.19

Since :: 3.0

void elm_color_class_del ( const char * color_class )

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

void elm_exit ( void )

Ask to exit Elementary's main loop

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

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

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

Since :: 2.3

int elm_init	(	int	argc,
		char **	argv
	)

Initialize Elementary

Parameters:

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

Returns:: The init counter value.

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

Warning:: This call is exported only for use by the ELM_MAIN() macro. There is no need to use this if you use this macro (which is highly advisable). An elm_main() should contain the entry point code for your application, having the same prototype as elm_init(), and not being static (putting the EAPI_MAIN symbol in front of its type declaration is advisable). The ELM_MAIN() call should be placed just after it.

Example:

See also:: elm_shutdown().

Since :: 2.3

void elm_language_set ( const char * lang )

Change the language of the current application

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

Changing language with this function will make Elementary run through all its widgets, translating strings set with elm_object_domain_translatable_part_text_set(). This way, an entire UI can have its language changed without having to restart the program.

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

Parameters:

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

Since :: 2.3

const char* elm_object_access_info_get ( Evas_Object * obj )

Get the text to read out when in accessibility mode

Parameters:

obj	The object which is to be described

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

Since (EFL) :: 1.14

Since :: 3.0

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

Set the text to read out when in accessibility mode

Parameters:

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

Since :: 2.3

void elm_object_color_class_clear ( Evas_Object * obj )

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:

obj	The object to query.

Since :: 3.0

Eina_Bool elm_object_color_class_color2_get	(	Evas_Object *	obj,
		const char *	color_class,
		int *	r,
		int *	g,
		int *	b,
		int *	a
	)

Get the second color of color class for a given widget.

The second color is commonly used for outline of text.

Note:: These color values are expected to be premultiplied by a.

Parameters:

[in]	obj	The Elementary widget.
[in]	color_class	The name of color class.
[in]	r	The intensity of the red color.
[in]	g	The intensity of the green color.
[in]	b	The intensity of the blue color.
[in]	a	The alpha value.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise

Since (EFL) :: 1.19

Since :: 3.0

Eina_Bool elm_object_color_class_color2_set	(	Evas_Object *	obj,
		const char *	color_class,
		int	r,
		int	g,
		int	b,
		int	a
	)

Set the second color of color class for a given widget.

The second color is commonly used for outline of text.

Note:: These color values are expected to be premultiplied by a.

Parameters:

[in]	obj	The Elementary widget.
[in]	color_class	The name of color class.
[in]	r	The intensity of the red color.
[in]	g	The intensity of the green color.
[in]	b	The intensity of the blue color.
[in]	a	The alpha value.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise

Since (EFL) :: 1.19

Since :: 3.0

Eina_Bool elm_object_color_class_color3_get	(	Evas_Object *	obj,
		const char *	color_class,
		int *	r,
		int *	g,
		int *	b,
		int *	a
	)

Get the third color of color class for a given widget.

The third color is commonly used for shadow of text.

Note:: These color values are expected to be premultiplied by a.

Parameters:

[in]	obj	The Elementary widget.
[in]	color_class	The name of color class.
[in]	r	The intensity of the red color.
[in]	g	The intensity of the green color.
[in]	b	The intensity of the blue color.
[in]	a	The alpha value.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise

Since (EFL) :: 1.19

Since :: 3.0

Eina_Bool elm_object_color_class_color3_set	(	Evas_Object *	obj,
		const char *	color_class,
		int	r,
		int	g,
		int	b,
		int	a
	)

Set the third color of color class for a given widget.

The third color is commonly used for shadow of text.

Note:: These color values are expected to be premultiplied by a.

Parameters:

[in]	obj	The Elementary widget.
[in]	color_class	The name of color class.
[in]	r	The intensity of the red color.
[in]	g	The intensity of the green color.
[in]	b	The intensity of the blue color.
[in]	a	The alpha value.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise

Since (EFL) :: 1.19

Since :: 3.0

Eina_Bool elm_object_color_class_color_get	(	Evas_Object *	obj,
		const char *	color_class,
		int *	r,
		int *	g,
		int *	b,
		int *	a
	)

Get the color of color class for a given widget.

Note:: These color values are expected to be premultiplied by a.

Parameters:

[in]	obj	The Elementary widget.
[in]	color_class	The name of color class.
[in]	r	The intensity of the red color.
[in]	g	The intensity of the green color.
[in]	b	The intensity of the blue color.
[in]	a	The alpha value.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise

Since (EFL) :: 1.19

Since :: 3.0

Eina_Bool elm_object_color_class_color_set	(	Evas_Object *	obj,
		const char *	color_class,
		int	r,
		int	g,
		int	b,
		int	a
	)

Set the color of color class for a given widget.

Note:: These color values are expected to be premultiplied by a.

Parameters:

[in]	obj	The Elementary widget.
[in]	color_class	The name of color class.
[in]	r	The intensity of the red color.
[in]	g	The intensity of the green color.
[in]	b	The intensity of the blue color.
[in]	a	The alpha value.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise

Since (EFL) :: 1.19

Since :: 3.0

void elm_object_color_class_del	(	Evas_Object *	obj,
		const char *	color_class
	)

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] color_class The name of color class.

Since :: 3.0

Eina_Bool elm_object_disabled_get ( const Evas_Object * obj )

Get the disabled state of an Elementary object.

Parameters:

obj	The Elementary object to operate on

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

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

Since :: 2.3

void elm_object_disabled_set	(	Evas_Object *	obj,
		Eina_Bool	disabled
	)

Set the disabled state of an Elementary object.

Parameters:

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

Elementary objects can be disabled, in which state they won't receive input and, in general, will be themed differently from their normal state, usually greyed out. Useful for contexts where you don't want your users to interact with some of the parts of you interface.

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

Since :: 2.3

void elm_object_domain_part_text_translatable_set	(	Evas_Object *	obj,
		const char *	part,
		const char *	domain,
		Eina_Bool	translatable
	)

Mark the part text to be translatable or not.

Once you mark the part text to be translatable, the text will be translated internally regardless of elm_object_part_text_set() and elm_object_domain_translatable_part_text_set(). In other case, if you set the Elementary policy that all text will be translatable in default, you can set the part text to not be translated by calling this API.

Parameters:

obj	The object containing the text part
part	The part name of the translatable text
domain	The translation domain to use
translatable	`EINA_TRUE`, the part text will be translated internally. `EINA_FALSE`, otherwise.

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

Since (EFL) :: 1.8

Since :: 2.3

void elm_object_domain_translatable_part_text_set	(	Evas_Object *	obj,
		const char *	part,
		const char *	domain,
		const char *	text
	)

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

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

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

Parameters:

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

Since (EFL) :: 1.8

Since :: 2.3

void elm_object_event_callback_add	(	Evas_Object *	obj,
		Elm_Event_Cb	func,
		const void *	data
	)

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

Parameters:

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

Every widget in an Elementary interface set to receive focus, with elm_object_focus_allow_set(), will propagate all of its key up, key down and mouse wheel input events up to its parent object, and so on. All of the focusable ones in this chain which had an event callback set, with this call, will be able to treat those events. There are two ways of making the propagation of these event upwards in the tree of widgets to cease:

Just return EINA_TRUE on func. EINA_FALSE will mean the event was not processed, so the propagation will go on.
The event_info pointer passed to func will contain the event's structure and, if you OR its event_flags inner value to EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary one has already handled it, thus killing the event's propagation, too.

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

See also:: elm_object_event_callback_del()

Since :: 2.3

void* elm_object_event_callback_del	(	Evas_Object *	obj,
		Elm_Event_Cb	func,
		const void *	data
	)

Remove an event callback from a widget.

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

Parameters:

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

Returns:: The data pointer

Since :: 2.3

void* elm_object_item_data_get ( const Elm_Object_Item * it )

Get the data associated with an object item

Parameters:

it	The Elementary object item

Returns:: The data associated with it

Note:: Every elm_object_item supports this API

Since :: 2.3

void elm_object_item_data_set	(	Elm_Object_Item *	it,
		void *	data
	)

Set the data associated with an object item

Parameters:

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

Note:: Every elm_object_item supports this API

Since :: 2.3

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

Get a named object from the children

Parameters:

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

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

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

Since :: 2.3

Eina_Bool elm_object_orientation_mode_disabled_get ( const Evas_Object * obj )

Get the orientation mode of a given widget.

Parameters:

obj	The Elementary widget to query for its orientation mode.

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

See also:: elm_object_orientation_mode_disabled_set()

Since (EFL) :: 1.8

Since :: 2.3

void elm_object_orientation_mode_disabled_set	(	Evas_Object *	obj,
		Eina_Bool	disabled
	)

Disable the orientation mode of a given widget.

Orientation Mode is used for widgets to change it's styles or to send signals whenever it's window degree is changed. If the orientation mode is enabled and the widget has different looks and styles for the window degree(0, 90, 180, 270), it will apply a style that is readied for the current degree, otherwise, it will send signals to it's own edje to change it's states if the style doesn't be readied.

Parameters:

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

Since (EFL) :: 1.8

Since :: 2.3

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

Get the access object which is registered to part.

Parameters:

obj	The object
part	The object's part name to get access object

Returns:: The access object which is registered to part

Since :: 4.0

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

Registers a part of an object as an access object.

Parameters:

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

Returns:: Access object working for the part object

Since :: 4.0

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

Get the content on a part of a given container widget

Parameters:

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

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

See also:: elm_object_part_content_set() for more details

Since :: 2.3

void elm_object_part_content_set	(	Evas_Object *	obj,
		const char *	part,
		Evas_Object *	content
	)

Set the content on part of a given container widget

Parameters:

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

All widgets deriving from the 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

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

Unset the content on a part of a given container widget

Parameters:

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

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

See also:: elm_object_part_content_set() for more details

Since :: 2.3

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

Get a text of an object

Parameters:

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

Returns:: text of the part or NULL for any error

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

Since :: 2.3

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

Set a text of an object

Parameters:

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

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

Since :: 2.3

void elm_object_signal_callback_add	(	Evas_Object *	obj,
		const char *	emission,
		const char *	source,
		Edje_Signal_Cb	func,
		void *	data
	)

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

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

Parameters:

obj	The object
emission	The signal's name.
source	The signal's source.
func	The callback function to be executed when the signal is emitted.
data	A pointer to data to pass to the callback function.

Since :: 2.3

void* elm_object_signal_callback_del	(	Evas_Object *	obj,
		const char *	emission,
		const char *	source,
		Edje_Signal_Cb	func
	)

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

Parameters:

obj	The object handle
emission	The signal's name.
source	The signal's source.
func	The callback function to be executed when the signal is emitted.

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

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

Since :: 2.3

void elm_object_signal_emit	(	Evas_Object *	obj,
		const char *	emission,
		const char *	source
	)

Send a signal to the widget edje object.

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

Parameters:

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

Since :: 2.3

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

Get the original string set as translatable for an object

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

Parameters:

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

Returns:: The original, untranslated string

See also:: elm_object_translatable_part_text_set()

Since (EFL) :: 1.8

Since :: 2.3

int elm_policy_get ( unsigned int policy )

Get the policy value for given policy identifier.

Parameters:

policy policy identifier, as in #Elm_Policy.

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

Since :: 2.3

Eina_Bool elm_policy_set	(	unsigned int	policy,
		int	value
	)

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

Parameters:

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

Returns:: EINA_TRUE on success or EINA_FALSE, on error.

Elementary policies define applications' behavior, somehow. These behaviors are divided in policy groups (see #Elm_Policy enumeration). This call will emit the Ecore event ELM_EVENT_POLICY_CHANGED, which can be hooked at with handlers. An #Elm_Event_Policy_Changed struct will be passed, then.

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

Since :: 2.3

Elm_Process_State elm_process_state_get ( void )

The state of the process as a whole.

Since (EFL) :: 1.12

EINA_DEPRECATED void elm_quicklaunch_cleanup ( void )

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

Since :: 2.3

EINA_DEPRECATED char* elm_quicklaunch_exe_path_get	(	const char *	exe,
		const char *	cwd
	)

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

Since :: 2.3

EINA_DEPRECATED int elm_quicklaunch_fallback	(	int	argc,
		char **	argv
	)

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

Since :: 2.3

EINA_DEPRECATED Eina_Bool elm_quicklaunch_fork	(	int	argc,
		char **	argv,
		char *	cwd,
		void()(void data)	postfork_func,
		void *	postfork_data
	)

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

Since :: 2.3

EINA_DEPRECATED int elm_quicklaunch_init	(	int	argc,
		char **	argv
	)

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

Since :: 2.3

EINA_DEPRECATED Eina_Bool elm_quicklaunch_mode_get ( void )

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

Since :: 2.3

EINA_DEPRECATED void elm_quicklaunch_mode_set ( Eina_Bool ql_on )

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

Since :: 2.3

EINA_DEPRECATED Eina_Bool elm_quicklaunch_prepare	(	int	argc,
		char **	argv,
		const char *	cwd
	)

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

Since :: 2.3

EINA_DEPRECATED void elm_quicklaunch_seed ( void )

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

Since :: 2.3

EINA_DEPRECATED int elm_quicklaunch_shutdown ( void )

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

Since :: 2.3

EINA_DEPRECATED int elm_quicklaunch_sub_init	(	int	argc,
		char **	argv
	)

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

Since :: 2.3

EINA_DEPRECATED int elm_quicklaunch_sub_shutdown ( void )

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

Since :: 2.3

void elm_run ( void )

Run Elementary's main loop

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

This function should be called once only from the same thread that initted elementary, (elm_init(), eina_init(), ...) and should never be nested. Never call it from within an instance of itself.

See also:: elm_init() for an example

Since :: 2.3

int elm_shutdown ( void )

Shut down Elementary

Returns:: The init counter value.

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

See also:: elm_init() for an example

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

Since :: 2.3

Variable Documentation

int ELM_EVENT_CONFIG_ALL_CHANGED

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

Since :: 2.3

int ELM_EVENT_POLICY_CHANGED

Emitted when any Elementary's policy value is changed.

Since :: 2.3

int ELM_EVENT_PROCESS_BACKGROUND

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

Since (EFL) :: 1.12

Since :: 2.3

int ELM_EVENT_PROCESS_FOREGROUND

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

Since (EFL) :: 1.12

Since :: 2.3

Functions

Typedefs

Defines

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation