Trap can be set with elm_win_trap_set() and will intercept 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 will be allowed, otherwise it will be ignored.

Since (EFL) :

1.7

In some environments, like phones, you may have an indicator that shows 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 will request that the indicator is hidden in this circumstance. The default is depend on the environments. For example, like phones, default is to have the indicator shown. But like TV, default is to have the indicator hidden.

Enumerator:

ELM_WIN_INDICATOR_HIDE	Unknown indicator state
ELM_WIN_INDICATOR_SHOW	Hides the indicator Shows the indicator

Defines the opacity modes of indicator that can be shown

Enumerator:

ELM_WIN_INDICATOR_OPAQUE	Unknown indicator opacity mode
ELM_WIN_INDICATOR_TRANSLUCENT	Opacifies the indicator
ELM_WIN_INDICATOR_TRANSPARENT	Be translucent the indicator
ELM_WIN_INDICATOR_BG_TRANSPARENT	Transparentizes the indicator Bg Transparentizes the indicator

Get the window's autodel state.

Parameters:

[in]

obj

The object.

Returns:

If true, the window will automatically delete itself when closed.

Note: This function is only available in C.

Set the window's autodel state.

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 Window Manager, a "delete,request" signal is emitted to indicate that this event occurred and the developer can take any action, which may include, or not, destroying the window object.

When the autodel parameter is set, the window will be automatically destroyed when this event occurs, after the signal is emitted. If autodel is false, then the window will not be destroyed and is up to the program to do so when it's required.

Parameters:

[in]	obj	The object.
[in]	autodel	If true, the window will automatically delete itself when closed.

Note: This function is only available in C.

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

Parameters:

parent	Parent object to add the window to, or NULL
name	The name of the window
type	The window type, one of #Elm_Win_Type.

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 will be created.

Returns:

The created object, or NULL on failure

Since :

2.3

Examples:

bg_example_02.c, and win_example.c.

Gets the window's autodel state.

Parameters:

[in]

obj

The object.

Returns:

If true, the window will automatically delete itself when closed.

Since :

2.3

Sets the window's autodel state.

Since :

2.3

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 Window Manager, a "delete,request" signal is emitted to indicate that this event occurred and the developer can take any action, which may include, or not, destroying the window object.

When the autodel parameter is set, the window will be automatically destroyed when this event occurs, after the signal is emitted. If autodel is false, then the window will not be destroyed and is up to the program to do so when it's required.

Parameters:

[in]	obj	The object.
[in]	autodel	If true, the window will automatically delete itself when closed.

Since :

2.3

Examples:

actionslider_example_01.c, bg_example_01.c, bg_example_02.c, bg_example_03.c, box_example_02.c, bubble_example_01.c, button_example_00.c, button_example_01.c, calendar_example_01.c, calendar_example_02.c, calendar_example_03.c, calendar_example_04.c, calendar_example_05.c, calendar_example_06.c, check_example_01.c, clock_example.c, codegen_example.c, colorselector_example_01.c, combobox_example_01.c, conformant_example_01.c, conformant_example_02.c, ctxpopup_example_01.c, datetime_example.c, dayselector_example.c, diskselector_example_01.c, diskselector_example_02.c, efl_thread_6.c, entry_example.c, fileselector_button_example.c, fileselector_entry_example.c, fileselector_example.c, flip_example_01.c, flipselector_example.c, frame_example_01.c, general_funcs_example.c, gengrid_example.c, genlist_example_01.c, genlist_example_02.c, genlist_example_03.c, genlist_example_04.c, genlist_example_05.c, glview_example_01.c, hover_example_01.c, hoversel_example_01.c, icon_example_01.c, image_example_01.c, index_example_01.c, index_example_02.c, inwin_example.c, label_example_01.c, layout_example_01.c, layout_example_02.c, layout_example_03.c, list_example_01.c, list_example_02.c, list_example_03.c, location_example_01.c, map_example_01.c, map_example_02.c, map_example_03.c, mapbuf_example.c, menu_example_01.c, naviframe_example.c, notify_example_01.c, panel_example_01.c, panes_example.c, photocam_example_01.c, popup_example_01.c, popup_example_02.c, popup_example_03.c, prefs_example_01.c, prefs_example_02.c, prefs_example_03.c, radio_example_01.c, scroller_example_01.c, segment_control_example.c, separator_example_01.c, slider_example.c, slideshow_example.c, spinner_example.c, table_example_01.c, table_example_02.c, theme_example_01.c, theme_example_02.c, thumb_example_01.c, toolbar_example_01.c, toolbar_example_02.c, toolbar_example_03.c, track_example_01.c, transit_example_01.c, transit_example_02.c, transit_example_03.c, transit_example_04.c, web_example_02.c, and win_example.c.

Gets if this window is an illume conformant window.

Returns:

The conformant flag.

Since :

2.3

Sets if this window is an illume conformant window.

Parameters:

[in]

conformant

The conformant flag.

Since :

2.3

Examples:

conformant_example_02.c.

Gets the demand_attention state of a window.

Returns:

If true, the window is demand_attention.

Since :

2.3

Sets the demand_attention state of a window.

Parameters:

[in]

demand_attention

If true, the window is demand_attention.

Since :

2.3

Creates a fake window object using a pre-existing canvas.

Parameters:

ee	The Ecore_Evas to use

The returned window widget will not manage or modify the canvas; this canvas must continue to be managed externally.

Do not use this function if you are not writing a window manager.

Warning:

Exact behaviors of this function are not guaranteed.

Returns:

The created object, or NULL on failure

Since (EFL) :

1.13

Since :

3.0

Internal. Used to complete the fake window type.

Parameters:

[in]

oee

Deprecated:

Since :

3.0

Gets the floating mode of a window.

Parameters:

obj	The window object

Returns:

If true, the window is floating mode

See also:

elm_win_floating_mode_set()

Since (EFL) :

1.8

Since :

2.3

Sets the floating mode of a window.

Parameters:

obj	The window object
floating	If true, the window is floating mode

The floating mode can be used on mobile environment. For example, if the video-player window sets the floating mode, then e (enlightenment window manager) changes its geometry and handles it like a popup. This is similar to a multi window concept in a mobile phone. The way of handling floating mode window is decided by enlightenment window manager.

See also:

elm_win_floating_mode_get()

Since (EFL) :

1.8

Since :

2.3

Gets the icon name of the window.

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

Returns:

The icon name to set.

Since :

2.3

Sets the icon name of the window.

Parameters:

[in]

icon_name

The icon name to set.

Since :

2.3

Sends a command to the windowing environment.

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]

params

Optional parameters for the command.

Since :

2.3

Gets the indicator mode of the window.

Returns:

The mode, one of Elm_Win_Indicator_Mode.

Since :

2.3

Sets the indicator mode of the window.

Parameters:

[in]

mode

The mode, one of Elm_Win_Indicator_Mode.

Since :

2.3

Gets the indicator opacity mode of the window.

Returns:

The mode, one of Elm_Win_Indicator_Opacity_Mode.

Since :

2.3

Sets the indicator opacity mode of the window.

Parameters:

[in]

mode

The mode, one of Elm_Win_Indicator_Opacity_Mode.

Since :

2.3

Gets the inlined image object handle.

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 control of elementary), and use it to do things like get pixel data, save the image to a file, etc.

Returns:

The inlined image object or null if none exists.

Since :

2.3

Gets the keyboard mode of the window.

Returns:

The mode, one of #Elm_Win_Keyboard_Mode.

Since :

2.3

Sets the keyboard mode of the window.

Parameters:

[in]

mode

The mode, one of #Elm_Win_Keyboard_Mode.

Since :

2.3

Gets the layer of the window.

Returns:

The layer of the window.

Since :

2.3

Sets the layer of the window.

What this means exactly will depend on the underlying engine used.

In the case of X11 backed engines, the value in layer has the following meanings - less than 3 means that the window will be placed below all others, more than 5 means that the window will be placed above all others, and anything else means that the window will be placed in the default layer.

Parameters:

[in]

layer

The layer of the window.

Since :

2.3

Lowers a window object.

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 Window Manager may ignore this request.

Since :

2.3

Examples:

win_example.c.

Gets the modal state of a window.

Returns:

If true, the window is modal.

Since :

2.3

Sets the modal state of a window.

Parameters:

[in]

modal

If true, the window is modal.

Since :

2.3

The returns how many times norender has been pushed on the window

Parameters:

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

Since (EFL) :

1.7

Since :

2.3

This pops (decrements) the norender counter on the window

Parameters:

obj	The window object

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

See also:

elm_win_norender_push()

elm_win_norender_get()

elm_win_render()

Since (EFL) :

1.7

Since :

2.3

This pushes (increments) the norender counter on the window

Parameters:

obj	The window object

There are some occasions where you wish to suspend rendering on a window. You may be "sleeping" and 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 have this work.

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

See also:

elm_win_norender_pop()

elm_win_norender_get()

elm_win_render()

Since (EFL) :

1.7

Since :

2.3

Gets the profile of a window.

Returns:

The string value of a window profile.

Since (EFL) :

1.8

Since :

2.3

Sets the profile of a window.

Parameters:

[in]

profile

The string value of a window profile.

Since (EFL) :

1.8

Since :

2.4

This manually asks evas to render the window now

Parameters:

obj	The window object

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

See also:

elm_win_norender_push()

elm_win_norender_pop()

elm_win_norender_get()

Since (EFL) :

1.7

Since :

2.3

Adds subobj as a resize object of window obj.

Setting an object as a resize object of the window means that the subobj child's size and position will be controlled by the window directly. That is, the object will be 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 what the minimum size of it will be, as well as whether it can or not 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 Window 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 the EVAS_HINT_EXPAND is set after the call to this. 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]

subobj

The resize object to add.

Since :

2.3

Examples:

actionslider_example_01.c, bg_example_02.c, bg_example_03.c, box_example_02.c, button_example_01.c, calendar_example_01.c, calendar_example_02.c, calendar_example_03.c, calendar_example_04.c, calendar_example_05.c, calendar_example_06.c, clock_example.c, codegen_example.c, colorselector_example_01.c, combobox_example_01.c, conformant_example_01.c, conformant_example_02.c, ctxpopup_example_01.c, datetime_example.c, dayselector_example.c, diskselector_example_01.c, diskselector_example_02.c, entry_example.c, fileselector_button_example.c, fileselector_entry_example.c, fileselector_example.c, flipselector_example.c, general_funcs_example.c, gengrid_example.c, genlist_example_01.c, genlist_example_02.c, genlist_example_03.c, genlist_example_04.c, genlist_example_05.c, glview_example_01.c, icon_example_01.c, image_example_01.c, index_example_01.c, index_example_02.c, inwin_example.c, layout_example_01.c, layout_example_02.c, layout_example_03.c, list_example_01.c, list_example_02.c, list_example_03.c, location_example_01.c, map_example_01.c, map_example_02.c, map_example_03.c, mapbuf_example.c, menu_example_01.c, naviframe_example.c, notify_example_01.c, panel_example_01.c, panes_example.c, prefs_example_01.c, prefs_example_02.c, progressbar_example.c, radio_example_01.c, scroller_example_01.c, segment_control_example.c, separator_example_01.c, slider_example.c, slideshow_example.c, spinner_example.c, table_example_01.c, table_example_02.c, theme_example_01.c, theme_example_02.c, thumb_example_01.c, toolbar_example_01.c, toolbar_example_02.c, toolbar_example_03.c, track_example_01.c, transit_example_03.c, transit_example_04.c, web_example_02.c, and win_example.c.

Deletes subobj as a resize object of window obj.

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

Parameters:

[in]

subobj

The resize object to add.

Since :

2.3

Gets the rotation of the window.

Returns:

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

Since :

2.3

Examples:

win_example.c.

Sets the rotation of the window.

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 will be resized to adjust to the new geometry of its contents. If you want to keep the window size, see elm_win_rotation_with_resize_set.

Parameters:

[in]

rotation

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

Since :

2.3

Examples:

win_example.c.

Rotates the window and resizes it.

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

Parameters:

[in]

rotation

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

Since :

2.3

Examples:

win_example.c.

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

Parameters:

[out]	xdpi	Pointer to value to store return horizontal dpi. May be null.
[out]	ydpi	Pointer to value to store return vertical dpi. May be null.

Since (EFL) :

1.7

Since :

2.3

Gets the screen position of a window.

Parameters:

[out]	x	The int to store the x coordinate to.
[out]	y	The int to store the y coordinate to.

Since :

2.3

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

Parameters:

[out]	x	Where to return the horizontal offset value. May be null.
[out]	y	Where to return the vertical offset value. May be null.
[out]	w	Where to return the width value. May be null.
[out]	h	Where to return the height value. May be null.

Since :

2.3

Gets the base size of a window.

Parameters:

[out]	w	The base width.
[out]	h	The base height.

Since (EFL) :

1.7

Since :

2.3

Sets the base window size used with stepping calculation.

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

Parameters:

[in]	w	The base width.
[in]	h	The base height.

Since (EFL) :

1.7

Since :

2.3

Gets the stepping of a window.

Parameters:

[out]	w	The stepping width (0 disables).
[out]	h	The stepping height (0 disables).

Since (EFL) :

1.7

Since :

2.3

Sets the window stepping used with sizing calculation.

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

Parameters:

[in]	w	The stepping width (0 disables).
[in]	h	The stepping height (0 disables).

Since (EFL) :

1.7

Since :

2.3

Gets the title of the window.

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

Returns:

The title.

Since :

2.3

Sets the title of the window.

Parameters:

[in]

title

The title.

Since :

2.3

Examples:

bg_example_02.c, codegen_example.c, layout_example_01.c, layout_example_03.c, and win_example.c.

Gets the trap data associated with a window.

Returns:

The trap data of the window.

Since (EFL) :

1.12

Since :

3.0

Sets the trap to be used for internal Ecore_Evas management.

Parameters:

trap	the trap to be used or NULL to remove traps. Pointer is not modified or copied, keep it alive.

Returns:

EINA_TRUE on success, EINA_FALSE if there was a problem, such as invalid version number.

Warning:

this is an advanced feature that you should avoid using.

Since (EFL) :

1.7

Since :

2.3

The type of the window.

It is a hint of how the Window Manager should handle it.

The window type is a constructing property that need to be set at creation within eo_add.

Note:

Once set, it can NOT be modified afterward.

Can only be used at creation time, within eo_add.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	type	Window type

Gets the urgent state of a window.

Returns:

If true, the window is urgent.

Since :

2.3

Sets the urgent state of a window.

Parameters:

[in]

urgent

If true, the window is urgent.

Since :

2.3

Adds a window object with dialog setup

Parameters:

parent	The parent window
name	The name of the window
title	The title for the window

This creates a window like elm_win_add() but also puts in a standard background with elm_bg_add(), as well as setting the window title to title. The window type created is of type ELM_WIN_DIALOG_BASIC. This tipe of window will be handled in special mode by window managers with regards of it's parent window.

Returns:

The created object, or NULL on failure

See also:

elm_win_add()

Since (EFL) :

1.13

Since :

3.0

Adds a window object with standard setup

Parameters:

name	The name of the window
title	The title for the window

This creates a window like elm_win_add() but also puts in a standard background with 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.

Returns:

The created object, or NULL on failure

See also:

elm_win_add()

Since :

2.3

Examples:

actionslider_example_01.c, bg_example_01.c, bg_example_03.c, box_example_02.c, bubble_example_01.c, button_example_00.c, button_example_01.c, calendar_example_01.c, calendar_example_02.c, calendar_example_03.c, calendar_example_04.c, calendar_example_05.c, calendar_example_06.c, check_example_01.c, clock_example.c, codegen_example.c, colorselector_example_01.c, combobox_example_01.c, conformant_example_01.c, conformant_example_02.c, ctxpopup_example_01.c, datetime_example.c, dayselector_example.c, diskselector_example_01.c, diskselector_example_02.c, efl_thread_1.c, efl_thread_2.c, efl_thread_3.c, efl_thread_4.c, efl_thread_5.c, efl_thread_6.c, entry_example.c, fileselector_button_example.c, fileselector_entry_example.c, fileselector_example.c, flip_example_01.c, flipselector_example.c, frame_example_01.c, general_funcs_example.c, gengrid_example.c, genlist_example_01.c, genlist_example_02.c, genlist_example_03.c, genlist_example_04.c, genlist_example_05.c, glview_example_01.c, hover_example_01.c, hoversel_example_01.c, icon_example_01.c, image_example_01.c, index_example_01.c, index_example_02.c, inwin_example.c, label_example_01.c, layout_example_01.c, layout_example_02.c, layout_example_03.c, list_example_01.c, list_example_02.c, list_example_03.c, location_example_01.c, map_example_01.c, map_example_02.c, map_example_03.c, mapbuf_example.c, menu_example_01.c, naviframe_example.c, notify_example_01.c, panel_example_01.c, panes_example.c, photocam_example_01.c, popup_example_01.c, popup_example_02.c, popup_example_03.c, prefs_example_01.c, prefs_example_02.c, prefs_example_03.c, progressbar_example.c, radio_example_01.c, scroller_example_01.c, segment_control_example.c, separator_example_01.c, slider_example.c, slideshow_example.c, spinner_example.c, table_example_01.c, table_example_02.c, theme_example_01.c, theme_example_02.c, thumb_example_01.c, toolbar_example_01.c, toolbar_example_02.c, toolbar_example_03.c, track_example_01.c, transit_example_01.c, transit_example_02.c, transit_example_03.c, transit_example_04.c, web_example_02.c, and win_example.c.

Gets the Ecore_Window of an Evas_Object.

When Elementary is using a Wayland engine, this function will return the surface id of the elm window's surface.

Parameters:

obj	The window object

Returns:

The Ecore_Window of an Evas_Object

Since (EFL) :

1.8

Note:

Unless you are getting the window id for the purpose of communicating between client<->compositor over dbus, this is definitely not the function you are looking for.

Since :

4.0

Gets the withdrawn state of a window.

Returns:

If true, the window is withdrawn.

Since :

2.3

Sets the withdrawn state of a window.

Parameters:

[in]

withdrawn

If true, the window is withdrawn.

Since :

2.3

To notify the rotation done to WM manually.

This function is used to notify the rotation done to WM manually.

Since (EFL) :

1.9

Since :

2.3

Gets the state of manual rotation done mode.

This function is used to get the state of manual rotation done mode.

Returns:

true to set manual rotation done mode, false otherwise.

Since (EFL) :

1.9

Since :

2.3

Sets the manual rotation done mode.

This function is used to set or reset the manual rotation done mode. the message of rotation done is sent to WM after rendering its canvas in Ecore_Evas. but if set the manual rotation done mode, it's disabled and user should call this explicitly to sends the message.

Parameters:

[in]

set

true to set manual rotation done mode, false otherwise.

Since (EFL) :

1.9

Since :

2.3

Gets the preferred rotation value.

This function is used to get the preferred rotation value.

Returns:

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

Since (EFL) :

1.9

Since :

2.3

Queries whether window manager supports window rotation or not.

The window manager rotation allows the WM to controls the rotation of application windows. It is designed to support synchronized rotation for the multiple application windows at same time.

See also elm_win_wm_rotation_preferred_rotation_get, elm_win_wm_rotation_available_rotations_get.

Since (EFL) :

1.9

Since :

2.3