5 * @image html img/widget/win/preview-00.png
6 * @image latex img/widget/win/preview-00.eps
8 * The window class of Elementary. Contains functions to manipulate
9 * windows. The Evas engine used to render the window contents is specified
10 * in the system or user elementary config files (whichever is found last),
11 * and can be overridden with the ELM_ENGINE environment variable for
12 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
13 * compilation setup and modules actually installed at runtime) are (listed
14 * in order of best supported and most likely to be complete and work to
17 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
18 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
20 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
22 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
24 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
26 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
27 * rendering using SDL as the buffer)
28 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
30 * @li "dfb", "directfb" (Rendering to a DirectFB window)
31 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
32 * grayscale using dedicated 8bit software engine in X11)
33 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
34 * X11 using 16bit software engine)
35 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
36 * (Windows CE rendering via GDI with 16bit software renderer)
37 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
38 * buffer with 16bit software renderer)
39 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
40 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
41 * @li "psl1ght" (PS3 rendering using PSL1GHT)
43 * All engines use a simple string to select the engine to render, EXCEPT
44 * the "shot" engine. This actually encodes the output of the virtual
45 * screenshot and how long to delay in the engine string. The engine string
46 * is encoded in the following way:
48 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
50 * Where options are separated by a ":" char if more than one option is
51 * given, with delay, if provided being the first option and file the last
52 * (order is important). The delay specifies how long to wait after the
53 * window is shown before doing the virtual "in memory" rendering and then
54 * save the output to the file specified by the file option (and then exit).
55 * If no delay is given, the default is 0.5 seconds. If no file is given the
56 * default output file is "out.png". Repeat option is for continuous
57 * capturing screenshots. Repeat range is from 1 to 999 and filename is
58 * fixed to "out001.png" Some examples of using the shot engine:
60 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
61 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
62 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
63 * ELM_ENGINE="shot:delay=2.0" elementary_test
64 * ELM_ENGINE="shot:" elementary_test
66 * Signals that you can add callbacks for are:
68 * @li "delete,request": the user requested to close the window. See
69 * elm_win_autodel_set().
70 * @li "focus,in": window got focus
71 * @li "focus,out": window lost focus
72 * @li "moved": window that holds the canvas was moved
73 * @li "withdrawn": window is still managed normally but removed from view
74 * @li "iconified": window is minimized (perhaps into an icon or taskbar)
75 * @li "normal": window is in a normal state (not withdrawn or iconified)
76 * @li "stick": window has become sticky (shows on all desktops)
77 * @li "unstick": window has stopped being sticky
78 * @li "fullscreen": window has become fullscreen
79 * @li "unfullscreen": window has stopped being fullscreen
80 * @li "maximized": window has been maximized
81 * @li "unmaximized": window has stopped being maximized
82 * @li "profile,changed": window's profile has been changed
85 * @li @ref win_example_01
90 * Defines the types of window that can be created
92 * These are hints set on the window so that a running Window Manager knows
93 * how the window should be handled and/or what kind of decorations it
96 * Currently, only the X11 backed engines use them.
100 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
101 window. Almost every window will be created with this
103 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
104 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
105 window holding desktop icons. */
106 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
107 be kept on top of any other window by the Window
109 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
111 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
112 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
114 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
115 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
116 entry in a menubar is clicked. Typically used
117 with elm_win_override_set(). This hint exists
118 for completion only, as the EFL way of
119 implementing a menu would not normally use a
120 separate window for its contents. */
121 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
122 triggered by right-clicking an object. */
123 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
124 explanatory text that typically appear after the
125 mouse cursor hovers over an object for a while.
126 Typically used with elm_win_override_set() and also
127 not very commonly used in the EFL. */
128 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
129 battery life or a new E-Mail received. */
130 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
131 usually used in the EFL. */
132 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
133 object being dragged across different windows, or even
134 applications. Typically used with
135 elm_win_override_set(). */
136 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
137 buffer. No actual window is created for this
138 type, instead the window and all of its
139 contents will be rendered to an image buffer.
140 This allows to have children window inside a
141 parent one just like any other object would
142 be, and do other things like applying @c
143 Evas_Map effects to it. This is the only type
144 of window that requires the @c parent
145 parameter of elm_win_add() to be a valid @c
147 ELM_WIN_SOCKET_IMAGE,/**< The window is rendered onto an image buffer
148 and can be shown other process's plug image object.
149 No actual window is created for this type,
150 instead the window and all of its contents will be
151 rendered to an image buffer and can be shown
152 other process's plug image object*/
156 * The different layouts that can be requested for the virtual keyboard.
158 * When the application window is being managed by Illume, it may request
159 * any of the following layouts for the virtual keyboard.
163 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
164 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
165 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
166 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
167 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
168 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
169 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
170 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
171 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QWERTY) keyboard layout */
172 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
173 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
174 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
175 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
176 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
177 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
178 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
179 } Elm_Win_Keyboard_Mode;
182 * In some environments, like phones, you may have an indicator that
183 * shows battery status, reception, time etc. This is the indicator.
185 * Sometimes you don't want it because you provide the same functionality
186 * inside your app, so this will request that the indicator is hidden in
187 * this circumstance if you use ELM_ILLUME_INDICATOR_HIDE. The default
188 * is to have the indicator shown.
192 ELM_WIN_INDICATOR_UNKNOWN, /**< Unknown indicator state */
193 ELM_WIN_INDICATOR_HIDE, /**< Hides the indicator */
194 ELM_WIN_INDICATOR_SHOW /**< Shows the indicator */
195 } Elm_Win_Indicator_Mode;
198 * Defines the opacity modes of indicator that can be shown
203 ELM_WIN_INDICATOR_OPACITY_UNKNOWN, /**< Unknown indicator opacity mode */
204 ELM_WIN_INDICATOR_OPAQUE, /**< Opacifies the indicator */
205 ELM_WIN_INDICATOR_TRANSLUCENT, /**< Be translucent the indicator */
206 ELM_WIN_INDICATOR_TRANSPARENT /**< Transparentizes the indicator */
207 } Elm_Win_Indicator_Opacity_Mode;
210 * Available commands that can be sent to the Illume manager.
212 * When running under an Illume session, a window may send commands to the
213 * Illume manager to perform different actions.
217 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous window */
218 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window in the list */
219 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home screen */
220 ELM_ILLUME_COMMAND_CLOSE, /**< Closes the currently active window */
221 } Elm_Illume_Command;
224 * Adds a window object. If this is the first window created, pass NULL as
227 * @param parent Parent object to add the window to, or NULL
228 * @param name The name of the window
229 * @param type The window type, one of #Elm_Win_Type.
231 * The @p parent parameter can be @c NULL for every window @p type except
232 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
233 * which the image object will be created.
235 * @return The created object, or NULL on failure
239 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
242 * Adds a window object with standard setup
244 * @param name The name of the window
245 * @param title The title for the window
247 * This creates a window like elm_win_add() but also puts in a standard
248 * background with elm_bg_add(), as well as setting the window title to
249 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
250 * as the parent widget.
252 * @return The created object, or NULL on failure
258 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
261 * Add @p subobj as a resize object of window @p obj.
264 * Setting an object as a resize object of the window means that the
265 * @p subobj child's size and position will be controlled by the window
266 * directly. That is, the object will be resized to match the window size
267 * and should never be moved or resized manually by the developer.
269 * In addition, resize objects of the window control what the minimum size
270 * of it will be, as well as whether it can or not be resized by the user.
272 * For the end user to be able to resize a window by dragging the handles
273 * or borders provided by the Window Manager, or using any other similar
274 * mechanism, all of the resize objects in the window should have their
275 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
277 * Also notice that the window can get resized to the current size of the
278 * object if the EVAS_HINT_EXPAND is set @b after the call to
279 * elm_win_resize_object_add(). So if the object should get resized to the
280 * size of the window, set this hint @b before adding it as a resize object
281 * (this happens because the size of the window and the object are evaluated
282 * as soon as the object is added to the window).
284 * @param obj The window object
285 * @param subobj The resize object to add
289 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj);
292 * Delete @p subobj as a resize object of window @p obj.
294 * This function removes the object @p subobj from the resize objects of
295 * the window @p obj. It will not delete the object itself, which will be
296 * left unmanaged and should be deleted by the developer, manually handled
297 * or set as child of some other container.
299 * @param obj The window object
300 * @param subobj The resize object to add
304 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj);
307 * Set the title of the window
309 * @param obj The window object
310 * @param title The title to set
314 EAPI void elm_win_title_set(Evas_Object *obj, const char *title);
317 * Get the title of the window
319 * The returned string is an internal one and should not be freed or
320 * modified. It will also be rendered invalid if a new title is set or if
321 * the window is destroyed.
323 * @param obj The window object
328 EAPI const char *elm_win_title_get(const Evas_Object *obj);
331 * Set the icon name of the window
333 * @param obj The window object
334 * @param icon_name The icon name to set
338 EAPI void elm_win_icon_name_set(Evas_Object *obj, const char *icon_name);
341 * Get the icon name of the window
343 * The returned string is an internal one and should not be freed or
344 * modified. It will also be rendered invalid if a new icon name is set or if
345 * the window is destroyed.
347 * @param obj The window object
348 * @return The icon name
352 EAPI const char *elm_win_icon_name_get(const Evas_Object *obj);
355 * Set the role of the window
357 * @param obj The window object
358 * @param role The role to set
362 EAPI void elm_win_role_set(Evas_Object *obj, const char *role);
365 * Get the role of the window
367 * The returned string is an internal one and should not be freed or
368 * modified. It will also be rendered invalid if a new role is set or if
369 * the window is destroyed.
371 * @param obj The window object
376 EAPI const char *elm_win_role_get(const Evas_Object *obj);
379 * Set the object to represent the window icon
381 * This sets an object that will be used as the icon for the window. The exact
382 * pixel dimensions of the object (not object size) will be used, and the
383 * image pixels will be used as-is when this function is called. If the
384 * image object has been updated, then call this function again to source
385 * the image pixels and put them on the window's icon. This has limitations
386 * as only image objects allowed at this stage. This may be lifted in future.
388 * @param obj The window object
389 * @param icon The object to use for an icon
393 EAPI void elm_win_icon_object_set(Evas_Object *obj, Evas_Object *icon);
396 * Get the icon object used for the window
398 * The object returns is the one marked by elm_win_icon_object_set() as the
399 * object to use for the window icon.
401 * @param obj The window object
402 * @return The icon object set
406 EAPI const Evas_Object *elm_win_icon_object_get(const Evas_Object *obj);
409 * Set the window's autodel state.
411 * When closing the window in any way outside of the program control, like
412 * pressing the X button in the titlebar or using a command from the
413 * Window Manager, a "delete,request" signal is emitted to indicate that
414 * this event occurred and the developer can take any action, which may
415 * include, or not, destroying the window object.
417 * When the @p autodel parameter is set, the window will be automatically
418 * destroyed when this event occurs, after the signal is emitted.
419 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
420 * and is up to the program to do so when it's required.
422 * @param obj The window object
423 * @param autodel If true, the window will automatically delete itself when
428 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel);
431 * Get the window's autodel state.
433 * @param obj The window object
434 * @return If the window will automatically delete itself when closed
436 * @see elm_win_autodel_set()
440 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj);
443 * Activate a window object.
445 * This function sends a request to the Window Manager to activate the
446 * window pointed by @p obj. If honored by the WM, the window will receive
447 * the keyboard focus.
449 * @note This is just a request that a Window Manager may ignore, so calling
450 * this function does not ensure in any way that the window will be the
451 * active one after it.
453 * @param obj The window object
457 EAPI void elm_win_activate(Evas_Object *obj);
460 * Lower a window object.
462 * Places the window pointed by @p obj at the bottom of the stack, so that
463 * no other window is covered by it.
465 * If elm_win_override_set() is not set, the Window Manager may ignore this
468 * @param obj The window object
472 EAPI void elm_win_lower(Evas_Object *obj);
475 * Raise a window object.
477 * Places the window pointed by @p obj at the top of the stack, so that it's
478 * not covered by any other window.
480 * If elm_win_override_set() is not set, the Window Manager may ignore this
483 * @param obj The window object
487 EAPI void elm_win_raise(Evas_Object *obj);
490 * Center a window on its screen
492 * This function centers window @p obj horizontally and/or vertically based on the values
494 * @param obj The window object
495 * @param h If true, center horizontally. If false, do not change horizontal location.
496 * @param v If true, center vertically. If false, do not change vertical location.
500 EAPI void elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v);
503 * Set the borderless state of a window.
505 * This function requests the Window Manager to not draw any decoration
508 * @param obj The window object
509 * @param borderless If true, the window is borderless
513 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless);
516 * Get the borderless state of a window.
518 * @param obj The window object
519 * @return If true, the window is borderless
523 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj);
526 * Set the shaped state of a window.
528 * Shaped windows, when supported, will render the parts of the window that
529 * has no content, transparent.
531 * If @p shaped is EINA_FALSE, then it is strongly advised to have some
532 * background object or cover the entire window in any other way, or the
533 * parts of the canvas that have no data will show framebuffer artifacts.
535 * @param obj The window object
536 * @param shaped If true, the window is shaped
538 * @see elm_win_alpha_set()
542 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped);
545 * Get the shaped state of a window.
547 * @param obj The window object
548 * @return If true, the window is shaped
550 * @see elm_win_shaped_set()
554 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj);
557 * Set the alpha channel state of a window.
559 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
560 * possibly making parts of the window completely or partially transparent.
561 * This is also subject to the underlying system supporting it, like for
562 * example, running under a compositing manager. If no compositing is
563 * available, enabling this option will instead fallback to using shaped
564 * windows, with elm_win_shaped_set().
566 * @param obj The window object
567 * @param alpha If true, the window has an alpha channel
569 * @see elm_win_alpha_set()
573 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha);
576 * Get the alpha channel state of a window.
578 * @param obj The window object
579 * @return If true, the window has an alpha channel
583 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj);
586 * Set the override state of a window.
588 * A window with @p override set to EINA_TRUE will not be managed by the
589 * Window Manager. This means that no decorations of any kind will be shown
590 * for it, moving and resizing must be handled by the application, as well
591 * as the window visibility.
593 * This should not be used for normal windows, and even for not so normal
594 * ones, it should only be used when there's a good reason and with a lot
595 * of care. Mishandling override windows may result situations that
596 * disrupt the normal workflow of the end user.
598 * @param obj The window object
599 * @param override If true, the window is overridden
603 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override);
606 * Get the override state of a window.
608 * @param obj The window object
609 * @return If true, the window is overridden
611 * @see elm_win_override_set()
615 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj);
618 * Set the fullscreen state of a window.
620 * @param obj The window object
621 * @param fullscreen If true, the window is fullscreen
625 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen);
628 * Get the fullscreen state of a window.
630 * @param obj The window object
631 * @return If true, the window is fullscreen
635 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj);
638 * Set the maximized state of a window.
640 * @param obj The window object
641 * @param maximized If true, the window is maximized
645 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized);
648 * Get the maximized state of a window.
650 * @param obj The window object
651 * @return If true, the window is maximized
655 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj);
658 * Set the iconified state of a window.
660 * @param obj The window object
661 * @param iconified If true, the window is iconified
665 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified);
668 * Get the iconified state of a window.
670 * @param obj The window object
671 * @return If true, the window is iconified
675 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj);
678 * Set the withdrawn state of a window.
680 * @param obj The window object
681 * @param withdrawn If true, the window is withdrawn
685 EAPI void elm_win_withdrawn_set(Evas_Object *obj, Eina_Bool withdrawn);
688 * Get the withdrawn state of a window.
690 * @param obj The window object
691 * @return If true, the window is withdrawn
695 EAPI Eina_Bool elm_win_withdrawn_get(const Evas_Object *obj);
698 * Set the profile list of a window.
700 * @param obj The window object
701 * @param profiles The list of profile's name
702 * @param num_profiles The number of profile names
706 EAPI void elm_win_profiles_set(Evas_Object *obj, const char **profiles, unsigned int num_profiles);
709 * Get the profile of a window.
711 * The returned string is an internal one and should not be freed or
712 * modified. It will also be rendered invalid if a new role is set or if
713 * the window is destroyed.
715 * @param obj The window object
716 * @return The profile's name
720 EAPI const char *elm_win_profile_get(const Evas_Object *obj);
723 * Set the urgent state of a window.
725 * @param obj The window object
726 * @param urgent If true, the window is urgent
730 EAPI void elm_win_urgent_set(Evas_Object *obj, Eina_Bool urgent);
733 * Get the urgent state of a window.
735 * @param obj The window object
736 * @return If true, the window is urgent
740 EAPI Eina_Bool elm_win_urgent_get(const Evas_Object *obj);
743 * Set the demand_attention state of a window.
745 * @param obj The window object
746 * @param demand_attention If true, the window is demand_attention
750 EAPI void elm_win_demand_attention_set(Evas_Object *obj, Eina_Bool demand_attention);
753 * Get the demand_attention state of a window.
755 * @param obj The window object
756 * @return If true, the window is demand_attention
760 EAPI Eina_Bool elm_win_demand_attention_get(const Evas_Object *obj);
763 * Set the modal state of a window.
765 * @param obj The window object
766 * @param modal If true, the window is modal
770 EAPI void elm_win_modal_set(Evas_Object *obj, Eina_Bool modal);
773 * Get the modal state of a window.
775 * @param obj The window object
776 * @return If true, the window is modal
780 EAPI Eina_Bool elm_win_modal_get(const Evas_Object *obj);
783 * Set the aspect ratio of a window.
785 * @param obj The window object
786 * @param aspect If 0, the window has no aspect limits, otherwise it is
787 * width divided by height
791 EAPI void elm_win_aspect_set(Evas_Object *obj, double aspect);
794 * Get the aspect ratio of a window.
796 * @param obj The window object
797 * @return The aspect ratio set (0 by default)
801 EAPI double elm_win_aspect_get(const Evas_Object *obj);
804 * Set the layer of the window.
806 * What this means exactly will depend on the underlying engine used.
808 * In the case of X11 backed engines, the value in @p layer has the
809 * following meanings:
810 * @li < 3: The window will be placed below all others.
811 * @li > 5: The window will be placed above all others.
812 * @li other: The window will be placed in the default layer.
814 * @param obj The window object
815 * @param layer The layer of the window
819 EAPI void elm_win_layer_set(Evas_Object *obj, int layer);
822 * Get the layer of the window.
824 * @param obj The window object
825 * @return The layer of the window
827 * @see elm_win_layer_set()
831 EAPI int elm_win_layer_get(const Evas_Object *obj);
834 * Set the rotation of the window.
836 * Most engines only work with multiples of 90.
838 * This function is used to set the orientation of the window @p obj to
839 * match that of the screen. The window itself will be resized to adjust
840 * to the new geometry of its contents. If you want to keep the window size,
841 * see elm_win_rotation_with_resize_set().
843 * @param obj The window object
844 * @param rotation The rotation of the window, in degrees (0-360),
849 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation);
852 * Rotates the window and resizes it.
854 * Like elm_win_rotation_set(), but it also resizes the window's contents so
855 * that they fit inside the current window geometry.
857 * @param obj The window object
858 * @param rotation The rotation of the window in degrees (0-360),
863 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation);
866 * Get the rotation of the window.
868 * @param obj The window object
869 * @return The rotation of the window in degrees (0-360)
871 * @see elm_win_rotation_set()
872 * @see elm_win_rotation_with_resize_set()
876 EAPI int elm_win_rotation_get(const Evas_Object *obj);
879 * Set the sticky state of the window.
881 * Hints the Window Manager that the window in @p obj should be left fixed
882 * at its position even when the virtual desktop it's on moves or changes.
884 * @param obj The window object
885 * @param sticky If true, the window's sticky state is enabled
889 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky);
892 * Get the sticky state of the window.
894 * @param obj The window object
895 * @return If true, the window's sticky state is enabled
897 * @see elm_win_sticky_set()
901 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj);
904 * Set if this window is an illume conformant window
906 * @param obj The window object
907 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
911 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant);
914 * Get if this window is an illume conformant window
916 * @param obj The window object
917 * @return A boolean if this window is illume conformant or not
921 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj);
924 * Set a window to be an illume quickpanel window
926 * By default window objects are not quickpanel windows.
928 * @param obj The window object
929 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
933 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel);
936 * Get if this window is a quickpanel or not
938 * @param obj The window object
939 * @return A boolean if this window is a quickpanel or not
943 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj);
946 * Set the major priority of a quickpanel window
948 * @param obj The window object
949 * @param priority The major priority for this quickpanel
953 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority);
956 * Get the major priority of a quickpanel window
958 * @param obj The window object
959 * @return The major priority of this quickpanel
963 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj);
966 * Set the minor priority of a quickpanel window
968 * @param obj The window object
969 * @param priority The minor priority for this quickpanel
973 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority);
976 * Get the minor priority of a quickpanel window
978 * @param obj The window object
979 * @return The minor priority of this quickpanel
983 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj);
986 * Set which zone this quickpanel should appear in
988 * @param obj The window object
989 * @param zone The requested zone for this quickpanel
993 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone);
996 * Get which zone this quickpanel should appear in
998 * @param obj The window object
999 * @return The requested zone for this quickpanel
1003 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj);
1006 * Set the window to be skipped by keyboard focus
1008 * This sets the window to be skipped by normal keyboard input. This means
1009 * a window manager will be asked to not focus this window as well as omit
1010 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
1012 * Call this and enable it on a window BEFORE you show it for the first time,
1013 * otherwise it may have no effect.
1015 * Use this for windows that have only output information or might only be
1016 * interacted with by the mouse or fingers, and never for typing input.
1017 * Be careful that this may have side-effects like making the window
1018 * non-accessible in some cases unless the window is specially handled. Use
1021 * @param obj The window object
1022 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
1026 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip);
1029 * Send a command to the windowing environment
1031 * This is intended to work in touchscreen or small screen device
1032 * environments where there is a more simplistic window management policy in
1033 * place. This uses the window object indicated to select which part of the
1034 * environment to control (the part that this window lives in), and provides
1035 * a command and an optional parameter structure (use NULL for this if not
1038 * @param obj The window object that lives in the environment to control
1039 * @param command The command to send
1040 * @param params Optional parameters for the command
1044 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params);
1047 * Get the inlined image object handle
1049 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
1050 * then the window is in fact an evas image object inlined in the parent
1051 * canvas. You can get this object (be careful to not manipulate it as it
1052 * is under control of elementary), and use it to do things like get pixel
1053 * data, save the image to a file, etc.
1055 * @param obj The window object to get the inlined image from
1056 * @return The inlined image object, or NULL if none exists
1060 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
1063 * Determine whether a window has focus
1064 * @param obj The window to query
1065 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
1069 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj);
1072 * Constrain the maximum width and height of a window to the width and height of its screen
1074 * When @p constrain is true, @p obj will never resize larger than the screen.
1075 * @param obj The window object
1076 * @param constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
1080 EAPI void elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain);
1083 * Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen
1085 * When this function returns true, @p obj will never resize larger than the screen.
1086 * @param obj The window object
1087 * @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
1091 EAPI Eina_Bool elm_win_screen_constrain_get(Evas_Object *obj);
1094 * Get screen geometry details for the screen that a window is on
1095 * @param obj The window to query
1096 * @param x where to return the horizontal offset value. May be NULL.
1097 * @param y where to return the vertical offset value. May be NULL.
1098 * @param w where to return the width value. May be NULL.
1099 * @param h where to return the height value. May be NULL.
1103 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h);
1106 * Set the enabled status for the focus highlight in a window
1108 * This function will enable or disable the focus highlight only for the
1109 * given window, regardless of the global setting for it
1111 * @param obj The window where to enable the highlight
1112 * @param enabled The enabled value for the highlight
1116 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled);
1119 * Get the enabled value of the focus highlight for this window
1121 * @param obj The window in which to check if the focus highlight is enabled
1123 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
1127 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj);
1130 * Set the style for the focus highlight on this window
1132 * Sets the style to use for theming the highlight of focused objects on
1133 * the given window. If @p style is NULL, the default will be used.
1135 * @param obj The window where to set the style
1136 * @param style The style to set
1140 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style);
1143 * Get the style set for the focus highlight object
1145 * Gets the style set for this windows highlight object, or NULL if none
1148 * @param obj The window to retrieve the highlights style from
1150 * @return The style set or NULL if none was. Default is used in that case.
1154 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj);
1157 * Sets the keyboard mode of the window.
1159 * @param obj The window object
1160 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
1164 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode);
1167 * Gets the keyboard mode of the window.
1169 * @param obj The window object
1170 * @return The mode, one of #Elm_Win_Keyboard_Mode
1174 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj);
1177 * Sets whether the window is a keyboard.
1179 * @param obj The window object
1180 * @param is_keyboard If true, the window is a virtual keyboard
1184 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard);
1187 * Gets whether the window is a keyboard.
1189 * @param obj The window object
1190 * @return If the window is a virtual keyboard
1194 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj);
1197 * Sets the indicator mode of the window.
1199 * @param obj The window object
1200 * @param mode The mode to set, one of #Elm_Win_Indicator_Mode
1204 EAPI void elm_win_indicator_mode_set(Evas_Object *obj, Elm_Win_Indicator_Mode mode);
1206 // WRAPPER: Temperary added.
1207 EAPI void elm_win_indicator_state_set(Evas_Object *obj, Elm_Win_Indicator_Mode mode);
1210 * Gets the indicator mode of the window.
1212 * @param obj The window object
1213 * @return The mode, one of #Elm_Win_Indicator_Mode
1217 EAPI Elm_Win_Indicator_Mode elm_win_indicator_mode_get(const Evas_Object *obj);
1219 // WRAPPER: Temperary added.
1220 EAPI Elm_Win_Indicator_Mode elm_win_indicator_state_get(const Evas_Object *obj);
1223 * Sets the indicator opacity mode of the window.
1225 * @param obj The window object
1226 * @param mode The mode to set, one of #Elm_Win_Indicator_Opacity_Mode
1230 EAPI void elm_win_indicator_opacity_set(Evas_Object *obj, Elm_Win_Indicator_Opacity_Mode mode);
1233 * Gets the indicator opacity mode of the window.
1235 * @param obj The window object
1236 * @return The mode, one of #Elm_Win_Indicator_Opacity_Mode
1240 EAPI Elm_Win_Indicator_Opacity_Mode elm_win_indicator_opacity_get(const Evas_Object *obj);
1243 * Get the screen position of a window.
1245 * @param obj The window object
1246 * @param x The int to store the x coordinate to
1247 * @param y The int to store the y coordinate to
1251 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y);
1254 * Create a socket to provide the service for Plug widget
1256 * @param obj The window object
1257 * @param svcname The name of the service to be advertised. ensure that it is unique (when combined with @p svcnum) otherwise creation may fail.
1258 * @param svcnum A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.
1259 * @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.
1260 * @return If socket creation is successful
1264 EAPI Eina_Bool elm_win_socket_listen(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys);
1266 /* X specific calls - won't work on non-x engines (return 0) */
1268 * Get the Ecore_X_Window of an Evas_Object
1270 * @param obj The object
1272 * @return The Ecore_X_Window of @p obj
1276 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj);
1283 * @defgroup Inwin Inwin
1286 * @image html img/widget/inwin/preview-00.png
1287 * @image latex img/widget/inwin/preview-00.eps
1288 * @image html img/widget/inwin/preview-01.png
1289 * @image latex img/widget/inwin/preview-01.eps
1290 * @image html img/widget/inwin/preview-02.png
1291 * @image latex img/widget/inwin/preview-02.eps
1293 * An inwin is a window inside a window that is useful for a quick popup.
1294 * It does not hover.
1296 * It works by creating an object that will occupy the entire window, so it
1297 * must be created using an @ref Win "elm_win" as parent only. The inwin
1298 * object can be hidden or restacked below every other object if it's
1299 * needed to show what's behind it without destroying it. If this is done,
1300 * the elm_win_inwin_activate() function can be used to bring it back to
1301 * full visibility again.
1303 * There are three styles available in the default theme. These are:
1304 * @li default: The inwin is sized to take over most of the window it's
1306 * @li minimal: The size of the inwin will be the minimum necessary to show
1308 * @li minimal_vertical: Horizontally, the inwin takes as much space as
1309 * possible, but it's sized vertically the most it needs to fit its\
1312 * Some examples of Inwin can be found in the following:
1313 * @li @ref inwin_example_01
1319 * Adds an inwin to the current window
1321 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
1322 * Never call this function with anything other than the top-most window
1323 * as its parameter, unless you are fond of undefined behavior.
1325 * After creating the object, the widget will set itself as resize object
1326 * for the window with elm_win_resize_object_add(), so when shown it will
1327 * appear to cover almost the entire window (how much of it depends on its
1328 * content and the style used). It must not be added into other container
1329 * objects and it needs not be moved or resized manually.
1331 * @param parent The parent object
1332 * @return The new object or NULL if it cannot be created
1336 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *parent);
1339 * Activates an inwin object, ensuring its visibility
1341 * This function will make sure that the inwin @p obj is completely visible
1342 * by calling evas_object_show() and evas_object_raise() on it, to bring it
1343 * to the front. It also sets the keyboard focus to it, which will be passed
1346 * The object's theme will also receive the signal "elm,action,show" with
1349 * @param obj The inwin to activate
1353 EAPI void elm_win_inwin_activate(Evas_Object *obj);
1356 * Set the content of an inwin object.
1358 * Once the content object is set, a previously set one will be deleted.
1359 * If you want to keep that old content object, use the
1360 * elm_win_inwin_content_unset() function.
1362 * @param obj The inwin object
1363 * @param content The object to set as content
1367 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content);
1370 * Get the content of an inwin object.
1372 * Return the content object for this widget.
1374 * The returned object is valid as long as the inwin is still alive and no
1375 * other content is set on it. Deleting the object will notify the inwin
1376 * about it and this one will be left empty.
1378 * If you need to remove an inwin's content to be reused somewhere else,
1379 * see elm_win_inwin_content_unset().
1381 * @param obj The inwin object
1382 * @return The content that is being used
1386 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj);
1389 * Unset the content of an inwin object.
1391 * Unparent and return the content object which was set for this widget.
1393 * @param obj The inwin object
1394 * @return The content that was being used
1398 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj);
1401 * Set the floating mode of a window.
1403 * @param obj The window object
1404 * @param floating If true, the window is floating mode
1408 EAPI void elm_win_floating_mode_set(Evas_Object *obj, Eina_Bool floating);
1411 * Get the floating mode of a window.
1413 * @param obj The window object
1414 * @return If true, the window is floating mode
1418 EAPI Eina_Bool elm_win_floating_mode_get(const Evas_Object *obj);