These are functions setting and querying which rendering engine Elementary will use for drawing its windows' pixels.

The following are the available engines:

"fb" (Framebuffer)
"buffer" (Pixel Memory Buffer)
"ews" (Ecore + Evas Single Process Windowing System)
NULL - no engine config

Deprecated:: Please use elm_config_accel_preference_override_set() instead

Functions
EINA_DEPRECATED const char *	elm_config_engine_get (void)
	Get Elementary's rendering engine in use.
EINA_DEPRECATED void	elm_config_engine_set (const char *engine)
	Set Elementary's rendering engine for use.
const char *	elm_config_preferred_engine_get (void)
	Get Elementary's preferred engine to use.
void	elm_config_preferred_engine_set (const char *engine)
	Set Elementary's preferred rendering engine for use.
const char *	elm_config_accel_preference_get (void)
	Get Elementary's preferred engine to use.
void	elm_config_accel_preference_set (const char *pref)
	Set Elementary's acceleration preferences for new windows.
Eina_Bool	elm_config_selection_unfocused_clear_get (void)
void	elm_config_selection_unfocused_clear_set (Eina_Bool enabled)
Eina_Bool	elm_config_vsync_get (void)
void	elm_config_vsync_set (Eina_Bool enabled)
Eina_Bool	elm_config_accel_preference_override_get (void)
void	elm_config_accel_preference_override_set (Eina_Bool enabled)
Eina_Bool	elm_config_mirrored_get (void)
void	elm_config_mirrored_set (Eina_Bool mirrored)
Eina_Bool	elm_config_language_auto_mirrored_get (void)
void	elm_config_language_auto_mirrored_set (Eina_Bool auto_mirrored)
const char *	elm_config_indicator_service_get (int rotation)
Eina_List *	elm_config_color_classes_list_get (void)
void	elm_config_color_classes_list_free (Eina_List *list)
const Eina_List *	elm_config_color_overlay_list_get (void)
void	elm_config_color_overlay_set (const char *color_class, int r, int g, int b, int a, int r2, int g2, int b2, int a2, int r3, int g3, int b3, int a3)
void	elm_config_color_overlay_unset (const char *color_class)
void	elm_config_color_overlay_apply (void)
Eina_Bool	elm_config_window_auto_focus_enable_get (void)
void	elm_config_window_auto_focus_enable_set (Eina_Bool enable)
Eina_Bool	elm_config_window_auto_focus_animate_get (void)
void	elm_config_window_auto_focus_animate_set (Eina_Bool enable)
Eina_Bool	elm_config_popup_scrollable_get (void)
void	elm_config_popup_scrollable_set (Eina_Bool scrollable)
void	elm_config_transition_duration_factor_set (double factor)
double	elm_config_transition_duration_factor_get (void)

Function Documentation

const char* elm_config_accel_preference_get ( void )

Get Elementary's preferred engine to use.

Returns:: The acceleration preference hint string

Note:: there's no need to free the returned string, here.

See elm_config_accel_preference_set() for more information, but this simply returns what was set by this call, nothing more.

See also:: elm_config_accel_preference_set()

Since (EFL) :: 1.10

Since :: 2.3

Eina_Bool elm_config_accel_preference_override_get ( void )

Get the acceleration override preference flag

This gets the acceleration override preference. This is a flag that has the global system acceleration preference configuration forcibly override whatever acceleration preference the application may want.

Returns:: If acceleration override is enabled

Since (EFL) :: 1.11

Since :: 2.3

void elm_config_accel_preference_override_set ( Eina_Bool enabled )

Set the acceleration override preference flag

This sets the acceleration override preference. This is a flag that has the global system acceleration preference configuration forcibly override whatever acceleration preference the application may want.

Parameters:

enabled This should be EINA_TRUE if enabled, or EINA_FALSE if not.

See also:: elm_config_accel_preference_set()

Since (EFL) :: 1.11

Since :: 2.3

void elm_config_accel_preference_set ( const char * pref )

Set Elementary's acceleration preferences for new windows.

Parameters:

pref	The preference desired as a normal C string

Note that it will take effect only to Elementary windows created after this is called. The pref string is a freeform C string that indicates what kind of acceleration is preferred. Here "acceleration" majorly means to rendering and which hardware unit application renders GUIs with. This may or may not be honored, but a best attempt will be made. Known strings are as follows:

"gl", "opengl" - try use OpenGL. "3d" - try and use a 3d acceleration unit. "hw", "hardware", "accel" - try any acceleration unit (best possible) "none" - use no acceleration. try use software (since 1.16)

Since 1.14, it is also possible to specify some GL properties for the GL window surface. This allows applications to use GLView with depth, stencil and MSAA buffers with direct rendering. The new accel preference string format is thus "{HW Accel}[:depth{value}[:stencil{value}[:msaa{str}]]]".

Accepted values for depth are for instance "depth", "depth16", "depth24". Accepted values for stencil are "stencil", "stencil1", "stencil8". For MSAA, only predefined strings are accepted: "msaa", "msaa_low", "msaa_mid" and "msaa_high". The selected configuration is not guaranteed and is only valid in case of GL acceleration. Only the base acceleration string will be saved (e.g. "gl" or "hw").

Full examples include:

"gl", - try to use OpenGL "hw:depth:stencil", - use HW acceleration with default depth and stencil buffers "opengl:depth24:stencil8:msaa_mid" - use OpenGL with 24-bit depth, 8-bit stencil and a medium number of MSAA samples in the backbuffer.

This takes precedence over engine preferences set with elm_config_preferred_engine_set().

See also:: elm_win_add(); elm_config_accel_preference_override_set()

Since (EFL) :: 1.10

Since :: 2.3

void elm_config_color_classes_list_free ( Eina_List * list )

Free Elementary's list of supported color classes.

Since (EFL) :: 1.10

See also:: elm_config_color_classes_list_get().

Since :: 2.3

Eina_List* elm_config_color_classes_list_get ( void )

Get Elementary's list of supported color classes.

Returns:: The color classes list, with Elm_Color_Class blobs as data.

Since (EFL) :: 1.10

Release the list with elm_color_classes_list_free().

Since :: 2.3

void elm_config_color_overlay_apply ( void )

Apply the changes made with elm_config_color_overlay_set() and elm_config_color_overlay_unset() on the current Elementary window.

Since (EFL) :: 1.10

This applies all color overlays set to all objects in the UI.

Since :: 2.3

const Eina_List* elm_config_color_overlay_list_get ( void )

Get Elementary's list of color overlays, set with elm_config_color_overlay_set().

Returns:: The color overlays list, with Elm_Color_Overlay blobs as data.

Since (EFL) :: 1.10

For each color class, one can set a color overlay for it, overriding the default color properties for that class coming from the theme in use. There is no need to free this list.

See also:: elm_config_color_overlay_set(); elm_config_color_overlay_unset().

Since :: 2.3

void elm_config_color_overlay_set	(	const char *	color_class,
		int	r,
		int	g,
		int	b,
		int	a,
		int	r2,
		int	g2,
		int	b2,
		int	a2,
		int	r3,
		int	g3,
		int	b3,
		int	a3
	)

Set a color overlay for a given Elementary color class.

Parameters:

color_class	Color class name
r	Object Red value
g	Object Green value
b	Object Blue value
a	Object Alpha value
r2	Text outline Red value
g2	Text outline Green value
b2	Text outline Blue value
a2	Text outline Alpha value
r3	Text shadow Red value
g3	Text shadow Green value
b3	Text shadow Blue value
a3	Text shadow Alpha value

Since (EFL) :: 1.10

The first color is for the object itself, the second color is for the text outline, and the third color is for the text shadow.

Note:: The second two color are only for texts.

Setting color emits a signal "color_class,set" with source being the given color class in all edje objects.

See also:: elm_config_color_overlay_list_get(); elm_config_color_overlay_unset(); edje_color_class_set()

Note:: unlike Evas, Edje colors are not pre-multiplied. That is, half-transparent white is 255 255 255 128.

Since :: 2.3

void elm_config_color_overlay_unset ( const char * color_class )

Unset a color overlay for a given Elementary color class.

Parameters:

color_class Color class name

Since (EFL) :: 1.10

This will bring back color elements belonging to color class color_class back to their default color settings.

Since :: 2.3

EINA_DEPRECATED const char* elm_config_engine_get ( void )

Get Elementary's rendering engine in use.

Deprecated:: Deprecated since 2.4. Use elm_config_accel_preference_get() + elm_config_accel_preference_set().

Returns:: The rendering engine's name

Note:: there's no need to free the returned string, here.

This gets the global rendering engine that is applied to all Elementary applications.

See also:: elm_config_engine_set()

Since :: 2.3

EINA_DEPRECATED void elm_config_engine_set ( const char * engine )

Set Elementary's rendering engine for use.

Deprecated:: Deprecated since 2.4. Use elm_config_accel_preference_get() + elm_config_accel_preference_set().

Parameters:

engine The rendering engine's name

Note that it will take effect only to Elementary windows created after this is called.

See also:: elm_win_add()

Since :: 2.3

const char* elm_config_indicator_service_get ( int rotation )

Get the indicator service name according to the rotation degree.

Parameters:

rotation The rotation which related with the indicator service name, in degrees (0-360),

Returns:: The indicator service name according to the rotation degree. The indicator service name can be either "elm_indicator_portrait" or "elm_indicator_landscape".

Note:: Do not free the return string.

Since :: 2.3

Eina_Bool elm_config_language_auto_mirrored_get ( void )

Get the system auto mirrored mode. This determines whether the mirrored mode is determined automatically by the locale or not.

Returns:: EINA_TRUE if mirrored is set, EINA_FALSE otherwise

Since :: 4.0

void elm_config_language_auto_mirrored_set ( Eina_Bool auto_mirrored )

Set the system auto mirrored mode. This determines whether the mirrored mode is determined automatically by the locale or not.

Parameters:

mirrored EINA_TRUE to set auto mirrored mode, EINA_FALSE to unset it.

Since :: 4.0

Eina_Bool elm_config_mirrored_get ( void )

Get the system mirrored mode. This determines the default mirrored mode of widgets.

Returns:: EINA_TRUE if mirrored is set, EINA_FALSE otherwise

Since :: 2.3

void elm_config_mirrored_set ( Eina_Bool mirrored )

Set the system mirrored mode. This determines the default mirrored mode of widgets.

Parameters:

mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.

Since :: 2.3

Eina_Bool elm_config_popup_scrollable_get ( void )

Get the popup scrollable flag

If scrollable is true, popup's contents is wrapped in a scroller container in order to popup shouldn't be larger than its parent.

Returns:: The enabled state for popup scroll

Since (EFL) :: 1.18

void elm_config_popup_scrollable_set ( Eina_Bool scrollable )

Set the popup scrollable flag

If scrollable is true, popup's contents is wrapped in a scroller container in order to popup shouldn't be larger than its parent.

Parameters:

enable the popup scroll

Since (EFL) :: 1.18

const char* elm_config_preferred_engine_get ( void )

Get Elementary's preferred engine to use.

Returns:: The rendering engine's name

Note:: there's no need to free the returned string, here.

This gets the global rendering engine that is applied to all Elementary applications and is PREFERRED by the application. This can (and will) override the engine configured for all applications which. It is rare to explicitly ask for an engine (likely need is the buffer engine and not much more), so use elm_config_accel_preference_get() and elm_config_accel_preference_set() normally.

See also:: elm_config_preferred_engine_set()

Since :: 2.3

void elm_config_preferred_engine_set ( const char * engine )

Set Elementary's preferred rendering engine for use.

Parameters:

engine The rendering engine's name

Note that it will take effect only to Elementary windows created after this is called. This overrides the engine set by configuration at application startup. Note that it is a hint and may not be honored. It is rare to explicitly ask for an engine (likely need is the buffer engine and not much more), so use elm_config_accel_preference_get() and elm_config_accel_preference_set() normally.

See also:: elm_win_add(); elm_config_accel_preference_set(); elm_config_engine_set()

Since :: 2.3

Eina_Bool elm_config_selection_unfocused_clear_get ( void )

Get whether selection should be cleared when entry widget is unfocused.

Returns:: if the selection would be cleared on unfocus.

Since (EFL) :: 1.7

See also:: elm_config_selection_unfocused_clear_set()

Since :: 2.3

void elm_config_selection_unfocused_clear_set ( Eina_Bool enabled )

Set whether selection should be cleared when entry widget is unfocused.

Parameters:

enabled If EINA_TRUE, clear selection when unfocus, otherwise does not clear selection when unfocus.

Since (EFL) :: 1.7

See also:: elm_config_selection_unfocused_clear_get()

Since :: 2.3

double elm_config_transition_duration_factor_get ( void )

Get the duration factor of transitions

Returns:: The duration factor of transition in edje

Since (EFL) :: 1.15

Since :: 3.0

void elm_config_transition_duration_factor_set ( double factor )

Set the transition duration factor

This function sets the edje transition duration factor It will affect the duration of edje transitions

Parameters:

factor The duration factor for transition in edje

Note:: This value affect duration of transitions in edje

Since (EFL) :: 1.15

See also:: edje_transition_duration_set() for more details

Since :: 3.0

Eina_Bool elm_config_vsync_get ( void )

Get the configured vsync flag

This gets the globally configured vsync flag that asks some backend engines to use vsync display if possible.

Returns:: If vsync is enabled

Since (EFL) :: 1.11

Since :: 3.0

void elm_config_vsync_set ( Eina_Bool enabled )

Set the configured vsync flag

This sets the globally configured vsync flag that asks some backend engines to use vsync display if possible.

Parameters:

enabled This should be EINA_TRUE if enabled, or EINA_FALSE if not.

Since (EFL) :: 1.11

Since :: 3.0

Eina_Bool elm_config_window_auto_focus_animate_get ( void )

Get the auto focus animate flag

If auto focus - see elm_config_window_auto_focus_enable_set() , is enabled then this will determine if the focus display will be animated or not.

Returns:: The enabled state for auto focus animation

Since (EFL) :: 1.14

Since :: 3.0

void elm_config_window_auto_focus_animate_set ( Eina_Bool enable )

Set the auto focus animation flag

If auto focus - see elm_config_window_auto_focus_enable_set() , is enabled then this will determine if the focus display will be animated or not.

Parameters:

enable the auto focus animation state

Since (EFL) :: 1.14

Since :: 3.0

Eina_Bool elm_config_window_auto_focus_enable_get ( void )

Get the auto focus enable flag

This determines if elementary will show a focus box indicating the focused widget automatically if keyboard controls like "Tab" are used to switch focus between widgets. Mouse or touch control will hide this auto shown focus, unless focus display has been expliccitly forced on for the window.

Returns:: The enabled state for auto focus display

Since (EFL) :: 1.14

Since :: 3.0

void elm_config_window_auto_focus_enable_set ( Eina_Bool enable )

Set the auto focus enabled state

This determines if elementary will show a focus box indicating the focused widget automatically if keyboard controls like "Tab" are used to switch focus between widgets. Mouse or touch control will hide this auto shown focus, unless focus display has been expliccitly forced on for the window.

Parameters:

enable the auto focus display enabled state

Since (EFL) :: 1.14

Since :: 3.0

Functions

Function Documentation