4 * @image html img/widget/win/preview-00.png
5 * @image latex img/widget/win/preview-00.eps
7 * The window class of Elementary. Contains functions to manipulate
8 * windows. The Evas engine used to render the window contents is specified
9 * in the system or user elementary config files (whichever is found last),
10 * and can be overridden with the ELM_ENGINE environment variable for
11 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
12 * compilation setup and modules actually installed at runtime) are (listed
13 * in order of best supported and most likely to be complete and work to
16 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
17 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
19 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
21 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
23 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
25 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
26 * rendering using SDL as the buffer)
27 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
29 * @li "dfb", "directfb" (Rendering to a DirectFB window)
30 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
31 * grayscale using dedicated 8bit software engine in X11)
32 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
33 * X11 using 16bit software engine)
34 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
35 * (Windows CE rendering via GDI with 16bit software renderer)
36 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
37 * buffer with 16bit software renderer)
38 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
39 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
40 * @li "psl1ght" (PS3 rendering using PSL1GHT)
42 * All engines use a simple string to select the engine to render, EXCEPT
43 * the "shot" engine. This actually encodes the output of the virtual
44 * screenshot and how long to delay in the engine string. The engine string
45 * is encoded in the following way:
47 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
49 * Where options are separated by a ":" char if more than one option is
50 * given, with delay, if provided being the first option and file the last
51 * (order is important). The delay specifies how long to wait after the
52 * window is shown before doing the virtual "in memory" rendering and then
53 * save the output to the file specified by the file option (and then exit).
54 * If no delay is given, the default is 0.5 seconds. If no file is given the
55 * default output file is "out.png". Repeat option is for continuous
56 * capturing screenshots. Repeat range is from 1 to 999 and filename is
57 * fixed to "out001.png" Some examples of using the shot engine:
59 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
60 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
61 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
62 * ELM_ENGINE="shot:delay=2.0" elementary_test
63 * ELM_ENGINE="shot:" elementary_test
65 * Signals that you can add callbacks for are:
67 * @li "delete,request": the user requested to close the window. See
68 * elm_win_autodel_set().
69 * @li "focus,in": window got focus
70 * @li "focus,out": window lost focus
71 * @li "moved": window that holds the canvas was moved
72 * @li "withdrawn": window is still managed normally but removed from view
73 * @li "iconified": window is minimized (perhaps into an icon or taskbar)
74 * @li "normal": window is in a normal state (not withdrawn or iconified)
75 * @li "stick": window has become sticky (shows on all desktops)
76 * @li "unstick": window has stopped being sticky
77 * @li "fullscreen": window has become fullscreen
78 * @li "unfullscreen": window has stopped being fullscreen
79 * @li "maximized": window has been maximized
80 * @li "unmaximized": window has stopped being maximized
83 * @li @ref win_example_01
88 * Defines the types of window that can be created
90 * These are hints set on the window so that a running Window Manager knows
91 * how the window should be handled and/or what kind of decorations it
94 * Currently, only the X11 backed engines use them.
98 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
99 window. Almost every window will be created with this
101 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
102 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
103 window holding desktop icons. */
104 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
105 be kept on top of any other window by the Window
107 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
109 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
110 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
112 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
113 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
114 entry in a menubar is clicked. Typically used
115 with elm_win_override_set(). This hint exists
116 for completion only, as the EFL way of
117 implementing a menu would not normally use a
118 separate window for its contents. */
119 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
120 triggered by right-clicking an object. */
121 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
122 explanatory text that typically appear after the
123 mouse cursor hovers over an object for a while.
124 Typically used with elm_win_override_set() and also
125 not very commonly used in the EFL. */
126 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
127 battery life or a new E-Mail received. */
128 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
129 usually used in the EFL. */
130 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
131 object being dragged across different windows, or even
132 applications. Typically used with
133 elm_win_override_set(). */
134 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
135 buffer. No actual window is created for this
136 type, instead the window and all of its
137 contents will be rendered to an image buffer.
138 This allows to have children window inside a
139 parent one just like any other object would
140 be, and do other things like applying @c
141 Evas_Map effects to it. This is the only type
142 of window that requires the @c parent
143 parameter of elm_win_add() to be a valid @c
145 ELM_WIN_SOCKET_IMAGE,/**< The window is rendered onto an image buffer
146 and can be shown other process's plug image object.
147 No actual window is created for this type,
148 instead the window and all of its contents will be
149 rendered to an image buffer and can be shown
150 other process's plug image object*/
154 * The different layouts that can be requested for the virtual keyboard.
156 * When the application window is being managed by Illume, it may request
157 * any of the following layouts for the virtual keyboard.
159 // XXX: remove this as it conflicts with input panel
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 (QUERTY) 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 * Available commands that can be sent to the Illume manager.
199 * When running under an Illume session, a window may send commands to the
200 * Illume manager to perform different actions.
204 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous window */
205 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window in the list */
206 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home screen */
207 ELM_ILLUME_COMMAND_CLOSE, /**< Closes the currently active window */
208 } Elm_Illume_Command;
211 * Adds a window object. If this is the first window created, pass NULL as
214 * @param parent Parent object to add the window to, or NULL
215 * @param name The name of the window
216 * @param type The window type, one of #Elm_Win_Type.
218 * The @p parent parameter can be @c NULL for every window @p type except
219 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
220 * which the image object will be created.
222 * @return The created object, or NULL on failure
224 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
227 * Adds a window object with standard setup
229 * @param name The name of the window
230 * @param title The title for the window
232 * This creates a window like elm_win_add() but also puts in a standard
233 * background with elm_bg_add(), as well as setting the window title to
234 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
235 * as the parent widget.
237 * @return The created object, or NULL on failure
241 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
244 * Add @p subobj as a resize object of window @p obj.
247 * Setting an object as a resize object of the window means that the
248 * @p subobj child's size and position will be controlled by the window
249 * directly. That is, the object will be resized to match the window size
250 * and should never be moved or resized manually by the developer.
252 * In addition, resize objects of the window control what the minimum size
253 * of it will be, as well as whether it can or not be resized by the user.
255 * For the end user to be able to resize a window by dragging the handles
256 * or borders provided by the Window Manager, or using any other similar
257 * mechanism, all of the resize objects in the window should have their
258 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
260 * Also notice that the window can get resized to the current size of the
261 * object if the EVAS_HINT_EXPAND is set @b after the call to
262 * elm_win_resize_object_add(). So if the object should get resized to the
263 * size of the window, set this hint @b before adding it as a resize object
264 * (this happens because the size of the window and the object are evaluated
265 * as soon as the object is added to the window).
267 * @param obj The window object
268 * @param subobj The resize object to add
270 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj);
273 * Delete @p subobj as a resize object of window @p obj.
275 * This function removes the object @p subobj from the resize objects of
276 * the window @p obj. It will not delete the object itself, which will be
277 * left unmanaged and should be deleted by the developer, manually handled
278 * or set as child of some other container.
280 * @param obj The window object
281 * @param subobj The resize object to add
283 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj);
286 * Set the title of the window
288 * @param obj The window object
289 * @param title The title to set
291 EAPI void elm_win_title_set(Evas_Object *obj, const char *title);
294 * Get the title of the window
296 * The returned string is an internal one and should not be freed or
297 * modified. It will also be rendered invalid if a new title is set or if
298 * the window is destroyed.
300 * @param obj The window object
303 EAPI const char *elm_win_title_get(const Evas_Object *obj);
306 * Set the icon name of the window
308 * @param obj The window object
309 * @param icon_name The icon name to set
311 EAPI void elm_win_icon_name_set(Evas_Object *obj, const char *icon_name);
314 * Get the icon name of the window
316 * The returned string is an internal one and should not be freed or
317 * modified. It will also be rendered invalid if a new icon name is set or if
318 * the window is destroyed.
320 * @param obj The window object
321 * @return The icon name
323 EAPI const char *elm_win_icon_name_get(const Evas_Object *obj);
326 * Set the role of the window
328 * @param obj The window object
329 * @param role The role to set
331 EAPI void elm_win_role_set(Evas_Object *obj, const char *role);
334 * Get the role 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 role is set or if
338 * the window is destroyed.
340 * @param obj The window object
343 EAPI const char *elm_win_role_get(const Evas_Object *obj);
346 * Set the object to represent the window icon
348 * This sets an object that will be used as the icon for the window. The exact
349 * pixel dimensions of the object (not object size) will be used, and the
350 * image pixels will be used as-is when this function is called. If the
351 * image object has been updated, then call this function again to source
352 * the image pixels and put them on the window's icon. This has limitations
353 * as only image objects allowed at this stage. This may be lifted in future.
355 * @param obj The window object
356 * @param icon The object to use for an icon
358 EAPI void elm_win_icon_object_set(Evas_Object *obj, Evas_Object *icon);
361 * Get the icon object used for the window
363 * The object returns is the one marked by elm_win_icon_object_set() as the
364 * object to use for the window icon.
366 * @param obj The window object
367 * @return The icon object set
369 EAPI const Evas_Object *elm_win_icon_object_get(const Evas_Object *obj);
372 * Set the window's autodel state.
374 * When closing the window in any way outside of the program control, like
375 * pressing the X button in the titlebar or using a command from the
376 * Window Manager, a "delete,request" signal is emitted to indicate that
377 * this event occurred and the developer can take any action, which may
378 * include, or not, destroying the window object.
380 * When the @p autodel parameter is set, the window will be automatically
381 * destroyed when this event occurs, after the signal is emitted.
382 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
383 * and is up to the program to do so when it's required.
385 * @param obj The window object
386 * @param autodel If true, the window will automatically delete itself when
389 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel);
392 * Get the window's autodel state.
394 * @param obj The window object
395 * @return If the window will automatically delete itself when closed
397 * @see elm_win_autodel_set()
399 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj);
402 * Activate a window object.
404 * This function sends a request to the Window Manager to activate the
405 * window pointed by @p obj. If honored by the WM, the window will receive
406 * the keyboard focus.
408 * @note This is just a request that a Window Manager may ignore, so calling
409 * this function does not ensure in any way that the window will be the
410 * active one after it.
412 * @param obj The window object
414 EAPI void elm_win_activate(Evas_Object *obj);
417 * Lower a window object.
419 * Places the window pointed by @p obj at the bottom of the stack, so that
420 * no other window is covered by it.
422 * If elm_win_override_set() is not set, the Window Manager may ignore this
425 * @param obj The window object
427 EAPI void elm_win_lower(Evas_Object *obj);
430 * Raise a window object.
432 * Places the window pointed by @p obj at the top of the stack, so that it's
433 * not covered by any other window.
435 * If elm_win_override_set() is not set, the Window Manager may ignore this
438 * @param obj The window object
440 EAPI void elm_win_raise(Evas_Object *obj);
443 * Center a window on its screen
445 * This function centers window @p obj horizontally and/or vertically based on the values
447 * @param obj The window object
448 * @param h If true, center horizontally. If false, do not change horizontal location.
449 * @param v If true, center vertically. If false, do not change vertical location.
451 EAPI void elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v);
454 * Set the borderless state of a window.
456 * This function requests the Window Manager to not draw any decoration
459 * @param obj The window object
460 * @param borderless If true, the window is borderless
462 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless);
465 * Get the borderless state of a window.
467 * @param obj The window object
468 * @return If true, the window is borderless
470 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj);
473 * Set the shaped state of a window.
475 * Shaped windows, when supported, will render the parts of the window that
476 * has no content, transparent.
478 * If @p shaped is EINA_FALSE, then it is strongly advised to have some
479 * background object or cover the entire window in any other way, or the
480 * parts of the canvas that have no data will show framebuffer artifacts.
482 * @param obj The window object
483 * @param shaped If true, the window is shaped
485 * @see elm_win_alpha_set()
487 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped);
490 * Get the shaped state of a window.
492 * @param obj The window object
493 * @return If true, the window is shaped
495 * @see elm_win_shaped_set()
497 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj);
500 * Set the alpha channel state of a window.
502 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
503 * possibly making parts of the window completely or partially transparent.
504 * This is also subject to the underlying system supporting it, like for
505 * example, running under a compositing manager. If no compositing is
506 * available, enabling this option will instead fallback to using shaped
507 * windows, with elm_win_shaped_set().
509 * @param obj The window object
510 * @param alpha If true, the window has an alpha channel
512 * @see elm_win_alpha_set()
514 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha);
517 * Get the alpha channel state of a window.
519 * @param obj The window object
520 * @return If true, the window has an alpha channel
522 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj);
525 * Set the transparency state of a window.
527 * Use elm_win_alpha_set() instead.
529 * @param obj The window object
530 * @param transparent If true, the window is transparent
532 * @see elm_win_alpha_set()
534 // XXX: deprecate this
535 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent);
538 * Get the transparency state of a window.
540 * @param obj The window object
541 * @return If true, the window is transparent
543 * @see elm_win_transparent_set()
545 // XXX: deprecate this
546 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj);
549 * Set the override state of a window.
551 * A window with @p override set to EINA_TRUE will not be managed by the
552 * Window Manager. This means that no decorations of any kind will be shown
553 * for it, moving and resizing must be handled by the application, as well
554 * as the window visibility.
556 * This should not be used for normal windows, and even for not so normal
557 * ones, it should only be used when there's a good reason and with a lot
558 * of care. Mishandling override windows may result situations that
559 * disrupt the normal workflow of the end user.
561 * @param obj The window object
562 * @param override If true, the window is overridden
564 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override);
567 * Get the override state of a window.
569 * @param obj The window object
570 * @return If true, the window is overridden
572 * @see elm_win_override_set()
574 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj);
577 * Set the fullscreen state of a window.
579 * @param obj The window object
580 * @param fullscreen If true, the window is fullscreen
582 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen);
585 * Get the fullscreen state of a window.
587 * @param obj The window object
588 * @return If true, the window is fullscreen
590 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj);
593 * Set the maximized state of a window.
595 * @param obj The window object
596 * @param maximized If true, the window is maximized
598 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized);
601 * Get the maximized state of a window.
603 * @param obj The window object
604 * @return If true, the window is maximized
606 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj);
609 * Set the iconified state of a window.
611 * @param obj The window object
612 * @param iconified If true, the window is iconified
614 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified);
617 * Get the iconified state of a window.
619 * @param obj The window object
620 * @return If true, the window is iconified
622 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj);
625 * Set the withdrawn state of a window.
627 * @param obj The window object
628 * @param withdrawn If true, the window is withdrawn
630 EAPI void elm_win_withdrawn_set(Evas_Object *obj, Eina_Bool withdrawn);
633 * Get the withdrawn state of a window.
635 * @param obj The window object
636 * @return If true, the window is withdrawn
638 EAPI Eina_Bool elm_win_withdrawn_get(const Evas_Object *obj);
641 * Set the urgent state of a window.
643 * @param obj The window object
644 * @param urgent If true, the window is urgent
646 EAPI void elm_win_urgent_set(Evas_Object *obj, Eina_Bool urgent);
649 * Get the urgent state of a window.
651 * @param obj The window object
652 * @return If true, the window is urgent
654 EAPI Eina_Bool elm_win_urgent_get(const Evas_Object *obj);
657 * Set the demand_attention state of a window.
659 * @param obj The window object
660 * @param demand_attention If true, the window is demand_attention
662 EAPI void elm_win_demand_attention_set(Evas_Object *obj, Eina_Bool demand_attention);
665 * Get the demand_attention state of a window.
667 * @param obj The window object
668 * @return If true, the window is demand_attention
670 EAPI Eina_Bool elm_win_demand_attention_get(const Evas_Object *obj);
673 * Set the modal state of a window.
675 * @param obj The window object
676 * @param modal If true, the window is modal
678 EAPI void elm_win_modal_set(Evas_Object *obj, Eina_Bool modal);
681 * Get the modal state of a window.
683 * @param obj The window object
684 * @return If true, the window is modal
686 EAPI Eina_Bool elm_win_modal_get(const Evas_Object *obj);
689 * Set the aspect ratio of a window.
691 * @param obj The window object
692 * @param aspect If 0, the window has no aspect limits, otherwise it is
693 * width divided by height
695 EAPI void elm_win_aspect_set(Evas_Object *obj, double aspect);
698 * Get the aspect ratio of a window.
700 * @param obj The window object
701 * @return The aspect ratio set (0 by default)
703 EAPI double elm_win_aspect_get(const Evas_Object *obj);
706 * Set the layer of the window.
708 * What this means exactly will depend on the underlying engine used.
710 * In the case of X11 backed engines, the value in @p layer has the
711 * following meanings:
712 * @li < 3: The window will be placed below all others.
713 * @li > 5: The window will be placed above all others.
714 * @li other: The window will be placed in the default layer.
716 * @param obj The window object
717 * @param layer The layer of the window
719 EAPI void elm_win_layer_set(Evas_Object *obj, int layer);
722 * Get the layer of the window.
724 * @param obj The window object
725 * @return The layer of the window
727 * @see elm_win_layer_set()
729 EAPI int elm_win_layer_get(const Evas_Object *obj);
732 * Set the rotation of the window.
734 * Most engines only work with multiples of 90.
736 * This function is used to set the orientation of the window @p obj to
737 * match that of the screen. The window itself will be resized to adjust
738 * to the new geometry of its contents. If you want to keep the window size,
739 * see elm_win_rotation_with_resize_set().
741 * @param obj The window object
742 * @param rotation The rotation of the window, in degrees (0-360),
745 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation);
748 * Rotates the window and resizes it.
750 * Like elm_win_rotation_set(), but it also resizes the window's contents so
751 * that they fit inside the current window geometry.
753 * @param obj The window object
754 * @param rotation The rotation of the window in degrees (0-360),
757 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation);
760 * Get the rotation of the window.
762 * @param obj The window object
763 * @return The rotation of the window in degrees (0-360)
765 * @see elm_win_rotation_set()
766 * @see elm_win_rotation_with_resize_set()
768 EAPI int elm_win_rotation_get(const Evas_Object *obj);
771 * Set the sticky state of the window.
773 * Hints the Window Manager that the window in @p obj should be left fixed
774 * at its position even when the virtual desktop it's on moves or changes.
776 * @param obj The window object
777 * @param sticky If true, the window's sticky state is enabled
779 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky);
782 * Get the sticky state of the window.
784 * @param obj The window object
785 * @return If true, the window's sticky state is enabled
787 * @see elm_win_sticky_set()
789 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj);
792 * Set if this window is an illume conformant window
794 * @param obj The window object
795 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
797 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant);
800 * Get if this window is an illume conformant window
802 * @param obj The window object
803 * @return A boolean if this window is illume conformant or not
805 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj);
808 * Set a window to be an illume quickpanel window
810 * By default window objects are not quickpanel windows.
812 * @param obj The window object
813 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
815 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel);
818 * Get if this window is a quickpanel or not
820 * @param obj The window object
821 * @return A boolean if this window is a quickpanel or not
823 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj);
826 * Set the major priority of a quickpanel window
828 * @param obj The window object
829 * @param priority The major priority for this quickpanel
831 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority);
834 * Get the major priority of a quickpanel window
836 * @param obj The window object
837 * @return The major priority of this quickpanel
839 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj);
842 * Set the minor priority of a quickpanel window
844 * @param obj The window object
845 * @param priority The minor priority for this quickpanel
847 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority);
850 * Get the minor priority of a quickpanel window
852 * @param obj The window object
853 * @return The minor priority of this quickpanel
855 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj);
858 * Set which zone this quickpanel should appear in
860 * @param obj The window object
861 * @param zone The requested zone for this quickpanel
863 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone);
866 * Get which zone this quickpanel should appear in
868 * @param obj The window object
869 * @return The requested zone for this quickpanel
871 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj);
874 * Set the window to be skipped by keyboard focus
876 * This sets the window to be skipped by normal keyboard input. This means
877 * a window manager will be asked to not focus this window as well as omit
878 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
880 * Call this and enable it on a window BEFORE you show it for the first time,
881 * otherwise it may have no effect.
883 * Use this for windows that have only output information or might only be
884 * interacted with by the mouse or fingers, and never for typing input.
885 * Be careful that this may have side-effects like making the window
886 * non-accessible in some cases unless the window is specially handled. Use
889 * @param obj The window object
890 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
892 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip);
895 * Send a command to the windowing environment
897 * This is intended to work in touchscreen or small screen device
898 * environments where there is a more simplistic window management policy in
899 * place. This uses the window object indicated to select which part of the
900 * environment to control (the part that this window lives in), and provides
901 * a command and an optional parameter structure (use NULL for this if not
904 * @param obj The window object that lives in the environment to control
905 * @param command The command to send
906 * @param params Optional parameters for the command
908 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params);
911 * Get the inlined image object handle
913 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
914 * then the window is in fact an evas image object inlined in the parent
915 * canvas. You can get this object (be careful to not manipulate it as it
916 * is under control of elementary), and use it to do things like get pixel
917 * data, save the image to a file, etc.
919 * @param obj The window object to get the inlined image from
920 * @return The inlined image object, or NULL if none exists
922 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
925 * Determine whether a window has focus
926 * @param obj The window to query
927 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
929 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj);
932 * Constrain the maximum width and height of a window to the width and height of its screen
934 * When @p constrain is true, @p obj will never resize larger than the screen.
935 * @param obj The window object
936 * @param constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
938 EAPI void elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain);
941 * Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen
943 * When this function returns true, @p obj will never resize larger than the screen.
944 * @param obj The window object
945 * @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
947 EAPI Eina_Bool elm_win_screen_constrain_get(Evas_Object *obj);
950 * Get screen geometry details for the screen that a window is on
951 * @param obj The window to query
952 * @param x where to return the horizontal offset value. May be NULL.
953 * @param y where to return the vertical offset value. May be NULL.
954 * @param w where to return the width value. May be NULL.
955 * @param h where to return the height value. May be NULL.
957 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h);
960 * Set the enabled status for the focus highlight in a window
962 * This function will enable or disable the focus highlight only for the
963 * given window, regardless of the global setting for it
965 * @param obj The window where to enable the highlight
966 * @param enabled The enabled value for the highlight
968 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled);
971 * Get the enabled value of the focus highlight for this window
973 * @param obj The window in which to check if the focus highlight is enabled
975 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
977 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj);
980 * Set the style for the focus highlight on this window
982 * Sets the style to use for theming the highlight of focused objects on
983 * the given window. If @p style is NULL, the default will be used.
985 * @param obj The window where to set the style
986 * @param style The style to set
988 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style);
991 * Get the style set for the focus highlight object
993 * Gets the style set for this windows highlight object, or NULL if none
996 * @param obj The window to retrieve the highlights style from
998 * @return The style set or NULL if none was. Default is used in that case.
1000 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj);
1003 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
1004 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
1005 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
1006 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
1007 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
1008 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
1009 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
1011 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
1012 * (blank mouse, private mouse obj, defaultmouse)
1017 * Sets the keyboard mode of the window.
1019 * @param obj The window object
1020 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
1022 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode);
1025 * Gets the keyboard mode of the window.
1027 * @param obj The window object
1028 * @return The mode, one of #Elm_Win_Keyboard_Mode
1030 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj);
1033 * Sets whether the window is a keyboard.
1035 * @param obj The window object
1036 * @param is_keyboard If true, the window is a virtual keyboard
1038 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard);
1041 * Gets whether the window is a keyboard.
1043 * @param obj The window object
1044 * @return If the window is a virtual keyboard
1046 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj);
1049 * Sets the indicator mode of the window.
1051 * @param obj The window object
1052 * @param mode The mode to set, one of #Elm_Win_Indicator_Mode
1054 EAPI void elm_win_indicator_mode_set(Evas_Object *obj, Elm_Win_Indicator_Mode mode);
1057 * Gets the indicator mode of the window.
1059 * @param obj The window object
1060 * @return The mode, one of #Elm_Win_Indicator_Mode
1062 EAPI Elm_Win_Indicator_Mode elm_win_indicator_mode_get(const Evas_Object *obj);
1065 * Get the screen position of a window.
1067 * @param obj The window object
1068 * @param x The int to store the x coordinate to
1069 * @param y The int to store the y coordinate to
1071 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y);
1074 * Create a socket to provide the service for Plug widget
1076 * @param obj The window object
1077 * @param svcname The name of the service to be advertised. ensure that it is unique (when combined with @p svcnum) otherwise creation may fail.
1078 * @param svcnum A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.
1079 * @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.
1080 * @return If socket creation is successful
1082 EAPI Eina_Bool elm_win_socket_listen(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys);
1089 * @defgroup Inwin Inwin
1091 * @image html img/widget/inwin/preview-00.png
1092 * @image latex img/widget/inwin/preview-00.eps
1093 * @image html img/widget/inwin/preview-01.png
1094 * @image latex img/widget/inwin/preview-01.eps
1095 * @image html img/widget/inwin/preview-02.png
1096 * @image latex img/widget/inwin/preview-02.eps
1098 * An inwin is a window inside a window that is useful for a quick popup.
1099 * It does not hover.
1101 * It works by creating an object that will occupy the entire window, so it
1102 * must be created using an @ref Win "elm_win" as parent only. The inwin
1103 * object can be hidden or restacked below every other object if it's
1104 * needed to show what's behind it without destroying it. If this is done,
1105 * the elm_win_inwin_activate() function can be used to bring it back to
1106 * full visibility again.
1108 * There are three styles available in the default theme. These are:
1109 * @li default: The inwin is sized to take over most of the window it's
1111 * @li minimal: The size of the inwin will be the minimum necessary to show
1113 * @li minimal_vertical: Horizontally, the inwin takes as much space as
1114 * possible, but it's sized vertically the most it needs to fit its\
1117 * Some examples of Inwin can be found in the following:
1118 * @li @ref inwin_example_01
1124 * Adds an inwin to the current window
1126 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
1127 * Never call this function with anything other than the top-most window
1128 * as its parameter, unless you are fond of undefined behavior.
1130 * After creating the object, the widget will set itself as resize object
1131 * for the window with elm_win_resize_object_add(), so when shown it will
1132 * appear to cover almost the entire window (how much of it depends on its
1133 * content and the style used). It must not be added into other container
1134 * objects and it needs not be moved or resized manually.
1136 * @param parent The parent object
1137 * @return The new object or NULL if it cannot be created
1139 // XXX: deprecate this
1140 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *parent);
1143 * Activates an inwin object, ensuring its visibility
1145 * This function will make sure that the inwin @p obj is completely visible
1146 * by calling evas_object_show() and evas_object_raise() on it, to bring it
1147 * to the front. It also sets the keyboard focus to it, which will be passed
1150 * The object's theme will also receive the signal "elm,action,show" with
1153 * @param obj The inwin to activate
1155 // XXX: deprecate this
1156 EAPI void elm_win_inwin_activate(Evas_Object *obj);
1159 * Set the content of an inwin object.
1161 * Once the content object is set, a previously set one will be deleted.
1162 * If you want to keep that old content object, use the
1163 * elm_win_inwin_content_unset() function.
1165 * @param obj The inwin object
1166 * @param content The object to set as content
1168 // XXX: deprecate this
1169 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content);
1172 * Get the content of an inwin object.
1174 * Return the content object which is set for this widget.
1176 * The returned object is valid as long as the inwin is still alive and no
1177 * other content is set on it. Deleting the object will notify the inwin
1178 * about it and this one will be left empty.
1180 * If you need to remove an inwin's content to be reused somewhere else,
1181 * see elm_win_inwin_content_unset().
1183 * @param obj The inwin object
1184 * @return The content that is being used
1186 // XXX: deprecate this
1187 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj);
1190 * Unset the content of an inwin object.
1192 * Unparent and return the content object which was set for this widget.
1194 * @param obj The inwin object
1195 * @return The content that was being used
1197 // XXX: deprecate this
1198 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj);
1203 /* X specific calls - won't work on non-x engines (return 0) */
1206 * Get the Ecore_X_Window of an Evas_Object
1208 * @param obj The object
1210 * @return The Ecore_X_Window of @p obj
1214 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj);
1216 /* smart callbacks called:
1217 * "delete,request" - the user requested to delete the window
1218 * "focus,in" - window got focus
1219 * "focus,out" - window lost focus
1220 * "moved" - window that holds the canvas was moved