Modules | Data Structures | Typedefs | Enumerations | Functions
Win

Modules

 Inwin
 

Data Structures

struct  _Elm_Win_Trap
 

Typedefs

typedef struct _Elm_Win_Trap Elm_Win_Trap
 Trap can be set with elm_win_trap_set() and will intercept the calls to internal ecore_evas with the same name and parameters. More...
 

Enumerations

enum  Elm_Win_Indicator_Mode {
  ELM_WIN_INDICATOR_UNKNOWN = 0,
  ELM_WIN_INDICATOR_HIDE,
  ELM_WIN_INDICATOR_SHOW
}
 In some environments, like phones, you may have an indicator that shows battery status, reception, time etc. More...
 
enum  Elm_Win_Indicator_Opacity_Mode {
  ELM_WIN_INDICATOR_OPACITY_UNKNOWN = 0,
  ELM_WIN_INDICATOR_OPAQUE,
  ELM_WIN_INDICATOR_TRANSLUCENT,
  ELM_WIN_INDICATOR_TRANSPARENT
}
 Defines the opacity modes of indicator that can be shown. More...
 

Functions

Eina_Bool elm_win_trap_set (const Elm_Win_Trap *trap)
 Sets the trap to be used for internal Ecore_Evas management. More...
 
Evas_Objectelm_win_add (Evas_Object *parent, const char *name, Elm_Win_Type type)
 Adds a window object. More...
 
Evas_Objectelm_win_fake_add (Ecore_Evas *ee)
 Creates a fake window object using a pre-existing canvas. More...
 
Evas_Objectelm_win_util_standard_add (const char *name, const char *title)
 Adds a window object with standard setup. More...
 
Evas_Objectelm_win_util_dialog_add (Evas_Object *parent, const char *name, const char *title)
 Adds a window object with dialog setup. More...
 
Eina_Bool elm_win_autodel_get (const Evas_Object *obj)
 Get the window's autodel state. More...
 
void elm_win_floating_mode_set (Evas_Object *obj, Eina_Bool floating)
 Set the floating mode of a window. More...
 
Eina_Bool elm_win_floating_mode_get (const Evas_Object *obj)
 Get the floating mode of a window. More...
 
void elm_win_norender_push (Evas_Object *obj)
 This pushes (increments) the norender counter on the window. More...
 
void elm_win_norender_pop (Evas_Object *obj)
 This pops (decrements) the norender counter on the window. More...
 
int elm_win_norender_get (const Evas_Object *obj)
 The retruns how many times norender has been pushed on the window. More...
 
void elm_win_render (Evas_Object *obj)
 This manually asks evas to render the window now. More...
 
Ecore_Wl2_Window * elm_win_wl_window_get (const Evas_Object *obj)
 Get the Ecore_Wl_Window of an Evas_Object. More...
 
Ecore_Win32_Windowelm_win_win32_window_get (const Evas_Object *obj)
 Get the Ecore_Win32_Window of an Evas_Object. More...
 
void elm_win_resize_object_add (Evas_Object *obj, Evas_Object *subobj)
 Add subobj as a resize object of window obj. More...
 
void elm_win_resize_object_del (Evas_Object *obj, Evas_Object *subobj)
 Delete subobj as a resize object of window obj. More...
 
Ecore_X_Window elm_win_xwindow_get (const Evas_Object *obj)
 Get the Ecore_X_Window of an Evas_Object.
 
Ecore_Cocoa_Windowelm_win_cocoa_window_get (const Evas_Object *obj)
 Get the Ecore_Cocoa_Window of an Efl.Canvas.Object. More...
 
void * elm_win_trap_data_get (const Evas_Object *obj)
 Get the trap data associated with a window. More...
 
void elm_win_override_set (Evas_Object *obj, Eina_Bool override)
 Set the override state of a window. More...
 
Eina_Bool elm_win_override_get (const Evas_Object *obj)
 Get the override state of a window. More...
 
void elm_win_lower (Evas_Object *obj)
 Lower a window object. More...
 
void elm_win_quickpanel_set (Evas_Object *obj, Eina_Bool quickpanel)
 Set a window to be an illume quickpanel window. More...
 
Eina_Bool elm_win_quickpanel_get (const Evas_Object *obj)
 Get if this window is a quickpanel or not. More...
 
void elm_win_quickpanel_zone_set (Evas_Object *obj, int zone)
 Set which zone this quickpanel should appear in. More...
 
int elm_win_quickpanel_zone_get (const Evas_Object *obj)
 Get which zone this quickpanel should appear in. More...
 
void elm_win_quickpanel_priority_major_set (Evas_Object *obj, int priority)
 Set the major priority of a quickpanel window. More...
 
int elm_win_quickpanel_priority_major_get (const Evas_Object *obj)
 Get the major priority of a quickpanel window. More...
 
void elm_win_quickpanel_priority_minor_set (Evas_Object *obj, int priority)
 Set the minor priority of a quickpanel window. More...
 
int elm_win_quickpanel_priority_minor_get (const Evas_Object *obj)
 Get the minor priority of a quickpanel window. More...
 
void elm_win_indicator_mode_set (Evas_Object *obj, Elm_Win_Indicator_Mode mode)
 Sets the indicator mode of the window. More...
 
Elm_Win_Indicator_Mode elm_win_indicator_mode_get (const Evas_Object *obj)
 Get the indicator mode of the window. More...
 
void elm_win_indicator_opacity_set (Evas_Object *obj, Elm_Win_Indicator_Opacity_Mode mode)
 Sets the indicator opacity mode of the window. More...
 
Elm_Win_Indicator_Opacity_Mode elm_win_indicator_opacity_get (const Evas_Object *obj)
 Get the indicator opacity mode of the window. More...
 
void elm_win_keyboard_win_set (Evas_Object *obj, Eina_Bool is_keyboard)
 Sets whether the window is a keyboard. More...
 
Eina_Bool elm_win_keyboard_win_get (const Evas_Object *obj)
 Get whether the window is a keyboard. More...
 
void elm_win_conformant_set (Evas_Object *obj, Eina_Bool conformant)
 Set if this window is an illume conformant window. More...
 
Eina_Bool elm_win_conformant_get (const Evas_Object *obj)
 Get if this window is an illume conformant window. More...
 
void elm_win_wm_rotation_manual_rotation_done_set (Evas_Object *obj, Eina_Bool set)
 Set the manual rotation done mode. More...
 
Eina_Bool elm_win_wm_rotation_manual_rotation_done_get (const Evas_Object *obj)
 Get the state of manual rotation done mode. More...
 
void elm_win_wm_rotation_manual_rotation_done (Evas_Object *obj)
 To notify the rotation done to WM manually. More...
 
void elm_win_rotation_set (Evas_Object *obj, int rotation)
 Set the rotation of the window. More...
 
int elm_win_rotation_get (const Evas_Object *obj)
 Get the rotation of the window. More...
 
void elm_win_rotation_with_resize_set (Evas_Object *obj, int rotation)
 Rotates the window and resizes it. More...
 
Eina_Bool elm_win_wm_rotation_supported_get (const Evas_Object *obj)
 Query whether window manager supports window rotation or not. More...
 
int elm_win_wm_rotation_preferred_rotation_get (const Evas_Object *obj)
 Get the preferred rotation value. More...
 
void elm_win_screen_position_get (const Evas_Object *obj, int *x, int *y)
 Get the screen position of a window. More...
 
void elm_win_screen_size_get (const Evas_Object *obj, int *x, int *y, int *w, int *h)
 Get screen geometry details for the screen that a window is on. More...
 
void elm_win_screen_dpi_get (const Evas_Object *obj, int *xdpi, int *ydpi)
 Get screen dpi for the screen that a window is on. More...
 
void elm_win_icon_name_set (Evas_Object *obj, const char *icon_name)
 Set the icon name of the window. More...
 
const char * elm_win_icon_name_get (const Evas_Object *obj)
 Get the icon name of the window. More...
 
void elm_win_withdrawn_set (Evas_Object *obj, Eina_Bool withdrawn)
 Set the withdrawn state of a window. More...
 
Eina_Bool elm_win_withdrawn_get (const Evas_Object *obj)
 Get the withdrawn state of a window. More...
 
void elm_win_urgent_set (Evas_Object *obj, Eina_Bool urgent)
 Set the urgent state of a window. More...
 
Eina_Bool elm_win_urgent_get (const Evas_Object *obj)
 Get the urgent state of a window. More...
 
void elm_win_demand_attention_set (Evas_Object *obj, Eina_Bool demand_attention)
 Set the demand_attention state of a window. More...
 
Eina_Bool elm_win_demand_attention_get (const Evas_Object *obj)
 Get the demand_attention state of a window. More...
 
void elm_win_modal_set (Evas_Object *obj, Eina_Bool modal)
 Set the modal state of a window. More...
 
Eina_Bool elm_win_modal_get (const Evas_Object *obj)
 Get the modal state of a window. More...
 
void elm_win_shaped_set (Evas_Object *obj, Eina_Bool shaped)
 Set the shaped state of a window. More...
 
Eina_Bool elm_win_shaped_get (const Evas_Object *obj)
 Get the shaped state of a window. More...
 
void elm_win_title_set (Evas_Object *obj, const char *title)
 Set the title of the window. More...
 
const char * elm_win_title_get (const Evas_Object *obj)
 Get the title of the window. More...
 
void elm_win_size_base_set (Evas_Object *obj, int w, int h)
 Set the base window size used with stepping calculation. More...
 
void elm_win_size_base_get (const Evas_Object *obj, int *w, int *h)
 Get the base size of a window. More...
 
void elm_win_size_step_set (Evas_Object *obj, int w, int h)
 Set the window stepping used with sizing calculation. More...
 
void elm_win_size_step_get (const Evas_Object *obj, int *w, int *h)
 Get the stepping of a window. More...
 
void elm_win_illume_command_send (Evas_Object *obj, Elm_Illume_Command command, void *params)
 Send a command to the windowing environment. More...
 
void elm_win_profile_set (Evas_Object *obj, const char *profile)
 Set the profile of a window. More...
 
const char * elm_win_profile_get (const Evas_Object *obj)
 Get the profile of a window. More...
 
void elm_win_layer_set (Evas_Object *obj, int layer)
 Set the layer of the window. More...
 
int elm_win_layer_get (const Evas_Object *obj)
 Get the layer of the window. More...
 
Evas_Objectelm_win_inlined_image_object_get (const Evas_Object *obj)
 Get the inlined image object handle. More...
 
void elm_win_fake_canvas_set (Evas_Object *obj, Ecore_Evas *oee) EINA_DEPRECATED
 Internal. More...
 
Ecore_Window elm_win_window_id_get (const Evas_Object *obj)
 Get the Ecore_Window of an Evas_Object. More...
 
Evas_Objectelm_win_main_menu_get (Evas_Object *obj)
 Get the Main Menu of a window. More...
 
void elm_win_keyboard_mode_set (Elm_Win *obj, Elm_Win_Keyboard_Mode mode)
 Sets the keyboard mode of the window. More...
 
Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get (const Elm_Win *obj)
 Get the keyboard mode of the window. More...
 
void elm_win_autodel_set (Evas_Object *obj, Eina_Bool autodel)
 Set the window's autodel state. More...
 
static void efl_ui_win_autodel_set (Efl_Ui_Win *obj, Eina_Bool autodel)
 Set the window's autodel state. More...
 
static Eina_Bool efl_ui_win_autodel_get (const Efl_Ui_Win *obj)
 Get the window's autodel state. More...
 

Detailed Description

win_inheritance_tree.png
preview-00.png

The window class of Elementary. Contains functions to manipulate windows. The Evas engine used to render the window contents is specified in the system or user elementary config files (whichever is found last), and can be overridden with the ELM_ENGINE environment variable for testing. Engines that may be supported (depending on Evas and Ecore-Evas compilation setup and modules actually installed at runtime) are (listed in order of best supported and most likely to be complete and work to lowest quality). Note that ELM_ENGINE is really only needed for special cases and debugging. you should normally use ELM_DISPLAY and ELM_ACCEL environment variables, or core elementary config. ELM_DISPLAY can be set to "x11" or "wl" to indicate the target display system (as on Linux systems you may have both display systems available, so this selects which to use). ELM_ACCEL may also be set to indicate if you want accelerations and which kind to use. see elm_config_accel_preference_set(0 for details on this environment variable values.

All engines use a simple string to select the engine to render, EXCEPT the "shot" engine. This actually encodes the output of the virtual screenshot and how long to delay in the engine string. The engine string is encoded in the following way:

"shot:[delay=XX][:][repeat=DDD][:][file=XX]"

Where options are separated by a ":" char if more than one option is given, with delay, if provided being the first option and file the last (order is important). The delay specifies how long to wait after the window is shown before doing the virtual "in memory" rendering and then save the output to the file specified by the file option (and then exit). If no delay is given, the default is 0.5 seconds. If no file is given the default output file is "out.png". Repeat option is for continuous capturing screenshots. Repeat range is from 1 to 999 and filename is fixed to "out001.png" Some examples of using the shot engine:

ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test ELM_ENGINE="shot:file=elm_test2.png" elementary_test ELM_ENGINE="shot:delay=2.0" elementary_test ELM_ENGINE="shot:" elementary_test

Signals that you can add callbacks for are:

Note that calling evas_object_show() after window contents creation is recommended. It will trigger evas_smart_objects_calculate() and some backend calls directly. For example, XMapWindow is called directly during evas_object_show() in X11 engine.

Examples:

Typedef Documentation

◆ Elm_Win_Trap

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
1.7

Enumeration Type Documentation

◆ Elm_Win_Indicator_Mode

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

◆ Elm_Win_Indicator_Opacity_Mode

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.

Transparentizes the indicator

Function Documentation

◆ elm_win_trap_set()

Eina_Bool elm_win_trap_set ( const Elm_Win_Trap trap)

Sets the trap to be used for internal Ecore_Evas management.

Parameters
trapthe 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
1.7

References DBG, EINA_FALSE, and EINA_TRUE.

◆ elm_win_autodel_set()

void elm_win_autodel_set ( Evas_Object obj,
Eina_Bool  autodel 
)

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]objThe object.
[in]autodelIf true, the window will automatically delete itself when closed.

Referenced by efl_ui_win_autodel_set().

◆ elm_win_add()

Evas_Object* elm_win_add ( Evas_Object parent,
const char *  name,
Elm_Win_Type  type 
)

Adds a window object.

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

Parameters
parentParent object to add the window to, or NULL
nameThe name of the window
typeThe 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

Referenced by elm_quicklaunch_seed().

◆ elm_win_fake_add()

Evas_Object* elm_win_fake_add ( Ecore_Evas *  ee)

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

Parameters
eeThe 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
1.13

◆ elm_win_util_standard_add()

Evas_Object* elm_win_util_standard_add ( const char *  name,
const char *  title 
)

Adds a window object with standard setup.

Parameters
nameThe name of the window
titleThe 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()

◆ elm_win_util_dialog_add()

Evas_Object* elm_win_util_dialog_add ( Evas_Object parent,
const char *  name,
const char *  title 
)

Adds a window object with dialog setup.

Parameters
parentThe parent window
nameThe name of the window
titleThe 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
1.13

◆ elm_win_autodel_get()

Eina_Bool elm_win_autodel_get ( const Evas_Object obj)

Get the window's autodel state.

Parameters
[in]objThe object.
Returns
If true, the window will automatically delete itself when closed.

References efl_data_scope_safe_get(), and EINA_FALSE.

◆ elm_win_floating_mode_set()

void elm_win_floating_mode_set ( Evas_Object obj,
Eina_Bool  floating 
)

Set the floating mode of a window.

Parameters
objThe window object
floatingIf 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
1.8

References efl_data_scope_safe_get().

◆ elm_win_floating_mode_get()

Eina_Bool elm_win_floating_mode_get ( const Evas_Object obj)

Get the floating mode of a window.

Parameters
objThe window object
Returns
If true, the window is floating mode
See also
elm_win_floating_mode_set()
Since
1.8

References efl_data_scope_safe_get(), and EINA_FALSE.

◆ elm_win_norender_push()

void elm_win_norender_push ( Evas_Object obj)

This pushes (increments) the norender counter on the window.

Parameters
objThe 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
1.7

References ecore_evas_manual_render_set(), efl_data_scope_safe_get(), and EINA_TRUE.

◆ elm_win_norender_pop()

void elm_win_norender_pop ( Evas_Object obj)

This pops (decrements) the norender counter on the window.

Parameters
objThe 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
1.7

References ecore_evas_manual_render_set(), efl_data_scope_safe_get(), and EINA_FALSE.

◆ elm_win_norender_get()

int elm_win_norender_get ( const Evas_Object obj)

The retruns how many times norender has been pushed on the window.

Parameters
objThe 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
1.7

References efl_data_scope_safe_get().

◆ elm_win_render()

void elm_win_render ( Evas_Object obj)

This manually asks evas to render the window now.

Parameters
objThe 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
1.7

References ecore_evas_manual_render(), and efl_data_scope_safe_get().

◆ elm_win_wl_window_get()

Ecore_Wl2_Window* elm_win_wl_window_get ( const Evas_Object obj)

Get the Ecore_Wl_Window of an Evas_Object.

Get the Ecore_Wl2_Window of an Evas_Object.

Do not use this function if you'd like your application/library be portable. You have been warned.

Parameters
objthe object
Returns
The Ecore_Wl_Window of obj
The Ecore_Wl2_Window of obj.

Get the Ecore_Wl_Window of an Evas_Object.

Returns
The Ecore_Wl2_Window of obj.

References ecore_evas_ecore_evas_get(), efl_data_scope_safe_get(), elm_win_wl_window_get(), and evas_object_smart_type_check_ptr().

Referenced by elm_win_wl_window_get().

◆ elm_win_win32_window_get()

Ecore_Win32_Window* elm_win_win32_window_get ( const Evas_Object obj)

Get the Ecore_Win32_Window of an Evas_Object.

Do not use this function if you'd like your application/library be portable. You have been warned.

Parameters
objthe object
Returns
The Ecore_Win32_Window of obj
Since
1.16
Returns
The Ecore_Win32_Window of obj.
Since
1.17

References ecore_evas_ecore_evas_get(), ecore_evas_engine_name_get(), efl_data_scope_safe_get(), elm_win_win32_window_get(), and evas_object_smart_type_check_ptr().

Referenced by elm_win_win32_window_get().

◆ elm_win_resize_object_add()

void elm_win_resize_object_add ( Evas_Object obj,
Evas_Object subobj 
)

Add 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]subobjThe resize object to add.

References efl_data_scope_safe_get(), efl_isa(), and ERR.

Referenced by elm_quicklaunch_seed().

◆ elm_win_resize_object_del()

void elm_win_resize_object_del ( Evas_Object obj,
Evas_Object subobj 
)

Delete 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]subobjThe resize object to add.

References efl_data_scope_safe_get(), and ERR.

◆ elm_win_cocoa_window_get()

Ecore_Cocoa_Window* elm_win_cocoa_window_get ( const Evas_Object obj)

Get the Ecore_Cocoa_Window of an Efl.Canvas.Object.

Returns
The Ecore_Cocoa_Window of obj.
Since
1.17

References ecore_evas_ecore_evas_get(), efl_data_scope_safe_get(), and elm_win_cocoa_window_get().

Referenced by elm_win_cocoa_window_get().

◆ elm_win_trap_data_get()

void* elm_win_trap_data_get ( const Evas_Object obj)

Get the trap data associated with a window.

Returns
The trap data of the window.
Since
1.12

References efl_data_scope_safe_get().

◆ elm_win_override_set()

void elm_win_override_set ( Evas_Object obj,
Eina_Bool  override 
)

Set the override state of a window.

A window with override set to true will not be managed by the Window Manager. This means that no decorations of any kind will be 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 when there's a good reason and with a lot of care. Mishandling override windows may result situations that disrupt the normal workflow of the end user.

Parameters
[in]overrideIf true, the window is overridden.

References efl_data_scope_safe_get().

◆ elm_win_override_get()

Eina_Bool elm_win_override_get ( const Evas_Object obj)

Get the override state of a window.

Returns
If true, the window is overridden.

References ecore_evas_override_get(), efl_data_scope_safe_get(), and EINA_FALSE.

◆ elm_win_lower()

void elm_win_lower ( Evas_Object obj)

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

References efl_data_scope_safe_get().

◆ elm_win_quickpanel_set()

void elm_win_quickpanel_set ( Evas_Object obj,
Eina_Bool  quickpanel 
)

Set a window to be an illume quickpanel window.

By default window objects are not quickpanel windows.

Parameters
[in]quickpanelThe quickpanel flag.

References efl_data_scope_safe_get().

◆ elm_win_quickpanel_get()

Eina_Bool elm_win_quickpanel_get ( const Evas_Object obj)

Get if this window is a quickpanel or not.

Returns
The quickpanel flag.

References efl_data_scope_safe_get(), and EINA_FALSE.

◆ elm_win_quickpanel_zone_set()

void elm_win_quickpanel_zone_set ( Evas_Object obj,
int  zone 
)

Set which zone this quickpanel should appear in.

Parameters
[in]zoneThe requested zone for this quickpanel.

References efl_data_scope_safe_get().

◆ elm_win_quickpanel_zone_get()

int elm_win_quickpanel_zone_get ( const Evas_Object obj)

Get which zone this quickpanel should appear in.

Returns
The requested zone for this quickpanel.

References efl_data_scope_safe_get().

◆ elm_win_quickpanel_priority_major_set()

void elm_win_quickpanel_priority_major_set ( Evas_Object obj,
int  priority 
)

Set the major priority of a quickpanel window.

Parameters
[in]priorityThe major priority for this quickpanel or -1.

References efl_data_scope_safe_get().

◆ elm_win_quickpanel_priority_major_get()

int elm_win_quickpanel_priority_major_get ( const Evas_Object obj)

Get the major priority of a quickpanel window.

Returns
The major priority for this quickpanel or -1.

References efl_data_scope_safe_get().

◆ elm_win_quickpanel_priority_minor_set()

void elm_win_quickpanel_priority_minor_set ( Evas_Object obj,
int  priority 
)

Set the minor priority of a quickpanel window.

Parameters
[in]priorityThe minor priority for this quickpanel.

References efl_data_scope_safe_get().

◆ elm_win_quickpanel_priority_minor_get()

int elm_win_quickpanel_priority_minor_get ( const Evas_Object obj)

Get the minor priority of a quickpanel window.

Returns
The minor priority for this quickpanel.

References efl_data_scope_safe_get().

◆ elm_win_indicator_mode_set()

void elm_win_indicator_mode_set ( Evas_Object obj,
Elm_Win_Indicator_Mode  mode 
)

Sets the indicator mode of the window.

Parameters
[in]modeThe mode, one of Elm_Win_Indicator_Mode.

References efl_data_scope_safe_get(), and ELM_WIN_INDICATOR_SHOW.

◆ elm_win_indicator_mode_get()

Elm_Win_Indicator_Mode elm_win_indicator_mode_get ( const Evas_Object obj)

Get the indicator mode of the window.

Returns
The mode, one of Elm_Win_Indicator_Mode.

References efl_data_scope_safe_get().

◆ elm_win_indicator_opacity_set()

void elm_win_indicator_opacity_set ( Evas_Object obj,
Elm_Win_Indicator_Opacity_Mode  mode 
)

Sets the indicator opacity mode of the window.

Parameters
[in]modeThe mode, one of Elm_Win_Indicator_Opacity_Mode.

References efl_data_scope_safe_get(), and ELM_WIN_INDICATOR_OPAQUE.

◆ elm_win_indicator_opacity_get()

Elm_Win_Indicator_Opacity_Mode elm_win_indicator_opacity_get ( const Evas_Object obj)

Get the indicator opacity mode of the window.

Returns
The mode, one of Elm_Win_Indicator_Opacity_Mode.

References efl_data_scope_safe_get().

◆ elm_win_keyboard_win_set()

void elm_win_keyboard_win_set ( Evas_Object obj,
Eina_Bool  is_keyboard 
)

Sets whether the window is a keyboard.

Parameters
[in]modeIf true, the window is a virtual keyboard..

References efl_data_scope_safe_get().

◆ elm_win_keyboard_win_get()

Eina_Bool elm_win_keyboard_win_get ( const Evas_Object obj)

Get whether the window is a keyboard.

Returns
The mode, If true, the window is a virtual keyboard..

References efl_data_scope_safe_get(), and EINA_FALSE.

◆ elm_win_conformant_set()

void elm_win_conformant_set ( Evas_Object obj,
Eina_Bool  conformant 
)

Set if this window is an illume conformant window.

Parameters
[in]conformantThe conformant flag.

References efl_data_scope_safe_get().

◆ elm_win_conformant_get()

Eina_Bool elm_win_conformant_get ( const Evas_Object obj)

Get if this window is an illume conformant window.

Returns
The conformant flag.

References efl_data_scope_safe_get(), and EINA_FALSE.

◆ elm_win_wm_rotation_manual_rotation_done_set()

void elm_win_wm_rotation_manual_rotation_done_set ( Evas_Object obj,
Eina_Bool  set 
)

Set 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]settrue to set manual rotation done mode, false otherwise.
Since
1.9

References ecore_evas_wm_rotation_manual_rotation_done_set(), and efl_data_scope_safe_get().

◆ elm_win_wm_rotation_manual_rotation_done_get()

Eina_Bool elm_win_wm_rotation_manual_rotation_done_get ( const Evas_Object obj)

Get 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
1.9

References ecore_evas_wm_rotation_manual_rotation_done_get(), efl_data_scope_safe_get(), and EINA_FALSE.

◆ elm_win_wm_rotation_manual_rotation_done()

void elm_win_wm_rotation_manual_rotation_done ( Evas_Object obj)

To notify the rotation done to WM manually.

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

Since
1.9

References ecore_evas_wm_rotation_manual_rotation_done(), and efl_data_scope_safe_get().

◆ elm_win_rotation_set()

void elm_win_rotation_set ( Evas_Object obj,
int  rotation 
)

Set 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]rotationThe rotation of the window, in degrees (0-360), counter-clockwise.

References efl_data_scope_safe_get(), and EINA_FALSE.

◆ elm_win_rotation_get()

int elm_win_rotation_get ( const Evas_Object obj)

Get the rotation of the window.

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

References efl_data_scope_safe_get().

◆ elm_win_rotation_with_resize_set()

void elm_win_rotation_with_resize_set ( Evas_Object obj,
int  rotation 
)

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]rotationThe rotation of the window in degrees (0-360), counter-clockwise.

References efl_data_scope_safe_get(), and EINA_TRUE.

◆ elm_win_wm_rotation_supported_get()

Eina_Bool elm_win_wm_rotation_supported_get ( const Evas_Object obj)

Query 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
1.9

References efl_data_scope_safe_get(), and EINA_FALSE.

◆ elm_win_wm_rotation_preferred_rotation_get()

int elm_win_wm_rotation_preferred_rotation_get ( const Evas_Object obj)

Get 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
1.9

References efl_data_scope_safe_get().

◆ elm_win_screen_position_get()

void elm_win_screen_position_get ( const Evas_Object obj,
int *  x,
int *  y 
)

Get the screen position of a window.

Parameters
[out]xThe int to store the x coordinate to.
[out]yThe int to store the y coordinate to.

References efl_data_scope_safe_get().

◆ elm_win_screen_size_get()

void elm_win_screen_size_get ( const Evas_Object obj,
int *  x,
int *  y,
int *  w,
int *  h 
)

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

Parameters
[out]xWhere to return the horizontal offset value. May be null.
[out]yWhere to return the vertical offset value. May be null.
[out]wWhere to return the width value. May be null.
[out]hWhere to return the height value. May be null.

References ecore_evas_screen_geometry_get(), and efl_data_scope_safe_get().

◆ elm_win_screen_dpi_get()

void elm_win_screen_dpi_get ( const Evas_Object obj,
int *  xdpi,
int *  ydpi 
)

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

Parameters
[out]xdpiPointer to value to store return horizontal dpi. May be null.
[out]ydpiPointer to value to store return vertical dpi. May be null.
Since
1.7

References ecore_evas_screen_dpi_get(), and efl_data_scope_safe_get().

◆ elm_win_icon_name_set()

void elm_win_icon_name_set ( Evas_Object obj,
const char *  icon_name 
)

Set the icon name of the window.

Parameters
[in]icon_nameThe icon name to set.

References efl_data_scope_safe_get().

◆ elm_win_icon_name_get()

const char* elm_win_icon_name_get ( const Evas_Object obj)

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

References efl_data_scope_safe_get().

◆ elm_win_withdrawn_set()

void elm_win_withdrawn_set ( Evas_Object obj,
Eina_Bool  withdrawn 
)

Set the withdrawn state of a window.

Parameters
[in]withdrawnIf true, the window is withdrawn.

References efl_data_scope_safe_get().

◆ elm_win_withdrawn_get()

Eina_Bool elm_win_withdrawn_get ( const Evas_Object obj)

Get the withdrawn state of a window.

Returns
If true, the window is withdrawn.

References efl_data_scope_safe_get(), and EINA_FALSE.

◆ elm_win_urgent_set()

void elm_win_urgent_set ( Evas_Object obj,
Eina_Bool  urgent 
)

Set the urgent state of a window.

Parameters
[in]urgentIf true, the window is urgent.

References efl_data_scope_safe_get().

◆ elm_win_urgent_get()

Eina_Bool elm_win_urgent_get ( const Evas_Object obj)

Get the urgent state of a window.

Returns
If true, the window is urgent.

References efl_data_scope_safe_get(), and EINA_FALSE.

◆ elm_win_demand_attention_set()

void elm_win_demand_attention_set ( Evas_Object obj,
Eina_Bool  demand_attention 
)

Set the demand_attention state of a window.

Parameters
[in]demand_attentionIf true, the window is demand_attention.

References efl_data_scope_safe_get().

◆ elm_win_demand_attention_get()

Eina_Bool elm_win_demand_attention_get ( const Evas_Object obj)

Get the demand_attention state of a window.

Returns
If true, the window is demand_attention.

References efl_data_scope_safe_get(), and EINA_FALSE.

◆ elm_win_modal_set()

void elm_win_modal_set ( Evas_Object obj,
Eina_Bool  modal 
)

Set the modal state of a window.

Parameters
[in]modalIf true, the window is modal.

◆ elm_win_modal_get()

Eina_Bool elm_win_modal_get ( const Evas_Object obj)

Get the modal state of a window.

Returns
If true, the window is modal.

◆ elm_win_shaped_set()

void elm_win_shaped_set ( Evas_Object obj,
Eina_Bool  shaped 
)

Set the shaped state of a window.

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

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

Parameters
[in]shapedIf true, the window is shaped.

References efl_data_scope_safe_get().

◆ elm_win_shaped_get()

Eina_Bool elm_win_shaped_get ( const Evas_Object obj)

Get the shaped state of a window.

Returns
If true, the window is shaped.

References ecore_evas_shaped_get(), efl_data_scope_safe_get(), and EINA_FALSE.

◆ elm_win_title_set()

void elm_win_title_set ( Evas_Object obj,
const char *  title 
)

Set the title of the window.

Parameters
[in]titleThe title.

◆ elm_win_title_get()

const char* elm_win_title_get ( const Evas_Object obj)

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

◆ elm_win_size_base_set()

void elm_win_size_base_set ( Evas_Object obj,
int  w,
int  h 
)

Set the base window size used with stepping calculation.

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

Parameters
[in]wThe base width.
[in]hThe base height.
Since
1.7

◆ elm_win_size_base_get()

void elm_win_size_base_get ( const Evas_Object obj,
int *  w,
int *  h 
)

Get the base size of a window.

Parameters
[out]wThe base width.
[out]hThe base height.
Since
1.7

◆ elm_win_size_step_set()

void elm_win_size_step_set ( Evas_Object obj,
int  w,
int  h 
)

Set the window stepping used with sizing calculation.

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

Parameters
[in]wThe stepping width (0 disables).
[in]hThe stepping height (0 disables).
Since
1.7

◆ elm_win_size_step_get()

void elm_win_size_step_get ( const Evas_Object obj,
int *  w,
int *  h 
)

Get the stepping of a window.

Parameters
[out]wThe stepping width (0 disables).
[out]hThe stepping height (0 disables).
Since
1.7

◆ elm_win_illume_command_send()

void elm_win_illume_command_send ( Evas_Object obj,
Elm_Illume_Command  command,
void *  params 
)

Send 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]paramsOptional parameters for the command.

References efl_data_scope_safe_get().

◆ elm_win_profile_set()

void elm_win_profile_set ( Evas_Object obj,
const char *  profile 
)

Set the profile of a window.

Parameters
[in]profileThe string value of a window profile.
Since
1.8

References ecore_evas_window_profile_set(), ecore_evas_window_profile_supported_get(), efl_data_scope_safe_get(), and eina_array_count().

◆ elm_win_profile_get()

const char* elm_win_profile_get ( const Evas_Object obj)

Get the profile of a window.

Returns
The string value of a window profile.
Since
1.8

References efl_data_scope_safe_get().

◆ elm_win_layer_set()

void elm_win_layer_set ( Evas_Object obj,
int  layer 
)

Set 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]layerThe layer of the window.

References efl_data_scope_safe_get().

◆ elm_win_layer_get()

int elm_win_layer_get ( const Evas_Object obj)

Get the layer of the window.

Returns
The layer of the window.

References ecore_evas_layer_get(), and efl_data_scope_safe_get().

◆ elm_win_inlined_image_object_get()

Evas_Object* elm_win_inlined_image_object_get ( const Evas_Object obj)

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

References efl_data_scope_safe_get().

Referenced by elm_object_focus_set().

◆ elm_win_fake_canvas_set()

void elm_win_fake_canvas_set ( Evas_Object obj,
Ecore_Evas *  oee 
)

Internal.

Used to complete the fake window type.

Parameters
[in]oee
Deprecated:

References ERR.

◆ elm_win_window_id_get()

Ecore_Window elm_win_window_id_get ( const Evas_Object obj)

Get 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
objThe window object
Returns
The Ecore_Window of an Evas_Object
Since
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.

References ecore_evas_ecore_evas_get(), ecore_evas_window_get(), efl_data_scope_safe_get(), and evas_object_smart_type_check_ptr().

◆ elm_win_main_menu_get()

Evas_Object* elm_win_main_menu_get ( Evas_Object obj)

Get the Main Menu of a window.

Returns
The Main Menu of the window ($null on error).

References efl_data_scope_safe_get(), EINA_FALSE, EINA_TRUE, and elm_menu_add().

◆ elm_win_keyboard_mode_set()

void elm_win_keyboard_mode_set ( Elm_Win *  obj,
Elm_Win_Keyboard_Mode  mode 
)

Sets the keyboard mode of the window.

Parameters
[in]modeThe mode, one of #Elm_Win_Keyboard_Mode.

◆ elm_win_keyboard_mode_get()

Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get ( const Elm_Win *  obj)

Get the keyboard mode of the window.

Returns
The mode, one of #Elm_Win_Keyboard_Mode.

◆ efl_ui_win_autodel_set()

static void efl_ui_win_autodel_set ( Efl_Ui_Win *  obj,
Eina_Bool  autodel 
)
inlinestatic

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]objThe object.
[in]autodelIf true, the window will automatically delete itself when closed.

Note: This function is only available in C.

References elm_win_autodel_set().

◆ efl_ui_win_autodel_get()

static Eina_Bool efl_ui_win_autodel_get ( const Efl_Ui_Win *  obj)
inlinestatic

Get the window's autodel state.

Parameters
[in]objThe object.
Returns
If true, the window will automatically delete itself when closed.

Note: This function is only available in C.