Modules | |
Inwin | |
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. | |
Enumerations | |
enum | Elm_Win_Type { ELM_WIN_BASIC, ELM_WIN_DIALOG_BASIC, ELM_WIN_DESKTOP, ELM_WIN_DOCK, ELM_WIN_TOOLBAR, ELM_WIN_MENU, ELM_WIN_UTILITY, ELM_WIN_SPLASH, ELM_WIN_DROPDOWN_MENU, ELM_WIN_POPUP_MENU, ELM_WIN_TOOLTIP, ELM_WIN_NOTIFICATION, ELM_WIN_COMBO, ELM_WIN_DND, ELM_WIN_INLINED_IMAGE, ELM_WIN_SOCKET_IMAGE } |
Defines the types of window that can be created. More... | |
enum | Elm_Win_Keyboard_Mode { ELM_WIN_KEYBOARD_UNKNOWN, ELM_WIN_KEYBOARD_OFF, ELM_WIN_KEYBOARD_ON, ELM_WIN_KEYBOARD_ALPHA, ELM_WIN_KEYBOARD_NUMERIC, ELM_WIN_KEYBOARD_PIN, ELM_WIN_KEYBOARD_PHONE_NUMBER, ELM_WIN_KEYBOARD_HEX, ELM_WIN_KEYBOARD_TERMINAL, ELM_WIN_KEYBOARD_PASSWORD, ELM_WIN_KEYBOARD_IP, ELM_WIN_KEYBOARD_HOST, ELM_WIN_KEYBOARD_FILE, ELM_WIN_KEYBOARD_URL, ELM_WIN_KEYBOARD_KEYPAD, ELM_WIN_KEYBOARD_J2ME } |
The different layouts that can be requested for the virtual keyboard. More... | |
enum | Elm_Win_Indicator_Mode { ELM_WIN_INDICATOR_UNKNOWN, 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, ELM_WIN_INDICATOR_OPAQUE, ELM_WIN_INDICATOR_TRANSLUCENT, ELM_WIN_INDICATOR_TRANSPARENT } |
Defines the opacity modes of indicator that can be shown. More... | |
enum | Elm_Illume_Command { ELM_ILLUME_COMMAND_FOCUS_BACK, ELM_ILLUME_COMMAND_FOCUS_FORWARD, ELM_ILLUME_COMMAND_FOCUS_HOME, ELM_ILLUME_COMMAND_CLOSE } |
Available commands that can be sent to the Illume manager. More... | |
Functions | |
Evas_Object * | elm_win_add (Evas_Object *parent, const char *name, Elm_Win_Type type) |
Adds a window object. | |
Evas_Object * | elm_win_util_standard_add (const char *name, const char *title) |
Adds a window object with standard setup. | |
void | elm_win_resize_object_add (Evas_Object *obj, Evas_Object *subobj) |
Add subobj as a resize object of window obj . | |
void | elm_win_resize_object_del (Evas_Object *obj, Evas_Object *subobj) |
Delete subobj as a resize object of window obj . | |
void | elm_win_title_set (Evas_Object *obj, const char *title) |
Set the title of the window. | |
const char * | elm_win_title_get (const Evas_Object *obj) |
Get the title of the window. | |
void | elm_win_icon_name_set (Evas_Object *obj, const char *icon_name) |
Set the icon name of the window. | |
const char * | elm_win_icon_name_get (const Evas_Object *obj) |
Get the icon name of the window. | |
void | elm_win_role_set (Evas_Object *obj, const char *role) |
Set the role of the window. | |
const char * | elm_win_role_get (const Evas_Object *obj) |
Get the role of the window. | |
void | elm_win_icon_object_set (Evas_Object *obj, Evas_Object *icon) |
Set a window object's icon. | |
const Evas_Object * | elm_win_icon_object_get (const Evas_Object *obj) |
Get the icon object used for the window. | |
void | elm_win_autodel_set (Evas_Object *obj, Eina_Bool autodel) |
Set the window's autodel state. | |
Eina_Bool | elm_win_autodel_get (const Evas_Object *obj) |
Get the window's autodel state. | |
void | elm_win_activate (Evas_Object *obj) |
Activate a window object. | |
void | elm_win_lower (Evas_Object *obj) |
Lower a window object. | |
void | elm_win_raise (Evas_Object *obj) |
Raise a window object. | |
void | elm_win_center (Evas_Object *obj, Eina_Bool h, Eina_Bool v) |
Center a window on its screen. | |
void | elm_win_borderless_set (Evas_Object *obj, Eina_Bool borderless) |
Set the borderless state of a window. | |
Eina_Bool | elm_win_borderless_get (const Evas_Object *obj) |
Get the borderless state of a window. | |
void | elm_win_shaped_set (Evas_Object *obj, Eina_Bool shaped) |
Set the shaped state of a window. | |
Eina_Bool | elm_win_shaped_get (const Evas_Object *obj) |
Get the shaped state of a window. | |
void | elm_win_alpha_set (Evas_Object *obj, Eina_Bool alpha) |
Set the alpha channel state of a window. | |
Eina_Bool | elm_win_alpha_get (const Evas_Object *obj) |
Get the alpha channel state of a window. | |
void | elm_win_override_set (Evas_Object *obj, Eina_Bool override) |
Set the override state of a window. | |
Eina_Bool | elm_win_override_get (const Evas_Object *obj) |
Get the override state of a window. | |
void | elm_win_fullscreen_set (Evas_Object *obj, Eina_Bool fullscreen) |
Set the fullscreen state of a window. | |
Eina_Bool | elm_win_fullscreen_get (const Evas_Object *obj) |
Get the fullscreen state of a window. | |
void | elm_win_maximized_set (Evas_Object *obj, Eina_Bool maximized) |
Set the maximized state of a window. | |
Eina_Bool | elm_win_maximized_get (const Evas_Object *obj) |
Get the maximized state of a window. | |
void | elm_win_iconified_set (Evas_Object *obj, Eina_Bool iconified) |
Set the iconified state of a window. | |
Eina_Bool | elm_win_iconified_get (const Evas_Object *obj) |
Get the iconified state of a window. | |
void | elm_win_withdrawn_set (Evas_Object *obj, Eina_Bool withdrawn) |
Set the withdrawn state of a window. | |
Eina_Bool | elm_win_withdrawn_get (const Evas_Object *obj) |
Get the withdrawn state of a window. | |
void | elm_win_urgent_set (Evas_Object *obj, Eina_Bool urgent) |
Set the urgent state of a window. | |
Eina_Bool | elm_win_urgent_get (const Evas_Object *obj) |
Get the urgent state of a window. | |
void | elm_win_demand_attention_set (Evas_Object *obj, Eina_Bool demand_attention) |
Set the demand_attention state of a window. | |
Eina_Bool | elm_win_demand_attention_get (const Evas_Object *obj) |
Get the demand_attention state of a window. | |
void | elm_win_modal_set (Evas_Object *obj, Eina_Bool modal) |
Set the modal state of a window. | |
Eina_Bool | elm_win_modal_get (const Evas_Object *obj) |
Get the modal state of a window. | |
void | elm_win_aspect_set (Evas_Object *obj, double aspect) |
Set the aspect ratio of a window. | |
double | elm_win_aspect_get (const Evas_Object *obj) |
Get the aspect ratio of a window. | |
void | elm_win_size_base_set (Evas_Object *obj, int w, int h) |
Set the base window size used with stepping calculation. | |
void | elm_win_size_base_get (Evas_Object *obj, int *w, int *h) |
Get the base size of a window. | |
void | elm_win_size_step_set (Evas_Object *obj, int w, int h) |
Set the window stepping used with sizing calculation. | |
void | elm_win_size_step_get (Evas_Object *obj, int *w, int *h) |
Get the stepping of a window. | |
void | elm_win_layer_set (Evas_Object *obj, int layer) |
Set the layer of the window. | |
int | elm_win_layer_get (const Evas_Object *obj) |
Get the layer of the window. | |
void | elm_win_norender_push (Evas_Object *obj) |
This pushes (incriments) 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_rotation_set (Evas_Object *obj, int rotation) |
Set the rotation of the window. | |
void | elm_win_rotation_with_resize_set (Evas_Object *obj, int rotation) |
Rotates the window and resizes it. | |
int | elm_win_rotation_get (const Evas_Object *obj) |
Get the rotation of the window. | |
void | elm_win_sticky_set (Evas_Object *obj, Eina_Bool sticky) |
Set the sticky state of the window. | |
Eina_Bool | elm_win_sticky_get (const Evas_Object *obj) |
Get the sticky state of the window. | |
void | elm_win_conformant_set (Evas_Object *obj, Eina_Bool conformant) |
Set if this window is an illume conformant window. | |
Eina_Bool | elm_win_conformant_get (const Evas_Object *obj) |
Get if this window is an illume conformant window. | |
void | elm_win_quickpanel_set (Evas_Object *obj, Eina_Bool quickpanel) |
Set a window to be an illume quickpanel window. | |
Eina_Bool | elm_win_quickpanel_get (const Evas_Object *obj) |
Get if this window is a quickpanel or not. | |
void | elm_win_quickpanel_priority_major_set (Evas_Object *obj, int priority) |
Set the major priority of a quickpanel window. | |
int | elm_win_quickpanel_priority_major_get (const Evas_Object *obj) |
Get the major priority of a quickpanel window. | |
void | elm_win_quickpanel_priority_minor_set (Evas_Object *obj, int priority) |
Set the minor priority of a quickpanel window. | |
int | elm_win_quickpanel_priority_minor_get (const Evas_Object *obj) |
Get the minor priority of a quickpanel window. | |
void | elm_win_quickpanel_zone_set (Evas_Object *obj, int zone) |
Set which zone this quickpanel should appear in. | |
int | elm_win_quickpanel_zone_get (const Evas_Object *obj) |
Get which zone this quickpanel should appear in. | |
void | elm_win_prop_focus_skip_set (Evas_Object *obj, Eina_Bool skip) |
Set the window to be skipped by keyboard focus. | |
void | elm_win_illume_command_send (Evas_Object *obj, Elm_Illume_Command command, void *params) |
Send a command to the windowing environment. | |
Evas_Object * | elm_win_inlined_image_object_get (Evas_Object *obj) |
Get the inlined image object handle. | |
Eina_Bool | elm_win_focus_get (const Evas_Object *obj) |
Determine whether a window has focus. | |
void | elm_win_screen_constrain_set (Evas_Object *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 (Evas_Object *obj) |
Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen. | |
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. | |
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. | |
void | elm_win_focus_highlight_enabled_set (Evas_Object *obj, Eina_Bool enabled) |
Set the enabled status for the focus highlight in a window. | |
Eina_Bool | elm_win_focus_highlight_enabled_get (const Evas_Object *obj) |
Get the enabled value of the focus highlight for this window. | |
void | elm_win_focus_highlight_style_set (Evas_Object *obj, const char *style) |
Set the style for the focus highlight on this window. | |
const char * | elm_win_focus_highlight_style_get (const Evas_Object *obj) |
Get the style set for the focus highlight object. | |
void | elm_win_keyboard_mode_set (Evas_Object *obj, Elm_Win_Keyboard_Mode mode) |
Sets the keyboard mode of the window. | |
Elm_Win_Keyboard_Mode | elm_win_keyboard_mode_get (const Evas_Object *obj) |
Gets the keyboard mode of the window. | |
void | elm_win_keyboard_win_set (Evas_Object *obj, Eina_Bool is_keyboard) |
Sets whether the window is a keyboard. | |
Eina_Bool | elm_win_keyboard_win_get (const Evas_Object *obj) |
Gets whether the window is a keyboard. | |
void | elm_win_indicator_mode_set (Evas_Object *obj, Elm_Win_Indicator_Mode mode) |
Sets the indicator mode of the window. | |
Elm_Win_Indicator_Mode | elm_win_indicator_mode_get (const Evas_Object *obj) |
Gets the indicator mode of the window. | |
void | elm_win_indicator_opacity_set (Evas_Object *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 Evas_Object *obj) |
Gets the indicator opacity mode of the window. | |
void | elm_win_screen_position_get (const Evas_Object *obj, int *x, int *y) |
Get the screen position of a window. | |
Eina_Bool | elm_win_socket_listen (Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys) |
Create a socket to provide the service for Plug widget. | |
Ecore_X_Window | elm_win_xwindow_get (const Evas_Object *obj) |
Get the Ecore_X_Window of an Evas_Object. | |
Ecore_Wl_Window * | elm_win_wl_window_get (const Evas_Object *obj) |
Get the Ecore_Wl_Window of and Evas_Object. | |
Eina_Bool | elm_win_trap_set (const Elm_Win_Trap *trap) |
Sets the trap to be used for internal Ecore_Evas management. |
Detailed Description


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).
- "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)
- "dfb", "directfb" (Rendering to a DirectFB window)
- "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in grayscale using dedicated 8bit software engine in X11)
- "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in X11 using 16bit software engine)
- "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi" (Windows CE rendering via GDI with 16bit software renderer)
- "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL buffer with 16bit software renderer)
- "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
- "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
- "psl1ght" (PS3 rendering using PSL1GHT)
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
- "focus,out": window lost focus
- "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
Examples:
Typedef Documentation
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
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.
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.
Defines the opacity modes of indicator that can be shown.
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:
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 theparent
parameter of elm_win_add() to be a validEvas_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
Function Documentation
void elm_win_activate | ( | Evas_Object * | obj | ) |
Activate a window object.
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.
- Note:
- 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:
-
obj The window 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
.
- Parameters:
-
parent Parent object to add the window to, or NULL name The name of the window type The window type, one of Elm_Win_Type.
The parent
parameter can be NULL
for every window type
except ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on which the image object will be created.
- Returns:
- The created object, or
NULL
on failure
References elm_win_focus_highlight_enabled_set(), ELM_WIN_INDICATOR_UNKNOWN, ELM_WIN_INLINED_IMAGE, ELM_WIN_KEYBOARD_UNKNOWN, and ELM_WIN_SOCKET_IMAGE.
Referenced by elm_quicklaunch_seed(), and elm_win_util_standard_add().
Eina_Bool elm_win_alpha_get | ( | const Evas_Object * | obj | ) |
Get the alpha channel state of a window.
- Parameters:
-
obj The window object
- Returns:
- If true, the window has an alpha channel
void elm_win_alpha_set | ( | Evas_Object * | obj, |
Eina_Bool | alpha | ||
) |
Set the alpha channel state of a window.
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().
- Parameters:
-
obj The window object alpha If true, the window has an alpha channel
- See also:
- elm_win_alpha_set()
References elm_win_shaped_set().
double elm_win_aspect_get | ( | const Evas_Object * | obj | ) |
Get the aspect ratio of a window.
- Parameters:
-
obj The window object
- Returns:
- The aspect ratio set (0 by default)
void elm_win_aspect_set | ( | Evas_Object * | obj, |
double | aspect | ||
) |
Set the aspect ratio of a window.
- Parameters:
-
obj The window object aspect If 0, the window has no aspect limits, otherwise it is width divided by height
Eina_Bool elm_win_autodel_get | ( | const Evas_Object * | obj | ) |
Get the window's autodel state.
- Parameters:
-
obj The window object
- Returns:
- If the window will automatically delete itself when closed
- See also:
- 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 EINA_FALSE
, then the window will not be destroyed and is up to the program to do so when it's required.
- Parameters:
-
obj The window object autodel If true, the window will automatically delete itself when closed
Eina_Bool elm_win_borderless_get | ( | const Evas_Object * | obj | ) |
Get the borderless state of a window.
- Parameters:
-
obj The window object
- Returns:
- If true, the window is borderless
void elm_win_borderless_set | ( | Evas_Object * | obj, |
Eina_Bool | borderless | ||
) |
Set the borderless state of a window.
This function requests the Window Manager to not draw any decoration around the window.
- Parameters:
-
obj The window object borderless If true, the window is borderless
void elm_win_center | ( | Evas_Object * | obj, |
Eina_Bool | h, | ||
Eina_Bool | v | ||
) |
Center a window on its screen.
This function centers window obj
horizontally and/or vertically based on the values of h
and v
.
- Parameters:
-
obj The window object h If true, center horizontally. If false, do not change horizontal location. v If true, center vertically. If false, do not change vertical location.
Eina_Bool elm_win_conformant_get | ( | const Evas_Object * | obj | ) |
Get if this window is an illume conformant window.
- Parameters:
-
obj The window object
- Returns:
- A boolean if this window is illume conformant or not
void elm_win_conformant_set | ( | Evas_Object * | obj, |
Eina_Bool | conformant | ||
) |
Set if this window is an illume conformant window.
- Parameters:
-
obj The window object conformant The conformant flag (1 = conformant, 0 = non-conformant)
Eina_Bool elm_win_demand_attention_get | ( | const Evas_Object * | obj | ) |
Get the demand_attention state of a window.
- Parameters:
-
obj The window object
- Returns:
- If true, the window is demand_attention
void elm_win_demand_attention_set | ( | Evas_Object * | obj, |
Eina_Bool | demand_attention | ||
) |
Set the demand_attention state of a window.
- Parameters:
-
obj The window object demand_attention If true, the window is demand_attention
Eina_Bool elm_win_focus_get | ( | const Evas_Object * | obj | ) |
Determine whether a window has focus.
- Parameters:
-
obj The window to query
- Returns:
- EINA_TRUE if the window exists and has focus, else EINA_FALSE
Eina_Bool elm_win_focus_highlight_enabled_get | ( | const Evas_Object * | obj | ) |
Get the enabled value of the focus highlight for this window.
- Parameters:
-
obj The window in which to check if the focus highlight is enabled
- Returns:
- EINA_TRUE if enabled, EINA_FALSE otherwise
void elm_win_focus_highlight_enabled_set | ( | Evas_Object * | obj, |
Eina_Bool | enabled | ||
) |
Set the enabled status for the focus highlight in a window.
This function will enable or disable the focus highlight only for the given window, regardless of the global setting for it
- Parameters:
-
obj The window where to enable the highlight enabled The enabled value for the highlight
Referenced by elm_win_add().
const char* elm_win_focus_highlight_style_get | ( | const Evas_Object * | obj | ) |
Get the style set for the focus highlight object.
Gets the style set for this windows highlight object, or NULL if none is set.
- Parameters:
-
obj The window to retrieve the highlights style from
- Returns:
- The style set or NULL if none was. Default is used in that case.
void elm_win_focus_highlight_style_set | ( | Evas_Object * | obj, |
const char * | style | ||
) |
Set the style for the focus highlight on this window.
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:
-
obj The window where to set the style style The style to set
Eina_Bool elm_win_fullscreen_get | ( | const Evas_Object * | obj | ) |
Get the fullscreen state of a window.
- Parameters:
-
obj The window object
- Returns:
- If true, the window is fullscreen
void elm_win_fullscreen_set | ( | Evas_Object * | obj, |
Eina_Bool | fullscreen | ||
) |
Set the fullscreen state of a window.
- Parameters:
-
obj The window object fullscreen If true, the window is fullscreen
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 rendered invalid if a new icon name is set or if the window is destroyed.
- Parameters:
-
obj The window object
- Returns:
- The icon name
void elm_win_icon_name_set | ( | Evas_Object * | obj, |
const char * | icon_name | ||
) |
Set the icon name of the window.
- Parameters:
-
obj The window object icon_name The icon name to set
const Evas_Object* elm_win_icon_object_get | ( | const Evas_Object * | obj | ) |
Get the icon object used for the window.
The object returns is the one marked by elm_win_icon_object_set() as the object to use for the window icon.
- Parameters:
-
obj The window object
- Returns:
- The icon object set
void elm_win_icon_object_set | ( | Evas_Object * | obj, |
Evas_Object * | icon | ||
) |
Set a window object's icon.
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
- Parameters:
-
obj The window object to get an icon icon The Evas image object to use for an icon
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);
Eina_Bool elm_win_iconified_get | ( | const Evas_Object * | obj | ) |
Get the iconified state of a window.
- Parameters:
-
obj The window object
- Returns:
- If true, the window is iconified
void elm_win_iconified_set | ( | Evas_Object * | obj, |
Eina_Bool | iconified | ||
) |
Set the iconified state of a window.
- Parameters:
-
obj The window object iconified If true, the window is iconified
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:
-
obj The window object that lives in the environment to control command The command to send params Optional parameters for the command
References ELM_ILLUME_COMMAND_CLOSE, ELM_ILLUME_COMMAND_FOCUS_BACK, ELM_ILLUME_COMMAND_FOCUS_FORWARD, and ELM_ILLUME_COMMAND_FOCUS_HOME.
Elm_Win_Indicator_Mode elm_win_indicator_mode_get | ( | const Evas_Object * | obj | ) |
Gets the indicator mode of the window.
- Parameters:
-
obj The window object
- Returns:
- The mode, one of Elm_Win_Indicator_Mode
References ELM_WIN_INDICATOR_UNKNOWN.
void elm_win_indicator_mode_set | ( | Evas_Object * | obj, |
Elm_Win_Indicator_Mode | mode | ||
) |
Sets the indicator mode of the window.
- Parameters:
-
obj The window object mode The mode to set, one of Elm_Win_Indicator_Mode
References ELM_WIN_INDICATOR_HIDE, and ELM_WIN_INDICATOR_SHOW.
Elm_Win_Indicator_Opacity_Mode elm_win_indicator_opacity_get | ( | const Evas_Object * | obj | ) |
Gets the indicator opacity mode of the window.
- Parameters:
-
obj The window object
- Returns:
- The mode, one of Elm_Win_Indicator_Opacity_Mode
References ELM_WIN_INDICATOR_OPACITY_UNKNOWN.
void elm_win_indicator_opacity_set | ( | Evas_Object * | obj, |
Elm_Win_Indicator_Opacity_Mode | mode | ||
) |
Sets the indicator opacity mode of the window.
- Parameters:
-
obj The window object mode The mode to set, one of Elm_Win_Indicator_Opacity_Mode
References ELM_WIN_INDICATOR_OPAQUE, ELM_WIN_INDICATOR_TRANSLUCENT, and ELM_WIN_INDICATOR_TRANSPARENT.
Evas_Object* elm_win_inlined_image_object_get | ( | 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.
- Parameters:
-
obj The window object to get the inlined image from
- Returns:
- The inlined image object, or NULL if none exists
Referenced by elm_object_focus_set().
Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get | ( | const Evas_Object * | obj | ) |
Gets the keyboard mode of the window.
- Parameters:
-
obj The window object
- Returns:
- The mode, one of Elm_Win_Keyboard_Mode
References ELM_WIN_KEYBOARD_UNKNOWN.
void elm_win_keyboard_mode_set | ( | Evas_Object * | obj, |
Elm_Win_Keyboard_Mode | mode | ||
) |
Sets the keyboard mode of the window.
- Parameters:
-
obj The window object mode The mode to set, one of Elm_Win_Keyboard_Mode
Eina_Bool elm_win_keyboard_win_get | ( | const Evas_Object * | obj | ) |
Gets whether the window is a keyboard.
- Parameters:
-
obj The window object
- Returns:
- If the window is a virtual keyboard
void elm_win_keyboard_win_set | ( | Evas_Object * | obj, |
Eina_Bool | is_keyboard | ||
) |
Sets whether the window is a keyboard.
- Parameters:
-
obj The window object is_keyboard If true, the window is a virtual keyboard
int elm_win_layer_get | ( | const Evas_Object * | obj | ) |
Get the layer of the window.
- Parameters:
-
obj The window object
- Returns:
- The layer of the window
- See also:
- 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:
- < 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:
-
obj The window object layer The layer of the window
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.
- Parameters:
-
obj The window object
Eina_Bool elm_win_maximized_get | ( | const Evas_Object * | obj | ) |
Get the maximized state of a window.
- Parameters:
-
obj The window object
- Returns:
- If true, the window is maximized
void elm_win_maximized_set | ( | Evas_Object * | obj, |
Eina_Bool | maximized | ||
) |
Set the maximized state of a window.
- Parameters:
-
obj The window object maximized If true, the window is maximized
Eina_Bool elm_win_modal_get | ( | const Evas_Object * | obj | ) |
Get the modal state of a window.
- Parameters:
-
obj The window object
- Returns:
- If true, the window is modal
void elm_win_modal_set | ( | Evas_Object * | obj, |
Eina_Bool | modal | ||
) |
Set the modal state of a window.
- Parameters:
-
obj The window object modal If 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.
- Parameters:
-
obj The window object
- Returns:
- The number of times norender has been pushed
- Since:
- 1.7
void elm_win_norender_pop | ( | Evas_Object * | obj | ) |
This pops (decrements) the norender counter on the window.
- Parameters:
-
obj The window object
Once norender has gone back to 0, then automatic rendering will continue in the given window. If it is already at 0, this will have no effect.
- Since:
- 1.7
void elm_win_norender_push | ( | Evas_Object * | obj | ) |
This pushes (incriments) the norender counter on the window.
- Parameters:
-
obj The window object
There are some occasions where you wish to suspend rendering on a window. You may be "sleeping" and have nothing to update and do not want animations or other theme side-effects causing rendering to the window while "asleep". You can push (and pop) the norender mode to have this work.
If combined with evas_render_dump(), evas_image_cache_flush() and evas_font_cache_flush() (and maybe edje_file_cache_flush() and edje_collection_cache_flush()), you can minimize memory footprint significantly while "asleep", and the pausing of rendering ensures evas does not re-load data into memory until needed. When rendering is resumed, data will be re-loaded as needed, which may result in some lag, but does save memory.
- Since:
- 1.7
Eina_Bool elm_win_override_get | ( | const Evas_Object * | obj | ) |
Get the override state of a window.
- Parameters:
-
obj The window object
- Returns:
- If true, the window is overridden
- See also:
- 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 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.
- Parameters:
-
obj The window object override If true, the window is overridden
void elm_win_prop_focus_skip_set | ( | Evas_Object * | obj, |
Eina_Bool | skip | ||
) |
Set the window to be skipped by keyboard focus.
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:
-
obj The window object skip The skip flag state (EINA_TRUE if it is to be skipped)
Eina_Bool elm_win_quickpanel_get | ( | const Evas_Object * | obj | ) |
Get if this window is a quickpanel or not.
- Parameters:
-
obj The window object
- Returns:
- A boolean if this window is a quickpanel or not
int elm_win_quickpanel_priority_major_get | ( | const Evas_Object * | obj | ) |
Get the major priority of a quickpanel window.
- Parameters:
-
obj The window object
- Returns:
- The major priority of this quickpanel
void elm_win_quickpanel_priority_major_set | ( | Evas_Object * | obj, |
int | priority | ||
) |
Set the major priority of a quickpanel window.
- Parameters:
-
obj The window object priority The major priority for this quickpanel
int elm_win_quickpanel_priority_minor_get | ( | const Evas_Object * | obj | ) |
Get the minor priority of a quickpanel window.
- Parameters:
-
obj The window object
- Returns:
- The minor priority of this quickpanel
void elm_win_quickpanel_priority_minor_set | ( | Evas_Object * | obj, |
int | priority | ||
) |
Set the minor priority of a quickpanel window.
- Parameters:
-
obj The window object priority The minor priority for this quickpanel
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:
-
obj The window object quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
int elm_win_quickpanel_zone_get | ( | const Evas_Object * | obj | ) |
Get which zone this quickpanel should appear in.
- Parameters:
-
obj The window object
- Returns:
- The requested zone for this quickpanel
void elm_win_quickpanel_zone_set | ( | Evas_Object * | obj, |
int | zone | ||
) |
Set which zone this quickpanel should appear in.
- Parameters:
-
obj The window object zone The requested zone for this quickpanel
void elm_win_raise | ( | Evas_Object * | obj | ) |
Raise a window object.
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:
-
obj The window object
void elm_win_render | ( | Evas_Object * | obj | ) |
This manually asks evas to render the window now.
- Parameters:
-
obj The window object
You should NEVER call this unless you really know what you are doing and why. Never call this unless you are asking for performance degredation and possibly weird behavior. Windows get automatically rendered when the application goes idle so there is never a need to call this UNLESS you have enabled "norender" mode.
- Since:
- 1.7
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 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:
-
obj The window object subobj The resize object to add
References ELM_WIDGET_DATA.
Referenced by elm_quicklaunch_seed(), and elm_win_util_standard_add().
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:
-
obj The window object subobj The resize object to add
References ELM_WIDGET_DATA.
const char* elm_win_role_get | ( | const Evas_Object * | obj | ) |
Get the role of the window.
The returned string is an internal one and should not be freed or modified. It will also be rendered invalid if a new role is set or if the window is destroyed.
- Parameters:
-
obj The window object
- Returns:
- The role
void elm_win_role_set | ( | Evas_Object * | obj, |
const char * | role | ||
) |
Set the role of the window.
- Parameters:
-
obj The window object role The role to set
int elm_win_rotation_get | ( | const Evas_Object * | obj | ) |
Get the rotation of the window.
- Parameters:
-
obj The window object
- Returns:
- The rotation of the window in degrees (0-360)
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:
-
obj The window object rotation The rotation of the window, in degrees (0-360), counter-clockwise.
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:
-
obj The window object rotation The rotation of the window in degrees (0-360), counter-clockwise.
Eina_Bool elm_win_screen_constrain_get | ( | Evas_Object * | obj | ) |
Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen.
When this function returns true, obj
will never resize larger than the screen.
- Parameters:
-
obj The window object
- Returns:
- EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
void elm_win_screen_constrain_set | ( | Evas_Object * | obj, |
Eina_Bool | constrain | ||
) |
Constrain the maximum width and height of a window to the width and height of its screen.
When constrain
is true, obj
will never resize larger than the screen.
- Parameters:
-
obj The window object constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
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:
-
obj The window to query xdpi Pointer to value to store return horizontal dpi. May be NULL. ydpi Pointer to value to store return vertical dpi. May be NULL.
- Since:
- 1.7
void elm_win_screen_position_get | ( | const Evas_Object * | obj, |
int * | x, | ||
int * | y | ||
) |
Get the screen position of a window.
- Parameters:
-
obj The window object x The int to store the x coordinate to y The int to store the y coordinate to
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:
-
obj The window to query x where to return the horizontal offset value. May be NULL. y where to return the vertical offset value. May be NULL. w where to return the width value. May be NULL. h where to return the height value. May be NULL.
Eina_Bool elm_win_shaped_get | ( | const Evas_Object * | obj | ) |
Get the shaped state of a window.
- Parameters:
-
obj The window object
- Returns:
- If true, the window is shaped
- See also:
- 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 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.
- Parameters:
-
obj The window object shaped If true, the window is shaped
- See also:
- elm_win_alpha_set()
Referenced by elm_win_alpha_set().
void elm_win_size_base_get | ( | Evas_Object * | obj, |
int * | w, | ||
int * | h | ||
) |
Get the base size of a window.
- Parameters:
-
obj The window object w Pointer in which to store returned base width h Pointer in which to store returned base height
- Since:
- 1.7
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:
-
obj The window object w The base width h The base height
- Since:
- 1.7
void elm_win_size_step_get | ( | Evas_Object * | obj, |
int * | w, | ||
int * | h | ||
) |
Get the stepping of a window.
- Parameters:
-
obj The window object w Pointer in which to store returned stepping width h Pointer in which to store returned stepping height
- Since:
- 1.7
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:
-
obj The window object w The stepping width (0 disables) h The stepping height (0 disables)
- Since:
- 1.7
Eina_Bool elm_win_socket_listen | ( | Evas_Object * | obj, |
const char * | svcname, | ||
int | svcnum, | ||
Eina_Bool | svcsys | ||
) |
Create a socket to provide the service for Plug widget.
- Parameters:
-
obj The window object svcname The name of the service to be advertised. ensure that it is unique (when combined with svcnum
) otherwise creation may fail.svcnum A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name. svcsys A 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.
- Returns:
- If socket creation is successful
Eina_Bool elm_win_sticky_get | ( | const Evas_Object * | obj | ) |
Get the sticky state of the window.
- Parameters:
-
obj The window object
- Returns:
- If true, the window's sticky state is enabled
- See also:
- elm_win_sticky_set()
void elm_win_sticky_set | ( | Evas_Object * | obj, |
Eina_Bool | sticky | ||
) |
Set the sticky state of the window.
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.
- Parameters:
-
obj The window object sticky If true, the window's sticky state is enabled
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 rendered invalid if a new title is set or if the window is destroyed.
- Parameters:
-
obj The window object
- Returns:
- The title
void elm_win_title_set | ( | Evas_Object * | obj, |
const char * | title | ||
) |
Set the title of the window.
- Parameters:
-
obj The window object title The title to set
Referenced by elm_fileselector_button_window_title_set(), and elm_win_util_standard_add().
Eina_Bool elm_win_trap_set | ( | const Elm_Win_Trap * | trap | ) |
Sets the trap to be used for internal Ecore_Evas
management.
- Parameters:
-
trap the trap to be used or NULL
to remove traps. Pointer is not modified or copied, keep it alive.
- Returns:
EINA_TRUE
on success,EINA_FALSE
if there was a problem, such as invalid version number.
- Warning:
- this is an advanced feature that you should avoid using.
- Since:
- 1.7
Eina_Bool elm_win_urgent_get | ( | const Evas_Object * | obj | ) |
Get the urgent state of a window.
- Parameters:
-
obj The window object
- Returns:
- If true, the window is urgent
void elm_win_urgent_set | ( | Evas_Object * | obj, |
Eina_Bool | urgent | ||
) |
Set the urgent state of a window.
- Parameters:
-
obj The window object urgent If 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.
- Parameters:
-
name The name of the window title The title for the window
This creates a window like elm_win_add() but also puts in a standard background with elm_bg_add(), as well as setting the window title to title
. The window type created is of type ELM_WIN_BASIC, with NULL
as the parent widget.
- Returns:
- The created object, or
NULL
on failure
- See also:
- elm_win_add()
References elm_bg_add(), elm_win_add(), ELM_WIN_BASIC, elm_win_resize_object_add(), and elm_win_title_set().
Eina_Bool elm_win_withdrawn_get | ( | const Evas_Object * | obj | ) |
Get the withdrawn state of a window.
- Parameters:
-
obj The window object
- Returns:
- If true, the window is withdrawn
void elm_win_withdrawn_set | ( | Evas_Object * | obj, |
Eina_Bool | withdrawn | ||
) |
Set the withdrawn state of a window.
- Parameters:
-
obj The window object withdrawn If true, the window is withdrawn
Ecore_Wl_Window* elm_win_wl_window_get | ( | const Evas_Object * | obj | ) |
Get the Ecore_Wl_Window of and Evas_Object.
- Parameters:
-
obj the object
- Returns:
- The Ecore_Wl_Window of
obj
References elm_win_wl_window_get().
Referenced by elm_cnp_selection_get(), elm_cnp_selection_set(), and elm_win_wl_window_get().
Ecore_X_Window elm_win_xwindow_get | ( | const Evas_Object * | obj | ) |
Get the Ecore_X_Window of an Evas_Object.
- Parameters:
-
obj The object
- Returns:
- The Ecore_X_Window of
obj
References elm_win_xwindow_get().
Referenced by elm_entry_add(), and elm_win_xwindow_get().