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
84 * @li @ref win_example_01
89 * Defines the types of window that can be created
91 * These are hints set on the window so that a running Window Manager knows
92 * how the window should be handled and/or what kind of decorations it
95 * Currently, only the X11 backed engines use them.
99 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
100 window. Almost every window will be created with this
102 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
103 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
104 window holding desktop icons. */
105 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
106 be kept on top of any other window by the Window
108 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
110 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
111 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
113 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
114 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
115 entry in a menubar is clicked. Typically used
116 with elm_win_override_set(). This hint exists
117 for completion only, as the EFL way of
118 implementing a menu would not normally use a
119 separate window for its contents. */
120 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
121 triggered by right-clicking an object. */
122 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
123 explanatory text that typically appear after the
124 mouse cursor hovers over an object for a while.
125 Typically used with elm_win_override_set() and also
126 not very commonly used in the EFL. */
127 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
128 battery life or a new E-Mail received. */
129 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
130 usually used in the EFL. */
131 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
132 object being dragged across different windows, or even
133 applications. Typically used with
134 elm_win_override_set(). */
135 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
136 buffer. No actual window is created for this
137 type, instead the window and all of its
138 contents will be rendered to an image buffer.
139 This allows to have children window inside a
140 parent one just like any other object would
141 be, and do other things like applying @c
142 Evas_Map effects to it. This is the only type
143 of window that requires the @c parent
144 parameter of elm_win_add() to be a valid @c
146 ELM_WIN_SOCKET_IMAGE,/**< The window is rendered onto an image buffer
147 and can be shown other process's plug image object.
148 No actual window is created for this type,
149 instead the window and all of its contents will be
150 rendered to an image buffer and can be shown
151 other process's plug image object*/
155 * The different layouts that can be requested for the virtual keyboard.
157 * When the application window is being managed by Illume, it may request
158 * any of the following layouts for the virtual keyboard.
162 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
163 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
164 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
165 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
166 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
167 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
168 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
169 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
170 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QWERTY) keyboard layout */
171 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
172 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
173 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
174 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
175 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
176 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
177 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
178 } Elm_Win_Keyboard_Mode;
181 * In some environments, like phones, you may have an indicator that
182 * shows battery status, reception, time etc. This is the indicator.
184 * Sometimes you don't want it because you provide the same functionality
185 * inside your app, so this will request that the indicator is hidden in
186 * this circumstance if you use ELM_ILLUME_INDICATOR_HIDE. The default
187 * is to have the indicator shown.
191 ELM_WIN_INDICATOR_UNKNOWN, /**< Unknown indicator state */
192 ELM_WIN_INDICATOR_HIDE, /**< Hides the indicator */
193 ELM_WIN_INDICATOR_SHOW /**< Shows the indicator */
194 } Elm_Win_Indicator_Mode;
197 * Defines the opacity modes of indicator that can be shown
202 ELM_WIN_INDICATOR_OPACITY_UNKNOWN, /**< Unknown indicator opacity mode */
203 ELM_WIN_INDICATOR_OPAQUE, /**< Opacifies the indicator */
204 ELM_WIN_INDICATOR_TRANSLUCENT, /**< Be translucent the indicator */
205 ELM_WIN_INDICATOR_TRANSPARENT /**< Transparentizes the indicator */
206 } Elm_Win_Indicator_Opacity_Mode;
209 * Available commands that can be sent to the Illume manager.
211 * When running under an Illume session, a window may send commands to the
212 * Illume manager to perform different actions.
216 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous window */
217 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window in the list */
218 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home screen */
219 ELM_ILLUME_COMMAND_CLOSE, /**< Closes the currently active window */
220 } Elm_Illume_Command;
223 * Adds a window object. If this is the first window created, pass NULL as
226 * @param parent Parent object to add the window to, or NULL
227 * @param name The name of the window
228 * @param type The window type, one of #Elm_Win_Type.
230 * The @p parent parameter can be @c NULL for every window @p type except
231 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
232 * which the image object will be created.
234 * @return The created object, or NULL on failure
238 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
241 * Adds a window object with standard setup
243 * @param name The name of the window
244 * @param title The title for the window
246 * This creates a window like elm_win_add() but also puts in a standard
247 * background with elm_bg_add(), as well as setting the window title to
248 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
249 * as the parent widget.
251 * @return The created object, or NULL on failure
257 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
260 * Add @p subobj as a resize object of window @p obj.
263 * Setting an object as a resize object of the window means that the
264 * @p subobj child's size and position will be controlled by the window
265 * directly. That is, the object will be resized to match the window size
266 * and should never be moved or resized manually by the developer.
268 * In addition, resize objects of the window control what the minimum size
269 * of it will be, as well as whether it can or not be resized by the user.
271 * For the end user to be able to resize a window by dragging the handles
272 * or borders provided by the Window Manager, or using any other similar
273 * mechanism, all of the resize objects in the window should have their
274 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
276 * Also notice that the window can get resized to the current size of the
277 * object if the EVAS_HINT_EXPAND is set @b after the call to
278 * elm_win_resize_object_add(). So if the object should get resized to the
279 * size of the window, set this hint @b before adding it as a resize object
280 * (this happens because the size of the window and the object are evaluated
281 * as soon as the object is added to the window).
283 * @param obj The window object
284 * @param subobj The resize object to add
288 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj);
291 * Delete @p subobj as a resize object of window @p obj.
293 * This function removes the object @p subobj from the resize objects of
294 * the window @p obj. It will not delete the object itself, which will be
295 * left unmanaged and should be deleted by the developer, manually handled
296 * or set as child of some other container.
298 * @param obj The window object
299 * @param subobj The resize object to add
303 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj);
306 * Set the title of the window
308 * @param obj The window object
309 * @param title The title to set
313 EAPI void elm_win_title_set(Evas_Object *obj, const char *title);
316 * Get the title of the window
318 * The returned string is an internal one and should not be freed or
319 * modified. It will also be rendered invalid if a new title is set or if
320 * the window is destroyed.
322 * @param obj The window object
327 EAPI const char *elm_win_title_get(const Evas_Object *obj);
330 * Set the icon name of the window
332 * @param obj The window object
333 * @param icon_name The icon name to set
337 EAPI void elm_win_icon_name_set(Evas_Object *obj, const char *icon_name);
340 * Get the icon name of the window
342 * The returned string is an internal one and should not be freed or
343 * modified. It will also be rendered invalid if a new icon name is set or if
344 * the window is destroyed.
346 * @param obj The window object
347 * @return The icon name
351 EAPI const char *elm_win_icon_name_get(const Evas_Object *obj);
354 * Set the role of the window
356 * @param obj The window object
357 * @param role The role to set
361 EAPI void elm_win_role_set(Evas_Object *obj, const char *role);
364 * Get the role of the window
366 * The returned string is an internal one and should not be freed or
367 * modified. It will also be rendered invalid if a new role is set or if
368 * the window is destroyed.
370 * @param obj The window object
375 EAPI const char *elm_win_role_get(const Evas_Object *obj);
378 * Set the object to represent the window icon
380 * This sets an object that will be used as the icon for the window. The exact
381 * pixel dimensions of the object (not object size) will be used, and the
382 * image pixels will be used as-is when this function is called. If the
383 * image object has been updated, then call this function again to source
384 * the image pixels and put them on the window's icon. This has limitations
385 * as only image objects allowed at this stage. This may be lifted in future.
387 * @param obj The window object
388 * @param icon The object to use for an icon
392 EAPI void elm_win_icon_object_set(Evas_Object *obj, Evas_Object *icon);
395 * Get the icon object used for the window
397 * The object returns is the one marked by elm_win_icon_object_set() as the
398 * object to use for the window icon.
400 * @param obj The window object
401 * @return The icon object set
405 EAPI const Evas_Object *elm_win_icon_object_get(const Evas_Object *obj);
408 * Set the window's autodel state.
410 * When closing the window in any way outside of the program control, like
411 * pressing the X button in the titlebar or using a command from the
412 * Window Manager, a "delete,request" signal is emitted to indicate that
413 * this event occurred and the developer can take any action, which may
414 * include, or not, destroying the window object.
416 * When the @p autodel parameter is set, the window will be automatically
417 * destroyed when this event occurs, after the signal is emitted.
418 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
419 * and is up to the program to do so when it's required.
421 * @param obj The window object
422 * @param autodel If true, the window will automatically delete itself when
427 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel);
430 * Get the window's autodel state.
432 * @param obj The window object
433 * @return If the window will automatically delete itself when closed
435 * @see elm_win_autodel_set()
439 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj);
442 * Activate a window object.
444 * This function sends a request to the Window Manager to activate the
445 * window pointed by @p obj. If honored by the WM, the window will receive
446 * the keyboard focus.
448 * @note This is just a request that a Window Manager may ignore, so calling
449 * this function does not ensure in any way that the window will be the
450 * active one after it.
452 * @param obj The window object
456 EAPI void elm_win_activate(Evas_Object *obj);
459 * Lower a window object.
461 * Places the window pointed by @p obj at the bottom of the stack, so that
462 * no other window is covered by it.
464 * If elm_win_override_set() is not set, the Window Manager may ignore this
467 * @param obj The window object
471 EAPI void elm_win_lower(Evas_Object *obj);
474 * Raise a window object.
476 * Places the window pointed by @p obj at the top of the stack, so that it's
477 * not covered by any other window.
479 * If elm_win_override_set() is not set, the Window Manager may ignore this
482 * @param obj The window object
486 EAPI void elm_win_raise(Evas_Object *obj);
489 * Center a window on its screen
491 * This function centers window @p obj horizontally and/or vertically based on the values
493 * @param obj The window object
494 * @param h If true, center horizontally. If false, do not change horizontal location.
495 * @param v If true, center vertically. If false, do not change vertical location.
499 EAPI void elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v);
502 * Set the borderless state of a window.
504 * This function requests the Window Manager to not draw any decoration
507 * @param obj The window object
508 * @param borderless If true, the window is borderless
512 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless);
515 * Get the borderless state of a window.
517 * @param obj The window object
518 * @return If true, the window is borderless
522 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj);
525 * Set the shaped state of a window.
527 * Shaped windows, when supported, will render the parts of the window that
528 * has no content, transparent.
530 * If @p shaped is EINA_FALSE, then it is strongly advised to have some
531 * background object or cover the entire window in any other way, or the
532 * parts of the canvas that have no data will show framebuffer artifacts.
534 * @param obj The window object
535 * @param shaped If true, the window is shaped
537 * @see elm_win_alpha_set()
541 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped);
544 * Get the shaped state of a window.
546 * @param obj The window object
547 * @return If true, the window is shaped
549 * @see elm_win_shaped_set()
553 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj);
556 * Set the alpha channel state of a window.
558 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
559 * possibly making parts of the window completely or partially transparent.
560 * This is also subject to the underlying system supporting it, like for
561 * example, running under a compositing manager. If no compositing is
562 * available, enabling this option will instead fallback to using shaped
563 * windows, with elm_win_shaped_set().
565 * @param obj The window object
566 * @param alpha If true, the window has an alpha channel
568 * @see elm_win_alpha_set()
572 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha);
575 * Get the alpha channel state of a window.
577 * @param obj The window object
578 * @return If true, the window has an alpha channel
582 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj);
585 * Set the override state of a window.
587 * A window with @p override set to EINA_TRUE will not be managed by the
588 * Window Manager. This means that no decorations of any kind will be shown
589 * for it, moving and resizing must be handled by the application, as well
590 * as the window visibility.
592 * This should not be used for normal windows, and even for not so normal
593 * ones, it should only be used when there's a good reason and with a lot
594 * of care. Mishandling override windows may result situations that
595 * disrupt the normal workflow of the end user.
597 * @param obj The window object
598 * @param override If true, the window is overridden
602 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override);
605 * Get the override state of a window.
607 * @param obj The window object
608 * @return If true, the window is overridden
610 * @see elm_win_override_set()
614 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj);
617 * Set the fullscreen state of a window.
619 * @param obj The window object
620 * @param fullscreen If true, the window is fullscreen
624 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen);
627 * Get the fullscreen state of a window.
629 * @param obj The window object
630 * @return If true, the window is fullscreen
634 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj);
637 * Set the maximized state of a window.
639 * @param obj The window object
640 * @param maximized If true, the window is maximized
644 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized);
647 * Get the maximized state of a window.
649 * @param obj The window object
650 * @return If true, the window is maximized
654 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj);
657 * Set the iconified state of a window.
659 * @param obj The window object
660 * @param iconified If true, the window is iconified
664 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified);
667 * Get the iconified state of a window.
669 * @param obj The window object
670 * @return If true, the window is iconified
674 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj);
677 * Set the withdrawn state of a window.
679 * @param obj The window object
680 * @param withdrawn If true, the window is withdrawn
684 EAPI void elm_win_withdrawn_set(Evas_Object *obj, Eina_Bool withdrawn);
687 * Get the withdrawn state of a window.
689 * @param obj The window object
690 * @return If true, the window is withdrawn
694 EAPI Eina_Bool elm_win_withdrawn_get(const Evas_Object *obj);
697 * Set the urgent state of a window.
699 * @param obj The window object
700 * @param urgent If true, the window is urgent
704 EAPI void elm_win_urgent_set(Evas_Object *obj, Eina_Bool urgent);
707 * Get the urgent state of a window.
709 * @param obj The window object
710 * @return If true, the window is urgent
714 EAPI Eina_Bool elm_win_urgent_get(const Evas_Object *obj);
717 * Set the demand_attention state of a window.
719 * @param obj The window object
720 * @param demand_attention If true, the window is demand_attention
724 EAPI void elm_win_demand_attention_set(Evas_Object *obj, Eina_Bool demand_attention);
727 * Get the demand_attention state of a window.
729 * @param obj The window object
730 * @return If true, the window is demand_attention
734 EAPI Eina_Bool elm_win_demand_attention_get(const Evas_Object *obj);
737 * Set the modal state of a window.
739 * @param obj The window object
740 * @param modal If true, the window is modal
744 EAPI void elm_win_modal_set(Evas_Object *obj, Eina_Bool modal);
747 * Get the modal state of a window.
749 * @param obj The window object
750 * @return If true, the window is modal
754 EAPI Eina_Bool elm_win_modal_get(const Evas_Object *obj);
757 * Set the aspect ratio of a window.
759 * @param obj The window object
760 * @param aspect If 0, the window has no aspect limits, otherwise it is
761 * width divided by height
765 EAPI void elm_win_aspect_set(Evas_Object *obj, double aspect);
768 * Get the aspect ratio of a window.
770 * @param obj The window object
771 * @return The aspect ratio set (0 by default)
775 EAPI double elm_win_aspect_get(const Evas_Object *obj);
778 * Set the layer of the window.
780 * What this means exactly will depend on the underlying engine used.
782 * In the case of X11 backed engines, the value in @p layer has the
783 * following meanings:
784 * @li < 3: The window will be placed below all others.
785 * @li > 5: The window will be placed above all others.
786 * @li other: The window will be placed in the default layer.
788 * @param obj The window object
789 * @param layer The layer of the window
793 EAPI void elm_win_layer_set(Evas_Object *obj, int layer);
796 * Get the layer of the window.
798 * @param obj The window object
799 * @return The layer of the window
801 * @see elm_win_layer_set()
805 EAPI int elm_win_layer_get(const Evas_Object *obj);
808 * Set the rotation of the window.
810 * Most engines only work with multiples of 90.
812 * This function is used to set the orientation of the window @p obj to
813 * match that of the screen. The window itself will be resized to adjust
814 * to the new geometry of its contents. If you want to keep the window size,
815 * see elm_win_rotation_with_resize_set().
817 * @param obj The window object
818 * @param rotation The rotation of the window, in degrees (0-360),
823 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation);
826 * Rotates the window and resizes it.
828 * Like elm_win_rotation_set(), but it also resizes the window's contents so
829 * that they fit inside the current window geometry.
831 * @param obj The window object
832 * @param rotation The rotation of the window in degrees (0-360),
837 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation);
840 * Get the rotation of the window.
842 * @param obj The window object
843 * @return The rotation of the window in degrees (0-360)
845 * @see elm_win_rotation_set()
846 * @see elm_win_rotation_with_resize_set()
850 EAPI int elm_win_rotation_get(const Evas_Object *obj);
853 * Set the sticky state of the window.
855 * Hints the Window Manager that the window in @p obj should be left fixed
856 * at its position even when the virtual desktop it's on moves or changes.
858 * @param obj The window object
859 * @param sticky If true, the window's sticky state is enabled
863 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky);
866 * Get the sticky state of the window.
868 * @param obj The window object
869 * @return If true, the window's sticky state is enabled
871 * @see elm_win_sticky_set()
875 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj);
878 * Set if this window is an illume conformant window
880 * @param obj The window object
881 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
885 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant);
888 * Get if this window is an illume conformant window
890 * @param obj The window object
891 * @return A boolean if this window is illume conformant or not
895 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj);
898 * Set a window to be an illume quickpanel window
900 * By default window objects are not quickpanel windows.
902 * @param obj The window object
903 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
907 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel);
910 * Get if this window is a quickpanel or not
912 * @param obj The window object
913 * @return A boolean if this window is a quickpanel or not
917 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj);
920 * Set the major priority of a quickpanel window
922 * @param obj The window object
923 * @param priority The major priority for this quickpanel
927 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority);
930 * Get the major priority of a quickpanel window
932 * @param obj The window object
933 * @return The major priority of this quickpanel
937 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj);
940 * Set the minor priority of a quickpanel window
942 * @param obj The window object
943 * @param priority The minor priority for this quickpanel
947 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority);
950 * Get the minor priority of a quickpanel window
952 * @param obj The window object
953 * @return The minor priority of this quickpanel
957 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj);
960 * Set which zone this quickpanel should appear in
962 * @param obj The window object
963 * @param zone The requested zone for this quickpanel
967 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone);
970 * Get which zone this quickpanel should appear in
972 * @param obj The window object
973 * @return The requested zone for this quickpanel
977 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj);
980 * Set the window to be skipped by keyboard focus
982 * This sets the window to be skipped by normal keyboard input. This means
983 * a window manager will be asked to not focus this window as well as omit
984 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
986 * Call this and enable it on a window BEFORE you show it for the first time,
987 * otherwise it may have no effect.
989 * Use this for windows that have only output information or might only be
990 * interacted with by the mouse or fingers, and never for typing input.
991 * Be careful that this may have side-effects like making the window
992 * non-accessible in some cases unless the window is specially handled. Use
995 * @param obj The window object
996 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
1000 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip);
1003 * Send a command to the windowing environment
1005 * This is intended to work in touchscreen or small screen device
1006 * environments where there is a more simplistic window management policy in
1007 * place. This uses the window object indicated to select which part of the
1008 * environment to control (the part that this window lives in), and provides
1009 * a command and an optional parameter structure (use NULL for this if not
1012 * @param obj The window object that lives in the environment to control
1013 * @param command The command to send
1014 * @param params Optional parameters for the command
1018 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params);
1021 * Get the inlined image object handle
1023 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
1024 * then the window is in fact an evas image object inlined in the parent
1025 * canvas. You can get this object (be careful to not manipulate it as it
1026 * is under control of elementary), and use it to do things like get pixel
1027 * data, save the image to a file, etc.
1029 * @param obj The window object to get the inlined image from
1030 * @return The inlined image object, or NULL if none exists
1034 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
1037 * Determine whether a window has focus
1038 * @param obj The window to query
1039 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
1043 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj);
1046 * Constrain the maximum width and height of a window to the width and height of its screen
1048 * When @p constrain is true, @p obj will never resize larger than the screen.
1049 * @param obj The window object
1050 * @param constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
1054 EAPI void elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain);
1057 * Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen
1059 * When this function returns true, @p obj will never resize larger than the screen.
1060 * @param obj The window object
1061 * @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
1065 EAPI Eina_Bool elm_win_screen_constrain_get(Evas_Object *obj);
1068 * Get screen geometry details for the screen that a window is on
1069 * @param obj The window to query
1070 * @param x where to return the horizontal offset value. May be NULL.
1071 * @param y where to return the vertical offset value. May be NULL.
1072 * @param w where to return the width value. May be NULL.
1073 * @param h where to return the height value. May be NULL.
1077 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h);
1080 * Set the enabled status for the focus highlight in a window
1082 * This function will enable or disable the focus highlight only for the
1083 * given window, regardless of the global setting for it
1085 * @param obj The window where to enable the highlight
1086 * @param enabled The enabled value for the highlight
1090 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled);
1093 * Get the enabled value of the focus highlight for this window
1095 * @param obj The window in which to check if the focus highlight is enabled
1097 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
1101 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj);
1104 * Set the style for the focus highlight on this window
1106 * Sets the style to use for theming the highlight of focused objects on
1107 * the given window. If @p style is NULL, the default will be used.
1109 * @param obj The window where to set the style
1110 * @param style The style to set
1114 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style);
1117 * Get the style set for the focus highlight object
1119 * Gets the style set for this windows highlight object, or NULL if none
1122 * @param obj The window to retrieve the highlights style from
1124 * @return The style set or NULL if none was. Default is used in that case.
1128 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj);
1131 * Sets the keyboard mode of the window.
1133 * @param obj The window object
1134 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
1138 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode);
1141 * Gets the keyboard mode of the window.
1143 * @param obj The window object
1144 * @return The mode, one of #Elm_Win_Keyboard_Mode
1148 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj);
1151 * Sets whether the window is a keyboard.
1153 * @param obj The window object
1154 * @param is_keyboard If true, the window is a virtual keyboard
1158 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard);
1161 * Gets whether the window is a keyboard.
1163 * @param obj The window object
1164 * @return If the window is a virtual keyboard
1168 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj);
1171 * Sets the indicator mode of the window.
1173 * @param obj The window object
1174 * @param mode The mode to set, one of #Elm_Win_Indicator_Mode
1178 EAPI void elm_win_indicator_mode_set(Evas_Object *obj, Elm_Win_Indicator_Mode mode);
1180 // WRAPPER: Temperary added.
1181 EAPI void elm_win_indicator_state_set(Evas_Object *obj, Elm_Win_Indicator_Mode mode);
1184 * Gets the indicator mode of the window.
1186 * @param obj The window object
1187 * @return The mode, one of #Elm_Win_Indicator_Mode
1191 EAPI Elm_Win_Indicator_Mode elm_win_indicator_mode_get(const Evas_Object *obj);
1193 // WRAPPER: Temperary added.
1194 EAPI Elm_Win_Indicator_Mode elm_win_indicator_state_get(const Evas_Object *obj);
1197 * Sets the indicator opacity mode of the window.
1199 * @param obj The window object
1200 * @param mode The mode to set, one of #Elm_Win_Indicator_Opacity_Mode
1204 EAPI void elm_win_indicator_opacity_set(Evas_Object *obj, Elm_Win_Indicator_Opacity_Mode mode);
1207 * Gets the indicator opacity mode of the window.
1209 * @param obj The window object
1210 * @return The mode, one of #Elm_Win_Indicator_Opacity_Mode
1214 EAPI Elm_Win_Indicator_Opacity_Mode elm_win_indicator_opacity_get(const Evas_Object *obj);
1217 * Get the screen position of a window.
1219 * @param obj The window object
1220 * @param x The int to store the x coordinate to
1221 * @param y The int to store the y coordinate to
1225 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y);
1228 * Create a socket to provide the service for Plug widget
1230 * @param obj The window object
1231 * @param svcname The name of the service to be advertised. ensure that it is unique (when combined with @p svcnum) otherwise creation may fail.
1232 * @param svcnum A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.
1233 * @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.
1234 * @return If socket creation is successful
1238 EAPI Eina_Bool elm_win_socket_listen(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys);
1240 /* X specific calls - won't work on non-x engines (return 0) */
1242 * Get the Ecore_X_Window of an Evas_Object
1244 * @param obj The object
1246 * @return The Ecore_X_Window of @p obj
1250 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj);
1257 * @defgroup Inwin Inwin
1260 * @image html img/widget/inwin/preview-00.png
1261 * @image latex img/widget/inwin/preview-00.eps
1262 * @image html img/widget/inwin/preview-01.png
1263 * @image latex img/widget/inwin/preview-01.eps
1264 * @image html img/widget/inwin/preview-02.png
1265 * @image latex img/widget/inwin/preview-02.eps
1267 * An inwin is a window inside a window that is useful for a quick popup.
1268 * It does not hover.
1270 * It works by creating an object that will occupy the entire window, so it
1271 * must be created using an @ref Win "elm_win" as parent only. The inwin
1272 * object can be hidden or restacked below every other object if it's
1273 * needed to show what's behind it without destroying it. If this is done,
1274 * the elm_win_inwin_activate() function can be used to bring it back to
1275 * full visibility again.
1277 * There are three styles available in the default theme. These are:
1278 * @li default: The inwin is sized to take over most of the window it's
1280 * @li minimal: The size of the inwin will be the minimum necessary to show
1282 * @li minimal_vertical: Horizontally, the inwin takes as much space as
1283 * possible, but it's sized vertically the most it needs to fit its\
1286 * Some examples of Inwin can be found in the following:
1287 * @li @ref inwin_example_01
1293 * Adds an inwin to the current window
1295 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
1296 * Never call this function with anything other than the top-most window
1297 * as its parameter, unless you are fond of undefined behavior.
1299 * After creating the object, the widget will set itself as resize object
1300 * for the window with elm_win_resize_object_add(), so when shown it will
1301 * appear to cover almost the entire window (how much of it depends on its
1302 * content and the style used). It must not be added into other container
1303 * objects and it needs not be moved or resized manually.
1305 * @param parent The parent object
1306 * @return The new object or NULL if it cannot be created
1310 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *parent);
1313 * Activates an inwin object, ensuring its visibility
1315 * This function will make sure that the inwin @p obj is completely visible
1316 * by calling evas_object_show() and evas_object_raise() on it, to bring it
1317 * to the front. It also sets the keyboard focus to it, which will be passed
1320 * The object's theme will also receive the signal "elm,action,show" with
1323 * @param obj The inwin to activate
1327 EAPI void elm_win_inwin_activate(Evas_Object *obj);
1330 * Set the content of an inwin object.
1332 * Once the content object is set, a previously set one will be deleted.
1333 * If you want to keep that old content object, use the
1334 * elm_win_inwin_content_unset() function.
1336 * @param obj The inwin object
1337 * @param content The object to set as content
1341 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content);
1344 * Get the content of an inwin object.
1346 * Return the content object for this widget.
1348 * The returned object is valid as long as the inwin is still alive and no
1349 * other content is set on it. Deleting the object will notify the inwin
1350 * about it and this one will be left empty.
1352 * If you need to remove an inwin's content to be reused somewhere else,
1353 * see elm_win_inwin_content_unset().
1355 * @param obj The inwin object
1356 * @return The content that is being used
1360 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj);
1363 * Unset the content of an inwin object.
1365 * Unparent and return the content object which was set for this widget.
1367 * @param obj The inwin object
1368 * @return The content that was being used
1372 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj);