5 * @image html win_inheritance_tree.png
6 * @image latex win_inheritance_tree.eps
8 * @image html img/widget/win/preview-00.png
9 * @image latex img/widget/win/preview-00.eps
11 * The window class of Elementary. Contains functions to manipulate
12 * windows. The Evas engine used to render the window contents is specified
13 * in the system or user elementary config files (whichever is found last),
14 * and can be overridden with the ELM_ENGINE environment variable for
15 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
16 * compilation setup and modules actually installed at runtime) are (listed
17 * in order of best supported and most likely to be complete and work to
20 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
21 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
23 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
25 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
27 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
29 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
30 * rendering using SDL as the buffer)
31 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
33 * @li "dfb", "directfb" (Rendering to a DirectFB window)
34 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
35 * grayscale using dedicated 8bit software engine in X11)
36 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
37 * X11 using 16bit software engine)
38 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
39 * (Windows CE rendering via GDI with 16bit software renderer)
40 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
41 * buffer with 16bit software renderer)
42 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
43 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
44 * @li "psl1ght" (PS3 rendering using PSL1GHT)
46 * All engines use a simple string to select the engine to render, EXCEPT
47 * the "shot" engine. This actually encodes the output of the virtual
48 * screenshot and how long to delay in the engine string. The engine string
49 * is encoded in the following way:
51 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
53 * Where options are separated by a ":" char if more than one option is
54 * given, with delay, if provided being the first option and file the last
55 * (order is important). The delay specifies how long to wait after the
56 * window is shown before doing the virtual "in memory" rendering and then
57 * save the output to the file specified by the file option (and then exit).
58 * If no delay is given, the default is 0.5 seconds. If no file is given the
59 * default output file is "out.png". Repeat option is for continuous
60 * capturing screenshots. Repeat range is from 1 to 999 and filename is
61 * fixed to "out001.png" Some examples of using the shot engine:
63 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
64 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
65 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
66 * ELM_ENGINE="shot:delay=2.0" elementary_test
67 * ELM_ENGINE="shot:" elementary_test
69 * Signals that you can add callbacks for are:
71 * @li "delete,request": the user requested to close the window. See
72 * elm_win_autodel_set().
73 * @li "focus,in": window got focus
74 * @li "focus,out": window lost focus
75 * @li "moved": window that holds the canvas was moved
76 * @li "withdrawn": window is still managed normally but removed from view
77 * @li "iconified": window is minimized (perhaps into an icon or taskbar)
78 * @li "normal": window is in a normal state (not withdrawn or iconified)
79 * @li "stick": window has become sticky (shows on all desktops)
80 * @li "unstick": window has stopped being sticky
81 * @li "fullscreen": window has become fullscreen
82 * @li "unfullscreen": window has stopped being fullscreen
83 * @li "maximized": window has been maximized
84 * @li "unmaximized": window has stopped being maximized
85 * @li "wm,rotation,changed": rotation of window has been changed by window manager
86 * @li "ioerr": there has been a low-level I/O error with the display system
89 * @li @ref win_example_01
94 * Defines the types of window that can be created
96 * These are hints set on the window so that a running Window Manager knows
97 * how the window should be handled and/or what kind of decorations it
100 * Currently, only the X11 backed engines use them.
104 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
105 window. Almost every window will be created with this
107 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
108 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
109 window holding desktop icons. */
110 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
111 be kept on top of any other window by the Window
113 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
115 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
116 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
118 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
119 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
120 entry in a menubar is clicked. Typically used
121 with elm_win_override_set(). This hint exists
122 for completion only, as the EFL way of
123 implementing a menu would not normally use a
124 separate window for its contents. */
125 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
126 triggered by right-clicking an object. */
127 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
128 explanatory text that typically appear after the
129 mouse cursor hovers over an object for a while.
130 Typically used with elm_win_override_set() and also
131 not very commonly used in the EFL. */
132 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
133 battery life or a new E-Mail received. */
134 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
135 usually used in the EFL. */
136 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
137 object being dragged across different windows, or even
138 applications. Typically used with
139 elm_win_override_set(). */
140 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
141 buffer. No actual window is created for this
142 type, instead the window and all of its
143 contents will be rendered to an image buffer.
144 This allows to have children window inside a
145 parent one just like any other object would
146 be, and do other things like applying @c
147 Evas_Map effects to it. This is the only type
148 of window that requires the @c parent
149 parameter of elm_win_add() to be a valid @c
151 ELM_WIN_SOCKET_IMAGE,/**< The window is rendered onto an image buffer
152 and can be shown other process's plug image object.
153 No actual window is created for this type,
154 instead the window and all of its contents will be
155 rendered to an image buffer and can be shown
156 other process's plug image object*/
160 * The different layouts that can be requested for the virtual keyboard.
162 * When the application window is being managed by Illume, it may request
163 * any of the following layouts for the virtual keyboard.
167 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
168 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
169 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
170 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
171 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
172 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
173 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
174 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
175 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QWERTY) keyboard layout */
176 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
177 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
178 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
179 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
180 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
181 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
182 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
183 } Elm_Win_Keyboard_Mode;
186 * In some environments, like phones, you may have an indicator that
187 * shows battery status, reception, time etc. This is the indicator.
189 * Sometimes you don't want it because you provide the same functionality
190 * inside your app, so this will request that the indicator is hidden in
191 * this circumstance if you use ELM_ILLUME_INDICATOR_HIDE. The default
192 * is to have the indicator shown.
196 ELM_WIN_INDICATOR_UNKNOWN, /**< Unknown indicator state */
197 ELM_WIN_INDICATOR_HIDE, /**< Hides the indicator */
198 ELM_WIN_INDICATOR_SHOW /**< Shows the indicator */
199 } Elm_Win_Indicator_Mode;
202 * Defines the opacity modes of indicator that can be shown
207 ELM_WIN_INDICATOR_OPACITY_UNKNOWN, /**< Unknown indicator opacity mode */
208 ELM_WIN_INDICATOR_OPAQUE, /**< Opacifies the indicator */
209 ELM_WIN_INDICATOR_TRANSLUCENT, /**< Be translucent the indicator */
210 ELM_WIN_INDICATOR_TRANSPARENT /**< Transparentizes the indicator */
211 } Elm_Win_Indicator_Opacity_Mode;
214 * Defines the type modes of indicator that can be shown
215 * If the indicator can support several type of indicator,
216 * you can use this enum value to deal with different type of indicator
221 ELM_WIN_INDICATOR_TYPE_UNKNOWN, /**< Unknown indicator type mode */
222 ELM_WIN_INDICATOR_TYPE_1, /**< Type 0 the the indicator */
223 ELM_WIN_INDICATOR_TYPE_2, /**< Type 1 the indicator */
224 } Elm_Win_Indicator_Type_Mode;
227 * Available commands that can be sent to the Illume manager.
229 * When running under an Illume session, a window may send commands to the
230 * Illume manager to perform different actions.
234 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous window */
235 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window in the list */
236 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home screen */
237 ELM_ILLUME_COMMAND_CLOSE, /**< Closes the currently active window */
238 } Elm_Illume_Command;
241 * Adds a window object. If this is the first window created, pass NULL as
244 * @param parent Parent object to add the window to, or NULL
245 * @param name The name of the window
246 * @param type The window type, one of #Elm_Win_Type.
248 * The @p parent parameter can be @c NULL for every window @p type
249 * except #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the
250 * canvas on which the image object will be created.
252 * @return The created object, or @c NULL on failure
256 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
259 * Adds a window object with standard setup
261 * @param name The name of the window
262 * @param title The title for the window
264 * This creates a window like elm_win_add() but also puts in a standard
265 * background with elm_bg_add(), as well as setting the window title to
266 * @p title. The window type created is of type ELM_WIN_BASIC, with @c NULL
267 * as the parent widget.
269 * @return The created object, or @c NULL on failure
275 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
278 * Add @p subobj as a resize object of window @p obj.
281 * Setting an object as a resize object of the window means that the
282 * @p subobj child's size and position will be controlled by the window
283 * directly. That is, the object will be resized to match the window size
284 * and should never be moved or resized manually by the developer.
286 * In addition, resize objects of the window control what the minimum size
287 * of it will be, as well as whether it can or not be resized by the user.
289 * For the end user to be able to resize a window by dragging the handles
290 * or borders provided by the Window Manager, or using any other similar
291 * mechanism, all of the resize objects in the window should have their
292 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
294 * Also notice that the window can get resized to the current size of the
295 * object if the EVAS_HINT_EXPAND is set @b after the call to
296 * elm_win_resize_object_add(). So if the object should get resized to the
297 * size of the window, set this hint @b before adding it as a resize object
298 * (this happens because the size of the window and the object are evaluated
299 * as soon as the object is added to the window).
301 * @param obj The window object
302 * @param subobj The resize object to add
306 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj);
309 * Delete @p subobj as a resize object of window @p obj.
311 * This function removes the object @p subobj from the resize objects of
312 * the window @p obj. It will not delete the object itself, which will be
313 * left unmanaged and should be deleted by the developer, manually handled
314 * or set as child of some other container.
316 * @param obj The window object
317 * @param subobj The resize object to add
321 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj);
324 * Set the title of the window
326 * @param obj The window object
327 * @param title The title to set
331 EAPI void elm_win_title_set(Evas_Object *obj, const char *title);
334 * Get the title of the window
336 * The returned string is an internal one and should not be freed or
337 * modified. It will also be rendered invalid if a new title is set or if
338 * the window is destroyed.
340 * @param obj The window object
345 EAPI const char *elm_win_title_get(const Evas_Object *obj);
348 * Set the icon name of the window
350 * @param obj The window object
351 * @param icon_name The icon name to set
355 EAPI void elm_win_icon_name_set(Evas_Object *obj, const char *icon_name);
358 * Get the icon name of the window
360 * The returned string is an internal one and should not be freed or
361 * modified. It will also be rendered invalid if a new icon name is set or if
362 * the window is destroyed.
364 * @param obj The window object
365 * @return The icon name
369 EAPI const char *elm_win_icon_name_get(const Evas_Object *obj);
372 * Set the role of the window
374 * @param obj The window object
375 * @param role The role to set
379 EAPI void elm_win_role_set(Evas_Object *obj, const char *role);
382 * Get the role of the window
384 * The returned string is an internal one and should not be freed or
385 * modified. It will also be rendered invalid if a new role is set or if
386 * the window is destroyed.
388 * @param obj The window object
393 EAPI const char *elm_win_role_get(const Evas_Object *obj);
396 * Set a window object's icon
398 * This sets an image to be used as the icon for the given window, in
399 * the window manager decoration part. The exact pixel dimensions of
400 * the object (not object size) will be used, and the image pixels
401 * will be used as-is when this function is called. If the image
402 * object has been updated, then call this function again to source
403 * the image pixels and put them on the window's icon. Note that
404 * <b>only Evas image objects are allowed</b>, for
406 * @param obj The window object to get an icon
407 * @param icon The Evas image object to use for an icon
411 * icon = evas_object_image_add(evas_object_evas_get(elm_window));
412 * evas_object_image_file_set(icon, "/path/to/the/icon", NULL);
413 * elm_win_icon_object_set(elm_window, icon);
414 * evas_object_show(icon);
419 EAPI void elm_win_icon_object_set(Evas_Object *obj, Evas_Object *icon);
422 * Get the icon object used for the window
424 * The object returns is the one marked by elm_win_icon_object_set() as the
425 * object to use for the window icon.
427 * @param obj The window object
428 * @return The icon object set
432 EAPI const Evas_Object *elm_win_icon_object_get(const Evas_Object *obj);
435 * Set the window's autodel state.
437 * When closing the window in any way outside of the program control, like
438 * pressing the X button in the titlebar or using a command from the
439 * Window Manager, a "delete,request" signal is emitted to indicate that
440 * this event occurred and the developer can take any action, which may
441 * include, or not, destroying the window object.
443 * When the @p autodel parameter is set, the window will be automatically
444 * destroyed when this event occurs, after the signal is emitted.
445 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
446 * and is up to the program to do so when it's required.
448 * @param obj The window object
449 * @param autodel If true, the window will automatically delete itself when
454 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel);
457 * Get the window's autodel state.
459 * @param obj The window object
460 * @return If the window will automatically delete itself when closed
462 * @see elm_win_autodel_set()
466 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj);
469 * Activate a window object.
471 * This function sends a request to the Window Manager to activate the
472 * window pointed by @p obj. If honored by the WM, the window will receive
473 * the keyboard focus.
475 * @note This is just a request that a Window Manager may ignore, so calling
476 * this function does not ensure in any way that the window will be the
477 * active one after it.
479 * @param obj The window object
483 EAPI void elm_win_activate(Evas_Object *obj);
486 * Lower a window object.
488 * Places the window pointed by @p obj at the bottom of the stack, so that
489 * no other window is covered by it.
491 * If elm_win_override_set() is not set, the Window Manager may ignore this
494 * @param obj The window object
498 EAPI void elm_win_lower(Evas_Object *obj);
501 * Raise a window object.
503 * Places the window pointed by @p obj at the top of the stack, so that it's
504 * not covered by any other window.
506 * If elm_win_override_set() is not set, the Window Manager may ignore this
509 * @param obj The window object
513 EAPI void elm_win_raise(Evas_Object *obj);
516 * Center a window on its screen
518 * This function centers window @p obj horizontally and/or vertically based on the values
520 * @param obj The window object
521 * @param h If true, center horizontally. If false, do not change horizontal location.
522 * @param v If true, center vertically. If false, do not change vertical location.
526 EAPI void elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v);
529 * Set the borderless state of a window.
531 * This function requests the Window Manager to not draw any decoration
534 * @param obj The window object
535 * @param borderless If true, the window is borderless
539 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless);
542 * Get the borderless state of a window.
544 * @param obj The window object
545 * @return If true, the window is borderless
549 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj);
552 * Set the shaped state of a window.
554 * Shaped windows, when supported, will render the parts of the window that
555 * has no content, transparent.
557 * If @p shaped is EINA_FALSE, then it is strongly advised to have some
558 * background object or cover the entire window in any other way, or the
559 * parts of the canvas that have no data will show framebuffer artifacts.
561 * @param obj The window object
562 * @param shaped If true, the window is shaped
564 * @see elm_win_alpha_set()
568 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped);
571 * Get the shaped state of a window.
573 * @param obj The window object
574 * @return If true, the window is shaped
576 * @see elm_win_shaped_set()
580 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj);
583 * Set the alpha channel state of a window.
585 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
586 * possibly making parts of the window completely or partially transparent.
587 * This is also subject to the underlying system supporting it, like for
588 * example, running under a compositing manager. If no compositing is
589 * available, enabling this option will instead fallback to using shaped
590 * windows, with elm_win_shaped_set().
592 * @param obj The window object
593 * @param alpha If true, the window has an alpha channel
595 * @see elm_win_alpha_set()
599 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha);
602 * Get the alpha channel state of a window.
604 * @param obj The window object
605 * @return If true, the window has an alpha channel
609 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj);
612 * Set the override state of a window.
614 * A window with @p override set to EINA_TRUE will not be managed by the
615 * Window Manager. This means that no decorations of any kind will be shown
616 * for it, moving and resizing must be handled by the application, as well
617 * as the window visibility.
619 * This should not be used for normal windows, and even for not so normal
620 * ones, it should only be used when there's a good reason and with a lot
621 * of care. Mishandling override windows may result situations that
622 * disrupt the normal workflow of the end user.
624 * @param obj The window object
625 * @param override If true, the window is overridden
629 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override);
632 * Get the override state of a window.
634 * @param obj The window object
635 * @return If true, the window is overridden
637 * @see elm_win_override_set()
641 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj);
644 * Set the fullscreen state of a window.
646 * @param obj The window object
647 * @param fullscreen If true, the window is fullscreen
651 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen);
654 * Get the fullscreen state of a window.
656 * @param obj The window object
657 * @return If true, the window is fullscreen
661 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj);
664 * Set the maximized state of a window.
666 * @param obj The window object
667 * @param maximized If true, the window is maximized
671 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized);
674 * Get the maximized state of a window.
676 * @param obj The window object
677 * @return If true, the window is maximized
681 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj);
684 * Set the iconified state of a window.
686 * @param obj The window object
687 * @param iconified If true, the window is iconified
691 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified);
694 * Get the iconified state of a window.
696 * @param obj The window object
697 * @return If true, the window is iconified
701 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj);
704 * Set the withdrawn state of a window.
706 * @param obj The window object
707 * @param withdrawn If true, the window is withdrawn
711 EAPI void elm_win_withdrawn_set(Evas_Object *obj, Eina_Bool withdrawn);
714 * Get the withdrawn state of a window.
716 * @param obj The window object
717 * @return If true, the window is withdrawn
721 EAPI Eina_Bool elm_win_withdrawn_get(const Evas_Object *obj);
724 * Set the profile list of a window.
726 * @param obj The window object
727 * @param profiles The list of profile's name
728 * @param num_profiles The number of profile names
732 EAPI void elm_win_profiles_set(Evas_Object *obj, const char **profiles, unsigned int num_profiles);
735 * Get the profile of a window.
737 * The returned string is an internal one and should not be freed or
738 * modified. It will also be rendered invalid if a new role is set or if
739 * the window is destroyed.
741 * @param obj The window object
742 * @return The profile's name
746 EAPI const char *elm_win_profile_get(const Evas_Object *obj);
749 * Set the urgent state of a window.
751 * @param obj The window object
752 * @param urgent If true, the window is urgent
756 EAPI void elm_win_urgent_set(Evas_Object *obj, Eina_Bool urgent);
759 * Get the urgent state of a window.
761 * @param obj The window object
762 * @return If true, the window is urgent
766 EAPI Eina_Bool elm_win_urgent_get(const Evas_Object *obj);
769 * Set the demand_attention state of a window.
771 * @param obj The window object
772 * @param demand_attention If true, the window is demand_attention
776 EAPI void elm_win_demand_attention_set(Evas_Object *obj, Eina_Bool demand_attention);
779 * Get the demand_attention state of a window.
781 * @param obj The window object
782 * @return If true, the window is demand_attention
786 EAPI Eina_Bool elm_win_demand_attention_get(const Evas_Object *obj);
789 * Set the modal state of a window.
791 * @param obj The window object
792 * @param modal If true, the window is modal
796 EAPI void elm_win_modal_set(Evas_Object *obj, Eina_Bool modal);
799 * Get the modal state of a window.
801 * @param obj The window object
802 * @return If true, the window is modal
806 EAPI Eina_Bool elm_win_modal_get(const Evas_Object *obj);
809 * Set the aspect ratio of a window.
811 * @param obj The window object
812 * @param aspect If 0, the window has no aspect limits, otherwise it is
813 * width divided by height
817 EAPI void elm_win_aspect_set(Evas_Object *obj, double aspect);
820 * Get the aspect ratio of a window.
822 * @param obj The window object
823 * @return The aspect ratio set (0 by default)
827 EAPI double elm_win_aspect_get(const Evas_Object *obj);
830 * Set the base window size used with stepping calculation
832 * Base size + stepping is what is calculated for window sizing restrictions.
834 * @param obj The window object
835 * @param w The base width
836 * @param h The base height
839 * @see elm_win_size_step_set
840 * @see elm_win_size_base_get
843 EAPI void elm_win_size_base_set(Evas_Object *obj, int w, int h);
846 * Get the base size of a window.
848 * @param obj The window object
849 * @param w Pointer in which to store returned base width
850 * @param h Pointer in which to store returned base height
853 * @see elm_win_size_base_set
854 * @see elm_win_size_step_set
857 EAPI void elm_win_size_base_get(Evas_Object *obj, int *w, int *h);
860 * Set the window stepping used with sizing calculation
862 * Base size + stepping is what is calculated for window sizing restrictions.
864 * @param obj The window object
865 * @param w The stepping width (0 disables)
866 * @param h The stepping height (0 disables)
869 * @see elm_win_size_step_get
870 * @see elm_win_size_base_set
873 EAPI void elm_win_size_step_set(Evas_Object *obj, int w, int h);
876 * Get the stepping of a window.
878 * @param obj The window object
879 * @param w Pointer in which to store returned stepping width
880 * @param h Pointer in which to store returned stepping height
883 * @see elm_win_size_base_set
884 * @see elm_win_size_step_set
887 EAPI void elm_win_size_step_get(Evas_Object *obj, int *w, int *h);
890 * Set the layer of the window.
892 * What this means exactly will depend on the underlying engine used.
894 * In the case of X11 backed engines, the value in @p layer has the
895 * following meanings:
896 * @li < 3: The window will be placed below all others.
897 * @li > 5: The window will be placed above all others.
898 * @li other: The window will be placed in the default layer.
900 * @param obj The window object
901 * @param layer The layer of the window
905 EAPI void elm_win_layer_set(Evas_Object *obj, int layer);
908 * Get the layer of the window.
910 * @param obj The window object
911 * @return The layer of the window
913 * @see elm_win_layer_set()
917 EAPI int elm_win_layer_get(const Evas_Object *obj);
920 * This pushes (incriments) the norender counter on the window
922 * @param obj The window object
924 * There are some occasions where you wish to suspend rendering on a window.
925 * You may be "sleeping" and have nothing to update and do not want animations
926 * or other theme side-effects causing rendering to the window while "asleep".
927 * You can push (and pop) the norender mode to have this work.
929 * If combined with evas_render_dump(), evas_image_cache_flush() and
930 * evas_font_cache_flush() (and maybe edje_file_cache_flush() and
931 * edje_collection_cache_flush()), you can minimize memory footprint
932 * significantly while "asleep", and the pausing of rendering ensures
933 * evas does not re-load data into memory until needed. When rendering is
934 * resumed, data will be re-loaded as needed, which may result in some
935 * lag, but does save memory.
937 * @see elm_win_norender_pop()
938 * @see elm_win_norender_get()
939 * @see elm_win_render()
943 EAPI void elm_win_norender_push(Evas_Object *obj);
946 * This pops (decrements) the norender counter on the window
948 * @param obj The window object
950 * Once norender has gone back to 0, then automatic rendering will continue
951 * in the given window. If it is already at 0, this will have no effect.
953 * @see elm_win_norender_push()
954 * @see elm_win_norender_get()
955 * @see elm_win_render()
959 EAPI void elm_win_norender_pop(Evas_Object *obj);
962 * The retruns how many times norender has been pushed on the window
963 * @param obj The window object
964 * @return The number of times norender has been pushed
966 * @see elm_win_norender_push()
967 * @see elm_win_norender_pop()
968 * @see elm_win_render()
972 EAPI int elm_win_norender_get(Evas_Object *obj);
975 * This manually asks evas to render the window now
977 * @param obj The window object
979 * You should NEVER call this unless you really know what you are doing and
980 * why. Never call this unless you are asking for performance degredation
981 * and possibly weird behavior. Windows get automatically rendered when the
982 * application goes idle so there is never a need to call this UNLESS you
983 * have enabled "norender" mode.
985 * @see elm_win_norender_push()
986 * @see elm_win_norender_pop()
987 * @see elm_win_norender_get()
991 EAPI void elm_win_render(Evas_Object *obj);
994 * Set the rotation of the window.
996 * Most engines only work with multiples of 90.
998 * This function is used to set the orientation of the window @p obj to
999 * match that of the screen. The window itself will be resized to adjust
1000 * to the new geometry of its contents. If you want to keep the window size,
1001 * see elm_win_rotation_with_resize_set().
1003 * @param obj The window object
1004 * @param rotation The rotation of the window, in degrees (0-360),
1005 * counter-clockwise.
1009 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation);
1012 * Rotates the window and resizes it.
1014 * Like elm_win_rotation_set(), but it also resizes the window's contents so
1015 * that they fit inside the current window geometry.
1017 * @param obj The window object
1018 * @param rotation The rotation of the window in degrees (0-360),
1019 * counter-clockwise.
1023 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation);
1026 * Get the rotation of the window.
1028 * @param obj The window object
1029 * @return The rotation of the window in degrees (0-360)
1031 * @see elm_win_rotation_set()
1032 * @see elm_win_rotation_with_resize_set()
1036 EAPI int elm_win_rotation_get(const Evas_Object *obj);
1039 * Set the sticky state of the window.
1041 * Hints the Window Manager that the window in @p obj should be left fixed
1042 * at its position even when the virtual desktop it's on moves or changes.
1044 * @param obj The window object
1045 * @param sticky If true, the window's sticky state is enabled
1049 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky);
1052 * Get the sticky state of the window.
1054 * @param obj The window object
1055 * @return If true, the window's sticky state is enabled
1057 * @see elm_win_sticky_set()
1061 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj);
1064 * Set if this window is an illume conformant window
1066 * @param obj The window object
1067 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
1071 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant);
1074 * Get if this window is an illume conformant window
1076 * @param obj The window object
1077 * @return A boolean if this window is illume conformant or not
1081 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj);
1084 * Set a window to be an illume quickpanel window
1086 * By default window objects are not quickpanel windows.
1088 * @param obj The window object
1089 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
1093 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel);
1096 * Get if this window is a quickpanel or not
1098 * @param obj The window object
1099 * @return A boolean if this window is a quickpanel or not
1103 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj);
1106 * Set the major priority of a quickpanel window
1108 * @param obj The window object
1109 * @param priority The major priority for this quickpanel
1113 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority);
1116 * Get the major priority of a quickpanel window
1118 * @param obj The window object
1119 * @return The major priority of this quickpanel
1123 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj);
1126 * Set the minor priority of a quickpanel window
1128 * @param obj The window object
1129 * @param priority The minor priority for this quickpanel
1133 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority);
1136 * Get the minor priority of a quickpanel window
1138 * @param obj The window object
1139 * @return The minor priority of this quickpanel
1143 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj);
1146 * Set which zone this quickpanel should appear in
1148 * @param obj The window object
1149 * @param zone The requested zone for this quickpanel
1153 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone);
1156 * Get which zone this quickpanel should appear in
1158 * @param obj The window object
1159 * @return The requested zone for this quickpanel
1163 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj);
1166 * Set the window to be skipped by keyboard focus
1168 * This sets the window to be skipped by normal keyboard input. This means
1169 * a window manager will be asked to not focus this window as well as omit
1170 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
1172 * Call this and enable it on a window BEFORE you show it for the first time,
1173 * otherwise it may have no effect.
1175 * Use this for windows that have only output information or might only be
1176 * interacted with by the mouse or fingers, and never for typing input.
1177 * Be careful that this may have side-effects like making the window
1178 * non-accessible in some cases unless the window is specially handled. Use
1181 * @param obj The window object
1182 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
1186 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip);
1189 * Send a command to the windowing environment
1191 * This is intended to work in touchscreen or small screen device
1192 * environments where there is a more simplistic window management policy in
1193 * place. This uses the window object indicated to select which part of the
1194 * environment to control (the part that this window lives in), and provides
1195 * a command and an optional parameter structure (use NULL for this if not
1198 * @param obj The window object that lives in the environment to control
1199 * @param command The command to send
1200 * @param params Optional parameters for the command
1204 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params);
1207 * Get the inlined image object handle
1209 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
1210 * then the window is in fact an evas image object inlined in the parent
1211 * canvas. You can get this object (be careful to not manipulate it as it
1212 * is under control of elementary), and use it to do things like get pixel
1213 * data, save the image to a file, etc.
1215 * @param obj The window object to get the inlined image from
1216 * @return The inlined image object, or NULL if none exists
1220 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
1223 * Determine whether a window has focus
1224 * @param obj The window to query
1225 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
1229 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj);
1232 * Constrain the maximum width and height of a window to the width and height of its screen
1234 * When @p constrain is true, @p obj will never resize larger than the screen.
1235 * @param obj The window object
1236 * @param constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
1240 EAPI void elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain);
1243 * Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen
1245 * When this function returns true, @p obj will never resize larger than the screen.
1246 * @param obj The window object
1247 * @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
1251 EAPI Eina_Bool elm_win_screen_constrain_get(Evas_Object *obj);
1254 * Get screen geometry details for the screen that a window is on
1255 * @param obj The window to query
1256 * @param x where to return the horizontal offset value. May be NULL.
1257 * @param y where to return the vertical offset value. May be NULL.
1258 * @param w where to return the width value. May be NULL.
1259 * @param h where to return the height value. May be NULL.
1263 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h);
1266 * Get screen dpi for the screen that a window is on
1267 * @param obj The window to query
1268 * @param xdpi Pointer to value to store return horizontal dpi. May be NULL.
1269 * @param ydpi Pointer to value to store return vertical dpi. May be NULL.
1274 EAPI void elm_win_screen_dpi_get(const Evas_Object *obj, int *xdpi, int *ydpi);
1277 * Set the enabled status for the focus highlight in a window
1279 * This function will enable or disable the focus highlight only for the
1280 * given window, regardless of the global setting for it
1282 * @param obj The window where to enable the highlight
1283 * @param enabled The enabled value for the highlight
1287 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled);
1290 * Get the enabled value of the focus highlight for this window
1292 * @param obj The window in which to check if the focus highlight is enabled
1294 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
1298 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj);
1301 * Set the style for the focus highlight on this window
1303 * Sets the style to use for theming the highlight of focused objects on
1304 * the given window. If @p style is NULL, the default will be used.
1306 * @param obj The window where to set the style
1307 * @param style The style to set
1311 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style);
1314 * Get the style set for the focus highlight object
1316 * Gets the style set for this windows highlight object, or NULL if none
1319 * @param obj The window to retrieve the highlights style from
1321 * @return The style set or NULL if none was. Default is used in that case.
1325 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj);
1328 * Sets the keyboard mode of the window.
1330 * @param obj The window object
1331 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
1335 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode);
1338 * Gets the keyboard mode of the window.
1340 * @param obj The window object
1341 * @return The mode, one of #Elm_Win_Keyboard_Mode
1345 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj);
1348 * Sets whether the window is a keyboard.
1350 * @param obj The window object
1351 * @param is_keyboard If true, the window is a virtual keyboard
1355 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard);
1358 * Gets whether the window is a keyboard.
1360 * @param obj The window object
1361 * @return If the window is a virtual keyboard
1365 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj);
1368 * Sets the indicator mode of the window.
1370 * @param obj The window object
1371 * @param mode The mode to set, one of #Elm_Win_Indicator_Mode
1375 EAPI void elm_win_indicator_mode_set(Evas_Object *obj, Elm_Win_Indicator_Mode mode);
1378 * Gets the indicator mode of the window.
1380 * @param obj The window object
1381 * @return The mode, one of #Elm_Win_Indicator_Mode
1385 EAPI Elm_Win_Indicator_Mode elm_win_indicator_mode_get(const Evas_Object *obj);
1388 * Sets the indicator opacity mode of the window.
1390 * @param obj The window object
1391 * @param mode The mode to set, one of #Elm_Win_Indicator_Opacity_Mode
1395 EAPI void elm_win_indicator_opacity_set(Evas_Object *obj, Elm_Win_Indicator_Opacity_Mode mode);
1398 * Gets the indicator opacity mode of the window.
1400 * @param obj The window object
1401 * @return The mode, one of #Elm_Win_Indicator_Opacity_Mode
1405 EAPI Elm_Win_Indicator_Opacity_Mode elm_win_indicator_opacity_get(const Evas_Object *obj);
1408 * Sets the indicator type mode of the window.
1410 * @param obj The window object
1411 * @param mode The mode to set, one of #Elm_Win_Indicator_Type_Mode
1415 EAPI void elm_win_indicator_type_set(Evas_Object *obj, Elm_Win_Indicator_Type_Mode mode);
1418 * Gets the indicator type mode of the window.
1420 * @param obj The window object
1421 * @return The mode, one of #Elm_Win_Indicator_Type_Mode
1425 EAPI Elm_Win_Indicator_Type_Mode elm_win_indicator_type_get(const Evas_Object *obj);
1428 * Get the screen position of a window.
1430 * @param obj The window object
1431 * @param x The int to store the x coordinate to
1432 * @param y The int to store the y coordinate to
1436 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y);
1439 * Create a socket to provide the service for Plug widget
1441 * @param obj The window object
1442 * @param svcname The name of the service to be advertised. ensure that it is unique (when combined with @p svcnum) otherwise creation may fail.
1443 * @param svcnum A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.
1444 * @param 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.
1445 * @return If socket creation is successful
1449 EAPI Eina_Bool elm_win_socket_listen(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys);
1451 /* X specific calls - won't work on non-x engines (return 0) */
1453 * Get the Ecore_X_Window of an Evas_Object
1455 * @param obj The object
1457 * @return The Ecore_X_Window of @p obj
1461 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj);
1463 /* Wayland specific call - returns NULL on non-Wayland engines */
1465 * Get the Ecore_Wl_Window of and Evas_Object
1467 * @param obj the object
1469 * @return The Ecore_Wl_Window of @p obj
1473 EAPI Ecore_Wl_Window *elm_win_wl_window_get(const Evas_Object *obj);
1476 * @typedef Elm_Win_Trap
1478 * Trap can be set with elm_win_trap_set() and will intercept the
1479 * calls to internal ecore_evas with the same name and parameters. If
1480 * there is a trap and it returns @c EINA_TRUE then the call will be
1481 * allowed, otherwise it will be ignored.
1485 typedef struct _Elm_Win_Trap Elm_Win_Trap;
1486 struct _Elm_Win_Trap
1488 #define ELM_WIN_TRAP_VERSION (1UL)
1489 unsigned long version;
1490 void *(*add)(Evas_Object *o); /**< object was just added. The returned pointer will be handled to every other trap call. */
1491 void (*del)(void *data, Evas_Object *o); /**< object will be deleted. */
1492 Eina_Bool (*hide)(void *data, Evas_Object *o);
1493 Eina_Bool (*show)(void *data, Evas_Object *o);
1494 Eina_Bool (*move)(void *data, Evas_Object *o, int x, int y);
1495 Eina_Bool (*resize)(void *data, Evas_Object *o, int w, int h);
1496 Eina_Bool (*center)(void *data, Evas_Object *o); /* not in ecore_evas, but nice to trap */
1497 Eina_Bool (*lower)(void *data, Evas_Object *o);
1498 Eina_Bool (*raise)(void *data, Evas_Object *o);
1499 Eina_Bool (*activate)(void *data, Evas_Object *o);
1500 Eina_Bool (*alpha_set)(void *data, Evas_Object *o, Eina_Bool alpha);
1501 Eina_Bool (*aspect_set)(void *data, Evas_Object *o, double aspect);
1502 Eina_Bool (*avoid_damage_set)(void *data, Evas_Object *o, Ecore_Evas_Avoid_Damage_Type on);
1503 Eina_Bool (*borderless_set)(void *data, Evas_Object *o, Eina_Bool on);
1504 Eina_Bool (*demand_attention_set)(void *data, Evas_Object *o, Eina_Bool on);
1505 Eina_Bool (*focus_skip_set)(void *data, Evas_Object *o, Eina_Bool skip);
1506 Eina_Bool (*fullscreen_set)(void *data, Evas_Object *o, Eina_Bool on);
1507 Eina_Bool (*iconified_set)(void *data, Evas_Object *o, Eina_Bool on);
1508 Eina_Bool (*layer_set)(void *data, Evas_Object *o, int layer);
1509 Eina_Bool (*manual_render_set)(void *data, Evas_Object *o, Eina_Bool manual_render);
1510 Eina_Bool (*maximized_set)(void *data, Evas_Object *o, Eina_Bool on);
1511 Eina_Bool (*modal_set)(void *data, Evas_Object *o, Eina_Bool on);
1512 Eina_Bool (*name_class_set)(void *data, Evas_Object *o, const char *n, const char *c);
1513 Eina_Bool (*object_cursor_set)(void *data, Evas_Object *o, Evas_Object *obj, int layer, int hot_x, int hot_y);
1514 Eina_Bool (*override_set)(void *data, Evas_Object *o, Eina_Bool on);
1515 Eina_Bool (*rotation_set)(void *data, Evas_Object *o, int rot);
1516 Eina_Bool (*rotation_with_resize_set)(void *data, Evas_Object *o, int rot);
1517 Eina_Bool (*shaped_set)(void *data, Evas_Object *o, Eina_Bool shaped);
1518 Eina_Bool (*size_base_set)(void *data, Evas_Object *o, int w, int h);
1519 Eina_Bool (*size_step_set)(void *data, Evas_Object *o, int w, int h);
1520 Eina_Bool (*size_min_set)(void *data, Evas_Object *o, int w, int h);
1521 Eina_Bool (*size_max_set)(void *data, Evas_Object *o, int w, int h);
1522 Eina_Bool (*sticky_set)(void *data, Evas_Object *o, Eina_Bool sticky);
1523 Eina_Bool (*title_set)(void *data, Evas_Object *o, const char *t);
1524 Eina_Bool (*urgent_set)(void *data, Evas_Object *o, Eina_Bool urgent);
1525 Eina_Bool (*withdrawn_set)(void *data, Evas_Object *o, Eina_Bool withdrawn);
1529 * Sets the trap to be used for internal @c Ecore_Evas management.
1531 * @param trap the trap to be used or @c NULL to remove traps. Pointer
1532 * is not modified or copied, keep it alive.
1533 * @return @c EINA_TRUE on success, @c EINA_FALSE if there was a
1534 * problem, such as invalid version number.
1536 * @warning this is an advanced feature that you should avoid using.
1540 EAPI Eina_Bool elm_win_trap_set(const Elm_Win_Trap *trap);
1543 * Set the floating mode of a window.
1545 * @param obj The window object
1546 * @param floating If true, the window is floating mode
1549 * @see elm_win_floating_mode_get()
1552 EAPI void elm_win_floating_mode_set(Evas_Object *obj, Eina_Bool floating);
1555 * Get the floating mode of a window.
1557 * @param obj The window object
1558 * @return If true, the window is floating mode
1561 * @see elm_win_floating_mode_set()
1564 EAPI Eina_Bool elm_win_floating_mode_get(const Evas_Object *obj);
1566 EAPI Eina_Bool elm_win_wm_rotation_supported_get(const Evas_Object *obj);
1567 EAPI void elm_win_wm_rotation_preferred_rotation_set(Evas_Object *obj, const int rotation);
1568 EAPI int elm_win_wm_rotation_preferred_rotation_get(const Evas_Object *obj);
1569 EAPI void elm_win_wm_rotation_available_rotations_set(Evas_Object *obj, const int *rotations, unsigned int count);
1570 EAPI Eina_Bool elm_win_wm_rotation_available_rotations_get(const Evas_Object *obj, int **rotations, unsigned int *count);