Tizen Native API
|
Functions | |
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. | |
Elm_Win_Type | elm_win_type_get (Evas_Object *obj) |
Gets the type of a window. | |
Evas_Object * | elm_win_util_standard_add (const char *name, const char *title) |
Adds a window object with a standard setup. | |
void | elm_win_resize_object_add (Evas_Object *obj, Evas_Object *subobj) |
Adds subobj as a resize object of the window obj. | |
void | elm_win_resize_object_del (Evas_Object *obj, Evas_Object *subobj) |
Deletes subobj as a resize object of the window obj. | |
void | elm_win_title_set (Evas_Object *obj, const char *title) |
Sets the title of the window. | |
const char * | elm_win_title_get (const Evas_Object *obj) |
Gets the title of the window. | |
void | elm_win_icon_name_set (Evas_Object *obj, const char *icon_name) |
Sets the icon name of the window. | |
const char * | elm_win_icon_name_get (const Evas_Object *obj) |
Gets the icon name of the window. | |
void | elm_win_role_set (Evas_Object *obj, const char *role) |
Sets the role of the window. | |
const char * | elm_win_role_get (const Evas_Object *obj) |
Gets the role of the window. | |
void | elm_win_icon_object_set (Evas_Object *obj, Evas_Object *icon) |
Sets a window object icon. | |
const Evas_Object * | elm_win_icon_object_get (const Evas_Object *obj) |
Gets the icon object used for the window. | |
void | elm_win_autodel_set (Evas_Object *obj, Eina_Bool autodel) |
Sets the window autodel state. | |
Eina_Bool | elm_win_autodel_get (const Evas_Object *obj) |
Gets the window autodel state. | |
void | elm_win_activate (Evas_Object *obj) |
Activates the window object. | |
void | elm_win_lower (Evas_Object *obj) |
Lowers the window object. | |
void | elm_win_raise (Evas_Object *obj) |
Raises the window object. | |
void | elm_win_center (Evas_Object *obj, Eina_Bool h, Eina_Bool v) |
Centers a window on its screen. | |
void | elm_win_borderless_set (Evas_Object *obj, Eina_Bool borderless) |
Sets the borderless state of a window. | |
Eina_Bool | elm_win_borderless_get (const Evas_Object *obj) |
Gets the borderless state of a window. | |
void | elm_win_shaped_set (Evas_Object *obj, Eina_Bool shaped) |
Sets the shaped state of a window. | |
Eina_Bool | elm_win_shaped_get (const Evas_Object *obj) |
Gets the shaped state of a window. | |
void | elm_win_alpha_set (Evas_Object *obj, Eina_Bool alpha) |
Sets the alpha channel state of a window. | |
Eina_Bool | elm_win_alpha_get (const Evas_Object *obj) |
Gets the alpha channel state of a window. | |
void | elm_win_override_set (Evas_Object *obj, Eina_Bool override) |
Sets the override state of a window. | |
Eina_Bool | elm_win_override_get (const Evas_Object *obj) |
Gets the override state of a window. | |
void | elm_win_fullscreen_set (Evas_Object *obj, Eina_Bool fullscreen) |
Sets the fullscreen state of a window. | |
Eina_Bool | elm_win_fullscreen_get (const Evas_Object *obj) |
Geta the fullscreen state of a window. | |
void | elm_win_maximized_set (Evas_Object *obj, Eina_Bool maximized) |
Sets the maximized state of a window. | |
Eina_Bool | elm_win_maximized_get (const Evas_Object *obj) |
Gets the maximized state of a window. | |
void | elm_win_iconified_set (Evas_Object *obj, Eina_Bool iconified) |
Sets the iconified state of a window. | |
Eina_Bool | elm_win_iconified_get (const Evas_Object *obj) |
Gets the iconified state of a window. | |
void | elm_win_withdrawn_set (Evas_Object *obj, Eina_Bool withdrawn) |
Sets the withdrawn state of a window. | |
Eina_Bool | elm_win_withdrawn_get (const Evas_Object *obj) |
Gets the withdrawn state of a window. | |
void | elm_win_profiles_set (Evas_Object *obj, const char **profiles, unsigned int num_profiles) |
Sets the profile list of a window. | |
const char * | elm_win_profile_get (const Evas_Object *obj) |
Gets the profile of a window. | |
void | elm_win_urgent_set (Evas_Object *obj, Eina_Bool urgent) |
Sets the urgent state of a window. | |
Eina_Bool | elm_win_urgent_get (const Evas_Object *obj) |
Gets the urgent state of a window. | |
void | elm_win_demand_attention_set (Evas_Object *obj, Eina_Bool demand_attention) |
Sets the demand_attention state of a window. | |
Eina_Bool | elm_win_demand_attention_get (const Evas_Object *obj) |
Gets the demand_attention state of a window. | |
void | elm_win_modal_set (Evas_Object *obj, Eina_Bool modal) |
Sets the modal state of a window. | |
Eina_Bool | elm_win_modal_get (const Evas_Object *obj) |
Gets the modal state of a window. | |
void | elm_win_aspect_set (Evas_Object *obj, double aspect) |
Sets the aspect ratio of a window. | |
double | elm_win_aspect_get (const Evas_Object *obj) |
Gets the aspect ratio of a window. | |
void | elm_win_size_base_set (Evas_Object *obj, int w, int h) |
Sets the base window size used with stepping calculation. | |
void | elm_win_size_base_get (Evas_Object *obj, int *w, int *h) |
Gets the base size of a window. | |
void | elm_win_size_step_set (Evas_Object *obj, int w, int h) |
Sets the window stepping used with sizing calculation. | |
void | elm_win_size_step_get (Evas_Object *obj, int *w, int *h) |
Gets the stepping of a window. | |
void | elm_win_layer_set (Evas_Object *obj, int layer) |
Sets the layer of the window. | |
int | elm_win_layer_get (const Evas_Object *obj) |
Gets the layer of the window. | |
void | elm_win_norender_push (Evas_Object *obj) |
Pushes (incriments) the norender counter on the window. | |
void | elm_win_norender_pop (Evas_Object *obj) |
Pops (decrements) the norender counter on the window. | |
int | elm_win_norender_get (Evas_Object *obj) |
Returns the number of times norender has been pushed on the window. | |
void | elm_win_render (Evas_Object *obj) |
Manually asks evas to render the window immediately. | |
void | elm_win_rotation_set (Evas_Object *obj, int rotation) |
Sets 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) |
Gets the rotation of the window. | |
void | elm_win_sticky_set (Evas_Object *obj, Eina_Bool sticky) |
Sets the sticky state of the window. | |
Eina_Bool | elm_win_sticky_get (const Evas_Object *obj) |
Gets the sticky state of the window. | |
void | elm_win_conformant_set (Evas_Object *obj, Eina_Bool conformant) |
Sets whether this window is an illume conformant window. | |
Eina_Bool | elm_win_conformant_get (const Evas_Object *obj) |
Gets whether this window is an illume conformant window. | |
void | elm_win_quickpanel_set (Evas_Object *obj, Eina_Bool quickpanel) |
Sets a window to be an illume quickpanel window. | |
Eina_Bool | elm_win_quickpanel_get (const Evas_Object *obj) |
Gets whether this window is a quickpanel. | |
void | elm_win_quickpanel_priority_major_set (Evas_Object *obj, int priority) |
Sets the major priority of a quickpanel window. | |
int | elm_win_quickpanel_priority_major_get (const Evas_Object *obj) |
Gets the major priority of a quickpanel window. | |
void | elm_win_quickpanel_priority_minor_set (Evas_Object *obj, int priority) |
Sets the minor priority of a quickpanel window. | |
int | elm_win_quickpanel_priority_minor_get (const Evas_Object *obj) |
Gets the minor priority of a quickpanel window. | |
void | elm_win_quickpanel_zone_set (Evas_Object *obj, int zone) |
Sets the zone in which this quickpanel should appear. | |
int | elm_win_quickpanel_zone_get (const Evas_Object *obj) |
Gets the zone in which this should appear. | |
void | elm_win_prop_focus_skip_set (Evas_Object *obj, Eina_Bool skip) |
Sets the window to be skipped by keyboard focus. | |
void | elm_win_illume_command_send (Evas_Object *obj, Elm_Illume_Command command, void *params) |
Sends a command to the windowing environment. | |
Evas_Object * | elm_win_inlined_image_object_get (Evas_Object *obj) |
Gets the inlined image object handle. | |
Eina_Bool | elm_win_focus_get (const Evas_Object *obj) |
Determines whether a window has focus. | |
void | elm_win_screen_constrain_set (Evas_Object *obj, Eina_Bool constrain) |
Limits 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) |
Retrieves 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) |
Gets the 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) |
Gets the screen dpi for the screen that a window is on. | |
void | elm_win_focus_highlight_enabled_set (Evas_Object *obj, Eina_Bool enabled) |
Sets the enabled status for the focus highlight in a window. | |
Eina_Bool | elm_win_focus_highlight_enabled_get (const Evas_Object *obj) |
Gets the enabled value of the focus highlight for this window. | |
void | elm_win_focus_highlight_style_set (Evas_Object *obj, const char *style) |
Sets the style for the focus highlight on this window. | |
const char * | elm_win_focus_highlight_style_get (const Evas_Object *obj) |
Gets 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) |
Creates a socket to provide the service for a Plug widget. | |
Eina_Bool | elm_win_trap_set (const Elm_Win_Trap *trap) |
Sets the trap to be used for internal Ecore_Evas management. | |
void | elm_win_floating_mode_set (Evas_Object *obj, Eina_Bool floating) |
Sets the floating mode of a window. | |
Eina_Bool | elm_win_floating_mode_get (const Evas_Object *obj) |
Gets the floating mode of a window. | |
Eina_Bool | elm_win_wm_rotation_supported_get (const Evas_Object *obj) |
Queries whether Windows Manager supports window rotation. | |
void | elm_win_wm_rotation_preferred_rotation_set (Evas_Object *obj, const int rotation) |
Set the preferred rotation value. | |
int | elm_win_wm_rotation_preferred_rotation_get (const Evas_Object *obj) |
Gets the preferred rotation value. | |
void | elm_win_wm_rotation_available_rotations_set (Evas_Object *obj, const int *rotations, unsigned int count) |
Sets the array of available window rotations. | |
Eina_Bool | elm_win_wm_rotation_available_rotations_get (const Evas_Object *obj, int **rotations, unsigned int *count) |
Gets the array of available window rotations. | |
void | elm_win_wm_rotation_manual_rotation_done_set (Evas_Object *obj, Eina_Bool set) |
Sets the manual rotation done mode of the window. | |
Eina_Bool | elm_win_wm_rotation_manual_rotation_done_get (const Evas_Object *obj) |
Gets the manual rotation done mode of the window. | |
void | elm_win_wm_rotation_manual_rotation_done (Evas_Object *obj) |
Sets the rotation finish manually. | |
Typedefs | |
typedef struct _Elm_Win_Trap | Elm_Win_Trap |
Trap can be set with elm_win_trap_set() and intercepts the calls to internal ecore_evas with the same name and parameters. If there is a trap and it returns EINA_TRUE then the call is allowed, otherwise it is ignored. |
The window class of Elementary contains functions to manipulate Windows.
The Evas engine that is used to render the window contents is specified in the system or user elementary config files (whichever is found last), and can be overridden by using the ELM_ENGINE environment variable for testing. Engines that may be supported (depending on Evas and Ecore-Evas compilation setup and modules that are actually installed at runtime) are (listed in order of best supported and most likely to be complete and work to lowest quality).
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 the time for which to delay 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 displayed before doing the virtual "in memory" rendering and then saving the output to the file specified by the file option (and then exiting). If no delay is given, the default value is 0.5
seconds. If no file is given the default output file is "out.png". The repeat option is for continuous capturing of screenshots. The repeat range is from 1
to 999
and the filename is fixed to "out001.png" Some examples of using the shot engine are:
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 for which you can add callbacks are:
Trap can be set with elm_win_trap_set() and intercepts the calls to internal ecore_evas with the same name and parameters. If there is a trap and it returns EINA_TRUE
then the call is allowed, otherwise it is ignored.
enum Elm_Illume_Command |
Enumeration that defines the available commands that can be sent to the Illume manager.
Enumeration that defines the different indicator states.
ELM_ILLUME_INDICATOR_HIDE
. The default is to have the indicator shown. Enumeration that defines the opacity modes of an indicator that can be shown.
Enumeration that defines the type modes of an indicator that can be shown.
Enumeration that defines the different layouts that can be requested for the virtual keyboard.
enum Elm_Win_Type |
Enumeration that defines the types of windows that can be created.
ELM_WIN_UNKNOWN |
Unknown window type |
ELM_WIN_BASIC |
A normal window. It indicates a normal, top-level window. Almost every window is created with this type |
ELM_WIN_DIALOG_BASIC |
Used for simple dialog windows |
ELM_WIN_DESKTOP |
Used for special desktop windows, like a background window holding desktop icons |
ELM_WIN_DOCK |
The window is used as a dock or panel. Usually would be kept on top of any other window by the Windows Manager |
ELM_WIN_TOOLBAR |
The window is used to hold a floating toolbar, or something similar |
ELM_WIN_MENU |
This is similar to ELM_WIN_TOOLBAR |
ELM_WIN_UTILITY |
A persistent utility window, like a toolbox or palette |
ELM_WIN_SPLASH |
A splash window for an application that is starting up |
ELM_WIN_DROPDOWN_MENU |
The window is a dropdown menu, when an entry in a menubar is clicked. Typically used with elm_win_override_set(). This hint exists for completion only, as the EFL way of implementing a menu would not normally use a separate window for its contents |
ELM_WIN_POPUP_MENU |
Like ELM_WIN_DROPDOWN_MENU, but used for the menu triggered by right-clicking an object |
ELM_WIN_TOOLTIP |
The window is a tooltip. A short piece of explanatory text that typically appears after the mouse cursor hovers over an object for a while. Typically used with elm_win_override_set() and also not very commonly used in EFL |
ELM_WIN_NOTIFICATION |
A notification window, like a warning about battery life or a new email that is received |
ELM_WIN_COMBO |
A window holding the contents of a combo box. Not usually used in EFL |
ELM_WIN_DND |
Used to indicate that the window is a representation of an object being dragged across different windows, or even applications. Typically used with elm_win_override_set() |
ELM_WIN_INLINED_IMAGE |
The window is rendered onto an image buffer. No actual window is created for this type, instead the window and all of its contents are rendered to an image buffer. This allows to have a children window inside a parent one just like any other object would be, and do other things like applying |
ELM_WIN_SOCKET_IMAGE |
The window is rendered onto an image buffer and can be shown another process's plug image object. No actual window is created for this type, instead the window and all of its contents are rendered to an image buffer and can be shown another process's plug image object |
void elm_win_activate | ( | Evas_Object * | obj | ) |
Activates the window object.
This function sends a request to the Windows Manager to activate the window pointed by obj. If honored by the WM, the window receives the keyboard focus.
[in] | 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.
NULL
for every window type except ELM_WIN_INLINED_IMAGE
, which needs a parent to retrieve the canvas on which the image object is created.[in] | parent | The parent object to add the window to, otherwise NULL |
[in] | name | The name of the window |
[in] | type | The window type, one from Elm_Win_Type |
NULL
on failure Eina_Bool elm_win_alpha_get | ( | const Evas_Object * | obj | ) |
Gets the alpha channel state of a window.
[in] | obj | The window object |
true
if the window has an alpha channel, otherwise false
void elm_win_alpha_set | ( | Evas_Object * | obj, |
Eina_Bool | alpha | ||
) |
Sets the alpha channel state of a window.
EINA_TRUE
, the alpha channel of the canvas is enabled possibly making parts of the window completely or partially transparent. This is also subject to the underlying system supporting it, like for example, running under a compositing manager. If no compositing is available, enabling this option results in using shaped windows with elm_win_shaped_set().[in] | obj | The window object |
[in] | alpha | If true the window has an alpha channel, otherwise false |
double elm_win_aspect_get | ( | const Evas_Object * | obj | ) |
Gets the aspect ratio of a window.
[in] | obj | The window object |
0
by default) void elm_win_aspect_set | ( | Evas_Object * | obj, |
double | aspect | ||
) |
Sets the aspect ratio of a window.
[in] | obj | The window object |
[in] | 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 | ) |
Gets the window autodel state.
[in] | obj | The window object |
true
if the window automatically deletes itself when closed, otherwise false
void elm_win_autodel_set | ( | Evas_Object * | obj, |
Eina_Bool | autodel | ||
) |
Sets the window autodel state.
"delete,request"
signal is emitted to indicate that this event has occurred and the developer can take an action, which may or may not include destroying the window object.EINA_FALSE
, then the window is not destroyed and it is up to the program to decide when to do so if required.[in] | obj | The window object |
[in] | autodel | If true the window automatically deletes itself when closed, otherwise false |
Eina_Bool elm_win_borderless_get | ( | const Evas_Object * | obj | ) |
Gets the borderless state of a window.
[in] | obj | The window object |
true
if the window is borderless, otherwise false
void elm_win_borderless_set | ( | Evas_Object * | obj, |
Eina_Bool | borderless | ||
) |
Sets the borderless state of a window.
This function requests the Windows Manager to not draw any decoration around the window.
[in] | obj | The window object |
[in] | borderless | If true the window is borderless, otherwise false |
void elm_win_center | ( | Evas_Object * | obj, |
Eina_Bool | h, | ||
Eina_Bool | v | ||
) |
Centers a window on its screen.
This function centers a window obj horizontally and/or vertically based on the values of h and v.
[in] | obj | The window object |
[in] | h | If true it centers horizontally, otherwise false if it does not change the horizontal location |
[in] | v | If true it centers vertically, otherwise false if it does not change the vertical location |
Eina_Bool elm_win_conformant_get | ( | const Evas_Object * | obj | ) |
Gets whether this window is an illume conformant window.
[in] | obj | The window object |
void elm_win_conformant_set | ( | Evas_Object * | obj, |
Eina_Bool | conformant | ||
) |
Sets whether this window is an illume conformant window.
[in] | obj | The window object |
[in] | conformant | The conformant flag (1 = conformant, 0 = non-conformant) |
Eina_Bool elm_win_demand_attention_get | ( | const Evas_Object * | obj | ) |
Gets the demand_attention state of a window.
[in] | obj | The window object |
true
if the window is in the demand_attention state, otherwise false
void elm_win_demand_attention_set | ( | Evas_Object * | obj, |
Eina_Bool | demand_attention | ||
) |
Sets the demand_attention state of a window.
[in] | obj | The window object |
[in] | demand_attention | If true the window is in the demand_attention state, otherwise false |
Eina_Bool elm_win_floating_mode_get | ( | const Evas_Object * | obj | ) |
Gets the floating mode of a window.
[in] | obj | The window object |
true
if the window is in the floating mode, otherwise false
void elm_win_floating_mode_set | ( | Evas_Object * | obj, |
Eina_Bool | floating | ||
) |
Sets the floating mode of a window.
[in] | obj | The window object |
[in] | floating | If true the window is in the floating mode, otherwise false |
Eina_Bool elm_win_focus_get | ( | const Evas_Object * | obj | ) |
Determines whether a window has focus.
[in] | obj | The window to query |
EINA_TRUE
if the window exists and has focus, otherwise EINA_FALSE
Eina_Bool elm_win_focus_highlight_enabled_get | ( | const Evas_Object * | obj | ) |
Gets the enabled value of the focus highlight for this window.
[in] | obj | The window in which to check if the focus highlight is enabled |
EINA_TRUE
if enabled, otherwise EINA_FALSE
void elm_win_focus_highlight_enabled_set | ( | Evas_Object * | obj, |
Eina_Bool | enabled | ||
) |
Sets the enabled status for the focus highlight in a window.
This function enables or disables the focus highlight only for the given window, regardless of the global setting for it.
[in] | obj | The window for which to enable highlight |
[in] | enabled | The enabled value for the highlight |
const char* elm_win_focus_highlight_style_get | ( | const Evas_Object * | obj | ) |
Gets the style set for the focus highlight object.
This gets the style set for this windows highlight object, otherwise NULL
if no style is set.
[in] | obj | The window from which to retrieve the highlight style |
NULL
if no style is set void elm_win_focus_highlight_style_set | ( | Evas_Object * | obj, |
const char * | style | ||
) |
Sets the style for the focus highlight on this window.
This sets the style to use for theming the highlight of focused objects on the given window. If style is NULL
, the default value is used.
[in] | obj | The window for which to set the style |
[in] | style | The style to set |
Eina_Bool elm_win_fullscreen_get | ( | const Evas_Object * | obj | ) |
Geta the fullscreen state of a window.
[in] | obj | The window object |
true
if the window is fullscreen, otherwise false
void elm_win_fullscreen_set | ( | Evas_Object * | obj, |
Eina_Bool | fullscreen | ||
) |
Sets the fullscreen state of a window.
[in] | obj | The window object |
fullscreen | If true the window is fullscreen, otherwise false |
const char* elm_win_icon_name_get | ( | const Evas_Object * | obj | ) |
Gets the icon name of the window.
[in] | obj | The window object |
void elm_win_icon_name_set | ( | Evas_Object * | obj, |
const char * | icon_name | ||
) |
Sets the icon name of the window.
[in] | obj | The window object |
[in] | icon_name | The icon name to set |
const Evas_Object* elm_win_icon_object_get | ( | const Evas_Object * | obj | ) |
Gets the icon object used for the window.
[in] | obj | The window object |
void elm_win_icon_object_set | ( | Evas_Object * | obj, |
Evas_Object * | icon | ||
) |
Sets a window object icon.
This sets an image to be used as the icon for the given window, in the Windows Manager decoration part. The exact pixel dimensions of the object (not object size) is used, and the image pixels are used as-is when this function is called. If the image object has been updated, then call this function again to source the image pixels and put them on the window's icon. Note that only Evas image objects are allowed.
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);
[in] | obj | The window object used to get an icon |
[in] | icon | The Evas image object used as an icon |
Eina_Bool elm_win_iconified_get | ( | const Evas_Object * | obj | ) |
Gets the iconified state of a window.
[in] | obj | The window object |
true
if the window is iconified, otherwise false
void elm_win_iconified_set | ( | Evas_Object * | obj, |
Eina_Bool | iconified | ||
) |
Sets the iconified state of a window.
[in] | obj | The window object |
[in] | iconified | If true the window is iconified, otherwise false |
void elm_win_illume_command_send | ( | Evas_Object * | obj, |
Elm_Illume_Command | command, | ||
void * | params | ||
) |
Sends a command to the windowing environment.
NULL
for this if not needed).[in] | obj | The window object that lives in the environment to control |
[in] | command | The command to send |
[in] | params | The optional parameters for the command |
Elm_Win_Indicator_Mode elm_win_indicator_mode_get | ( | const Evas_Object * | obj | ) |
Gets the indicator mode of the window.
[in] | obj | The window object |
void elm_win_indicator_mode_set | ( | Evas_Object * | obj, |
Elm_Win_Indicator_Mode | mode | ||
) |
Sets the indicator mode of the window.
[in] | obj | The window object |
[in] | mode | The mode to set, one from Elm_Win_Indicator_Mode |
Gets the indicator opacity mode of the window.
[in] | obj | The window object |
void elm_win_indicator_opacity_set | ( | Evas_Object * | obj, |
Elm_Win_Indicator_Opacity_Mode | mode | ||
) |
Sets the indicator opacity mode of the window.
[in] | obj | The window object |
[in] | mode | The mode to set, one from Elm_Win_Indicator_Opacity_Mode |
Gets the inlined image object handle.
ELM_WIN_INLINED_IMAGE
, then the window is in fact an evas image object inlined in the parent canvas. You can get this object (be careful to not manipulate it as it is under the control of elementary), and use it to do things like get pixel data, save the image to a file, etc.[in] | obj | The window object from which to get the inlined image |
NULL
if none exist Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get | ( | const Evas_Object * | obj | ) |
Gets the keyboard mode of the window.
[in] | obj | The window object |
void elm_win_keyboard_mode_set | ( | Evas_Object * | obj, |
Elm_Win_Keyboard_Mode | mode | ||
) |
Sets the keyboard mode of the window.
[in] | obj | The window object |
[in] | mode | The mode to set, one from Elm_Win_Keyboard_Mode |
Eina_Bool elm_win_keyboard_win_get | ( | const Evas_Object * | obj | ) |
Gets whether the window is a keyboard.
[in] | obj | The window object |
true
if the window is a virtual keyboard, otherwise false
void elm_win_keyboard_win_set | ( | Evas_Object * | obj, |
Eina_Bool | is_keyboard | ||
) |
Sets whether the window is a keyboard.
[in] | obj | The window object |
[in] | is_keyboard | If true the window is a virtual keyboard, otherwise false |
int elm_win_layer_get | ( | const Evas_Object * | obj | ) |
Gets the layer of the window.
[in] | obj | The window object |
void elm_win_layer_set | ( | Evas_Object * | obj, |
int | layer | ||
) |
Sets the layer of the window.
[in] | obj | The window object |
[in] | layer | The layer of the window |
void elm_win_lower | ( | Evas_Object * | obj | ) |
Lowers the window object.
[in] | obj | The window object |
Eina_Bool elm_win_maximized_get | ( | const Evas_Object * | obj | ) |
Gets the maximized state of a window.
[in] | obj | The window object |
true
if the window is maximized, otherwise false
void elm_win_maximized_set | ( | Evas_Object * | obj, |
Eina_Bool | maximized | ||
) |
Sets the maximized state of a window.
[in] | obj | The window object |
[in] | maximized | If true the window is maximized, otherwise false |
Eina_Bool elm_win_modal_get | ( | const Evas_Object * | obj | ) |
Gets the modal state of a window.
[in] | obj | The window object |
true
the window is modal, otherwise false
void elm_win_modal_set | ( | Evas_Object * | obj, |
Eina_Bool | modal | ||
) |
Sets the modal state of a window.
[in] | obj | The window object |
[in] | modal | If true the window is modal, otherwise false |
int elm_win_norender_get | ( | Evas_Object * | obj | ) |
Returns the number of times norender has been pushed on the window.
[in] | obj | The window object |
void elm_win_norender_pop | ( | Evas_Object * | obj | ) |
Pops (decrements) the norender counter on the window.
0
, automatic rendering continues in the given window. If it is already at 0
, this has no effect.[in] | obj | The window object |
void elm_win_norender_push | ( | Evas_Object * | obj | ) |
Pushes (incriments) the norender counter on the window.
[in] | obj | The window object |
Eina_Bool elm_win_override_get | ( | const Evas_Object * | obj | ) |
Gets the override state of a window.
[in] | obj | The window object |
true
if the window is overridden, otherwise false
void elm_win_override_set | ( | Evas_Object * | obj, |
Eina_Bool | override | ||
) |
Sets the override state of a window.
EINA_TRUE
is not managed by the Windows Manager. This means that no decorations of any kind are shown for it, moving and resizing must be handled by the application as well as the window visibility.[in] | obj | The window object |
[in] | override | If true the window is overridden, otherwise false |
const char* elm_win_profile_get | ( | const Evas_Object * | obj | ) |
Gets the profile of a window.
[in] | obj | The window object |
void elm_win_profiles_set | ( | Evas_Object * | obj, |
const char ** | profiles, | ||
unsigned int | num_profiles | ||
) |
Sets the profile list of a window.
[in] | obj | The window object |
[in] | profiles | The list of profile names |
[in] | num_profiles | The number of profile names |
void elm_win_prop_focus_skip_set | ( | Evas_Object * | obj, |
Eina_Bool | skip | ||
) |
Sets the window to be skipped by keyboard focus.
This sets the window to be skipped by normal keyboard input. This means the Windows Manager is asked to not focus this window as well as omit it from things like the taskbar, pager, "alt-tab" list, etc.
[in] | obj | The window object |
[in] | skip | The skip flag state (EINA_TRUE if it is to be skipped) |
Eina_Bool elm_win_quickpanel_get | ( | const Evas_Object * | obj | ) |
Gets whether this window is a quickpanel.
[in] | obj | The window object |
int elm_win_quickpanel_priority_major_get | ( | const Evas_Object * | obj | ) |
Gets the major priority of a quickpanel window.
[in] | obj | The window object |
void elm_win_quickpanel_priority_major_set | ( | Evas_Object * | obj, |
int | priority | ||
) |
Sets the major priority of a quickpanel window.
[in] | obj | The window object |
[in] | priority | The major priority for this quickpanel |
int elm_win_quickpanel_priority_minor_get | ( | const Evas_Object * | obj | ) |
Gets the minor priority of a quickpanel window.
[in] | obj | The window object |
void elm_win_quickpanel_priority_minor_set | ( | Evas_Object * | obj, |
int | priority | ||
) |
Sets the minor priority of a quickpanel window.
[in] | obj | The window object |
[in] | priority | The minor priority for this quickpanel |
void elm_win_quickpanel_set | ( | Evas_Object * | obj, |
Eina_Bool | quickpanel | ||
) |
Sets a window to be an illume quickpanel window.
[in] | obj | The window object |
[in] | quickpanel | The quickpanel flag (1 = quickpanel, 0 = normal window) |
int elm_win_quickpanel_zone_get | ( | const Evas_Object * | obj | ) |
Gets the zone in which this should appear.
[in] | obj | The window object |
void elm_win_quickpanel_zone_set | ( | Evas_Object * | obj, |
int | zone | ||
) |
Sets the zone in which this quickpanel should appear.
[in] | obj | The window object |
[in] | zone | The requested zone for this quickpanel |
void elm_win_raise | ( | Evas_Object * | obj | ) |
Raises the window object.
[in] | obj | The window object |
void elm_win_render | ( | Evas_Object * | obj | ) |
Manually asks evas to render the window immediately.
[in] | obj | The window object |
void elm_win_resize_object_add | ( | Evas_Object * | obj, |
Evas_Object * | subobj | ||
) |
Adds subobj as a resize object of the window obj.
[in] | obj | The window object |
[in] | subobj | The resize object to add |
void elm_win_resize_object_del | ( | Evas_Object * | obj, |
Evas_Object * | subobj | ||
) |
Deletes subobj as a resize object of the window obj.
This function removes the object subobj from the resize objects of the window obj. It does not delete the object itself, which is left unmanaged and should be deleted by the developer, manually handled or set as the child of some other container.
[in] | obj | The window object |
[in] | subobj | The resize object to add |
const char* elm_win_role_get | ( | const Evas_Object * | obj | ) |
Gets the role of the window.
[in] | obj | The window object |
void elm_win_role_set | ( | Evas_Object * | obj, |
const char * | role | ||
) |
Sets the role of the window.
[in] | obj | The window object |
[in] | role | The role to set |
int elm_win_rotation_get | ( | const Evas_Object * | obj | ) |
Gets the rotation of the window.
[in] | obj | The window object |
void elm_win_rotation_set | ( | Evas_Object * | obj, |
int | rotation | ||
) |
Sets the rotation of the window.
90
.[in] | obj | The window object |
[in] | 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.
[in] | obj | The window object |
[in] | rotation | The rotation of the window, in degrees (0-360), counter-clockwise |
Retrieves the constraints on the maximum width and height of a window relative to the width and height of its screen.
true
, obj never resizes to a size larger than the screen. [in] | obj | The window object |
EINA_TRUE
to restrict the window's maximum size, otherwise EINA_FALSE
to disable restriction void elm_win_screen_constrain_set | ( | Evas_Object * | obj, |
Eina_Bool | constrain | ||
) |
Limits the maximum width and height of a window to the width and height of its screen.
true
, obj never resizes to a size larger than the screen. [in] | obj | The window object |
[in] | constrain | EINA_TRUE to restrict the window's maximum size, otherwise EINA_FALSE to disable restriction |
void elm_win_screen_dpi_get | ( | const Evas_Object * | obj, |
int * | xdpi, | ||
int * | ydpi | ||
) |
Gets the screen dpi for the screen that a window is on.
[in] | obj | The window to query |
[out] | xdpi | The pointer to the value that stores the returned horizontal dpi This may be NULL . |
[out] | ydpi | The pointer to the value that stores the returned vertical dpi This may be NULL . |
void elm_win_screen_position_get | ( | const Evas_Object * | obj, |
int * | x, | ||
int * | y | ||
) |
Get the screen position of a window.
[in] | obj | The window object |
[out] | x | The integer that stores the x coordinate |
[out] | y | The integer that stores the y coordinate |
void elm_win_screen_size_get | ( | const Evas_Object * | obj, |
int * | x, | ||
int * | y, | ||
int * | w, | ||
int * | h | ||
) |
Gets the screen geometry details for the screen that a window is on.
[in] | obj | The window to query |
[out] | x | The coordinate at which to return the horizontal offset value This may be NULL . |
[out] | y | The coordinate at which to return the vertical offset value This may be NULL . |
[out] | w | The coordinate at which to return the width value This may be NULL . |
[out] | h | The coordinate at which to return the height value This may be NULL . |
Eina_Bool elm_win_shaped_get | ( | const Evas_Object * | obj | ) |
Gets the shaped state of a window.
[in] | obj | The window object |
true
if the window is shaped, otherwise false
void elm_win_shaped_set | ( | Evas_Object * | obj, |
Eina_Bool | shaped | ||
) |
Sets the shaped state of a window.
EINA_FALSE
, then it is strongly advised to have some background object or cover the entire window in any other way, otherwise the parts of the canvas that have no data show framebuffer artifacts.[in] | obj | The window object |
[in] | shaped | If true the window is shaped, otherwise false |
void elm_win_size_base_get | ( | Evas_Object * | obj, |
int * | w, | ||
int * | h | ||
) |
Gets the base size of a window.
[in] | obj | The window object |
[out] | w | The pointer that stores the returned base width |
[out] | h | The pointer that stores the returned base height |
void elm_win_size_base_set | ( | Evas_Object * | obj, |
int | w, | ||
int | h | ||
) |
Sets the base window size used with stepping calculation.
[in] | obj | The window object |
[in] | w | The base width |
[in] | h | The base height |
void elm_win_size_step_get | ( | Evas_Object * | obj, |
int * | w, | ||
int * | h | ||
) |
Gets the stepping of a window.
[in] | obj | The window object |
[out] | w | The pointer that stores the returned stepping width |
[out] | h | The pointer that stores the returned stepping height |
void elm_win_size_step_set | ( | Evas_Object * | obj, |
int | w, | ||
int | h | ||
) |
Sets the window stepping used with sizing calculation.
[in] | obj | The window object |
[in] | w | The stepping width (0 disables) |
[in] | h | The stepping height (0 disables) |
Eina_Bool elm_win_socket_listen | ( | Evas_Object * | obj, |
const char * | svcname, | ||
int | svcnum, | ||
Eina_Bool | svcsys | ||
) |
Creates a socket to provide the service for a Plug widget.
[in] | obj | The window object |
[in] | svcname | The name of the service to be advertised Ensure that it is unique (when combined with svcnum), otherwise the creation may fail. |
[in] | svcnum | A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name |
[in] | svcsys | If true it specifies to create a system-wide service that all users can connect to, otherwise false if the service is private to the user ID that created the service |
Eina_Bool elm_win_sticky_get | ( | const Evas_Object * | obj | ) |
Gets the sticky state of the window.
[in] | obj | The window object |
true
the window's sticky state is enabled, otherwise false
void elm_win_sticky_set | ( | Evas_Object * | obj, |
Eina_Bool | sticky | ||
) |
Sets the sticky state of the window.
[in] | obj | The window object |
[in] | sticky | If true the window's sticky state is enabled, otherwise false |
const char* elm_win_title_get | ( | const Evas_Object * | obj | ) |
Gets the title of the window.
[in] | obj | The window object |
void elm_win_title_set | ( | Evas_Object * | obj, |
const char * | title | ||
) |
Sets the title of the window.
[in] | obj | The window object |
[in] | title | The 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.
[in] | trap | The trap to be used, otherwise NULL to remove traps The pointer is not modified or copied, it is kept alive. |
EINA_TRUE
on success, otherwise EINA_FALSE
if there is a problem, such as an invalid version number Elm_Win_Type elm_win_type_get | ( | Evas_Object * | obj | ) |
Gets the type of a window.
[in] | obj | The window object for which to get the type |
-1
. Eina_Bool elm_win_urgent_get | ( | const Evas_Object * | obj | ) |
Gets the urgent state of a window.
[in] | obj | The window object |
true
if the window is urgent, otherwise false
void elm_win_urgent_set | ( | Evas_Object * | obj, |
Eina_Bool | urgent | ||
) |
Sets the urgent state of a window.
[in] | obj | The window object |
[in] | urgent | If true the window is urgent, otherwise false |
Evas_Object* elm_win_util_standard_add | ( | const char * | name, |
const char * | title | ||
) |
Adds a window object with a standard setup.
ELM_WIN_BASIC
with NULL
as the parent widget.[in] | name | The name of the window |
[in] | title | The title of the window |
NULL
on failureEina_Bool elm_win_withdrawn_get | ( | const Evas_Object * | obj | ) |
Gets the withdrawn state of a window.
[in] | obj | The window object |
true
if the window is withdrawn, otherwise false
void elm_win_withdrawn_set | ( | Evas_Object * | obj, |
Eina_Bool | withdrawn | ||
) |
Sets the withdrawn state of a window.
[in] | obj | The window object |
[in] | withdrawn | If true the window is withdrawn, otherwise false |
Eina_Bool elm_win_wm_rotation_available_rotations_get | ( | const Evas_Object * | obj, |
int ** | rotations, | ||
unsigned int * | count | ||
) |
Gets the array of available window rotations.
This function is used to get the available rotations.
[in] | obj | The window object |
[out] | rotations | The array of rotation values |
[out] | count | The number of arrays of rotations |
void elm_win_wm_rotation_available_rotations_set | ( | Evas_Object * | obj, |
const int * | rotations, | ||
unsigned int | count | ||
) |
Sets the array of available window rotations.
This function is used to set the available rotations to give hints to WM. WM refers these hints and sets the orientation of the window properly.
[in] | obj | The window object |
[in] | rotations | The array of rotation values |
[in] | count | The number of arrays of rotations |
void elm_win_wm_rotation_manual_rotation_done | ( | Evas_Object * | obj | ) |
Sets the rotation finish manually.
[in] | obj | The window object |
Eina_Bool elm_win_wm_rotation_manual_rotation_done_get | ( | const Evas_Object * | obj | ) |
Gets the manual rotation done mode of the window.
[in] | obj | The window object |
true
if the manual rotation done mode is enabled, otherwise false
void elm_win_wm_rotation_manual_rotation_done_set | ( | Evas_Object * | obj, |
Eina_Bool | set | ||
) |
Sets the manual rotation done mode of the window.
[in] | obj | The window object |
[in] | set | If true , the Windows Manager does not rotate the window until the rotation done event is received by elm_win_wm_rotation_manual_rotation_done, otherwise false if the manual rotation mode is disabled |
int elm_win_wm_rotation_preferred_rotation_get | ( | const Evas_Object * | obj | ) |
Gets the preferred rotation value.
This function is used to get the preferred rotation value.
[in] | obj | The window object |
void elm_win_wm_rotation_preferred_rotation_set | ( | Evas_Object * | obj, |
const int | rotation | ||
) |
Set the preferred rotation value.
This function is used to set the orientation of window obj
to spicific angle fixed.
[in] | obj | The window object |
[in] | rotation | The preferred rotation of the window in degrees (0-360), counter-clockwise. |
Eina_Bool elm_win_wm_rotation_supported_get | ( | const Evas_Object * | obj | ) |
Queries whether Windows Manager supports window rotation.
[in] | obj | The window object |
EINA_TRUE
if the Windows Manager rotation is supported, otherwise EINA_FALSE