Tizen Native API
Functions | Typedefs
Win
Elementary Widgets

Functions

void elm_win_profiles_set (Evas_Object *obj, const char **profiles, unsigned int num_profiles)
 Sets the profile list of a window.
void elm_win_keyboard_win_set (Elm_Win *obj, Eina_Bool is_keyboard)
 Sets whether the window is a keyboard.
Eina_Bool elm_win_keyboard_win_get (const Elm_Win *obj)
 Get whether the window is a keyboard.
void elm_win_autodel_set (Elm_Win *obj, Eina_Bool autodel)
 Set the window's autodel state.
Eina_Bool elm_win_autodel_get (const Elm_Win *obj)
 Get the window's autodel state.
void elm_win_override_set (Elm_Win *obj, Eina_Bool override)
 Set the override state of a window.
Eina_Bool elm_win_override_get (const Elm_Win *obj)
 Get the override state of a window.
void elm_win_iconified_set (Elm_Win *obj, Eina_Bool iconified)
 Set the iconified state of a window.
Eina_Bool elm_win_iconified_get (const Elm_Win *obj)
 Get the iconified state of a window.
void elm_win_wm_rotation_available_rotations_set (Elm_Win *obj, const int *rotations, unsigned int count)
Eina_Bool elm_win_wm_rotation_available_rotations_get (const Elm_Win *obj, int **rotations, unsigned int *count)
void elm_win_quickpanel_zone_set (Elm_Win *obj, int zone)
 Set which zone this quickpanel should appear in.
int elm_win_quickpanel_zone_get (const Elm_Win *obj)
 Get which zone this quickpanel should appear in.
void elm_win_maximized_set (Elm_Win *obj, Eina_Bool maximized)
 Set the maximized state of a window.
Eina_Bool elm_win_maximized_get (const Elm_Win *obj)
 Get the maximized state of a window.
void elm_win_modal_set (Elm_Win *obj, Eina_Bool modal)
 Set the modal state of a window.
Eina_Bool elm_win_modal_get (const Elm_Win *obj)
 Get the modal state of a window.
void elm_win_icon_name_set (Elm_Win *obj, const char *icon_name)
 Set the icon name of the window.
const char * elm_win_icon_name_get (const Elm_Win *obj)
 Get the icon name of the window.
void elm_win_withdrawn_set (Elm_Win *obj, Eina_Bool withdrawn)
 Set the withdrawn state of a window.
Eina_Bool elm_win_withdrawn_get (const Elm_Win *obj)
 Get the withdrawn state of a window.
void elm_win_role_set (Elm_Win *obj, const char *role)
 Set the role of the window.
const char * elm_win_role_get (const Elm_Win *obj)
 Get the role of the window.
void elm_win_size_step_set (Elm_Win *obj, int w, int h)
 Set the window stepping used with sizing calculation.
void elm_win_size_step_get (const Elm_Win *obj, int *w, int *h)
 Get the stepping of a window.
void elm_win_focus_highlight_style_set (Elm_Win *obj, const char *style)
 Set the style for the focus highlight on this window.
const char * elm_win_focus_highlight_style_get (const Elm_Win *obj)
 Get the style set for the focus highlight object.
void elm_win_borderless_set (Elm_Win *obj, Eina_Bool borderless)
 Set the borderless state of a window.
Eina_Bool elm_win_borderless_get (const Elm_Win *obj)
 Get the borderless state of a window.
void elm_win_screen_constrain_set (Elm_Win *obj, Eina_Bool constrain)
 Constrain the maximum width and height of a window to the width and height of its screen.
Eina_Bool elm_win_screen_constrain_get (const Elm_Win *obj)
 Get the constraints on the maximum width and height of a window relative to the width and height of its screen.
void elm_win_focus_highlight_enabled_set (Elm_Win *obj, Eina_Bool enabled)
 Set the enabled status for the focus highlight in a window.
Eina_Bool elm_win_focus_highlight_enabled_get (const Elm_Win *obj)
 Get the enabled value of the focus highlight for this window.
void elm_win_title_set (Elm_Win *obj, const char *title)
 Set the title of the window.
const char * elm_win_title_get (const Elm_Win *obj)
 Get the title of the window.
void elm_win_alpha_set (Elm_Win *obj, Eina_Bool alpha)
 Set the alpha channel state of a window.
Eina_Bool elm_win_alpha_get (const Elm_Win *obj)
 Get the alpha channel state of a window.
void elm_win_urgent_set (Elm_Win *obj, Eina_Bool urgent)
 Set the urgent state of a window.
Eina_Bool elm_win_urgent_get (const Elm_Win *obj)
 Get the urgent state of a window.
void elm_win_rotation_set (Elm_Win *obj, int rotation)
 Set the rotation of the window.
int elm_win_rotation_get (const Elm_Win *obj)
 Get the rotation of the window.
void elm_win_icon_object_set (Elm_Win *obj, Evas_Object *icon)
 Set a window object's icon.
const Evas_Object * elm_win_icon_object_get (const Elm_Win *obj)
 Get the icon object used for the window.
void elm_win_quickpanel_priority_minor_set (Elm_Win *obj, int priority)
 Set the minor priority of a quickpanel window.
int elm_win_quickpanel_priority_minor_get (const Elm_Win *obj)
 Get the minor priority of a quickpanel window.
void elm_win_sticky_set (Elm_Win *obj, Eina_Bool sticky)
 Set the sticky state of the window.
Eina_Bool elm_win_sticky_get (const Elm_Win *obj)
 Get the sticky state of the window.
void elm_win_keyboard_mode_set (Elm_Win *obj, Elm_Win_Keyboard_Mode mode)
 Sets the keyboard mode of the window.
Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get (const Elm_Win *obj)
 Get the keyboard mode of the window.
void elm_win_aspect_set (Elm_Win *obj, double aspect)
 Set the aspect ratio of a window.
double elm_win_aspect_get (const Elm_Win *obj)
 Get the aspect ratio of a window.
void elm_win_quickpanel_priority_major_set (Elm_Win *obj, int priority)
 Set the major priority of a quickpanel window.
int elm_win_quickpanel_priority_major_get (const Elm_Win *obj)
 Get the major priority of a quickpanel window.
void elm_win_indicator_opacity_set (Elm_Win *obj, Elm_Win_Indicator_Opacity_Mode mode)
 Sets the indicator opacity mode of the window.
Elm_Win_Indicator_Opacity_Mode elm_win_indicator_opacity_get (const Elm_Win *obj)
 Get the indicator opacity mode of the window.
void elm_win_demand_attention_set (Elm_Win *obj, Eina_Bool demand_attention)
 Set the demand_attention state of a window.
Eina_Bool elm_win_demand_attention_get (const Elm_Win *obj)
 Get the demand_attention state of a window.
int elm_win_wm_rotation_preferred_rotation_get (const Elm_Win *obj)
void elm_win_layer_set (Elm_Win *obj, int layer)
 Set the layer of the window.
int elm_win_layer_get (const Elm_Win *obj)
 Get the layer of the window.
void elm_win_profile_set (Elm_Win *obj, const char *profile)
 Set the profile of a window.
const char * elm_win_profile_get (const Elm_Win *obj)
 Get the profile of a window.
void elm_win_shaped_set (Elm_Win *obj, Eina_Bool shaped)
 Set the shaped state of a window.
Eina_Bool elm_win_shaped_get (const Elm_Win *obj)
 Get the shaped state of a window.
void elm_win_fullscreen_set (Elm_Win *obj, Eina_Bool fullscreen)
 Set the fullscreen state of a window.
Eina_Bool elm_win_fullscreen_get (const Elm_Win *obj)
 Get the fullscreen state of a window.
void elm_win_wm_rotation_manual_rotation_done_set (Elm_Win *obj, Eina_Bool set)
 Set the manual rotation done mode.
Eina_Bool elm_win_wm_rotation_manual_rotation_done_get (const Elm_Win *obj)
 Get the state of manual rotation done mode.
void elm_win_indicator_mode_set (Elm_Win *obj, Elm_Win_Indicator_Mode mode)
 Sets the indicator mode of the window.
Elm_Win_Indicator_Mode elm_win_indicator_mode_get (const Elm_Win *obj)
 Get the indicator mode of the window.
void elm_win_conformant_set (Elm_Win *obj, Eina_Bool conformant)
 Set if this window is an illume conformant window.
Eina_Bool elm_win_conformant_get (const Elm_Win *obj)
 Get if this window is an illume conformant window.
void elm_win_size_base_set (Elm_Win *obj, int w, int h)
 Set the base window size used with stepping calculation.
void elm_win_size_base_get (const Elm_Win *obj, int *w, int *h)
 Get the base size of a window.
void elm_win_quickpanel_set (Elm_Win *obj, Eina_Bool quickpanel)
 Set a window to be an illume quickpanel window.
Eina_Bool elm_win_quickpanel_get (const Elm_Win *obj)
 Get if this window is a quickpanel or not.
void elm_win_rotation_with_resize_set (Elm_Win *obj, int rotation)
 Rotates the window and resizes it.
void elm_win_prop_focus_skip_set (Elm_Win *obj, Eina_Bool skip)
 Set the window to be skipped by keyboard focus.
void elm_win_screen_position_get (const Elm_Win *obj, int *x, int *y)
 Get the screen position of a window.
Eina_Bool elm_win_wm_rotation_supported_get (const Elm_Win *obj)
 Query whether window manager supports window rotation or not.
Eina_Bool elm_win_focus_get (const Elm_Win *obj)
 Determine whether a window has focus.
void elm_win_screen_size_get (const Elm_Win *obj, int *x, int *y, int *w, int *h)
 Get screen geometry details for the screen that a window is on.
void elm_win_screen_dpi_get (const Elm_Win *obj, int *xdpi, int *ydpi)
 Get screen dpi for the screen that a window is on.
Evas_Object * elm_win_inlined_image_object_get (const Elm_Win *obj)
 Get the inlined image object handle.
Elm_Win_Type elm_win_type_get (const Elm_Win *obj)
 Get the type of a window.
void elm_win_wm_rotation_manual_rotation_done (Elm_Win *obj)
Eina_Bool elm_win_socket_listen (Elm_Win *obj, const char *svcname, int svcnum, Eina_Bool svcsys)
 Create a socket to provide the service for Plug widget.
void elm_win_illume_command_send (Elm_Win *obj, Elm_Illume_Command command, void *params)
 Send a command to the windowing environment.
void elm_win_activate (Elm_Win *obj)
 Activate a window object.
void elm_win_resize_object_add (Elm_Win *obj, Evas_Object *subobj)
 Add subobj as a resize object of window obj.
void elm_win_raise (Elm_Win *obj)
 Raise a window object.
void elm_win_lower (Elm_Win *obj)
 Lower a window object.
void elm_win_resize_object_del (Elm_Win *obj, Evas_Object *subobj)
 Delete subobj as a resize object of window obj.
void elm_win_center (Elm_Win *obj, Eina_Bool h, Eina_Bool v)
 Center a window on its screen.
Eina_Bool elm_win_trap_set (const Elm_Win_Trap *trap)
 Sets the trap to be used for internal Ecore_Evas management.
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.
Evas_Object * elm_win_util_standard_add (const char *name, const char *title)
 Adds a window object with standard setup.
void elm_win_floating_mode_set (Evas_Object *obj, Eina_Bool floating)
 Set the floating mode of a window.
Eina_Bool elm_win_floating_mode_get (const Evas_Object *obj)
 Get the floating mode of a window.
void elm_win_norender_push (Evas_Object *obj)
 This pushes (increments) the norender counter on the window.
void elm_win_norender_pop (Evas_Object *obj)
 This pops (decrements) the norender counter on the window.
int elm_win_norender_get (Evas_Object *obj)
 The retruns how many times norender has been pushed on the window.
void elm_win_render (Evas_Object *obj)
 This manually asks evas to render the window now.
void elm_win_wm_rotation_preferred_rotation_set (const Evas_Object *obj, int rotation)
 Set the preferred rotation value.

Typedefs

typedef struct _Elm_Win_Trap Elm_Win_Trap

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

  • "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
  • "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2 rendering in X11)
  • "shot:..." (Virtual screenshot renderer - renders to output file and exits)
  • "fb", "software-fb", "software_fb" (Linux framebuffer direct software rendering)
  • "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL buffer)
  • "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2 rendering using SDL as the buffer)
  • "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via GDI with software)
  • "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
  • "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
  • "wayland_shm" (Wayland client SHM rendering)
  • "wayland_egl" (Wayland client OpenGL/EGL rendering)
  • "drm" (Linux drm/kms etc. direct display)

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:

  • "delete,request": the user requested to close the window. See elm_win_autodel_set().
  • "focus,in": window got focus (deprecated. use "focused" instead.)
  • "focus,out": window lost focus (deprecated. use "unfocused" instead.)
  • "moved": window that holds the canvas was moved
  • "withdrawn": window is still managed normally but removed from view
  • "iconified": window is minimized (perhaps into an icon or taskbar)
  • "normal": window is in a normal state (not withdrawn or iconified)
  • "stick": window has become sticky (shows on all desktops)
  • "unstick": window has stopped being sticky
  • "fullscreen": window has become fullscreen
  • "unfullscreen": window has stopped being fullscreen
  • "maximized": window has been maximized
  • "unmaximized": window has stopped being maximized
  • "ioerr": there has been a low-level I/O error with the display system
  • "indicator,prop,changed": an indicator's property has been changed
  • "rotation,changed": window rotation has been changed
  • "profile,changed": profile of the window has been changed
  • "focused" : When the win has received focus. (since 1.8)
  • "unfocused" : When the win has lost focus. (since 1.8)
  • "theme,changed" - The theme was changed. (since 1.13)

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.

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 (EFL) :
1.7

Enumeration Type Documentation

enum Elm_Illume_Command

Available commands that can be sent to the Illume manager.

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

enum 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 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

enum Elm_Win_Indicator_Opacity_Mode

Defines the opacity modes of indicator that can be shown

Enumerator:
ELM_WIN_INDICATOR_OPACITY_UNKNOWN 

Unknown indicator opacity mode

ELM_WIN_INDICATOR_OPAQUE 

Opacifies the indicator

ELM_WIN_INDICATOR_TRANSLUCENT 

Be translucent the indicator

ELM_WIN_INDICATOR_TRANSPARENT 

Transparentizes the indicator

ELM_WIN_INDICATOR_BG_TRANSPARENT 

Transparentizes the indicator background

enum Elm_Win_Keyboard_Mode

The different layouts that can be requested for the virtual keyboard.

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

enum Elm_Win_Type

Defines the types of window that can be created

These are hints set on the window so that a running Window 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_BASIC 

A normal window. Indicates a normal, top-level window. Almost every window will be created with this type.

ELM_WIN_DIALOG_BASIC 

Used for simple dialog windows/

ELM_WIN_DESKTOP 

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 Window Manager.

ELM_WIN_TOOLBAR 

The window is used to hold a floating toolbar, or similar.

ELM_WIN_MENU 

Similar to ELM_WIN_TOOLBAR.

ELM_WIN_UTILITY 

A persistent utility window, like a toolbox or palette.

ELM_WIN_SPLASH 

Splash window for a starting up application.

ELM_WIN_DROPDOWN_MENU 

The window is a dropdown menu, as 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 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 appear 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 the EFL.

ELM_WIN_NOTIFICATION 

A notification window, like a warning about battery life or a new E-Mail received.

ELM_WIN_COMBO 

A window holding the contents of a combo box. Not usually used in the EFL.

ELM_WIN_DND 

Used to indicate 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 will be rendered to an image buffer. This allows to have 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 other process's plug image object. No actual window is created for this type, instead the window and all of its contents will be rendered to an image buffer and can be shown other process's plug image object

ELM_WIN_FAKE 

This window was created using a pre-existing canvas. The window widget can be deleted, but the canvas must be managed externally.

Since (EFL) :
1.13

Function Documentation

void elm_win_activate ( Elm_Win *  obj)

Activate a window object.

Since :
2.3
Remarks:
This function sends a request to the Window Manager to activate the window pointed by obj. If honored by the WM, the window will receive the keyboard focus.
This is just a request that a Window Manager may ignore, so calling this function does not ensure in any way that the window will be the active one after it.
Parameters:
[in]objThe elm win object
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.

Since :
2.3
Parameters:
[in]parentParent object to add the window to, or NULL
[in]nameThe name of the window
[in]typeThe window type, one of Elm_Win_Type.
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 will be created.
Returns:
The created object, or NULL on failure
Eina_Bool elm_win_alpha_get ( const Elm_Win *  obj)

Get the alpha channel state of a window.

Since :
2.3
Returns:
EINA_TRUE if the window alpha channel is enabled, EINA_FALSE otherwise
Parameters:
[in]objThe elm win object
void elm_win_alpha_set ( Elm_Win *  obj,
Eina_Bool  alpha 
)

Set the alpha channel state of a window.

Since :
2.3
Remarks:
If alpha is EINA_TRUE, the alpha channel of the canvas will be 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 will instead fallback to using shaped windows, with elm_win_shaped_set().
Note:
Alpha window can be enabled automatically by window theme style's property. If "alpha" data.item is "1" or "true" in window style(eg. elm/win/base/default), the window is switched to alpha automatically without the explicit api call.
See also:
elm_win_alpha_set()
Parameters:
[in]objThe elm win object
[in]alphaEINA_TRUE if the window alpha channel is enabled, EINA_FALSE otherwise
double elm_win_aspect_get ( const Elm_Win *  obj)

Get the aspect ratio of a window.

Since :
2.3
Returns:
The aspect ratio set (0 by default)
Parameters:
[in]objThe elm win object
void elm_win_aspect_set ( Elm_Win *  obj,
double  aspect 
)

Set the aspect ratio of a window.

Since :
2.3
Parameters:
[in]objThe elm win object
[in]aspectIf 0, the window has no aspect limits, otherwise it is width divided by height
Eina_Bool elm_win_autodel_get ( const Elm_Win *  obj)

Get the window's autodel state.

Since :
2.3
Returns:
If the window will automatically delete itself when closed
See also:
elm_win_autodel_set()
Parameters:
[in]objThe elm win object
void elm_win_autodel_set ( Elm_Win *  obj,
Eina_Bool  autodel 
)

Set the window's autodel state.

Since :
2.3
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 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 EINA_FALSE, then the window will not be destroyed and is up to the program to do so when it's required.
Parameters:
[in]objThe elm win object
[in]autodelIf true, the window will automatically delete itself when closed
Eina_Bool elm_win_borderless_get ( const Elm_Win *  obj)

Get the borderless state of a window.

Since :
2.3
Returns:
If true, the window is borderless
Parameters:
[in]objThe elm win object
void elm_win_borderless_set ( Elm_Win *  obj,
Eina_Bool  borderless 
)

Set the borderless state of a window.

Since :
2.3
Remarks:
This function requests the Window Manager to not draw any decoration around the window.
Parameters:
[in]objThe elm win object
[in]borderlessIf true, the window is borderless
void elm_win_center ( Elm_Win *  obj,
Eina_Bool  h,
Eina_Bool  v 
)

Center a window on its screen.

Since :
2.3
Deprecated:
Deprecated since Tizen 2.4
Remarks:
This function centers window obj horizontally and/or vertically based on the values of h and v.
Parameters:
[in]objThe elm win object
[in]hIf true, center horizontally. If false, do not change horizontal location.
[in]vIf true, center vertically. If false, do not change vertical location.
Eina_Bool elm_win_conformant_get ( const Elm_Win *  obj)

Get if this window is an illume conformant window.

Since :
2.3
Returns:
A boolean if this window is illume conformant or not
Parameters:
[in]objThe elm win object
void elm_win_conformant_set ( Elm_Win *  obj,
Eina_Bool  conformant 
)

Set if this window is an illume conformant window.

Since :
2.3
Parameters:
[in]objThe elm win object
[in]conformantThe conformant flag (1 = conformant, 0 = non-conformant)
Eina_Bool elm_win_demand_attention_get ( const Elm_Win *  obj)

Get the demand_attention state of a window.

Since :
2.3
Returns:
If true, the window is demand_attention
Parameters:
[in]objThe elm win object
void elm_win_demand_attention_set ( Elm_Win *  obj,
Eina_Bool  demand_attention 
)

Set the demand_attention state of a window.

Since :
2.3
Parameters:
[in]objThe elm win object
[in]demand_attentionIf true, the window is demand_attention
Eina_Bool elm_win_floating_mode_get ( const Evas_Object *  obj)

Get the floating mode of a window.

Since :
2.3
Parameters:
[in]objThe window object
Returns:
If true, the window is floating mode
See also:
elm_win_floating_mode_set()
Since (EFL) :
1.8
void elm_win_floating_mode_set ( Evas_Object *  obj,
Eina_Bool  floating 
)

Set the floating mode of a window.

Since :
2.3
Parameters:
[in]objThe window object
[in]floatingIf true, the window is floating mode
Remarks:
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
Eina_Bool elm_win_focus_get ( const Elm_Win *  obj)

Determine whether a window has focus.

Since :
2.3
Returns:
EINA_TRUE if the window exists and has focus, else EINA_FALSE
Parameters:
[in]objThe elm win object
Eina_Bool elm_win_focus_highlight_enabled_get ( const Elm_Win *  obj)

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

Since :
2.3
Returns:
EINA_TRUE if enabled, EINA_FALSE otherwise
Parameters:
[in]objThe elm win object
void elm_win_focus_highlight_enabled_set ( Elm_Win *  obj,
Eina_Bool  enabled 
)

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

Since :
2.3
Remarks:
This function will enable or disable the focus highlight only for the given window, regardless of the global setting for it
Parameters:
[in]objThe elm win object
[in]enabledThe enabled value for the highlight
const char* elm_win_focus_highlight_style_get ( const Elm_Win *  obj)

Get the style set for the focus highlight object.

Since :
2.3
Remarks:
Get the style set for this windows highlight object, or NULL if none is set.
Returns:
The style set or NULL if none was. Default is used in that case.
Parameters:
[in]objThe elm win object
void elm_win_focus_highlight_style_set ( Elm_Win *  obj,
const char *  style 
)

Set the style for the focus highlight on this window.

Since :
2.3
Remarks:
Sets the style to use for theming the highlight of focused objects on the given window. If style is NULL, the default will be used.
Parameters:
[in]objThe elm win object
[in]styleThe style to set
Eina_Bool elm_win_fullscreen_get ( const Elm_Win *  obj)

Get the fullscreen state of a window.

Since :
2.3
Deprecated:
Deprecated since Tizen 2.4
Returns:
If true, the window is fullscreen
Parameters:
[in]objThe elm win object
void elm_win_fullscreen_set ( Elm_Win *  obj,
Eina_Bool  fullscreen 
)

Set the fullscreen state of a window.

Since :
2.3
Deprecated:
Deprecated since Tizen 2.4
Parameters:
[in]objThe elm win object
[in]fullscreenIf true, the window is fullscreen
const char* elm_win_icon_name_get ( const Elm_Win *  obj)

Get the icon name of the window.

Since :
2.3
Remarks:
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
Parameters:
[in]objThe elm win object
void elm_win_icon_name_set ( Elm_Win *  obj,
const char *  icon_name 
)

Set the icon name of the window.

Since :
2.3
Parameters:
[in]objThe elm win object
[in]icon_nameThe icon name to set
const Evas_Object* elm_win_icon_object_get ( const Elm_Win *  obj)

Get the icon object used for the window.

Since :
2.3
Remarks:
The object returns is the one marked by elm_win_icon_object_set() as the object to use for the window icon.
Returns:
The icon object set
Parameters:
[in]objThe elm win object
void elm_win_icon_object_set ( Elm_Win *  obj,
Evas_Object *  icon 
)

Set a window object's icon.

Since :
2.3
Remarks:
This sets an image to be used as the icon for the given window, in the window manager decoration part. The exact pixel dimensions of the object (not object size) will be used, and the image pixels will be 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, for
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]objThe elm win object
[in]iconThe Evas image object to use for an icon
Eina_Bool elm_win_iconified_get ( const Elm_Win *  obj)

Get the iconified state of a window.

Since :
2.3
Returns:
If true, the window is iconified
Parameters:
[in]objThe elm win object
void elm_win_iconified_set ( Elm_Win *  obj,
Eina_Bool  iconified 
)

Set the iconified state of a window.

Since :
2.3
Parameters:
[in]objThe elm win object
[in]iconifiedIf true, the window is iconified
void elm_win_illume_command_send ( Elm_Win *  obj,
Elm_Illume_Command  command,
void *  params 
)

Send a command to the windowing environment.

Since :
2.3
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]objThe elm win object
[in]commandThe command to send
[in]paramsOptional parameters for the command
Elm_Win_Indicator_Mode elm_win_indicator_mode_get ( const Elm_Win *  obj)

Get the indicator mode of the window.

Since :
2.3
Returns:
The mode, one of Elm_Win_Indicator_Mode
Parameters:
[in]objThe elm win object
void elm_win_indicator_mode_set ( Elm_Win *  obj,
Elm_Win_Indicator_Mode  mode 
)

Sets the indicator mode of the window.

Since :
2.3
Parameters:
[in]objThe elm win object
[in]modeThe mode to set, one of Elm_Win_Indicator_Mode
Elm_Win_Indicator_Opacity_Mode elm_win_indicator_opacity_get ( const Elm_Win *  obj)

Get the indicator opacity mode of the window.

Since :
2.3
Returns:
The mode, one of Elm_Win_Indicator_Opacity_Mode
Parameters:
[in]objThe elm win object
void elm_win_indicator_opacity_set ( Elm_Win *  obj,
Elm_Win_Indicator_Opacity_Mode  mode 
)

Sets the indicator opacity mode of the window.

Since :
2.3
Parameters:
[in]objThe elm win object
[in]modeThe mode to set, one of Elm_Win_Indicator_Opacity_Mode
Evas_Object* elm_win_inlined_image_object_get ( const Elm_Win *  obj)

Get the inlined image object handle.

Since :
2.3
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 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
Parameters:
[in]objThe elm win object
Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get ( const Elm_Win *  obj)

Get the keyboard mode of the window.

Since :
2.3
Returns:
The mode, one of Elm_Win_Keyboard_Mode
Parameters:
[in]objThe elm win object
void elm_win_keyboard_mode_set ( Elm_Win *  obj,
Elm_Win_Keyboard_Mode  mode 
)

Sets the keyboard mode of the window.

Since :
2.3
Parameters:
[in]objThe elm win object
[in]modeThe mode to set, one of Elm_Win_Keyboard_Mode
Eina_Bool elm_win_keyboard_win_get ( const Elm_Win *  obj)

Get whether the window is a keyboard.

Since :
2.3
Returns:
If the window is a virtual keyboard
Deprecated:
Deprecated since Tizen 2.4
Parameters:
[in]objThe elm win object
void elm_win_keyboard_win_set ( Elm_Win *  obj,
Eina_Bool  is_keyboard 
)

Sets whether the window is a keyboard.

Since :
2.3
Deprecated:
Deprecated since Tizen 2.4
Parameters:
[in]objThe elm win object
[in]is_keyboardIf true, the window is a virtual keyboard
int elm_win_layer_get ( const Elm_Win *  obj)

Get the layer of the window.

Since :
2.3
Returns:
The layer of the window
See also:
elm_win_layer_set()
Parameters:
[in]objThe elm win object
void elm_win_layer_set ( Elm_Win *  obj,
int  layer 
)

Set the layer of the window.

Since :
2.3
Remarks:
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:
  • < 3: The window will be placed below all others.
  • > 5: The window will be placed above all others.
  • other: The window will be placed in the default layer.
Parameters:
[in]objThe elm win object
[in]layerThe layer of the window
void elm_win_lower ( Elm_Win *  obj)

Lower a window object.

Since :
2.3
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 Window Manager may ignore this request.
Parameters:
[in]objThe elm win object
Eina_Bool elm_win_maximized_get ( const Elm_Win *  obj)

Get the maximized state of a window.

Since :
2.3
Returns:
If true, the window is maximized
Parameters:
[in]objThe elm win object
void elm_win_maximized_set ( Elm_Win *  obj,
Eina_Bool  maximized 
)

Set the maximized state of a window.

Since :
2.3
Parameters:
[in]objThe elm win object
[in]maximizedIf true, the window is maximized
Eina_Bool elm_win_modal_get ( const Elm_Win *  obj)

Get the modal state of a window.

Since :
2.3
Returns:
If true, the window is modal
Parameters:
[in]objThe elm win object
void elm_win_modal_set ( Elm_Win *  obj,
Eina_Bool  modal 
)

Set the modal state of a window.

Since :
2.3
Parameters:
[in]objThe elm win object
[in]modalIf true, the window is modal
int elm_win_norender_get ( Evas_Object *  obj)

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

Since :
2.3
Parameters:
[in]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 (EFL) :
1.7
void elm_win_norender_pop ( Evas_Object *  obj)

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

Since :
2.3
Parameters:
[in]objThe window object
Remarks:
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
void elm_win_norender_push ( Evas_Object *  obj)

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

Since :
2.3
Parameters:
[in]objThe window object
Remarks:
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
Eina_Bool elm_win_override_get ( const Elm_Win *  obj)

Get the override state of a window.

Since :
2.3
Returns:
If true, the window is overridden
See also:
elm_win_override_set()
Deprecated:
Deprecated since Tizen 2.4
Parameters:
[in]objThe elm win object
void elm_win_override_set ( Elm_Win *  obj,
Eina_Bool  override 
)

Set the override state of a window.

Since :
2.3
Remarks:
A window with override set to EINA_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.
Deprecated:
Deprecated since Tizen 2.4
Parameters:
[in]objThe elm win object
[in]overrideIf true, the window is overridden
const char* elm_win_profile_get ( const Elm_Win *  obj)

Get the profile of a window.

Since :
2.3
Returns:
The string value of a window profile, or NULL if none exists
Since (EFL) :
1.8
Parameters:
[in]objThe elm win object
void elm_win_profile_set ( Elm_Win *  obj,
const char *  profile 
)

Set the profile of a window.

Since :
2.4
Since (EFL) :
1.8
Parameters:
[in]objThe elm win object
[in]profileThe string value of a window profile
void elm_win_profiles_set ( Evas_Object *  obj,
const char **  profiles,
unsigned int  num_profiles 
)

Sets the profile list of a window.

Since :
2.3
Parameters:
[in]objThe window object
[in]profilesThe list of profile names
[in]num_profilesThe number of profile names
Deprecated:
Deprecated since Tizen 2.4
void elm_win_prop_focus_skip_set ( Elm_Win *  obj,
Eina_Bool  skip 
)

Set the window to be skipped by keyboard focus.

Since :
2.3
Remarks:
This sets the window to be skipped by normal keyboard input. This means a window manager will be asked to not focus this window as well as omit it from things like the taskbar, pager, "alt-tab" list etc. etc.
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 the 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]objThe elm win object
[in]skipThe skip flag state (EINA_TRUE if it is to be skipped)
Eina_Bool elm_win_quickpanel_get ( const Elm_Win *  obj)

Get if this window is a quickpanel or not.

Since :
2.3
Returns:
A boolean if this window is a quickpanel or not
Deprecated:
Deprecated since Tizen 2.4
Parameters:
[in]objThe elm win object
int elm_win_quickpanel_priority_major_get ( const Elm_Win *  obj)

Get the major priority of a quickpanel window.

Since :
2.3
Deprecated:
Deprecated since Tizen 2.4
Returns:
The major priority of this quickpanel. If the object is not window object, return -1.
Parameters:
[in]objThe elm win object
void elm_win_quickpanel_priority_major_set ( Elm_Win *  obj,
int  priority 
)

Set the major priority of a quickpanel window.

Since :
2.3
Deprecated:
Deprecated since Tizen 2.4
Parameters:
[in]objThe elm win object
[in]priorityThe major priority for this quickpanel
int elm_win_quickpanel_priority_minor_get ( const Elm_Win *  obj)

Get the minor priority of a quickpanel window.

Since :
2.3
Returns:
The minor priority of this quickpanel. If the object is not window object, return -1.
Deprecated:
Deprecated since Tizen 2.4
Parameters:
[in]objThe elm win object
void elm_win_quickpanel_priority_minor_set ( Elm_Win *  obj,
int  priority 
)

Set the minor priority of a quickpanel window.

Since :
2.3
Deprecated:
Deprecated since Tizen 2.4
Parameters:
[in]objThe elm win object
[in]priorityThe minor priority for this quickpanel
void elm_win_quickpanel_set ( Elm_Win *  obj,
Eina_Bool  quickpanel 
)

Set a window to be an illume quickpanel window.

Since :
2.3
Remarks:
By default window objects are not quickpanel windows.
Deprecated:
Deprecated since Tizen 2.4
Parameters:
[in]objThe elm win object
[in]quickpanelThe quickpanel flag (1 = quickpanel, 0 = normal window)
int elm_win_quickpanel_zone_get ( const Elm_Win *  obj)

Get which zone this quickpanel should appear in.

Since :
2.3
Returns:
The requested zone for this quickpanel
Deprecated:
Deprecated since Tizen 2.4
Parameters:
[in]objThe elm win object
void elm_win_quickpanel_zone_set ( Elm_Win *  obj,
int  zone 
)

Set which zone this quickpanel should appear in.

Since :
2.3
Deprecated:
Deprecated since Tizen 2.4
Parameters:
[in]objThe elm win object
[in]zoneThe requested zone for this quickpanel
void elm_win_raise ( Elm_Win *  obj)

Raise a window object.

Since :
2.3
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 Window Manager may ignore this request.
Parameters:
[in]objThe elm win object
void elm_win_render ( Evas_Object *  obj)

This manually asks evas to render the window now.

Since :
2.3
Parameters:
[in]objThe window object
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 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
void elm_win_resize_object_add ( Elm_Win *  obj,
Evas_Object *  subobj 
)

Add subobj as a resize object of window obj.

Since :
2.3
Remarks:
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 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]objThe elm win object
[in]subobjThe resize object to add
void elm_win_resize_object_del ( Elm_Win *  obj,
Evas_Object *  subobj 
)

Delete subobj as a resize object of window obj.

Since :
2.3
Remarks:
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]objThe elm win object
[in]subobjThe resize object to add
const char* elm_win_role_get ( const Elm_Win *  obj)

Get the role of the window.

Since :
2.3
Remarks:
The returned string is an internal one and should not be freed or modified. It will also be invalid if a new role is set or if the window is destroyed.
Returns:
The role
Parameters:
[in]objThe elm win object
void elm_win_role_set ( Elm_Win *  obj,
const char *  role 
)

Set the role of the window.

Since :
2.3
Parameters:
[in]objThe elm win object
[in]roleThe role to set
int elm_win_rotation_get ( const Elm_Win *  obj)

Get the rotation of the window.

Since :
2.3
Returns:
The rotation of the window in degrees (0-360)
See also:
elm_win_rotation_set()
elm_win_rotation_with_resize_set()
Parameters:
[in]objThe elm win object
void elm_win_rotation_set ( Elm_Win *  obj,
int  rotation 
)

Set the rotation of the window.

Since :
2.3
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 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]objThe elm win object
[in]rotationThe rotation of the window, in degrees (0-360), counter-clockwise.
void elm_win_rotation_with_resize_set ( Elm_Win *  obj,
int  rotation 
)

Rotates the window and resizes it.

Since :
2.3
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]objThe elm win object
[in]rotationThe rotation of the window in degrees (0-360), counter-clockwise.
Eina_Bool elm_win_screen_constrain_get ( const Elm_Win *  obj)

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

Since :
2.3
Remarks:
When this function returns true, obj will never resize larger than the screen.
Returns:
EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
Parameters:
[in]objThe elm win object
void elm_win_screen_constrain_set ( Elm_Win *  obj,
Eina_Bool  constrain 
)

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

Since :
2.3
Remarks:
When constrain is true, obj will never resize larger than the screen.
Parameters:
[in]objThe elm win object
[in]constrainEINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
void elm_win_screen_dpi_get ( const Elm_Win *  obj,
int *  xdpi,
int *  ydpi 
)

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

Since :
2.3
Since (EFL) :
1.7
Parameters:
[in]objThe elm win object
[out]xdpiPointer to value to store return horizontal dpi. May be NULL.
[out]ydpiPointer to value to store return vertical dpi. May be NULL.
void elm_win_screen_position_get ( const Elm_Win *  obj,
int *  x,
int *  y 
)

Get the screen position of a window.

Since :
2.3
Parameters:
[in]objThe elm win object
[out]xThe int to store the x coordinate to
[out]yThe int to store the y coordinate to
void elm_win_screen_size_get ( const Elm_Win *  obj,
int *  x,
int *  y,
int *  w,
int *  h 
)

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

Since :
2.3
Parameters:
[in]objThe elm win object
[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.
Eina_Bool elm_win_shaped_get ( const Elm_Win *  obj)

Get the shaped state of a window.

Since :
2.3
Returns:
If true, the window is shaped
See also:
elm_win_shaped_set()
Deprecated:
Deprecated since Tizen 2.4
Parameters:
[in]objThe elm win object
void elm_win_shaped_set ( Elm_Win *  obj,
Eina_Bool  shaped 
)

Set the shaped state of a window.

Since :
2.3
Remarks:
Shaped windows, when supported, will render the parts of the window that has no content, 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, or the parts of the canvas that have no data will show framebuffer artifacts.
See also:
elm_win_alpha_set()
Deprecated:
Deprecated since Tizen 2.4
Parameters:
[in]objThe elm win object
[in]shapedIf true, the window is shaped
void elm_win_size_base_get ( const Elm_Win *  obj,
int *  w,
int *  h 
)

Get the base size of a window.

Since :
2.3
See also:
elm_win_size_base_set
elm_win_size_step_set
Since (EFL) :
1.7
Parameters:
[in]objThe elm win object
[out]wThe base width
[out]hThe base height
void elm_win_size_base_set ( Elm_Win *  obj,
int  w,
int  h 
)

Set the base window size used with stepping calculation.

Since :
2.3
Remarks:
Base size + stepping is what is calculated for window sizing restrictions.
See also:
elm_win_size_step_set
elm_win_size_base_get
Since (EFL) :
1.7
Parameters:
[in]objThe elm win object
[in]wThe base width
[in]hThe base height
void elm_win_size_step_get ( const Elm_Win *  obj,
int *  w,
int *  h 
)

Get the stepping of a window.

Since :
2.3
See also:
elm_win_size_base_set
elm_win_size_step_set
Since (EFL) :
1.7
Parameters:
[in]objThe elm win object
[out]wThe stepping width (0 disables)
[out]hThe stepping height (0 disables)
void elm_win_size_step_set ( Elm_Win *  obj,
int  w,
int  h 
)

Set the window stepping used with sizing calculation.

Since :
2.3
Remarks:
Base size + stepping is what is calculated for window sizing restrictions.
See also:
elm_win_size_step_get
elm_win_size_base_set
Since (EFL) :
1.7
Parameters:
[in]objThe elm win object
[in]wThe stepping width (0 disables)
[in]hThe stepping height (0 disables)
Eina_Bool elm_win_socket_listen ( Elm_Win *  obj,
const char *  svcname,
int  svcnum,
Eina_Bool  svcsys 
)

Create a socket to provide the service for Plug widget.

Since :
2.3
Returns:
If socket creation is successful
Parameters:
[in]objThe elm win object
[in]svcnameThe name of the service to be advertised. ensure that it is unique (when combined with svcnum) otherwise creation may fail.
[in]svcnumA number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.
[in]svcsysA boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user id that created the service.
Eina_Bool elm_win_sticky_get ( const Elm_Win *  obj)

Get the sticky state of the window.

Since :
2.3
Returns:
If true, the window's sticky state is enabled
See also:
elm_win_sticky_set()
Deprecated:
Deprecated since Tizen 2.4
Parameters:
[in]objThe elm win object
void elm_win_sticky_set ( Elm_Win *  obj,
Eina_Bool  sticky 
)

Set the sticky state of the window.

Since :
2.3
Remarks:
Hints the Window Manager that the window in obj should be left fixed at its position even when the virtual desktop it's on moves or changes.
Deprecated:
Deprecated since Tizen 2.4
Parameters:
[in]objThe elm win object
[in]stickyIf true, the window's sticky state is enabled
const char* elm_win_title_get ( const Elm_Win *  obj)

Get the title of the window.

Since :
2.3
Remarks:
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
Parameters:
[in]objThe elm win object
void elm_win_title_set ( Elm_Win *  obj,
const char *  title 
)

Set the title of the window.

Since :
2.3
Parameters:
[in]objThe elm win object
[in]titleThe title to set
Eina_Bool elm_win_trap_set ( const Elm_Win_Trap *  trap)

Sets the trap to be used for internal Ecore_Evas management.

Since :
2.3
Parameters:
[in]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 (EFL) :
1.7
Elm_Win_Type elm_win_type_get ( const Elm_Win *  obj)

Get the type of a window.

Since :
2.3
Returns:
The type of a window object. If the object is not window object, return #ELM_WIN_UNKNOWN.

// TIZEN_ONLY(20150205): Apply Tizen #ELM_WIN_UNKNOWN value as 0. // return: Elm_Win_Type(-1);

Parameters:
[in]objThe elm win object
Eina_Bool elm_win_urgent_get ( const Elm_Win *  obj)

Get the urgent state of a window.

Since :
2.3
Returns:
If true, the window is urgent
Parameters:
[in]objThe elm win object
void elm_win_urgent_set ( Elm_Win *  obj,
Eina_Bool  urgent 
)

Set the urgent state of a window.

Since :
2.3
Parameters:
[in]objThe elm win object
[in]urgentIf true, the window is urgent
Evas_Object* elm_win_util_standard_add ( const char *  name,
const char *  title 
)

Adds a window object with standard setup.

Since :
2.3
Parameters:
[in]nameThe name of the window
[in]titleThe title for the window
Remarks:
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()
Eina_Bool elm_win_withdrawn_get ( const Elm_Win *  obj)

Get the withdrawn state of a window.

Since :
2.3
Returns:
If true, the window is withdrawn
Parameters:
[in]objThe elm win object
void elm_win_withdrawn_set ( Elm_Win *  obj,
Eina_Bool  withdrawn 
)

Set the withdrawn state of a window.

Since :
2.3
Parameters:
[in]objThe elm win object
[in]withdrawnIf true, the window is withdrawn
Eina_Bool elm_win_wm_rotation_available_rotations_get ( const Elm_Win *  obj,
int **  rotations,
unsigned int *  count 
)

Get the array of available window rotations.

Since :
2.3

This function is used to get the available rotations.

See also:
elm_win_wm_rotation_available_rotations_set()
Since (EFL) :
1.9
Parameters:
[in]objThe elm win object
[out]rotationsThe array of rotation value.
[out]countThe size of the
rotationsarray.
void elm_win_wm_rotation_available_rotations_set ( Elm_Win *  obj,
const int *  rotations,
unsigned int  count 
)

Set the array of available window rotations.

Since :
2.3

This function is used to set the available rotations to give the hints to WM. WM will refer this hints and set the orientation window properly.

See also:
elm_win_wm_rotation_available_rotations_get()
Since (EFL) :
1.9
Parameters:
[in]objThe elm win object
[in]rotationsThe array of rotation value.
[in]countThe size of the
rotationsarray.
void elm_win_wm_rotation_manual_rotation_done ( Elm_Win *  obj)

To notify the rotation done to WM manually.

Since :
2.3

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

See also:
elm_win_wm_rotation_manual_rotation_done_set()
elm_win_wm_rotation_manual_rotation_done_get()
Since (EFL) :
1.9
Parameters:
[in]objThe elm win object
Eina_Bool elm_win_wm_rotation_manual_rotation_done_get ( const Elm_Win *  obj)

Get the state of manual rotation done mode.

Since :
2.3
Remarks:
This function is used to get the state of manual rotation done mode.
Returns:
EINA_TRUE manual rotationn done mode, EINA_FALSE otherwise.
See also:
elm_win_wm_rotation_manual_rotation_done_set()
elm_win_wm_rotation_manual_rotation_done()
Since (EFL) :
1.9
Parameters:
[in]objThe elm win object
void elm_win_wm_rotation_manual_rotation_done_set ( Elm_Win *  obj,
Eina_Bool  set 
)

Set the manual rotation done mode.

Since :
2.3
Remarks:
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 the "elm_win_wm_rotation_manual_done" explicitly to sends the message.
See also:
elm_win_wm_rotation_manual_rotation_done_get()
elm_win_wm_rotation_manual_rotation_done()
Since (EFL) :
1.9
Parameters:
[in]objThe elm win object
[in]setEINA_TRUE means to set manual rotation done mode EINA_FALSE otherwise.
int elm_win_wm_rotation_preferred_rotation_get ( const Elm_Win *  obj)

Get the preferred rotation value.

Since :
2.3

This function is used to get the preferred rotoation value.

Returns:
The preferred rotation of the window in degrees (0-360), counter-clockwise.
See also:
elm_win_wm_rotation_preferred_rotation_set()
Since (EFL) :
1.9
Parameters:
[in]objThe elm win object
void elm_win_wm_rotation_preferred_rotation_set ( const Evas_Object *  obj,
int  rotation 
)

Set the preferred rotation value.

Since :
2.3
Remarks:
This function is used to set the orientation of window obj to spicific angle fixed.
Parameters:
[in]objThe window object
[in]rotationThe preferred rotation of the window in degrees (0-360), counter-clockwise.
See also:
elm_win_wm_rotation_preferred_rotation_get()
Since (EFL) :
1.9
Eina_Bool elm_win_wm_rotation_supported_get ( const Elm_Win *  obj)

Query whether window manager supports window rotation or not.

Since :
2.3
Remarks:
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.
Returns:
EINA_TRUE if the window manager rotation is supported, EINA_FALSE otherwise.
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()
Since (EFL) :
1.9
Parameters:
[in]objThe elm win object