Trap can be set with elm_win_trap_set() and intercepts the calls to internal ecore_evas with the same name and parameters. If there is a trap and it returns EINA_TRUE then the call is allowed, otherwise it is ignored.

Since (EFL) :

1.7

Since :

2.3.1

Enumeration that defines the available commands that can be sent to the Illume manager.

Since :

2.3.1

Remarks:

When running under an Illume session, a window may send commands to the Illume manager to perform different actions.

Enumerator:

ELM_ILLUME_COMMAND_FOCUS_BACK	Reverts focus to the previous window
ELM_ILLUME_COMMAND_FOCUS_FORWARD	Sends focus to the next window in the list
ELM_ILLUME_COMMAND_FOCUS_HOME	Hides all windows to show the Home screen
ELM_ILLUME_COMMAND_CLOSE	Closes the currently active window

Enumeration that defines the different indicator states.

Since :

2.3.1

Remarks:

In some environments, like phones, you may have an indicator that shows the battery status, reception, time etc. This is the indicator.

Sometimes you don't want it because you provide the same functionality inside your app, so this requests that the indicator be hidden in such a circumstance if you use ELM_ILLUME_INDICATOR_HIDE. The default is to have the indicator shown.

Enumerator:

ELM_WIN_INDICATOR_UNKNOWN	Unknown indicator state
ELM_WIN_INDICATOR_HIDE	Hides the indicator
ELM_WIN_INDICATOR_SHOW	Shows the indicator

Enumeration that defines the opacity modes of an indicator that can be shown.

Since :

2.3.1

Enumerator:

ELM_WIN_INDICATOR_OPACITY_UNKNOWN	Unknown indicator opacity mode
ELM_WIN_INDICATOR_OPAQUE	Opacifies the indicator
ELM_WIN_INDICATOR_TRANSLUCENT	Makes the indicator translucent
ELM_WIN_INDICATOR_TRANSPARENT	Transparentizes the indicator
ELM_WIN_INDICATOR_BG_TRANSPARENT	Transparentizes the indicator background

Enumeration that defines the type modes of an indicator that can be shown.

Since :

2.3.1

Remarks:

If the indicator can support several types, you can use this enum value to deal with different types of indicators.

Enumerator:

ELM_WIN_INDICATOR_TYPE_UNKNOWN	Unknown indicator type mode
ELM_WIN_INDICATOR_TYPE_1	Type 0 indicator
ELM_WIN_INDICATOR_TYPE_2	Type 1 indicator

Enumeration that defines the different layouts that can be requested for the virtual keyboard.

Since :

2.3.1

Remarks:

When the application window is being managed by Illume, it may request any of the following layouts for the virtual keyboard.

Enumerator:

ELM_WIN_KEYBOARD_UNKNOWN	Unknown keyboard state
ELM_WIN_KEYBOARD_OFF	Request to deactivate the keyboard
ELM_WIN_KEYBOARD_ON	Enable keyboard with default layout
ELM_WIN_KEYBOARD_ALPHA	Alpha (a-z) keyboard layout
ELM_WIN_KEYBOARD_NUMERIC	Numeric keyboard layout
ELM_WIN_KEYBOARD_PIN	PIN keyboard layout
ELM_WIN_KEYBOARD_PHONE_NUMBER	Phone keyboard layout
ELM_WIN_KEYBOARD_HEX	Hexadecimal numeric keyboard layout
ELM_WIN_KEYBOARD_TERMINAL	Full (QWERTY) keyboard layout
ELM_WIN_KEYBOARD_PASSWORD	Password keyboard layout
ELM_WIN_KEYBOARD_IP	IP keyboard layout
ELM_WIN_KEYBOARD_HOST	Host keyboard layout
ELM_WIN_KEYBOARD_FILE	File keyboard layout
ELM_WIN_KEYBOARD_URL	URL keyboard layout
ELM_WIN_KEYBOARD_KEYPAD	Keypad layout
ELM_WIN_KEYBOARD_J2ME	J2ME keyboard layout

Enumeration that defines the types of windows that can be created.

Since :

2.3.1

Remarks:

These are hints set on the window so that a running Windows Manager knows how the window should be handled and/or what kind of decorations it should have.

Currently, only the X11 backed engines use them.

Enumerator:

ELM_WIN_UNKNOWN	Unknown window type
ELM_WIN_BASIC	A normal window. It indicates a normal, top-level window. Almost every window is created with this type
ELM_WIN_DIALOG_BASIC	Used for simple dialog windows
ELM_WIN_DESKTOP	Used for special desktop windows, like a background window holding desktop icons
ELM_WIN_DOCK	The window is used as a dock or panel. Usually would be kept on top of any other window by the Windows Manager
ELM_WIN_TOOLBAR	The window is used to hold a floating toolbar, or something similar
ELM_WIN_MENU	This is similar to ELM_WIN_TOOLBAR
ELM_WIN_UTILITY	A persistent utility window, like a toolbox or palette
ELM_WIN_SPLASH	A splash window for an application that is starting up
ELM_WIN_DROPDOWN_MENU	The window is a dropdown menu, when an entry in a menubar is clicked. Typically used with elm_win_override_set(). This hint exists for completion only, as the EFL way of implementing a menu would not normally use a separate window for its contents
ELM_WIN_POPUP_MENU	Like ELM_WIN_DROPDOWN_MENU, but used for the menu triggered by right-clicking an object
ELM_WIN_TOOLTIP	The window is a tooltip. A short piece of explanatory text that typically appears after the mouse cursor hovers over an object for a while. Typically used with elm_win_override_set() and also not very commonly used in EFL
ELM_WIN_NOTIFICATION	A notification window, like a warning about battery life or a new email that is received
ELM_WIN_COMBO	A window holding the contents of a combo box. Not usually used in EFL
ELM_WIN_DND	Used to indicate that the window is a representation of an object being dragged across different windows, or even applications. Typically used with elm_win_override_set()
ELM_WIN_INLINED_IMAGE	The window is rendered onto an image buffer. No actual window is created for this type, instead the window and all of its contents are rendered to an image buffer. This allows to have a children window inside a parent one just like any other object would be, and do other things like applying Evas_Map effects to it. This is the only type of window that requires the parent parameter of elm_win_add() to be a valid Evas_Object
ELM_WIN_SOCKET_IMAGE	The window is rendered onto an image buffer and can be shown another process's plug image object. No actual window is created for this type, instead the window and all of its contents are rendered to an image buffer and can be shown another process's plug image object

Activates the window object.

This function sends a request to the Windows Manager to activate the window pointed by obj. If honored by the WM, the window receives the keyboard focus.

Since :

2.3.1

Remarks:

This is just a request that a Window Manager may ignore, so calling this function does not ensure in any way that the window is going to be the active one after it.

Parameters:

[in]

obj

The window object

Adds a window object. If this is the first window created, pass NULL as parent.

Since :

2.3.1

Remarks:

The parent parameter can be NULL for every window type except ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on which the image object is created.

Parameters:

[in]	parent	The parent object to add the window to, otherwise NULL
[in]	name	The name of the window
[in]	type	The window type, one from Elm_Win_Type

Returns:

The created object, otherwise NULL on failure

Gets the alpha channel state of a window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

true if the window has an alpha channel, otherwise false

Sets the alpha channel state of a window.

Since :

2.3.1

Remarks:

If alpha is EINA_TRUE, the alpha channel of the canvas is enabled possibly making parts of the window completely or partially transparent. This is also subject to the underlying system supporting it, like for example, running under a compositing manager. If no compositing is available, enabling this option results in using shaped windows with elm_win_shaped_set().

Parameters:

[in]	obj	The window object
[in]	alpha	If true the window has an alpha channel, otherwise false

See also:

elm_win_alpha_set()

Gets the aspect ratio of a window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

The set aspect ratio (0 by default)

Sets the aspect ratio of a window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	aspect	If 0 the window has no aspect limits, otherwise it is width divided by height

Gets the window autodel state.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

true if the window automatically deletes itself when closed, otherwise false

See also:

elm_win_autodel_set()

Sets the window autodel state.

Since :

2.3.1

Remarks:

When closing the window in any way outside of the program control, like pressing the X button in the titlebar or using a command from the Windows Manager, a "delete,request" signal is emitted to indicate that this event has occurred and the developer can take an action, which may or may not include destroying the window object.

When the autodel parameter is set, the window is automatically destroyed when this event occurs, after the signal is emitted. If autodel is EINA_FALSE, then the window is not destroyed and it is up to the program to decide when to do so if required.

Parameters:

[in]	obj	The window object
[in]	autodel	If true the window automatically deletes itself when closed, otherwise false

Gets the borderless state of a window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

true if the window is borderless, otherwise false

Sets the borderless state of a window.

This function requests the Windows Manager to not draw any decoration around the window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	borderless	If true the window is borderless, otherwise false

Centers a window on its screen.

This function centers a window obj horizontally and/or vertically based on the values of h and v.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	h	If true it centers horizontally, otherwise false if it does not change the horizontal location
[in]	v	If true it centers vertically, otherwise false if it does not change the vertical location

Gets whether this window is an illume conformant window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

The boolean value that indicates whether this window is illume conformant

Sets whether this window is an illume conformant window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	conformant	The conformant flag (1 = conformant, 0 = non-conformant)

Gets the demand_attention state of a window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

true if the window is in the demand_attention state, otherwise false

Sets the demand_attention state of a window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	demand_attention	If true the window is in the demand_attention state, otherwise false

Gets the floating mode of a window.

Since (EFL) :

1.8

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

true if the window is in the floating mode, otherwise false

See also:

elm_win_floating_mode_set()

Sets the floating mode of a window.

Since (EFL) :

1.8

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	floating	If true the window is in the floating mode, otherwise false

See also:

elm_win_floating_mode_get()

Determines whether a window has focus.

Since :

2.3.1

Parameters:

[in]

obj

The window to query

Returns:

EINA_TRUE if the window exists and has focus, otherwise EINA_FALSE

Gets the enabled value of the focus highlight for this window.

Since :

2.3.1

Parameters:

[in]

obj

The window in which to check if the focus highlight is enabled

Returns:

EINA_TRUE if enabled, otherwise EINA_FALSE

Sets the enabled status for the focus highlight in a window.

This function enables or disables the focus highlight only for the given window, regardless of the global setting for it.

Since :

2.3.1

Parameters:

[in]	obj	The window for which to enable highlight
[in]	enabled	The enabled value for the highlight

Gets the style set for the focus highlight object.

This gets the style set for this windows highlight object, otherwise NULL if no style is set.

Since :

2.3.1

Parameters:

[in]

obj

The window from which to retrieve the highlight style

Returns:

The style set, otherwise NULL if no style is set
The default value is used in that case.

Sets the style for the focus highlight on this window.

This sets the style to use for theming the highlight of focused objects on the given window. If style is NULL, the default value is used.

Since :

2.3.1

Parameters:

[in]	obj	The window for which to set the style
[in]	style	The style to set

Geta the fullscreen state of a window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

true if the window is fullscreen, otherwise false

Sets the fullscreen state of a window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
	fullscreen	If true the window is fullscreen, otherwise false

Gets the icon name of the window.

Since :

2.3.1

Remarks:

The returned string is an internal one and should not be freed or modified. It should also be rendered invalid if a new icon name is set or if the window is destroyed.

Parameters:

[in]

obj

The window object

Returns:

The icon name

Sets the icon name of the window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	icon_name	The icon name to set

Gets the icon object used for the window.

Since :

2.3.1

Remarks:

The object returned is the one marked by elm_win_icon_object_set() as the object to use for the window icon.

Parameters:

[in]

obj

The window object

Returns:

The icon object to set

Sets a window object icon.

This sets an image to be used as the icon for the given window, in the Windows Manager decoration part. The exact pixel dimensions of the object (not object size) is used, and the image pixels are used as-is when this function is called. If the image object has been updated, then call this function again to source the image pixels and put them on the window's icon. Note that only Evas image objects are allowed.

Since :

2.3.1

Remarks:

Example of usage:

  icon = evas_object_image_add(evas_object_evas_get(elm_window));
  evas_object_image_file_set(icon, "/path/to/the/icon", NULL);
  elm_win_icon_object_set(elm_window, icon);
  evas_object_show(icon);

Parameters:

[in]	obj	The window object used to get an icon
[in]	icon	The Evas image object used as an icon

Gets the iconified state of a window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

true if the window is iconified, otherwise false

Sets the iconified state of a window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	iconified	If true the window is iconified, otherwise false

Sends a command to the windowing environment.

Since :

2.3.1

Remarks:

This is intended to work in touchscreen or small screen device environments where there is a more simplistic window management policy in place. This uses the window object indicated to select which part of the environment to control (the part that this window lives in), and provides a command and an optional parameter structure (use NULL for this if not needed).

Parameters:

[in]	obj	The window object that lives in the environment to control
[in]	command	The command to send
[in]	params	The optional parameters for the command

Gets the indicator mode of the window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

The mode, one from Elm_Win_Indicator_Mode

Sets the indicator mode of the window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	mode	The mode to set, one from Elm_Win_Indicator_Mode

Gets the indicator opacity mode of the window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

The mode, one from Elm_Win_Indicator_Opacity_Mode

Sets the indicator opacity mode of the window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	mode	The mode to set, one from Elm_Win_Indicator_Opacity_Mode

Gets the inlined image object handle.

Since :

2.3.1

Remarks:

When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE, then the window is in fact an evas image object inlined in the parent canvas. You can get this object (be careful to not manipulate it as it is under the control of elementary), and use it to do things like get pixel data, save the image to a file, etc.

Parameters:

[in]

obj

The window object from which to get the inlined image

Returns:

The inlined image object, otherwise NULL if none exist

Gets the keyboard mode of the window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

The mode, one from Elm_Win_Keyboard_Mode

Sets the keyboard mode of the window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	mode	The mode to set, one from Elm_Win_Keyboard_Mode

Gets whether the window is a keyboard.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

true if the window is a virtual keyboard, otherwise false

Sets whether the window is a keyboard.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	is_keyboard	If true the window is a virtual keyboard, otherwise false

Gets the layer of the window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

The layer of the window

See also:

elm_win_layer_set()

Sets the layer of the window.

Since :

2.3.1

Remarks:

What this means exactly depends on the underlying engine used.

In case of X11 backed engines, the value in layer has one of the following meanings:

• < 3: The window is placed below all others.
• > 5: The window is placed above all others.
• other: The window is placed in the default layer.

Parameters:

[in]	obj	The window object
[in]	layer	The layer of the window

Lowers the window object.

Since :

2.3.1

Remarks:

Places the window pointed by obj at the bottom of the stack, so that no other window is covered by it.

If elm_win_override_set() is not set, the Windows Manager may ignore this request.

Parameters:

[in]

obj

The window object

Gets the maximized state of a window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

true if the window is maximized, otherwise false

Sets the maximized state of a window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	maximized	If true the window is maximized, otherwise false

Gets the modal state of a window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

If true the window is modal, otherwise false

Sets the modal state of a window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	modal	If true the window is modal, otherwise false

Returns the number of times norender has been pushed on the window.

Since (EFL) :

1.7

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

The number of times norender has been pushed

See also:

elm_win_norender_push()

elm_win_norender_pop()

elm_win_render()

Pops (decrements) the norender counter on the window.

Since (EFL) :

1.7

Since :

2.3.1

Remarks:

Once norender has gone back to 0, automatic rendering continues in the given window. If it is already at 0, this has no effect.

Parameters:

[in]

obj

The window object

See also:

elm_win_norender_push()

elm_win_norender_get()

elm_win_render()

Pushes (incriments) the norender counter on the window.

Since (EFL) :

1.7

Since :

2.3.1

Remarks:

There are some occasions where you wish to suspend rendering on a window. You may be "sleeping" and may have nothing to update and do not want animations or other theme side-effects causing rendering to the window while "asleep". You can push (and pop) the norender mode to make this work.

If combined with evas_render_dump(), you can minimize memory footprint significantly while "asleep", and the pausing of rendering ensures that evas does not re-load data into memory until needed. When rendering is resumed, data is re-loaded as needed, which may result in some lag, but does save memory.

Parameters:

[in]

obj

The window object

See also:

elm_win_norender_pop()

elm_win_norender_get()

elm_win_render()

Gets the override state of a window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

true if the window is overridden, otherwise false

See also:

elm_win_override_set()

Sets the override state of a window.

Since :

2.3.1

Remarks:

A window with override set to EINA_TRUE is not managed by the Windows Manager. This means that no decorations of any kind are shown for it, moving and resizing must be handled by the application as well as the window visibility.

This should not be used for normal windows, and even for not so normal ones, it should only be used with a lot of care and when there's a good reason. Mishandling override windows may result in situations that disrupt the normal workflow of the end user.

Parameters:

[in]	obj	The window object
[in]	override	If true the window is overridden, otherwise false

Gets the profile of a window.

Since :

2.3.1

Remarks:

The returned string is an internal one and should not be freed or modified. It is also rendered invalid if a new role is set or if the window is destroyed.

Parameters:

[in]

obj

The window object

Returns:

The profile name

Sets the profile list of a window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	profiles	The list of profile names
[in]	num_profiles	The number of profile names

Sets the window to be skipped by keyboard focus.

This sets the window to be skipped by normal keyboard input. This means the Windows Manager is asked to not focus this window as well as omit it from things like the taskbar, pager, "alt-tab" list, etc.

Since :

2.3.1

Remarks:

Call this and enable it on a window BEFORE you show it for the first time, otherwise it may have no effect.

Use this for windows that have only output information or might only be interacted with by a mouse or fingers, and never for typing input. Be careful that this may have side-effects like making the window non-accessible in some cases unless the window is specially handled. Use this with care.

Parameters:

[in]	obj	The window object
[in]	skip	The skip flag state (EINA_TRUE if it is to be skipped)

Gets whether this window is a quickpanel.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

A boolean value that indicates whether this window is a quickpanel

Gets the major priority of a quickpanel window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

The major priority of this quickpanel

Sets the major priority of a quickpanel window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	priority	The major priority for this quickpanel

Gets the minor priority of a quickpanel window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

The minor priority of this quickpanel

Sets the minor priority of a quickpanel window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	priority	The minor priority for this quickpanel

Sets a window to be an illume quickpanel window.

Since :

2.3.1

Remarks:

By default, window objects are not quickpanel windows.

Parameters:

[in]	obj	The window object
[in]	quickpanel	The quickpanel flag (1 = quickpanel, 0 = normal window)

Gets the zone in which this should appear.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

The requested zone for this quickpanel

Sets the zone in which this quickpanel should appear.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	zone	The requested zone for this quickpanel

Raises the window object.

Since :

2.3.1

Remarks:

Places the window pointed by obj at the top of the stack, so that it's not covered by any other window.

If elm_win_override_set() is not set, the Windows Manager may ignore this request.

Parameters:

[in]

obj

The window object

Manually asks evas to render the window immediately.

Since (EFL) :

1.7

Since :

2.3.1

Remarks:

You should NEVER call this unless you really know what you are doing and why. Never call this unless you are asking for performance degredation and possibly weird behavior. Windows gets automatically rendered when the application goes idle so there is never a need to call this UNLESS you have enabled the "norender" mode.

Parameters:

[in]

obj

The window object

See also:

elm_win_norender_push()

elm_win_norender_pop()

elm_win_norender_get()

Adds subobj as a resize object of the window obj.

Since :

2.3.1

Remarks:

Setting an object as a resize object of the window means that the subobj child's size and position is controlled by the window directly. That is, the object is resized to match the window size and should never be moved or resized manually by the developer.

In addition, resize objects of the window control the minimum size of it as well as whether it can or cannot be resized by the user.

For the end user to be able to resize a window by dragging the handles or borders provided by the Windows Manager, or using any other similar mechanism, all of the resize objects in the window should have their evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.

Also notice that the window can get resized to the current size of the object if EVAS_HINT_EXPAND is set after the call to elm_win_resize_object_add(). So if the object should get resized to the size of the window, set this hint before adding it as a resize object (this happens because the size of the window and the object are evaluated as soon as the object is added to the window).

Parameters:

[in]	obj	The window object
[in]	subobj	The resize object to add

Deletes subobj as a resize object of the window obj.

This function removes the object subobj from the resize objects of the window obj. It does not delete the object itself, which is left unmanaged and should be deleted by the developer, manually handled or set as the child of some other container.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	subobj	The resize object to add

Gets the role of the window.

Since :

2.3.1

Remarks:

The returned string is an internal one and should not be freed or modified. It should also be rendered invalid if a new role is set or if the window is destroyed.

Parameters:

[in]

obj

The window object

Returns:

The role

Sets the role of the window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	role	The role to set

Gets the rotation of the window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

The rotation of the window in degrees (0-360)

See also:

elm_win_rotation_set()

elm_win_rotation_with_resize_set()

Sets the rotation of the window.

Since :

2.3.1

Remarks:

Most engines only work with multiples of 90.

This function is used to set the orientation of the window obj to match that of the screen. The window itself is resized to adjust to the new geometry of its contents. If you want to keep the window size,

Parameters:

[in]	obj	The window object
[in]	rotation	The rotation of the window, in degrees (0-360), counter-clockwise

See also:

elm_win_rotation_with_resize_set()

Rotates the window and resizes it.

Since :

2.3.1

Remarks:

Like elm_win_rotation_set(), but it also resizes the window's contents so that they fit inside the current window geometry.

Parameters:

[in]	obj	The window object
[in]	rotation	The rotation of the window, in degrees (0-360), counter-clockwise

Retrieves the constraints on the maximum width and height of a window relative to the width and height of its screen.

Since :

2.3.1

Remarks:

When this function returns true, obj never resizes to a size larger than the screen.

Parameters:

[in]

obj

The window object

Returns:

EINA_TRUE to restrict the window's maximum size, otherwise EINA_FALSE to disable restriction

Limits the maximum width and height of a window to the width and height of its screen.

Since :

2.3.1

Remarks:

When constrain is true, obj never resizes to a size larger than the screen.

Parameters:

[in]	obj	The window object
[in]	constrain	EINA_TRUE to restrict the window's maximum size, otherwise EINA_FALSE to disable restriction

Gets the screen dpi for the screen that a window is on.

Since (EFL) :

1.7

Since :

2.3.1

Parameters:

[in]	obj	The window to query
[out]	xdpi	The pointer to the value that stores the returned horizontal dpi This may be NULL.
[out]	ydpi	The pointer to the value that stores the returned vertical dpi This may be NULL.

Get the screen position of a window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[out]	x	The integer that stores the x coordinate
[out]	y	The integer that stores the y coordinate

Gets the screen geometry details for the screen that a window is on.

Since :

2.3.1

Parameters:

[in]	obj	The window to query
[out]	x	The coordinate at which to return the horizontal offset value This may be NULL.
[out]	y	The coordinate at which to return the vertical offset value This may be NULL.
[out]	w	The coordinate at which to return the width value This may be NULL.
[out]	h	The coordinate at which to return the height value This may be NULL.

Gets the shaped state of a window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

true if the window is shaped, otherwise false

See also:

elm_win_shaped_set()

Sets the shaped state of a window.

Since :

2.3.1

Remarks:

Shaped windows, when supported, render the parts of the window that has no content and is transparent.

If shaped is EINA_FALSE, then it is strongly advised to have some background object or cover the entire window in any other way, otherwise the parts of the canvas that have no data show framebuffer artifacts.

Parameters:

[in]	obj	The window object
[in]	shaped	If true the window is shaped, otherwise false

See also:

elm_win_alpha_set()

Gets the base size of a window.

Since (EFL) :

1.7

Since :

2.3.1

Parameters:

[in]	obj	The window object
[out]	w	The pointer that stores the returned base width
[out]	h	The pointer that stores the returned base height

See also:

elm_win_size_base_set

elm_win_size_step_set

Sets the base window size used with stepping calculation.

Since (EFL) :

1.7

Since :

2.3.1

Remarks:

Base size + stepping is what is calculated for window sizing restrictions.

Parameters:

[in]	obj	The window object
[in]	w	The base width
[in]	h	The base height

See also:

elm_win_size_step_set

elm_win_size_base_get

Gets the stepping of a window.

Since (EFL) :

1.7

Since :

2.3.1

Parameters:

[in]	obj	The window object
[out]	w	The pointer that stores the returned stepping width
[out]	h	The pointer that stores the returned stepping height

See also:

elm_win_size_base_set

elm_win_size_step_set

Sets the window stepping used with sizing calculation.

Since (EFL) :

1.7

Since :

2.3.1

Remarks:

Base size + stepping is what is calculated for window sizing restrictions.

Parameters:

[in]	obj	The window object
[in]	w	The stepping width (0 disables)
[in]	h	The stepping height (0 disables)

See also:

elm_win_size_step_get

elm_win_size_base_set

Creates a socket to provide the service for a Plug widget.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	svcname	The name of the service to be advertised Ensure that it is unique (when combined with svcnum), otherwise the creation may fail.
[in]	svcnum	A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name
[in]	svcsys	If true it specifies to create a system-wide service that all users can connect to, otherwise false if the service is private to the user ID that created the service

Returns:

The boolean value that indicates whether the socket creation is successful

Gets the sticky state of the window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

If true the window's sticky state is enabled, otherwise false

See also:

elm_win_sticky_set()

Sets the sticky state of the window.

Since :

2.3.1

Remarks:

Hints the Windows Manager that the window in obj should be left fixed at its position even when the virtual desktop that it's on moves or changes.

Parameters:

[in]	obj	The window object
[in]	sticky	If true the window's sticky state is enabled, otherwise false

Gets the title of the window.

Since :

2.3.1

Remarks:

The returned string is an internal one and should not be freed or modified. It should also be rendered invalid if a new title is set or if the window is destroyed.

Parameters:

[in]

obj

The window object

Returns:

The title

Sets the title of the window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	title	The title to set

Sets the trap to be used for internal Ecore_Evas management.

Since (EFL) :

1.7

Since :

2.3.1

Remarks:

This is an advanced feature that you should avoid using.

Parameters:

[in]

trap

The trap to be used, otherwise NULL to remove traps The pointer is not modified or copied, it is kept alive.

Returns:

EINA_TRUE on success, otherwise EINA_FALSE if there is a problem, such as an invalid version number

Gets the type of a window.

Since :

2.3.1

Parameters:

[in]

obj

The window object for which to get the type

Returns:

The type of a window object
If the object is not a window object, return -1.

Gets the urgent state of a window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

true if the window is urgent, otherwise false

Sets the urgent state of a window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	urgent	If true the window is urgent, otherwise false

Adds a window object with a standard setup.

Since :

2.3.1

Remarks:

This creates a window like elm_win_add(), but also puts in a standard background using elm_bg_add() as well as setting the window title to title. The window type created is of type ELM_WIN_BASIC with NULL as the parent widget.

Parameters:

[in]	name	The name of the window
[in]	title	The title of the window

Returns:

The created object, otherwise NULL on failure

See also:

elm_win_add()

Gets the withdrawn state of a window.

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

true if the window is withdrawn, otherwise false

Sets the withdrawn state of a window.

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	withdrawn	If true the window is withdrawn, otherwise false

Gets the array of available window rotations.

This function is used to get the available rotations.

Since (EFL) :

1.9

Since :

2.3.1

Parameters:

[in]	obj	The window object
[out]	rotations	The array of rotation values
[out]	count	The number of arrays of rotations

Returns:

EINA_TRUE if succeed, otherwise EINA_FALSE

See also:

elm_win_wm_rotation_available_rotations_set()

Sets the array of available window rotations.

This function is used to set the available rotations to give hints to WM. WM refers these hints and sets the orientation of the window properly.

Since (EFL) :

1.9

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	rotations	The array of rotation values
[in]	count	The number of arrays of rotations

See also:

elm_win_wm_rotation_available_rotations_get()

Sets the rotation finish manually.

Since (EFL) :

1.8

Since :

2.3.1

Parameters:

[in]

obj

The window object

See also:

elm_win_wm_rotation_manual_rotation_done_set()

elm_win_wm_rotation_manual_rotation_done_get()

Gets the manual rotation done mode of the window.

Since (EFL) :

1.8

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

true if the manual rotation done mode is enabled, otherwise false

See also:

elm_win_wm_rotation_manual_rotation_done_set()

elm_win_wm_rotation_manual_rotation_done()

Sets the manual rotation done mode of the window.

Since (EFL) :

1.8

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	set	If true, the Windows Manager does not rotate the window until the rotation done event is received by elm_win_wm_rotation_manual_rotation_done, otherwise false if the manual rotation mode is disabled

See also:

elm_win_wm_rotation_manual_rotation_done_get()

elm_win_wm_rotation_manual_rotation_done()

Gets the preferred rotation value.

This function is used to get the preferred rotation value.

Since (EFL) :

1.9

Since :

2.3.1

Parameters:

[in]

obj

The window object

Returns:

The preferred rotation of the window, in degrees (0-360), counter-clockwise

See also:

elm_win_wm_rotation_preferred_rotation_set()

Set the preferred rotation value.

This function is used to set the orientation of window obj to spicific angle fixed.

Since (EFL) :

1.9

Since :

2.3.1

Parameters:

[in]	obj	The window object
[in]	rotation	The preferred rotation of the window in degrees (0-360), counter-clockwise.

See also:

elm_win_wm_rotation_preferred_rotation_get()

Queries whether Windows Manager supports window rotation.

Since (EFL) :

1.9

Since :

2.3.1

Remarks:

The Windows Manager rotation allows the WM to control the rotation of application windows. It is designed to support synchronized rotation for multiple application windows at the same time.

Parameters:

[in]

obj

The window object

Returns:

EINA_TRUE if the Windows Manager rotation is supported, otherwise EINA_FALSE

See also:

elm_win_wm_rotation_supported_get()

elm_win_wm_rotation_preferred_rotation_set()

elm_win_wm_rotation_preferred_rotation_get()

elm_win_wm_rotation_available_rotations_set()

elm_win_wm_rotation_available_rotations_get()

elm_win_wm_rotation_manual_rotation_done_set()

elm_win_wm_rotation_manual_rotation_done_get()

elm_win_wm_rotation_manual_rotation_done()