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
56 * default output file is "out.png". Repeat option is for continous
58 * default output file is "out.png". Repeat option is for continuous
59 >>>>>>> remotes/origin/upstream
60 * capturing screenshots. Repeat range is from 1 to 999 and filename is
61 * fixed to "out001.png" Some examples of using the shot engine:
63 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
64 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
65 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
66 * ELM_ENGINE="shot:delay=2.0" elementary_test
67 * ELM_ENGINE="shot:" elementary_test
69 * Signals that you can add callbacks for are:
71 * @li "delete,request": the user requested to close the window. See
72 * elm_win_autodel_set().
73 * @li "focus,in": window got focus
74 * @li "focus,out": window lost focus
75 * @li "moved": window that holds the canvas was moved
78 * @li "withdrawn": window is still managed normally but removed from view
79 * @li "iconified": window is minimized (perhaps into an icon or taskbar)
80 * @li "normal": window is in a normal state (not withdrawn or iconified)
81 * @li "stick": window has become sticky (shows on all desktops)
82 * @li "unstick": window has stopped being sticky
83 * @li "fullscreen": window has become fullscreen
84 * @li "unfullscreen": window has stopped being fullscreen
85 * @li "maximized": window has been maximized
86 * @li "unmaximized": window has stopped being maximized
87 >>>>>>> remotes/origin/upstream
90 * @li @ref win_example_01
95 * Defines the types of window that can be created
97 * These are hints set on the window so that a running Window Manager knows
98 * how the window should be handled and/or what kind of decorations it
101 * Currently, only the X11 backed engines use them.
105 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
106 window. Almost every window will be created with this
108 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
109 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
110 window holding desktop icons. */
111 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
112 be kept on top of any other window by the Window
114 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
116 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
117 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
122 >>>>>>> remotes/origin/upstream
123 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
124 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
125 entry in a menubar is clicked. Typically used
126 with elm_win_override_set(). This hint exists
127 for completion only, as the EFL way of
128 implementing a menu would not normally use a
129 separate window for its contents. */
130 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
131 triggered by right-clicking an object. */
132 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
133 explanatory text that typically appear after the
134 mouse cursor hovers over an object for a while.
135 Typically used with elm_win_override_set() and also
136 not very commonly used in the EFL. */
137 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
138 battery life or a new E-Mail received. */
139 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
140 usually used in the EFL. */
141 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
142 object being dragged across different windows, or even
143 applications. Typically used with
144 elm_win_override_set(). */
145 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
146 buffer. No actual window is created for this
147 type, instead the window and all of its
148 contents will be rendered to an image buffer.
149 This allows to have children window inside a
150 parent one just like any other object would
151 be, and do other things like applying @c
152 Evas_Map effects to it. This is the only type
153 of window that requires the @c parent
154 parameter of elm_win_add() to be a valid @c
156 ELM_WIN_SOCKET_IMAGE,/**< The window is rendered onto an image buffer
157 and can be shown other process's plug image object.
159 No actural window is created for this type,
161 No actual window is created for this type,
162 >>>>>>> remotes/origin/upstream
163 instead the window and all of its contents will be
164 rendered to an image buffer and can be shown
165 other process's plug image object*/
169 * The different layouts that can be requested for the virtual keyboard.
171 * When the application window is being managed by Illume, it may request
172 * any of the following layouts for the virtual keyboard.
175 // XXX: remove this as it conflicts with input panel
177 >>>>>>> remotes/origin/upstream
180 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
181 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
182 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
183 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
184 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
185 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
186 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
187 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
189 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
191 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QWERTY) keyboard layout */
192 >>>>>>> remotes/origin/upstream
193 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
194 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
195 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
196 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
197 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
198 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
199 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
200 } Elm_Win_Keyboard_Mode;
205 * In some environments, like phones, you may have an indicator that
206 * shows battery status, reception, time etc. This is the indicator.
208 * Sometimes you don't want it because you provide the same functionality
209 * inside your app, so this will request that the indicator is hidden in
210 * this circumstance if you use ELM_ILLUME_INDICATOR_HIDE. The default
211 * is to have the indicator shown.
215 ELM_WIN_INDICATOR_UNKNOWN, /**< Unknown indicator state */
216 ELM_WIN_INDICATOR_HIDE, /**< Hides the indicator */
217 ELM_WIN_INDICATOR_SHOW /**< Shows the indicator */
218 } Elm_Win_Indicator_Mode;
221 * Defines the opacity modes of indicator that can be shown
226 ELM_WIN_INDICATOR_OPACITY_UNKNOWN, /**< Unknown indicator opacity mode */
227 ELM_WIN_INDICATOR_OPAQUE, /**< Opacifies the indicator */
228 ELM_WIN_INDICATOR_TRANSLUCENT, /**< Be translucent the indicator */
229 ELM_WIN_INDICATOR_TRANSPARENT /**< Transparentizes the indicator */
230 } Elm_Win_Indicator_Opacity_Mode;
233 >>>>>>> remotes/origin/upstream
234 * Available commands that can be sent to the Illume manager.
236 * When running under an Illume session, a window may send commands to the
237 * Illume manager to perform different actions.
241 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous window */
242 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window in the list */
243 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home screen */
245 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
247 ELM_ILLUME_COMMAND_CLOSE, /**< Closes the currently active window */
248 >>>>>>> remotes/origin/upstream
249 } Elm_Illume_Command;
252 * Adds a window object. If this is the first window created, pass NULL as
255 * @param parent Parent object to add the window to, or NULL
256 * @param name The name of the window
257 * @param type The window type, one of #Elm_Win_Type.
260 * The @p parent paramter can be @c NULL for every window @p type except
262 * The @p parent parameter can be @c NULL for every window @p type except
263 >>>>>>> remotes/origin/upstream
264 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
265 * which the image object will be created.
267 * @return The created object, or NULL on failure
269 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
272 * Adds a window object with standard setup
274 * @param name The name of the window
275 * @param title The title for the window
277 * This creates a window like elm_win_add() but also puts in a standard
278 * background with elm_bg_add(), as well as setting the window title to
279 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
280 * as the parent widget.
282 * @return The created object, or NULL on failure
286 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
289 * Add @p subobj as a resize object of window @p obj.
292 * Setting an object as a resize object of the window means that the
293 * @p subobj child's size and position will be controlled by the window
294 * directly. That is, the object will be resized to match the window size
295 * and should never be moved or resized manually by the developer.
297 * In addition, resize objects of the window control what the minimum size
298 * of it will be, as well as whether it can or not be resized by the user.
300 * For the end user to be able to resize a window by dragging the handles
301 * or borders provided by the Window Manager, or using any other similar
302 * mechanism, all of the resize objects in the window should have their
303 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
305 * Also notice that the window can get resized to the current size of the
306 * object if the EVAS_HINT_EXPAND is set @b after the call to
307 * elm_win_resize_object_add(). So if the object should get resized to the
308 * size of the window, set this hint @b before adding it as a resize object
309 * (this happens because the size of the window and the object are evaluated
310 * as soon as the object is added to the window).
312 * @param obj The window object
313 * @param subobj The resize object to add
315 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj);
318 * Delete @p subobj as a resize object of window @p obj.
320 * This function removes the object @p subobj from the resize objects of
321 * the window @p obj. It will not delete the object itself, which will be
322 * left unmanaged and should be deleted by the developer, manually handled
323 * or set as child of some other container.
325 * @param obj The window object
326 * @param subobj The resize object to add
328 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj);
331 * Set the title of the window
333 * @param obj The window object
334 * @param title The title to set
336 EAPI void elm_win_title_set(Evas_Object *obj, const char *title);
339 * Get the title of the window
341 * The returned string is an internal one and should not be freed or
342 * modified. It will also be rendered invalid if a new title is set or if
343 * the window is destroyed.
345 * @param obj The window object
348 EAPI const char *elm_win_title_get(const Evas_Object *obj);
353 * Set the icon name of the window
355 * @param obj The window object
356 * @param icon_name The icon name to set
358 EAPI void elm_win_icon_name_set(Evas_Object *obj, const char *icon_name);
361 * Get the icon name of the window
363 * The returned string is an internal one and should not be freed or
364 * modified. It will also be rendered invalid if a new icon name is set or if
365 * the window is destroyed.
367 * @param obj The window object
368 * @return The icon name
370 EAPI const char *elm_win_icon_name_get(const Evas_Object *obj);
373 * Set the role of the window
375 * @param obj The window object
376 * @param role The role to set
378 EAPI void elm_win_role_set(Evas_Object *obj, const char *role);
381 * Get the role of the window
383 * The returned string is an internal one and should not be freed or
384 * modified. It will also be rendered invalid if a new role is set or if
385 * the window is destroyed.
387 * @param obj The window object
390 EAPI const char *elm_win_role_get(const Evas_Object *obj);
393 * Set the object to represent the window icon
395 * This sets an object that will be used as the icon for the window. The exact
396 * pixel dimensions of the object (not object size) will be used, and the
397 * image pixels will be used as-is when this function is called. If the
398 * image object has been updated, then call this function again to source
399 * the image pixels and put them on the window's icon. This has limitations
400 * as only image objects allowed at this stage. This may be lifted in future.
402 * @param obj The window object
403 * @param icon The object to use for an icon
405 EAPI void elm_win_icon_object_set(Evas_Object *obj, Evas_Object *icon);
408 * Get the icon object used for the window
410 * The object returns is the one marked by elm_win_icon_object_set() as the
411 * object to use for the window icon.
413 * @param obj The window object
414 * @return The icon object set
416 EAPI const Evas_Object *elm_win_icon_object_get(const Evas_Object *obj);
419 >>>>>>> remotes/origin/upstream
420 * Set the window's autodel state.
422 * When closing the window in any way outside of the program control, like
423 * pressing the X button in the titlebar or using a command from the
424 * Window Manager, a "delete,request" signal is emitted to indicate that
425 * this event occurred and the developer can take any action, which may
426 * include, or not, destroying the window object.
428 * When the @p autodel parameter is set, the window will be automatically
429 * destroyed when this event occurs, after the signal is emitted.
430 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
431 * and is up to the program to do so when it's required.
433 * @param obj The window object
434 * @param autodel If true, the window will automatically delete itself when
437 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel);
440 * Get the window's autodel state.
442 * @param obj The window object
443 * @return If the window will automatically delete itself when closed
445 * @see elm_win_autodel_set()
447 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj);
450 * Activate a window object.
452 * This function sends a request to the Window Manager to activate the
453 * window pointed by @p obj. If honored by the WM, the window will receive
454 * the keyboard focus.
456 * @note This is just a request that a Window Manager may ignore, so calling
457 * this function does not ensure in any way that the window will be the
458 * active one after it.
460 * @param obj The window object
462 EAPI void elm_win_activate(Evas_Object *obj);
465 * Lower a window object.
467 * Places the window pointed by @p obj at the bottom of the stack, so that
468 * no other window is covered by it.
470 * If elm_win_override_set() is not set, the Window Manager may ignore this
473 * @param obj The window object
475 EAPI void elm_win_lower(Evas_Object *obj);
478 * Raise a window object.
480 * Places the window pointed by @p obj at the top of the stack, so that it's
481 * not covered by any other window.
483 * If elm_win_override_set() is not set, the Window Manager may ignore this
486 * @param obj The window object
488 EAPI void elm_win_raise(Evas_Object *obj);
491 * Center a window on its screen
493 * This function centers window @p obj horizontally and/or vertically based on the values
498 >>>>>>> remotes/origin/upstream
499 * @param obj The window object
500 * @param h If true, center horizontally. If false, do not change horizontal location.
501 * @param v If true, center vertically. If false, do not change vertical location.
503 EAPI void elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v);
506 * Set the borderless state of a window.
508 * This function requests the Window Manager to not draw any decoration
511 * @param obj The window object
512 * @param borderless If true, the window is borderless
514 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless);
517 * Get the borderless state of a window.
519 * @param obj The window object
520 * @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.
531 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
533 * If @p shaped is EINA_FALSE, then it is strongly advised to have some
534 >>>>>>> remotes/origin/upstream
535 * background object or cover the entire window in any other way, or the
536 * parts of the canvas that have no data will show framebuffer artifacts.
538 * @param obj The window object
539 * @param shaped If true, the window is shaped
541 * @see elm_win_alpha_set()
543 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped);
546 * Get the shaped state of a window.
548 * @param obj The window object
549 * @return If true, the window is shaped
551 * @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()
570 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha);
574 * Get the transparency state of a window.
576 * @param obj The window object
577 * @return If true, the window is transparent
579 * @see elm_win_transparent_set()
581 // XXX: deprecate this
582 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj);
585 * Set the transparency state of a window.
587 * Use elm_win_alpha_set() instead.
589 * @param obj The window object
590 * @param transparent If true, the window is transparent
592 * @see elm_win_alpha_set()
594 // XXX: deprecate this
595 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent);
599 >>>>>>> remotes/origin/upstream
600 * Get the alpha channel state of a window.
602 * @param obj The window object
603 * @return If true, the window has an alpha channel
605 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj);
608 * Set the override state of a window.
610 * A window with @p override set to EINA_TRUE will not be managed by the
611 * Window Manager. This means that no decorations of any kind will be shown
612 * for it, moving and resizing must be handled by the application, as well
613 * as the window visibility.
615 * This should not be used for normal windows, and even for not so normal
616 * ones, it should only be used when there's a good reason and with a lot
617 * of care. Mishandling override windows may result situations that
618 * disrupt the normal workflow of the end user.
620 * @param obj The window object
621 * @param override If true, the window is overridden
623 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override);
626 * Get the override state of a window.
628 * @param obj The window object
629 * @return If true, the window is overridden
631 * @see elm_win_override_set()
633 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj);
636 * Set the fullscreen state of a window.
638 * @param obj The window object
639 * @param fullscreen If true, the window is fullscreen
641 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen);
644 * Get the fullscreen state of a window.
646 * @param obj The window object
647 * @return If true, the window is fullscreen
649 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj);
652 * Set the maximized state of a window.
654 * @param obj The window object
655 * @param maximized If true, the window is maximized
657 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized);
660 * Get the maximized state of a window.
662 * @param obj The window object
663 * @return If true, the window is maximized
665 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj);
668 * Set the iconified state of a window.
670 * @param obj The window object
671 * @param iconified If true, the window is iconified
673 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified);
676 * Get the iconified state of a window.
678 * @param obj The window object
679 * @return If true, the window is iconified
681 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj);
686 * Set the withdrawn state of a window.
688 * @param obj The window object
689 * @param withdrawn If true, the window is withdrawn
691 EAPI void elm_win_withdrawn_set(Evas_Object *obj, Eina_Bool withdrawn);
694 * Get the withdrawn state of a window.
696 * @param obj The window object
697 * @return If true, the window is withdrawn
699 EAPI Eina_Bool elm_win_withdrawn_get(const Evas_Object *obj);
702 * Set the urgent state of a window.
704 * @param obj The window object
705 * @param urgent If true, the window is urgent
707 EAPI void elm_win_urgent_set(Evas_Object *obj, Eina_Bool urgent);
710 * Get the urgent state of a window.
712 * @param obj The window object
713 * @return If true, the window is urgent
715 EAPI Eina_Bool elm_win_urgent_get(const Evas_Object *obj);
718 * Set the demand_attention state of a window.
720 * @param obj The window object
721 * @param demand_attention If true, the window is demand_attention
723 EAPI void elm_win_demand_attention_set(Evas_Object *obj, Eina_Bool demand_attention);
726 * Get the demand_attention state of a window.
728 * @param obj The window object
729 * @return If true, the window is demand_attention
731 EAPI Eina_Bool elm_win_demand_attention_get(const Evas_Object *obj);
734 * Set the modal state of a window.
736 * @param obj The window object
737 * @param modal If true, the window is modal
739 EAPI void elm_win_modal_set(Evas_Object *obj, Eina_Bool modal);
742 * Get the modal state of a window.
744 * @param obj The window object
745 * @return If true, the window is modal
747 EAPI Eina_Bool elm_win_modal_get(const Evas_Object *obj);
750 * Set the aspect ratio of a window.
752 * @param obj The window object
753 * @param aspect If 0, the window has no aspect limits, otherwise it is
754 * width divided by height
756 EAPI void elm_win_aspect_set(Evas_Object *obj, double aspect);
759 * Get the aspect ratio of a window.
761 * @param obj The window object
762 * @return The aspect ratio set (0 by default)
764 EAPI double elm_win_aspect_get(const Evas_Object *obj);
767 >>>>>>> remotes/origin/upstream
768 * Set the layer of the window.
770 * What this means exactly will depend on the underlying engine used.
772 * In the case of X11 backed engines, the value in @p layer has the
773 * following meanings:
774 * @li < 3: The window will be placed below all others.
775 * @li > 5: The window will be placed above all others.
776 * @li other: The window will be placed in the default layer.
778 * @param obj The window object
779 * @param layer The layer of the window
781 EAPI void elm_win_layer_set(Evas_Object *obj, int layer);
784 * Get the layer of the window.
786 * @param obj The window object
787 * @return The layer of the window
789 * @see elm_win_layer_set()
791 EAPI int elm_win_layer_get(const Evas_Object *obj);
794 * Set the rotation of the window.
796 * Most engines only work with multiples of 90.
798 * This function is used to set the orientation of the window @p obj to
799 * match that of the screen. The window itself will be resized to adjust
800 * to the new geometry of its contents. If you want to keep the window size,
801 * see elm_win_rotation_with_resize_set().
803 * @param obj The window object
804 * @param rotation The rotation of the window, in degrees (0-360),
807 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation);
810 * Rotates the window and resizes it.
812 * Like elm_win_rotation_set(), but it also resizes the window's contents so
813 * that they fit inside the current window geometry.
815 * @param obj The window object
816 * @param rotation The rotation of the window in degrees (0-360),
819 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation);
822 * Get the rotation of the window.
824 * @param obj The window object
825 * @return The rotation of the window in degrees (0-360)
827 * @see elm_win_rotation_set()
828 * @see elm_win_rotation_with_resize_set()
830 EAPI int elm_win_rotation_get(const Evas_Object *obj);
833 * Set the sticky state of the window.
835 * Hints the Window Manager that the window in @p obj should be left fixed
836 * at its position even when the virtual desktop it's on moves or changes.
838 * @param obj The window object
839 * @param sticky If true, the window's sticky state is enabled
841 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky);
844 * Get the sticky state of the window.
846 * @param obj The window object
847 * @return If true, the window's sticky state is enabled
849 * @see elm_win_sticky_set()
851 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj);
854 * Set if this window is an illume conformant window
856 * @param obj The window object
857 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
859 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant);
862 * Get if this window is an illume conformant window
864 * @param obj The window object
865 * @return A boolean if this window is illume conformant or not
867 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj);
870 * Set a window to be an illume quickpanel window
872 * By default window objects are not quickpanel windows.
874 * @param obj The window object
875 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
877 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel);
880 * Get if this window is a quickpanel or not
882 * @param obj The window object
883 * @return A boolean if this window is a quickpanel or not
885 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj);
888 * Set the major priority of a quickpanel window
890 * @param obj The window object
891 * @param priority The major priority for this quickpanel
893 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority);
896 * Get the major priority of a quickpanel window
898 * @param obj The window object
899 * @return The major priority of this quickpanel
901 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj);
904 * Set the minor priority of a quickpanel window
906 * @param obj The window object
907 * @param priority The minor priority for this quickpanel
909 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority);
912 * Get the minor priority of a quickpanel window
914 * @param obj The window object
915 * @return The minor priority of this quickpanel
917 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj);
920 * Set which zone this quickpanel should appear in
922 * @param obj The window object
923 * @param zone The requested zone for this quickpanel
925 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone);
928 * Get which zone this quickpanel should appear in
930 * @param obj The window object
931 * @return The requested zone for this quickpanel
933 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj);
936 * Set the window to be skipped by keyboard focus
938 * This sets the window to be skipped by normal keyboard input. This means
939 * a window manager will be asked to not focus this window as well as omit
940 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
942 * Call this and enable it on a window BEFORE you show it for the first time,
943 * otherwise it may have no effect.
945 * Use this for windows that have only output information or might only be
946 * interacted with by the mouse or fingers, and never for typing input.
947 * Be careful that this may have side-effects like making the window
948 * non-accessible in some cases unless the window is specially handled. Use
951 * @param obj The window object
952 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
954 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip);
957 * Send a command to the windowing environment
959 * This is intended to work in touchscreen or small screen device
960 * environments where there is a more simplistic window management policy in
961 * place. This uses the window object indicated to select which part of the
962 * environment to control (the part that this window lives in), and provides
963 * a command and an optional parameter structure (use NULL for this if not
966 * @param obj The window object that lives in the environment to control
967 * @param command The command to send
968 * @param params Optional parameters for the command
970 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params);
973 * Get the inlined image object handle
975 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
976 * then the window is in fact an evas image object inlined in the parent
977 * canvas. You can get this object (be careful to not manipulate it as it
978 * is under control of elementary), and use it to do things like get pixel
979 * data, save the image to a file, etc.
981 * @param obj The window object to get the inlined image from
982 * @return The inlined image object, or NULL if none exists
984 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
987 * Determine whether a window has focus
988 * @param obj The window to query
989 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
991 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj);
994 * Constrain the maximum width and height of a window to the width and height of its screen
996 * When @p constrain is true, @p obj will never resize larger than the screen.
997 * @param obj The window object
998 * @param constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
1000 EAPI void elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain);
1003 * Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen
1005 * When this function returns true, @p obj will never resize larger than the screen.
1006 * @param obj The window object
1007 * @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
1009 EAPI Eina_Bool elm_win_screen_constrain_get(Evas_Object *obj);
1012 * Get screen geometry details for the screen that a window is on
1013 * @param obj The window to query
1014 * @param x where to return the horizontal offset value. May be NULL.
1015 * @param y where to return the vertical offset value. May be NULL.
1016 * @param w where to return the width value. May be NULL.
1017 * @param h where to return the height value. May be NULL.
1019 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h);
1022 * Set the enabled status for the focus highlight in a window
1024 * This function will enable or disable the focus highlight only for the
1025 * given window, regardless of the global setting for it
1027 * @param obj The window where to enable the highlight
1028 * @param enabled The enabled value for the highlight
1030 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled);
1033 * Get the enabled value of the focus highlight for this window
1035 * @param obj The window in which to check if the focus highlight is enabled
1037 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
1039 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj);
1042 * Set the style for the focus highlight on this window
1044 * Sets the style to use for theming the highlight of focused objects on
1045 * the given window. If @p style is NULL, the default will be used.
1047 * @param obj The window where to set the style
1048 * @param style The style to set
1050 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style);
1053 * Get the style set for the focus highlight object
1056 * Gets the style set for this windows highilght object, or NULL if none
1058 * Gets the style set for this windows highlight object, or NULL if none
1059 >>>>>>> remotes/origin/upstream
1062 * @param obj The window to retrieve the highlights style from
1064 * @return The style set or NULL if none was. Default is used in that case.
1066 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj);
1068 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
1069 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
1071 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
1072 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
1073 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
1074 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
1075 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
1076 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
1077 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
1079 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
1080 * (blank mouse, private mouse obj, defaultmouse)
1084 >>>>>>> remotes/origin/upstream
1087 * Sets the keyboard mode of the window.
1089 * @param obj The window object
1090 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
1092 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode);
1095 * Gets the keyboard mode of the window.
1097 * @param obj The window object
1098 * @return The mode, one of #Elm_Win_Keyboard_Mode
1100 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj);
1103 * Sets whether the window is a keyboard.
1105 * @param obj The window object
1106 * @param is_keyboard If true, the window is a virtual keyboard
1108 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard);
1111 * Gets whether the window is a keyboard.
1113 * @param obj The window object
1114 * @return If the window is a virtual keyboard
1116 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj);
1121 * Sets the indicator mode of the window.
1123 * @param obj The window object
1124 * @param mode The mode to set, one of #Elm_Win_Indicator_Mode
1126 EAPI void elm_win_indicator_mode_set(Evas_Object *obj, Elm_Win_Indicator_Mode mode);
1129 * Gets the indicator mode of the window.
1131 * @param obj The window object
1132 * @return The mode, one of #Elm_Win_Indicator_Mode
1134 EAPI Elm_Win_Indicator_Mode elm_win_indicator_mode_get(const Evas_Object *obj);
1137 * Sets the indicator opacity mode of the window.
1139 * @param obj The window object
1140 * @param mode The mode to set, one of #Elm_Win_Indicator_Opacity_Mode
1142 EAPI void elm_win_indicator_opacity_set(Evas_Object *obj, Elm_Win_Indicator_Opacity_Mode mode);
1145 * Gets the indicator opacity mode of the window.
1147 * @param obj The window object
1148 * @return The mode, one of #Elm_Win_Indicator_Opacity_Mode
1150 EAPI Elm_Win_Indicator_Opacity_Mode elm_win_indicator_opacity_get(const Evas_Object *obj);
1153 >>>>>>> remotes/origin/upstream
1154 * Get the screen position of a window.
1156 * @param obj The window object
1157 * @param x The int to store the x coordinate to
1158 * @param y The int to store the y coordinate to
1160 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y);
1163 * Create a socket to provide the service for Plug widget
1165 * @param obj The window object
1166 * @param svcname The name of the service to be advertised. ensure that it is unique (when combined with @p svcnum) otherwise creation may fail.
1168 * @param svcnum A number (any value, 0 beig the common default) to differentiate multiple instances of services with the same name.
1169 * @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 ide that created the service.
1171 * @param svcnum A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.
1172 * @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.
1173 >>>>>>> remotes/origin/upstream
1174 * @return If socket creation is successful
1176 EAPI Eina_Bool elm_win_socket_listen(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys);
1183 * @defgroup Inwin Inwin
1185 * @image html img/widget/inwin/preview-00.png
1186 * @image latex img/widget/inwin/preview-00.eps
1187 * @image html img/widget/inwin/preview-01.png
1188 * @image latex img/widget/inwin/preview-01.eps
1189 * @image html img/widget/inwin/preview-02.png
1190 * @image latex img/widget/inwin/preview-02.eps
1192 * An inwin is a window inside a window that is useful for a quick popup.
1193 * It does not hover.
1195 * It works by creating an object that will occupy the entire window, so it
1196 * must be created using an @ref Win "elm_win" as parent only. The inwin
1197 * object can be hidden or restacked below every other object if it's
1198 * needed to show what's behind it without destroying it. If this is done,
1199 * the elm_win_inwin_activate() function can be used to bring it back to
1200 * full visibility again.
1202 * There are three styles available in the default theme. These are:
1203 * @li default: The inwin is sized to take over most of the window it's
1205 * @li minimal: The size of the inwin will be the minimum necessary to show
1207 * @li minimal_vertical: Horizontally, the inwin takes as much space as
1208 * possible, but it's sized vertically the most it needs to fit its\
1211 * Some examples of Inwin can be found in the following:
1212 * @li @ref inwin_example_01
1218 * Adds an inwin to the current window
1220 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
1221 * Never call this function with anything other than the top-most window
1222 * as its parameter, unless you are fond of undefined behavior.
1224 * After creating the object, the widget will set itself as resize object
1225 * for the window with elm_win_resize_object_add(), so when shown it will
1226 * appear to cover almost the entire window (how much of it depends on its
1227 * content and the style used). It must not be added into other container
1228 * objects and it needs not be moved or resized manually.
1230 * @param parent The parent object
1231 * @return The new object or NULL if it cannot be created
1234 // XXX: deprecate this
1236 >>>>>>> remotes/origin/upstream
1237 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *parent);
1240 * Activates an inwin object, ensuring its visibility
1242 * This function will make sure that the inwin @p obj is completely visible
1243 * by calling evas_object_show() and evas_object_raise() on it, to bring it
1244 * to the front. It also sets the keyboard focus to it, which will be passed
1247 * The object's theme will also receive the signal "elm,action,show" with
1250 * @param obj The inwin to activate
1253 // XXX: deprecate this
1255 >>>>>>> remotes/origin/upstream
1256 EAPI void elm_win_inwin_activate(Evas_Object *obj);
1259 * Set the content of an inwin object.
1261 * Once the content object is set, a previously set one will be deleted.
1262 * If you want to keep that old content object, use the
1263 * elm_win_inwin_content_unset() function.
1265 * @param obj The inwin object
1266 * @param content The object to set as content
1269 // XXX: deprecate this
1271 >>>>>>> remotes/origin/upstream
1272 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content);
1275 * Get the content of an inwin object.
1278 * Return the content object which is set for this widget.
1280 * Return the content object for this widget.
1281 >>>>>>> remotes/origin/upstream
1283 * The returned object is valid as long as the inwin is still alive and no
1284 * other content is set on it. Deleting the object will notify the inwin
1285 * about it and this one will be left empty.
1287 * If you need to remove an inwin's content to be reused somewhere else,
1288 * see elm_win_inwin_content_unset().
1290 * @param obj The inwin object
1291 * @return The content that is being used
1294 // XXX: deprecate this
1296 >>>>>>> remotes/origin/upstream
1297 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj);
1300 * Unset the content of an inwin object.
1302 * Unparent and return the content object which was set for this widget.
1304 * @param obj The inwin object
1305 * @return The content that was being used
1308 // XXX: deprecate this
1310 >>>>>>> remotes/origin/upstream
1311 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj);
1316 /* X specific calls - won't work on non-x engines (return 0) */
1319 * Get the Ecore_X_Window of an Evas_Object
1321 * @param obj The object
1323 * @return The Ecore_X_Window of @p obj
1327 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj);
1329 /* smart callbacks called:
1330 * "delete,request" - the user requested to delete the window
1331 * "focus,in" - window got focus
1332 * "focus,out" - window lost focus
1333 * "moved" - window that holds the canvas was moved