2 * @brief In some environments, like phones, you may have an indicator that
3 * shows battery status, reception, time etc. This is the indicator.
5 * Sometimes you don't want it because you provide the same functionality
6 * inside your app, so this will request that the indicator is hidden in this
7 * circumstance. The default is depend on the environments. For example, like
8 * phones, default is to have the indicator shown. But like TV, default is to
9 * have the indicator hidden.
11 * @ingroup Elm_Win_Group
15 ELM_WIN_INDICATOR_UNKNOWN = 0, /** Unknown indicator state */
16 ELM_WIN_INDICATOR_HIDE, /** Hides the indicator */
17 ELM_WIN_INDICATOR_SHOW /** Shows the indicator */
18 } Elm_Win_Indicator_Mode;
20 /** Defines the opacity modes of indicator that can be shown
22 * @ingroup Elm_Win_Group
26 ELM_WIN_INDICATOR_OPACITY_UNKNOWN = 0, /** Unknown indicator opacity mode */
27 ELM_WIN_INDICATOR_OPAQUE, /** Opacifies the indicator */
28 ELM_WIN_INDICATOR_TRANSLUCENT, /** Be translucent the indicator */
29 ELM_WIN_INDICATOR_TRANSPARENT, /** Transparentizes the indicator */
30 //TIZEN_ONLY(20171209): migration build-fix app's build break
31 ELM_WIN_INDICATOR_BG_TRANSPARENT /** Bg Transparentizes the indicator */
33 } Elm_Win_Indicator_Opacity_Mode;
36 * @brief Available commands that can be sent to the Illume manager.
38 * When running under an Illume session, a window may send commands to the
39 * Illume manager to perform different actions.
45 ELM_ILLUME_COMMAND_FOCUS_BACK = 0, /** Reverts focus to the previous window
47 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /** Sends focus to the next window in the
49 ELM_ILLUME_COMMAND_FOCUS_HOME, /** Hides all windows to show the Home screen
51 ELM_ILLUME_COMMAND_CLOSE /** Closes the currently active window */
55 * @brief Defines the types of window that can be created
57 * These are hints set on a window so that a running Window Manager knows how
58 * the window should be handled and/or what kind of decorations it should have.
60 * Currently, only the X11 backed engines use them.
62 * @ingroup Elm_Win_Group
66 //TIZEN_ONLY(20180406): fix ABI break related with window type
67 ELM_WIN_UNKNOWN = 0 /* +1 */, /**< Default, unknown, type */
69 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level window.
70 * Almost every window will be created with this type. */
71 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows. */
72 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background window
73 * holding desktop icons. */
74 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would be
75 * kept on top of any other window by the Window Manager. */
76 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
78 ELM_WIN_MENU, /**< Similar to @.toolbar. */
79 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
81 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
82 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
83 * entry in a menubar is clicked. This hint exists
84 * for completion only, as the EFL way of
85 * implementing a menu would not normally use a
86 * separate window for its contents. */
87 ELM_WIN_POPUP_MENU, /**< Like @.dropdown_menu, but for the menu triggered
88 * by right-clicking an object. */
89 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of explanatory
90 * text that typically appear after the mouse cursor
91 * hovers over an object for a while. Typically not very
92 * commonly used in the EFL. */
93 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
94 * battery life or a new E-Mail received. */
95 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
96 * usually used in the EFL. */
99 * Used to indicate the window is a representation of an object being
100 * dragged across different windows, or even applications. Typically
101 * used with elm_win_override_set().
104 ELM_WIN_INLINED_IMAGE, /**< The window is an image. */
105 ELM_WIN_SOCKET_IMAGE, /**< The window is an image received through a socket. */
107 //TIZEN_ONLY(20180406): fix ABI break related with window type
108 ELM_WIN_NAVIFRAME_BASIC, /**< Used for naviframe style replacement with
109 * a back button instead of a close button.
113 ELM_WIN_FAKE, /**< See elm_win_fake_add(). @since 1.13 */
118 * @brief The different layouts that can be requested for the virtual keyboard.
120 * When the application window is being managed by Illume it may request any of
121 * the following layouts for the virtual keyboard.
123 * @ingroup Elm_Win_Group
127 ELM_WIN_KEYBOARD_UNKNOWN = 0, /**< Unknown keyboard state */
128 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
129 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
130 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
131 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
132 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
133 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
134 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
135 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QWERTY) keyboard layout */
136 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
137 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
138 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
139 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
140 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
141 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
142 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
143 } Elm_Win_Keyboard_Mode;
145 /** Define the keygrab modes of window. A window may send commands to the
146 * Keyrouter according this mode, and perform different actions.
148 * @ingroup Elm_Win_Group
152 ELM_WIN_KEYGRAB_UNKNOWN = 0, /**< Unknown keygrab mode */
153 ELM_WIN_KEYGRAB_SHARED = 256 /* 1 >> 8 */, /**< Get the grabbed-key
154 * together with the other
156 ELM_WIN_KEYGRAB_TOPMOST = 512 /* 1 >> 9 */, /**< Get the grabbed-key only
157 * when window is top of the
159 ELM_WIN_KEYGRAB_EXCLUSIVE = 1024 /* 1 >> 10 */, /**< Get the grabbed-key
160 * exclusively regardless
161 * of window's position */
162 ELM_WIN_KEYGRAB_OVERRIDE_EXCLUSIVE = 2048 /* 1 >> 11 */ /**< Get the grabbed-key exclusively
163 * regardless of window's position.
164 * This is overrided by grabs from the
165 * other client window */
166 } Elm_Win_Keygrab_Mode;
170 * @brief Define the move or resize mode of window.
172 * The user can request the display server to start moving or resizing the
173 * window by combining these modes. However only limited combinations are
176 * Currently, only the following 9 combinations are permitted. More
177 * combinations may be added in future: 1. move, 2. top, 3. bottom, 4. left, 5.
178 * right, 6. top | left, 7. top | right, 8. bottom | left, 9. bottom | right.
182 * @ingroup Elm_Win_Group
186 ELM_WIN_MOVE_RESIZE_MOVE = 1, /**< Start moving window */
187 ELM_WIN_MOVE_RESIZE_TOP = 2 /* 1 >> 1 */, /**< Start resizing window to the
189 ELM_WIN_MOVE_RESIZE_BOTTOM = 4 /* 1 >> 2 */, /**< Start resizing window to
191 ELM_WIN_MOVE_RESIZE_LEFT = 8 /* 1 >> 3 */, /**< Start resizing window to
193 ELM_WIN_MOVE_RESIZE_RIGHT = 16 /* 1 >> 4 */ /**< Start resizing window to
195 } Elm_Win_Move_Resize_Mode;
199 * Adds a window object. If this is the first window created, pass NULL as
202 * @param parent Parent object to add the window to, or NULL
203 * @param name The name of the window
204 * @param type The window type, one of #Elm_Win_Type.
206 * The @p parent parameter can be @c NULL for every window @p type
207 * except #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the
208 * canvas on which the image object will be created.
210 * @return The created object, or @c NULL on failure
212 * @ingroup Elm_Win_Group
214 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
216 typedef Evas_Object Elm_Win;
219 * Creates a fake window object using a pre-existing canvas.
221 * @param ee The Ecore_Evas to use
223 * The returned window widget will not manage or modify the canvas;
224 * this canvas must continue to be managed externally.
226 * Do not use this function if you are not writing a window manager.
227 * @warning Exact behaviors of this function are not guaranteed.
229 * @return The created object, or @c NULL on failure
231 * @ingroup Elm_Win_Group
235 EAPI Evas_Object *elm_win_fake_add(Ecore_Evas *ee);
238 * Adds a window object with standard setup
240 * @param name The name of the window
241 * @param title The title for the window
243 * This creates a window like elm_win_add() but also puts in a standard
244 * background with elm_bg_add(), as well as setting the window title to
245 * @p title. The window type created is of type ELM_WIN_BASIC, with @c NULL
246 * as the parent widget.
248 * @return The created object, or @c NULL on failure
252 * @ingroup Elm_Win_Group
254 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
257 * Adds a window object with dialog setup
259 * @param parent The parent window
260 * @param name The name of the window
261 * @param title The title for the window
263 * This creates a window like elm_win_add() but also puts in a standard
264 * background with elm_bg_add(), as well as setting the window title to
265 * @p title. The window type created is of type ELM_WIN_DIALOG_BASIC.
266 * This type of window will be handled in special mode by window managers
267 * with regards of it's @p parent window.
269 * @return The created object, or @c NULL on failure
273 * @ingroup Elm_Win_Group
276 EAPI Evas_Object *elm_win_util_dialog_add(Evas_Object *parent, const char *name, const char *title);
279 * Adds a window object with frontbuffer setup
281 * @param parent The parent window
282 * @param name The name of the window
283 * @param title The title for the window
284 * @param type The type of the window
286 * This creates a window like elm_win_add() but also setup frontbuffer rendering mode if it is possible.
287 * Currently only wayland support this.
289 * @return The created object, or @c NULL on failure
293 * @ingroup Elm_Win_Group
296 EAPI Evas_Object *elm_win_frontbuffer_add(Evas_Object *parent, const char *name, const char *title, Elm_Win_Type type);
299 * @brief Sets the window's autodel state.
301 * When closing the window in any way outside of the program control, like
302 * pressing the X button in the titlebar or using a command from the Window
303 * Manager, a "delete,request" signal is emitted to indicate that this event
304 * occurred and the developer can take any action, which may include, or not,
305 * destroying the window object.
307 * When the @c autodel parameter is set, the window will be automatically
308 * destroyed when this event occurs, after the signal is emitted. If @c autodel
309 * is @c false, then the window will not be destroyed and is up to the program
310 * to do so when it's required.
312 * @param[in] obj The object.
313 * @param[in] autodel If @c true, the window will automatically delete itself
316 * @ingroup Elm_Win_Group
318 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel);
321 * @brief Gets the window's autodel state.
323 * @param[in] obj The object.
325 * @return If @c true, the window will automatically delete itself when closed.
327 * @ingroup Elm_Win_Group
329 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj);
332 * @brief Sets the floating mode of a window.
334 * @param obj The window object
335 * @param floating If true, the window is floating mode
337 * The floating mode can be used on mobile environment. For example, if the
338 * video-player window sets the floating mode, then e (enlightenment window
339 * manager) changes its geometry and handles it like a popup. This is similar to
340 * a multi window concept in a mobile phone. The way of handling floating mode
341 * window is decided by enlightenment window manager.
343 * @ingroup Elm_Win_Group
344 * @see elm_win_floating_mode_get()
347 EAPI void elm_win_floating_mode_set(Evas_Object *obj, Eina_Bool floating);
350 * @brief Gets the floating mode of a window.
352 * @param obj The window object
353 * @return If true, the window is floating mode
355 * @ingroup Elm_Win_Group
356 * @see elm_win_floating_mode_set()
359 EAPI Eina_Bool elm_win_floating_mode_get(const Evas_Object *obj);
362 * This pushes (increments) the norender counter on the window
364 * @param obj The window object
366 * There are some occasions where you wish to suspend rendering on a window.
367 * You may be "sleeping" and have nothing to update and do not want animations
368 * or other theme side-effects causing rendering to the window while "asleep".
369 * You can push (and pop) the norender mode to have this work.
371 * If combined with evas_render_dump(), evas_image_cache_flush() and
372 * evas_font_cache_flush() (and maybe edje_file_cache_flush() and
373 * edje_collection_cache_flush()), you can minimize memory footprint
374 * significantly while "asleep", and the pausing of rendering ensures
375 * evas does not re-load data into memory until needed. When rendering is
376 * resumed, data will be re-loaded as needed, which may result in some
377 * lag, but does save memory.
379 * @see elm_win_norender_pop()
380 * @see elm_win_norender_get()
381 * @see elm_win_render()
382 * @ingroup Elm_Win_Group
385 EAPI void elm_win_norender_push(Evas_Object *obj);
388 * This pops (decrements) the norender counter on the window
390 * @param obj The window object
392 * Once norender has gone back to 0, then automatic rendering will continue
393 * in the given window. If it is already at 0, this will have no effect.
395 * @see elm_win_norender_push()
396 * @see elm_win_norender_get()
397 * @see elm_win_render()
398 * @ingroup Elm_Win_Group
401 EAPI void elm_win_norender_pop(Evas_Object *obj);
404 * The returns how many times norender has been pushed on the window
405 * @param obj The window object
406 * @return The number of times norender has been pushed
408 * @see elm_win_norender_push()
409 * @see elm_win_norender_pop()
410 * @see elm_win_render()
411 * @ingroup Elm_Win_Group
414 EAPI int elm_win_norender_get(const Evas_Object *obj);
417 * This manually asks evas to render the window now
419 * @param obj The window object
421 * You should NEVER call this unless you really know what you are doing and
422 * why. Never call this unless you are asking for performance degradation
423 * and possibly weird behavior. Windows get automatically rendered when the
424 * application goes into the idle enter state so there is never a need to call
425 * this UNLESS you have enabled "norender" mode.
427 * @see elm_win_norender_push()
428 * @see elm_win_norender_pop()
429 * @see elm_win_norender_get()
430 * @ingroup Elm_Win_Group
433 EAPI void elm_win_render(Evas_Object *obj);
435 /* Wayland specific call - returns NULL on non-Wayland engines */
437 * @brief Gets the Ecore_Wl_Window of an Evas_Object
439 * Do not use this function if you'd like your application/library be portable.
440 * You have been warned.
442 * @param obj the object
444 * @return The Ecore_Wl_Window of @p obj
446 * @ingroup Elm_Win_Group
449 //TIZEN_ONLY(20171208) : fix build break by opensource temporarily until migration finish
450 EAPI Ecore_Wl_Window *elm_win_wl_window_get(const Evas_Object *obj);
453 /* Windows specific call - returns NULL on non-Windows engines */
455 * @brief Gets the Ecore_Win32_Window of an Evas_Object
457 * Do not use this function if you'd like your application/library be portable.
458 * You have been warned.
460 * @param obj the object
462 * @return The Ecore_Win32_Window of @p obj
464 * @ingroup Elm_Win_Group
468 EAPI Ecore_Win32_Window *elm_win_win32_window_get(const Evas_Object *obj);
471 * @brief Sets the preferred rotation value.
473 * This function is used to set the orientation of window @p obj to specific angle fixed.
475 * @param obj The window object
476 * @param rotation The preferred rotation of the window in degrees (0-360),
479 * @see elm_win_wm_rotation_preferred_rotation_get()
481 * @ingroup Elm_Win_Group
484 EAPI void elm_win_wm_rotation_preferred_rotation_set(Evas_Object *obj, int rotation);
487 * @brief Adds @c subobj as a resize object of window @c obj.
489 * Setting an object as a resize object of the window means that the @c subobj
490 * child's size and position will be controlled by the window directly. That
491 * is, the object will be resized to match the window size and should never be
492 * moved or resized manually by the developer.
494 * In addition, resize objects of the window control what the minimum size of
495 * it will be, as well as whether it can or not be resized by the user.
497 * For the end user to be able to resize a window by dragging the handles or
498 * borders provided by the Window Manager, or using any other similar
499 * mechanism, all of the resize objects in the window should have their @ref
500 * evas_object_size_hint_weight_set set to EVAS_HINT_EXPAND.
502 * Also notice that the window can get resized to the current size of the
503 * object if the EVAS_HINT_EXPAND is set after the call to this. So if the
504 * object should get resized to the size of the window, set this hint before
505 * adding it as a resize object (this happens because the size of the window
506 * and the object are evaluated as soon as the object is added to the window).
508 * @param[in] subobj The resize object to add.
510 * @ingroup Elm_Win_Group
512 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj);
515 * @brief Deletes @c subobj as a resize object of window @c obj.
517 * This function removes the object @c subobj from the resize objects of the
518 * window @c obj. It will not delete the object itself, which will be left
519 * unmanaged and should be deleted by the developer, manually handled or set as
520 * child of some other container.
522 * @param[in] subobj The resize object to add.
524 * @ingroup Elm_Win_Group
526 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj);
531 * @brief Gets the Ecore_X_Window of an Evas_Object.
533 * @ingroup Elm_Win_Group
535 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj);
538 * @brief Gets the Ecore_Win32_Window of an Evas_Object
540 * @return The Ecore_Win32_Window of @c obj.
544 * @ingroup Elm_Win_Group
546 EAPI Ecore_Win32_Window *elm_win_win32_window_get(const Evas_Object *obj);
549 * @brief Gets the Ecore_Cocoa_Window of an Efl.Canvas.Object.
551 * @return The Ecore_Cocoa_Window of @c obj.
555 * @ingroup Elm_Win_Group
557 EAPI Ecore_Cocoa_Window *elm_win_cocoa_window_get(const Evas_Object *obj);
560 * @brief Gets the trap data associated with a window.
562 * @return The trap data of the window.
566 * @ingroup Elm_Win_Group
568 EAPI void *elm_win_trap_data_get(const Evas_Object *obj);
571 * @brief Sets the override state of a window.
573 * A window with @c override set to true will not be managed by the Window
574 * Manager. This means that no decorations of any kind will be shown for it,
575 * moving and resizing must be handled by the application, as well as the
578 * This should not be used for normal windows, and even for not so normal ones,
579 * it should only be used when there's a good reason and with a lot of care.
580 * Mishandling override windows may result situations that disrupt the normal
581 * workflow of the end user.
583 * @param[in] override If true, the window is overridden.
585 * @ingroup Elm_Win_Group
587 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override);
590 * @brief Gets the override state of a window.
592 * @return If true, the window is overridden.
594 * @ingroup Elm_Win_Group
596 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj);
599 * @brief Lowers a window object.
601 * Places the window pointed by @c obj at the bottom of the stack, so that no
602 * other window is covered by it.
604 * If @ref elm_win_override_set is not set, the Window Manager may ignore this
607 * @ingroup Elm_Win_Group
609 EAPI void elm_win_lower(Evas_Object *obj);
612 * @brief Sets a window to be an illume quickpanel window.
614 * By default window objects are not quickpanel windows.
616 * @param[in] quickpanel The quickpanel flag.
618 * @ingroup Elm_Win_Group
620 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel);
623 * @brief Gets if this window is a quickpanel or not.
625 * @return The quickpanel flag.
627 * @ingroup Elm_Win_Group
629 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj);
631 * @brief Sets which zone this quickpanel should appear in.
633 * @param[in] zone The requested zone for this quickpanel.
635 * @ingroup Elm_Win_Group
637 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone);
640 * @brief Gets which zone this quickpanel should appear in.
642 * @return The requested zone for this quickpanel.
644 * @ingroup Elm_Win_Group
646 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj);
648 * @brief Sets the major priority of a quickpanel window.
650 * @param[in] priority The major priority for this quickpanel or -1.
652 * @ingroup Elm_Win_Group
654 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority);
657 * @brief Gets the major priority of a quickpanel window.
659 * @return The major priority for this quickpanel or -1.
661 * @ingroup Elm_Win_Group
663 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj);
666 * @brief Sets the minor priority of a quickpanel window.
668 * @param[in] priority The minor priority for this quickpanel.
670 * @ingroup Elm_Win_Group
672 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority);
675 * @brief Gets the minor priority of a quickpanel window.
677 * @return The minor priority for this quickpanel.
679 * @ingroup Elm_Win_Group
681 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj);
684 * @brief Sets the indicator mode of the window.
686 * @param[in] mode The mode, one of #Elm_Win_Indicator_Mode.
688 * @ingroup Elm_Win_Group
690 EAPI void elm_win_indicator_mode_set(Evas_Object *obj, Elm_Win_Indicator_Mode mode);
693 * @brief Gets the indicator mode of the window.
695 * @return The mode, one of #Elm_Win_Indicator_Mode.
697 * @ingroup Elm_Win_Group
699 EAPI Elm_Win_Indicator_Mode elm_win_indicator_mode_get(const Evas_Object *obj);
702 * @brief Sets the indicator opacity mode of the window.
704 * @param[in] mode The mode, one of #Elm_Win_Indicator_Opacity_Mode.
706 * @ingroup Elm_Win_Group
708 EAPI void elm_win_indicator_opacity_set(Evas_Object *obj, Elm_Win_Indicator_Opacity_Mode mode);
711 * @brief Gets the indicator opacity mode of the window.
713 * @return The mode, one of #Elm_Win_Indicator_Opacity_Mode.
715 * @ingroup Elm_Win_Group
717 EAPI Elm_Win_Indicator_Opacity_Mode elm_win_indicator_opacity_get(const Evas_Object *obj);
720 * @brief Sets whether the window is a keyboard.
722 * @param[in] is_keyboard If true, the window is a virtual keyboard..
724 * @ingroup Elm_Win_Group
726 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard);
729 * @brief Gets whether the window is a keyboard
731 * @return The mode, If true, the window is a virtual keyboard..
733 * @ingroup Elm_Win_Group
735 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj);
738 * @brief Sets if this window is an illume conformant window.
740 * @param[in] conformant The conformant flag.
742 * @ingroup Elm_Win_Group
744 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant);
747 * @brief Gets if this window is an illume conformant window.
749 * @return The conformant flag.
751 * @ingroup Elm_Win_Group
753 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj);
756 * @brief Sets the manual rotation done mode.
758 * This function is used to set or reset the manual rotation done mode. the
759 * message of rotation done is sent to WM after rendering its canvas in
760 * Ecore_Evas. but if set the manual rotation done mode, it's disabled and user
761 * should call this explicitly to sends the message.
763 * @param[in] set @c true to set manual rotation done mode, @c false otherwise.
767 * @ingroup Elm_Win_Group
769 EAPI void elm_win_wm_rotation_manual_rotation_done_set(Evas_Object *obj, Eina_Bool set);
772 * @brief Gets the state of manual rotation done mode.
774 * This function is used to get the state of manual rotation done mode.
776 * @return @c true to set manual rotation done mode, @c false otherwise.
780 * @ingroup Elm_Win_Group
782 EAPI Eina_Bool elm_win_wm_rotation_manual_rotation_done_get(const Evas_Object *obj);
785 * @brief To notify the rotation done to WM manually.
787 * This function is used to notify the rotation done to WM manually.
791 * @ingroup Elm_Win_Group
793 EAPI void elm_win_wm_rotation_manual_rotation_done(Evas_Object *obj);
796 * @brief Sets the rotation of the window.
798 * Most engines only work with multiples of 90.
800 * This function is used to set the orientation of the window @c obj to match
801 * that of the screen. The window itself will be resized to adjust to the new
802 * geometry of its contents. If you want to keep the window size, see
803 * @ref elm_win_rotation_with_resize_set.
805 * @param[in] rotation The rotation of the window, in degrees (0-360),
808 * @ingroup Elm_Win_Group
810 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation);
813 * @brief Gets the rotation of the window.
815 * @return The rotation of the window, in degrees (0-360), counter-clockwise.
817 * @ingroup Elm_Win_Group
819 EAPI int elm_win_rotation_get(const Evas_Object *obj);
822 * @brief Rotates the window and resizes it.
824 * Like @ref elm_win_rotation_set, but it also resizes the window's contents so
825 * that they fit inside the current window geometry.
827 * @param[in] rotation The rotation of the window in degrees (0-360),
830 * @ingroup Elm_Win_Group
832 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation);
835 * @brief Queries whether window manager supports window rotation or not.
837 * The window manager rotation allows the WM to controls the rotation of
838 * application windows. It is designed to support synchronized rotation for the
839 * multiple application windows at same time.
841 * See also @ref elm_win_wm_rotation_preferred_rotation_get,
842 * @ref elm_win_wm_rotation_available_rotations_get.
846 * @ingroup Elm_Win_Group
848 EAPI Eina_Bool elm_win_wm_rotation_supported_get(const Evas_Object *obj);
851 * @brief Gets the preferred rotation value.
853 * This function is used to get the preferred rotation value.
855 * @return The preferred rotation of the window in degrees (0-360),
860 * @ingroup Elm_Win_Group
862 EAPI int elm_win_wm_rotation_preferred_rotation_get(const Evas_Object *obj);
866 * @brief Gets the screen position of a window.
868 * @param[out] x The int to store the x coordinate to.
869 * @param[out] y The int to store the y coordinate to.
871 * @ingroup Elm_Win_Group
873 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y);
876 * @brief Gets screen geometry details for the screen that a window is on.
878 * @param[out] x Where to return the horizontal offset value. May be @c null.
879 * @param[out] y Where to return the vertical offset value. May be @c null.
880 * @param[out] w Where to return the width value. May be @c null.
881 * @param[out] h Where to return the height value. May be @c null.
883 * @ingroup Elm_Win_Group
885 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h);
888 * @brief Gets screen dpi for the screen that a window is on.
890 * @param[out] xdpi Pointer to value to store return horizontal dpi. May be
892 * @param[out] ydpi Pointer to value to store return vertical dpi. May be
897 * @ingroup Elm_Win_Group
899 EAPI void elm_win_screen_dpi_get(const Evas_Object *obj, int *xdpi, int *ydpi);
902 * @brief Sets the icon name of the window.
904 * @param[in] icon_name The icon name to set.
906 * @ingroup Elm_Win_Group
908 EAPI void elm_win_icon_name_set(Evas_Object *obj, const char *icon_name);
911 * @brief Gets the icon name of the window.
913 * The returned string is an internal one and should not be freed or modified.
914 * It will also be invalid if a new icon name is set or if the window is
917 * @return The icon name to set.
919 * @ingroup Elm_Win_Group
921 EAPI const char *elm_win_icon_name_get(const Evas_Object *obj);
924 * @brief Sets the withdrawn state of a window.
926 * @param[in] withdrawn If true, the window is withdrawn.
928 * @ingroup Elm_Win_Group
930 EAPI void elm_win_withdrawn_set(Evas_Object *obj, Eina_Bool withdrawn);
933 * @brief Gets the withdrawn state of a window.
935 * @return If true, the window is withdrawn.
937 * @ingroup Elm_Win_Group
939 EAPI Eina_Bool elm_win_withdrawn_get(const Evas_Object *obj);
942 * @brief Sets the urgent state of a window.
944 * @param[in] urgent If true, the window is urgent.
946 * @ingroup Elm_Win_Group
948 EAPI void elm_win_urgent_set(Evas_Object *obj, Eina_Bool urgent);
951 * @brief Gets the urgent state of a window.
953 * @return If true, the window is urgent.
955 * @ingroup Elm_Win_Group
957 EAPI Eina_Bool elm_win_urgent_get(const Evas_Object *obj);
960 * @brief Sets the demand_attention state of a window.
962 * @param[in] demand_attention If true, the window is demand_attention.
964 * @ingroup Elm_Win_Group
966 EAPI void elm_win_demand_attention_set(Evas_Object *obj, Eina_Bool demand_attention);
969 * @brief Gets the demand_attention state of a window.
971 * @return If true, the window is demand_attention.
973 * @ingroup Elm_Win_Group
975 EAPI Eina_Bool elm_win_demand_attention_get(const Evas_Object *obj);
978 * @brief Sets the modal state of a window.
980 * @param[in] modal If true, the window is modal.
982 * @ingroup Elm_Win_Group
984 EAPI void elm_win_modal_set(Evas_Object *obj, Eina_Bool modal);
987 * @brief Gets the modal state of a window.
989 * @return If true, the window is modal.
991 * @ingroup Elm_Win_Group
993 EAPI Eina_Bool elm_win_modal_get(const Evas_Object *obj);
996 * @brief Sets the shaped state of a window.
998 * Shaped windows, when supported, will render the parts of the window that has
999 * no content, transparent.
1001 * If @c shaped is false, then it is strongly advised to have some background
1002 * object or cover the entire window in any other way, or the parts of the
1003 * canvas that have no data will show framebuffer artifacts.
1005 * @param[in] shaped If @c true, the window is shaped.
1007 * @ingroup Elm_Win_Group
1009 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped);
1012 * @brief Gets the shaped state of a window.
1014 * @return If @c true, the window is shaped.
1016 * @ingroup Elm_Win_Group
1018 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj);
1021 * @brief Sets the title of the window.
1023 * @param[in] title The title.
1025 * @ingroup Elm_Win_Group
1027 EAPI void elm_win_title_set(Evas_Object *obj, const char *title);
1030 * @brief Gets the title of the window.
1032 * The returned string is an internal one and should not be freed or modified.
1033 * It will also be invalid if a new title is set or if the window is destroyed.
1035 * @return The title.
1037 * @ingroup Elm_Win_Group
1039 EAPI const char *elm_win_title_get(const Evas_Object *obj);
1042 * @brief Sets the base window size used with stepping calculation
1044 * Base size + stepping is what is calculated for window sizing restrictions.
1046 * @param[in] w The base width.
1047 * @param[in] h The base height.
1051 * @ingroup Elm_Win_Group
1053 EAPI void elm_win_size_base_set(Evas_Object *obj, int w, int h);
1056 * @brief Gets the base size of a window.
1058 * @param[out] w The base width.
1059 * @param[out] h The base height.
1063 * @ingroup Elm_Win_Group
1065 EAPI void elm_win_size_base_get(const Evas_Object *obj, int *w, int *h);
1068 * @brief Sets the window stepping used with sizing calculation.
1070 * Base size + stepping is what is calculated for window sizing restrictions.
1072 * @param[in] w The stepping width (0 disables).
1073 * @param[in] h The stepping height (0 disables).
1077 * @ingroup Elm_Win_Group
1079 EAPI void elm_win_size_step_set(Evas_Object *obj, int w, int h);
1082 * @brief Gets the stepping of a window.
1084 * @param[out] w The stepping width (0 disables).
1085 * @param[out] h The stepping height (0 disables).
1089 * @ingroup Elm_Win_Group
1091 EAPI void elm_win_size_step_get(const Evas_Object *obj, int *w, int *h);
1094 * @brief Sends a command to the windowing environment
1096 * This is intended to work in touchscreen or small screen device environments
1097 * where there is a more simplistic window management policy in place. This
1098 * uses the window object indicated to select which part of the environment to
1099 * control (the part that this window lives in), and provides a command and an
1100 * optional parameter structure (use NULL for this if not needed).
1102 * @param[in] params Optional parameters for the command.
1104 * @ingroup Elm_Win_Group
1106 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params);
1109 * @brief Sets the profile of a window.
1111 * @param[in] profile The string value of a window profile.
1115 * @ingroup Elm_Win_Group
1117 EAPI void elm_win_profile_set(Evas_Object *obj, const char *profile);
1120 * @brief Gets the profile of a window.
1122 * @return The string value of a window profile.
1126 * @ingroup Elm_Win_Group
1128 EAPI const char *elm_win_profile_get(const Evas_Object *obj);
1131 * @brief Sets the layer of the window.
1133 * What this means exactly will depend on the underlying engine used.
1135 * In the case of X11 backed engines, the value in @c layer has the following
1136 * meanings - less than 3 means that the window will be placed below all
1137 * others, more than 5 means that the window will be placed above all others,
1138 * and anything else means that the window will be placed in the default layer.
1140 * @param[in] layer The layer of the window.
1142 * @ingroup Elm_Win_Group
1144 EAPI void elm_win_layer_set(Evas_Object *obj, int layer);
1147 * @brief Gets the layer of the window.
1149 * @return The layer of the window.
1151 * @ingroup Elm_Win_Group
1153 EAPI int elm_win_layer_get(const Evas_Object *obj);
1156 * @brief Gets the inlined image object handle
1158 * When you create a window with elm_win_add() of type #ELM_WIN_INLINED_IMAGE,
1159 * then the window is in fact an evas image object inlined in the parent
1160 * canvas. You can get this object (be careful to not manipulate it as it is
1161 * under control of elementary), and use it to do things like get pixel data,
1162 * save the image to a file, etc.
1164 * @return The inlined image object or @c null if none exists.
1166 * @ingroup Elm_Win_Group
1168 EAPI Evas_Object *elm_win_inlined_image_object_get(const Evas_Object *obj);
1171 * @brief Internal. Used to complete the fake window type.
1175 * @ingroup Elm_Win_Group
1179 EAPI void elm_win_fake_canvas_set(Evas_Object *obj, Ecore_Evas *oee) EINA_DEPRECATED;
1182 * @brief Gets the Ecore_Window of an Evas_Object
1184 * When Elementary is using a Wayland engine, this function will return the surface id of the elm window's surface.
1186 * @param obj The window object
1187 * @return The Ecore_Window of an Evas_Object
1189 * @ingroup Elm_Win_Group
1191 * @note Unless you are getting the window id for the purpose of communicating between client<->compositor over dbus,
1192 * this is definitely not the function you are looking for.
1194 * @if MOBILE @since_tizen 4.0
1195 * @elseif WEARABLE @since_tizen 4.0
1198 EAPI Ecore_Window elm_win_window_id_get(const Evas_Object *obj);
1200 // TIZEN_ONLY(20160218): Improve launching performance.
1204 * @brief Sets the precreated object.
1206 * @param obj The window object
1208 * @ingroup Elm_Win_Group
1209 * @see elm_win_precreated_object_get()
1212 EAPI void elm_win_precreated_object_set(Evas_Object *obj);
1217 * @brief Gets the precreated object.
1219 * @return The precreated window object
1221 * @ingroup Elm_Win_Group
1222 * @see elm_win_precreated_object_set()
1225 EAPI Evas_Object *elm_win_precreated_object_get(void);
1229 * @brief Gets the Main Menu of a window.
1231 * @return The Main Menu of the window ($null on error).
1233 * @ingroup Elm_Win_Group
1235 EAPI Evas_Object *elm_win_main_menu_get(Evas_Object *obj);
1238 * @brief Sets the keyboard mode of the window.
1240 * @param[in] mode The mode, one of #Elm_Win_Keyboard_Mode.
1242 * @ingroup Elm_Win_Group
1244 EAPI void elm_win_keyboard_mode_set(Elm_Win *obj, Elm_Win_Keyboard_Mode mode);
1247 * @brief Gets the keyboard mode of the window.
1249 * @return The mode, one of #Elm_Win_Keyboard_Mode.
1251 * @ingroup Elm_Win_Group
1253 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Elm_Win *obj);
1256 * @brief Sets the aspect ratio of a window.
1258 * @param[in] aspect If 0, the window has no aspect limits, otherwise it is
1259 * width divided by height.
1261 EAPI void elm_win_aspect_set(Elm_Win *obj, double aspect);
1264 * @brief Gets the aspect ratio of a window.
1266 * @return If 0, the window has no aspect limits, otherwise it is width divided
1269 EAPI double elm_win_aspect_get(const Elm_Win *obj);
1272 * @brief Sets keygrab value of the window
1274 * This function grabs the @c key of window using @c grab_mode.
1276 * @param[in] key This string is the keyname to grab.
1277 * @param[in] modifiers A combination of modifier keys that must be present to
1278 * trigger the event. Not supported yet.
1279 * @param[in] not_modifiers A combination of modifier keys that must not be
1280 * present to trigger the event. Not supported yet.
1281 * @param[in] priority Not supported yet.
1282 * @param[in] grab_mode Describes how the key should be grabbed, wrt. focus and
1285 * @return @c true on success, @c false otherwise
1287 EAPI Eina_Bool elm_win_keygrab_set(Elm_Win *obj, const char *key, Evas_Modifier_Mask modifiers, Evas_Modifier_Mask not_modifiers, int priority, Elm_Win_Keygrab_Mode grab_mode);
1290 * @brief Unsets keygrab value of the window
1292 * This function unset keygrab value. Ungrab @c key of window.
1294 * @param[in] key This string is the keyname to grab.
1295 * @param[in] modifiers A combination of modifier keys that must be present to
1296 * trigger the event. Not supported yet.
1297 * @param[in] not_modifiers A combination of modifier keys that must not be
1298 * present to trigger the event. Not supported yet.
1300 * @return @c true on success, @c false otherwise
1302 EAPI Eina_Bool elm_win_keygrab_unset(Elm_Win *obj, const char *key, Evas_Modifier_Mask modifiers, Evas_Modifier_Mask not_modifiers);
1305 * @brief Get the elm_win object from any child object
1307 * @return The elm_win, or @c NULL on failure
1310 EAPI Evas_Object *elm_win_get(Evas_Object *obj);
1313 * @brief Creates a socket to provide the service for Plug widget.
1315 * @param[in] svcname The name of the service to be advertised. Eensure that it
1316 * is unique (when combined with @c svcnum) otherwise creation may fail.
1317 * @param[in] svcnum A number (any value, 0 being the common default) to
1318 * differentiate multiple instances of services with the same name.
1319 * @param[in] svcsys A boolean that if true, specifies to create a system-wide
1320 * service all users can connect to, otherwise the service is private to the
1321 * user id that created the service.
1323 * @return @c true on success, @c false otherwise
1325 * @ingroup Elm_Win_Group
1327 EAPI Eina_Bool elm_win_socket_listen(Elm_Win *obj, const char *svcname, int svcnum, Eina_Bool svcsys);
1330 * @brief Gets whether a window has focus.
1332 * @return @c true if window has focus, @c false otherwise
1334 * @ingroup Elm_Win_Group
1336 EAPI Eina_Bool elm_win_focus_get(const Elm_Win *obj);
1339 * @brief Sets the style for the focus highlight on this window.
1341 * Sets the style to use for theming the highlight of focused objects on the
1342 * given window. If @c style is NULL, the default will be used.
1344 * @param[in] style The style or @c null if none.
1346 * @ingroup Elm_Win_Group
1348 EAPI Eina_Bool elm_win_focus_highlight_style_set(Elm_Win *obj, const char *style);
1351 * @brief Gets the style set for the focus highlight object.
1353 * @return The style or @c null if none.
1355 * @ingroup Elm_Win_Group
1357 EAPI const char *elm_win_focus_highlight_style_get(const Elm_Win *obj);
1360 * @brief Sets the enabled status for the focus highlight in a window.
1362 * This function will enable or disable the focus highlight only for the given
1363 * window, regardless of the global setting for it.
1365 * @param[in] enabled The enabled value for the highlight.
1367 * @ingroup Elm_Win_Group
1369 EAPI void elm_win_focus_highlight_enabled_set(Elm_Win *obj, Eina_Bool enabled);
1372 * @brief Gets the enabled value of the focus highlight for this window.
1374 * @return The enabled value for the highlight.
1376 * @ingroup Elm_Win_Group
1378 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Elm_Win *obj);
1381 * @brief Sets the animate status for the focus highlight for this window.
1383 * This function will enable or disable the animation of focus highlight only
1384 * for the given window, rof the global setting for it.
1386 * @param[in] animate The enabled value for the highlight animation.
1388 * @ingroup Elm_Win_Group
1390 EAPI void elm_win_focus_highlight_animate_set(Elm_Win *obj, Eina_Bool animate);
1393 * @brief Gets the animate value of the focus highlight for this window.
1395 * @return The enabled value for the highlight animation.
1397 * @ingroup Elm_Win_Group
1399 EAPI Eina_Bool elm_win_focus_highlight_animate_get(const Elm_Win *obj);
1402 * @brief Raise a window object.
1404 * Places the window pointed by @c obj at the top of the stack, so that it's
1405 * not covered by any other window.
1407 * @ingroup Elm_Win_Group
1409 EAPI void elm_win_raise(Elm_Win *obj);
1412 * @brief Sets the array of available profiles to a window.
1414 * @param[in] profiles The string array of available profiles.
1415 * @param[in] count The number of members in profiles.
1419 * @ingroup Elm_Win_Group
1421 EAPI void elm_win_available_profiles_set(Elm_Win *obj, const char **profiles, unsigned int count);
1424 * @brief Gets the array of available profiles of a window.
1426 * @param[out] profiles The string array of available profiles.
1427 * @param[out] count The number of members in profiles.
1429 * @return @c true on success, @c false otherwise
1433 * @ingroup Elm_Win_Group
1435 EAPI Eina_Bool elm_win_available_profiles_get(const Elm_Win *obj, char ***profiles, unsigned int *count);
1438 * @brief Sets the array of available window rotations.
1440 * This function is used to set the available rotations to give the hints to
1441 * WM. WM will refer this hints and set the orientation window properly.
1443 * @param[in] obj The object.
1444 * @param[in] rotations The array of rotation value.
1445 * @param[in] count The size of the rotations array.
1449 * @ingroup Elm_Win_Group
1451 EAPI void elm_win_wm_rotation_available_rotations_set(Elm_Win *obj, const int *rotations, unsigned int count);
1454 * @brief Gets the array of available window rotations.
1456 * This function is used to get the available rotations.
1458 * @param[in] obj The object.
1459 * @param[out] rotations The array of rotation value.
1460 * @param[out] count The size of the rotations array.
1462 * @return @c true on success, @c false otherwise
1466 * @ingroup Elm_Win_Group
1468 EAPI Eina_Bool elm_win_wm_rotation_available_rotations_get(const Elm_Win *obj, int **rotations, unsigned int *count);
1470 // TIZEN_ONLY(20160617) : add elm_win_active_win_orientation_get
1473 * @remarks Tizen only feature
1475 * @brief Gets the orientation of current active window on the screen.
1476 * @remarks Support for this depends on the underlying windowing system.
1478 * @param obj The window object
1479 * @return The rotation of active window, in degrees (0-360) conter-clockwise.
1480 * otherwise @c -1 on failure
1482 EAPI int elm_win_active_win_orientation_get(Evas_Object *obj);
1485 // TIZEN_ONLY(20150722): added signal for aux_hint(auxiliary hint)
1487 * @brief Gets the list of supported auxiliary hint strings.
1491 * @remarks Do not change the returned list of contents. Auxiliary hint
1492 * strings are internal and should be considered constants, do not free or
1494 * @remarks Support for this depends on the underlying windowing system.
1496 * @remarks The window auxiliary hint is the value that is used to decide which action should
1497 * be made available to the user by the Windows Manager. If you want to set a specific hint
1498 * to your window, then you should check whether it exists in the supported auxiliary
1499 * hints that are registered in the root window by the Windows Manager. Once you have added
1500 * an auxiliary hint, you can get a new ID which is used to change the value and delete the hint.
1501 * The Windows Manager sends a response message to the application on receiving the auxiliary
1502 * hint change event.
1504 * @param obj The window object
1505 * @return The list of supported auxiliary hint strings
1507 * @if MOBILE @since_tizen 5.5
1508 * @elseif WEARABLE @since_tizen 5.5
1513 EAPI const Eina_List *elm_win_aux_hints_supported_get(const Evas_Object *obj);
1516 * @brief Creates an auxiliary hint of the window.
1520 * @remarks Support for this depends on the underlying windowing system.
1522 * @param obj The window object
1523 * @param hint The auxiliary hint string
1524 * @param val The value string
1525 * @return The ID of the created auxiliary hint,
1526 * otherwise @c -1 on failure
1528 * @if MOBILE @since_tizen 5.5
1529 * @elseif WEARABLE @since_tizen 5.5
1534 EAPI int elm_win_aux_hint_add(Evas_Object *obj, const char *hint, const char *val);
1537 * @brief Deletes an auxiliary hint of the window.
1541 * @remarks Support for this depends on the underlying windowing system.
1542 * @param obj The window object
1543 * @param id The ID of the auxiliary hint
1544 * @return @c EINA_TRUE if no error occurs,
1545 * otherwise @c EINA_FALSE
1547 * @if MOBILE @since_tizen 5.5
1548 * @elseif WEARABLE @since_tizen 5.5
1553 EAPI Eina_Bool elm_win_aux_hint_del(Evas_Object *obj, const int id);
1556 * @brief Changes a value of the auxiliary hint.
1560 * @remarks Support for this depends on the underlying windowing system.
1561 * @param obj The window object
1562 * @param id The auxiliary hint ID
1563 * @param val The value string to be set
1564 * @return @c EINA_TRUE if no error occurs,
1565 * otherwise @c EINA_FALSE
1567 * @if MOBILE @since_tizen 5.5
1568 * @elseif WEARABLE @since_tizen 5.5
1573 EAPI Eina_Bool elm_win_aux_hint_val_set(Evas_Object *obj, const int id, const char *val);
1576 * @brief Gets a value of the auxiliary hint.
1578 * @remarks Support for this depends on the underlying windowing system.
1579 * @param obj The window object
1580 * @param id The auxiliary hint ID
1581 * @return The string value of the auxiliary hint ID,
1584 * @if MOBILE @since_tizen 5.5
1585 * @elseif WEARABLE @since_tizen 5.5
1590 EAPI const char *elm_win_aux_hint_val_get(Evas_Object *obj, int id);
1594 * @brief Gets an ID of the auxiliary hint string.
1596 * @remarks Support for this depends on the underlying windowing system.
1597 * @param obj The window object
1598 * @param hint The auxiliary hint string
1599 * @return The ID of the auxiliary hint,
1600 * otherwise @c -1 on failure
1602 * @if MOBILE @since_tizen 5.5
1603 * @elseif WEARABLE @since_tizen 5.5
1608 EAPI int elm_win_aux_hint_id_get(Evas_Object *obj, const char *hint);
1612 * @remarks Tizen only feature
1614 * @brief Sets an input rect of surface.
1615 * @remarks Support for this depends on the underlying windowing system.
1616 * @param obj The window object
1617 * @param input_rect The rectangle of input to be set
1619 EAPI void elm_win_input_rect_set(Evas_Object *obj, Eina_Rectangle *input_rect);
1623 * @remarks Tizen only feature
1625 * @brief Adds an input rect of surface.
1626 * @remarks Support for this depends on the underlying windowing system.
1627 * @param obj The window object
1628 * @param input_rect The rectangle of input to be added
1630 EAPI void elm_win_input_rect_add(Evas_Object *obj, Eina_Rectangle *input_rect);
1634 * @remarks Tizen only feature
1636 * @brief Subtracts an input rect of surface.
1637 * @remarks Support for this depends on the underlying windowing system.
1638 * @param obj The window object
1639 * @param input_rect The rectangle of input to be subtracted
1641 EAPI void elm_win_input_rect_subtract(Evas_Object *obj, Eina_Rectangle *input_rect);
1645 * @remarks Tizen only feature
1647 * @brief Gets the orientation of current active window on the screen.
1648 * @remarks Support for this depends on the underlying windowing system.
1650 * @param obj The window object
1651 * @return The rotation of active window, in degrees (0-360) conter-clockwise.
1652 * otherwise @c -1 on failure
1654 EAPI int elm_win_active_win_orientation_get(Evas_Object *obj);
1657 * @brief A structure to store aux message information from the window manager.
1658 * @remarks Support for this depends on the underlying windowing system.
1663 typedef struct _Elm_Win_Aux_Message Elm_Win_Aux_Message;
1666 * @brief Gets the key string from an aux message
1667 * @remarks Support for this depends on the underlying windowing system.
1669 * @param obj The window object
1670 * @return Constant key string of the aux message. otherwise @c NULL on failure.
1671 * Do not use this return value after end of the aux message callback.
1675 EAPI const char *elm_win_aux_msg_key_get(Evas_Object *obj, Elm_Win_Aux_Message *msg);
1678 * @brief Gets the value string from an aux message
1679 * @remarks Support for this depends on the underlying windowing system.
1681 * @param obj The window object
1682 * @return Constant value string of the aux message. otherwise @c NULL on failure.
1683 * Do not use this return value after end of the aux message callback.
1687 EAPI const char *elm_win_aux_msg_val_get(Evas_Object *obj, Elm_Win_Aux_Message *msg);
1690 * @brief Gets the list of option from an aux message
1691 * @remarks Support for this depends on the underlying windowing system.
1693 * @param obj The window object
1694 * @return Constant list of option of the aux message. otherwise @c NULL on failure.
1695 * Do not use this return value after end of the aux message callback.
1699 EAPI const Eina_List *elm_win_aux_msg_options_get(Evas_Object *obj, Elm_Win_Aux_Message *msg);
1700 // END of TIZEN_ONLY(20150722)
1702 //TIZEN_ONLY(20171214): tizen need to change win type after win creating
1704 * @brief The type of the window.
1706 * It is a hint of how the Window Manager should handle it.
1708 * The window type is a constructing property that need to be set at creation
1709 * within @ref eo_add.
1711 * @note Once set, it can NOT be modified afterward.
1713 * Can only be used at creation time, within @ref eo_add.
1715 * @if MOBILE @since_tizen 3.0 @elseif WEARABLE @since_tizen 3.0 @endif
1717 * @param[in] obj The object.
1718 * @param[in] type Window type
1722 EAPI void elm_win_type_set(Evas_Object *obj, Elm_Win_Type type);
1726 * @brief Constrain the maximum width and height of a window to the width and
1727 * height of the screen.
1729 * When @c constrain is @c true, @c obj will never resize larger than the
1732 * @param[in] obj The object.
1733 * @param[in] constrain @c true to restrict the window's maximum size.
1735 * @ingroup Elm_Win_Group
1737 EAPI void elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain);
1740 * @brief Get the constraints on the maximum width and height of a window
1741 * relative to the width and height of the screen.
1743 * When this function returns @c true, @c obj will never resize larger than the
1746 * @param[in] obj The object.
1748 * @return @c true to restrict the window's maximum size.
1750 * @ingroup Elm_Win_Group
1752 EAPI Eina_Bool elm_win_screen_constrain_get(const Evas_Object *obj);
1755 * @brief Set the window to be skipped by keyboard focus.
1757 * This sets the window to be skipped by normal keyboard input. This means a
1758 * window manager will be asked not to focus this window as well as omit it
1759 * from things like the taskbar, pager, "alt-tab" list etc. etc.
1761 * Call this and enable it on a window BEFORE you show it for the first time,
1762 * otherwise it may have no effect.
1764 * Use this for windows that have only output information or might only be
1765 * interacted with by the mouse or touchscreen, never for typing. This may have
1766 * side-effects like making the window non-accessible in some cases unless the
1767 * window is specially handled. Use this with care.
1769 * @param[in] obj The object.
1770 * @param[in] skip The skip flag state ($true if it is to be skipped).
1772 * @ingroup Elm_Win_Group
1774 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip);
1777 * @brief Window's autohide state.
1779 * When closing the window in any way outside of the program control, like
1780 * pressing the X button in the titlebar or using a command from the Window
1781 * Manager, a "delete,request" signal is emitted to indicate that this event
1782 * occurred and the developer can take any action, which may include, or not,
1783 * destroying the window object.
1785 * When this property is set to @c true, the window will be automatically
1786 * hidden when this event occurs, after the signal is emitted. If this property
1787 * is @c false nothing will happen, beyond the event emission.
1789 * C applications can use this option along with the quit policy
1790 * @c ELM_POLICY_QUIT_LAST_WINDOW_HIDDEN which allows exiting EFL's main loop
1791 * when all the windows are hidden.
1793 * @note @c autodel and @c autohide are not mutually exclusive. The window will
1794 * be deleted if both are set to @c true.
1796 * @param[in] obj The object.
1797 * @param[in] autohide If @c true, the window will automatically hide itself
1800 * @ingroup Elm_Win_Group
1802 EAPI void elm_win_autohide_set(Evas_Object *obj, Eina_Bool autohide);
1805 * @brief Window's autohide state.
1807 * When closing the window in any way outside of the program control, like
1808 * pressing the X button in the titlebar or using a command from the Window
1809 * Manager, a "delete,request" signal is emitted to indicate that this event
1810 * occurred and the developer can take any action, which may include, or not,
1811 * destroying the window object.
1813 * When this property is set to @c true, the window will be automatically
1814 * hidden when this event occurs, after the signal is emitted. If this property
1815 * is @c false nothing will happen, beyond the event emission.
1817 * C applications can use this option along with the quit policy
1818 * @c ELM_POLICY_QUIT_LAST_WINDOW_HIDDEN which allows exiting EFL's main loop
1819 * when all the windows are hidden.
1821 * @note @c autodel and @c autohide are not mutually exclusive. The window will
1822 * be deleted if both are set to @c true.
1824 * @param[in] obj The object.
1826 * @return If @c true, the window will automatically hide itself when closed.
1828 * @ingroup Elm_Win_Group
1830 EAPI Eina_Bool elm_win_autohide_get(const Evas_Object *obj);
1833 * @brief Set a window object's icon.
1835 * This sets an image to be used as the icon for the given window, in the
1836 * window manager decoration part. The exact pixel dimensions of the object
1837 * (not object size) will be used and the image pixels will be used as-is when
1838 * this function is called. If the image object has been updated, then call
1839 * this function again to source the image pixels and place them in the
1840 * window's icon. Note that only objects of type @ref Efl_Canvas_Image or
1841 * @ref Efl_Ui_Image are allowed.
1843 * @param[in] obj The object.
1844 * @param[in] icon The image object to use for an icon.
1846 * @ingroup Elm_Win_Group
1848 EAPI void elm_win_icon_object_set(Evas_Object *obj, Evas_Object *icon);
1851 * @brief Get the icon object used for the window.
1853 * The object returns is the one marked by @ref elm_win_icon_object_set as the
1854 * object to use for the window icon.
1856 * @param[in] obj The object.
1858 * @return The Evas image object to use for an icon.
1860 * @ingroup Elm_Win_Group
1862 EAPI const Evas_Object *elm_win_icon_object_get(const Evas_Object *obj);
1865 * @brief Set the iconified state of a window.
1867 * @param[in] obj The object.
1868 * @param[in] iconified If @c true, the window is iconified.
1870 * @ingroup Elm_Win_Group
1872 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified);
1875 * @brief Get the iconified state of a window.
1877 * @param[in] obj The object.
1879 * @return If @c true, the window is iconified.
1881 * @ingroup Elm_Win_Group
1883 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj);
1886 * @brief Set the maximized state of a window.
1888 * @param[in] obj The object.
1889 * @param[in] maximized If @c true, the window is maximized.
1891 * @ingroup Elm_Win_Group
1893 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized);
1896 * @brief Get the maximized state of a window.
1898 * @param[in] obj The object.
1900 * @return If @c true, the window is maximized.
1902 * @ingroup Elm_Win_Group
1904 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj);
1907 * @brief Set the fullscreen state of a window.
1909 * @param[in] obj The object.
1910 * @param[in] fullscreen If @c true, the window is fullscreen.
1912 * @ingroup Elm_Win_Group
1914 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen);
1917 * @brief Get the fullscreen state of a window.
1919 * @param[in] obj The object.
1921 * @return If @c true, the window is fullscreen.
1923 * @ingroup Elm_Win_Group
1925 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj);
1928 * @brief Set the sticky state of the window.
1930 * Hints the Window Manager that the window in @c obj should be left fixed at
1931 * its position even when the virtual desktop it's on moves or changes.
1933 * @param[in] obj The object.
1934 * @param[in] sticky If @c true, the window's sticky state is enabled.
1936 * @ingroup Elm_Win_Group
1938 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky);
1941 * @brief Get the sticky state of the window.
1943 * @param[in] obj The object.
1945 * @return If @c true, the window's sticky state is enabled.
1947 * @ingroup Elm_Win_Group
1949 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj);
1956 * @brief Set the noblank property of a window.
1958 * The "noblank" property is a way to request the display on which the window
1959 * is shown does not blank, go to screensaver or otherwise hide or obscure the
1960 * window. It is intended for uses such as media playback on a television where
1961 * a user may not want to be interrupted by an idle screen. The noblank
1962 * property may have no effect if the window is iconified/minimized or hidden.
1964 * @param[in] obj The object.
1965 * @param[in] noblank If @c true, the window is set to noblank.
1969 * @ingroup Elm_Win_Group
1971 EAPI void elm_win_noblank_set(Evas_Object *obj, Eina_Bool noblank);
1974 * @brief Get the noblank property of a window.
1976 * @param[in] obj The object.
1978 * @return If @c true, the window is set to noblank.
1982 * @ingroup Elm_Win_Group
1984 EAPI Eina_Bool elm_win_noblank_get(const Evas_Object *obj);
1987 * @brief Set the borderless state of a window.
1989 * This function requests the Window Manager not to draw any decoration around
1992 * @param[in] obj The object.
1993 * @param[in] borderless If @c true, the window is borderless.
1995 * @ingroup Elm_Win_Group
1997 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless);
2000 * @brief Get the borderless state of a window.
2002 * @param[in] obj The object.
2004 * @return If @c true, the window is borderless.
2006 * @ingroup Elm_Win_Group
2008 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj);
2011 * @brief The role of the window.
2013 * It is a hint of how the Window Manager should handle it. Unlike
2014 * @ref elm_win_type_get and @ref elm_win_name_get this can be changed at
2017 * Set the role of the window.
2019 * @param[in] obj The object.
2020 * @param[in] role The role to set.
2022 * @ingroup Elm_Win_Group
2024 EAPI void elm_win_role_set(Evas_Object *obj, const char *role);
2027 * @brief The role of the window.
2029 * It is a hint of how the Window Manager should handle it. Unlike
2030 * @ref elm_win_type_get and @ref elm_win_name_get this can be changed at
2033 * Get the role of the window.
2035 * The returned string is an internal one and should not be freed or modified.
2036 * It will also be invalid if a new role is set or if the window is destroyed.
2038 * @param[in] obj The object.
2040 * @return The role to set.
2042 * @ingroup Elm_Win_Group
2044 EAPI const char *elm_win_role_get(const Evas_Object *obj);
2048 * @brief The window name.
2050 * The meaning of name depends on the underlying windowing system.
2052 * The window name is a construction property that can only be set at creation
2053 * time, before finalize. In C this means inside @c efl_add().
2055 * @note Once set, it cannot be modified afterwards.
2057 * No description supplied.
2059 * @param[in] obj The object.
2061 * @return Window name
2065 * @ingroup Elm_Win_Group
2067 EAPI const char *elm_win_name_get(const Evas_Object *obj);
2070 //TIZEN_ONLY(20171214): tizen need to change win type after win creating
2072 * @brief The type of the window.
2074 * It is a hint of how the Window Manager should handle it.
2076 * The window type is a construction property that can only be set at creation
2077 * time, before finalize. In C this means inside @c efl_add().
2079 * @note Once set, it cannot be modified afterward.
2081 * If the object is not window object, returns @c unknown.
2083 * @param[in] obj The object.
2085 * @return Window type
2087 * @ingroup Elm_Win_Group
2089 EAPI Elm_Win_Type elm_win_type_get(const Evas_Object *obj);
2093 * @brief The hardware acceleration preference for this window.
2095 * This is a constructor function and can only be called before
2096 * @ref Efl.Object.finalize.
2098 * This property overrides the global EFL configuration option
2099 * "accel_preference" for this single window, and accepts the same syntax.
2101 * The @c accel string is a freeform C string that indicates what kind of
2102 * acceleration is preferred. Here "acceleration" generally refers to rendering
2103 * and the hardware with which the unit application renders GUIs. This may or
2104 * may not be honored but a best attempt will be made. Known strings are as
2107 * "gl", "opengl" - try use OpenGL. "3d" - try to use a 3d acceleration unit.
2108 * "hw", "hardware", "accel" - try any acceleration unit (best possible) "none"
2109 * - use no acceleration but software instead (since 1.16)
2111 * Since 1.14, it is also possible to specify some GL properties for the GL
2112 * window surface. This allows applications to use GLView with depth, stencil
2113 * and MSAA buffers with direct rendering. The new accel preference string
2114 * format is thus "{HW Accel}[:depth{value}[:stencil{value}[:msaa{str}$]$]$]".
2116 * Accepted values for depth are for instance "depth", "depth16", "depth24".
2117 * Accepted values for stencil are "stencil", "stencil1", "stencil8". For MSAA,
2118 * only predefined strings are accepted: "msaa", "msaa_low", "msaa_mid" and
2119 * "msaa_high". The selected configuration is not guaranteed and is only valid
2120 * in case of GL acceleration. Only the base acceleration string will be saved
2121 * (e.g. "gl" or "hw").
2123 * Full examples include:
2125 * "gl", - try to use OpenGL "hw:depth:stencil", - use HW acceleration with
2126 * default depth and stencil buffers "opengl:depth24:stencil8:msaa_mid" - use
2127 * OpenGL with 24-bit depth, 8-bit stencil and a medium number of MSAA samples
2128 * in the backbuffer.
2130 * Note that this option may be overriden by environment variables or the
2131 * configuration option "accel_preference_override".
2133 * This will return the value of "accel_preference" when the window was
2136 * @param[in] obj The object.
2138 * @return Acceleration
2142 * @ingroup Elm_Win_Group
2144 EAPI const char *elm_win_accel_preference_get(const Evas_Object *obj);
2147 * @brief The frontbuffer preference for this window.
2149 * Note that this option may be used only in wayland
2151 * @param[in] obj The object.
2152 * @param[in] Eina_Bool frontbuffer enabled value
2156 * @ingroup Elm_Win_Group
2158 EAPI void elm_win_use_frontbuffer_set(Evas_Object *obj, Eina_Bool use_frontbuffer);
2161 * @brief The frontbuffer preference for this window.
2163 * This is a constructor function and can only be called before
2164 * @ref Efl.Object.finalize.
2166 * Note that this option may be used only in wayland
2168 * This will return the value of "use_frontbuffer" when the window was
2171 * @param[in] obj The object.
2177 * @ingroup Elm_Win_Group
2179 EAPI Eina_Bool elm_win_use_frontbuffer_get(const Evas_Object *obj);
2182 * @brief Set the alpha channel state of a window.
2184 * If @c alpha is true, the alpha channel of the canvas will be enabled
2185 * possibly making parts of the window completely or partially transparent.
2186 * This is also subject to the underlying system supporting it, for example a
2187 * system using a compositing manager.
2189 * @note Alpha window can be enabled automatically by window theme style's
2190 * property. If "alpha" data.item is "1" or "true" in window style(eg.
2191 * elm/win/base/default), the window is switched to alpha automatically without
2192 * the explicit api call.
2194 * @param[in] obj The object.
2195 * @param[in] alpha @c true if the window alpha channel is enabled, @c false
2198 * @ingroup Elm_Win_Group
2200 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha);
2203 * @brief Get the alpha channel state of a window.
2205 * @param[in] obj The object.
2207 * @return @c true if the window alpha channel is enabled, @c false otherwise.
2209 * @ingroup Elm_Win_Group
2211 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj);
2214 * @brief Activate a window object.
2216 * This function sends a request to the Window Manager to activate the window
2217 * pointed by @c obj. If honored by the WM, the window will receive the
2220 * @note This is just a request that a Window Manager may ignore, so calling
2221 * this function does not ensure in any way that the window will be the active
2223 * @param[in] obj The object.
2225 * @ingroup Elm_Win_Group
2227 EAPI void elm_win_activate(Evas_Object *obj);
2230 * @brief Center a window on the screen.
2232 * This function centers window @c obj horizontally and/or vertically based on
2233 * the values of @c h and @c v.
2235 * @note This is just a request that a Window Manager may ignore, so calling
2236 * this function does not ensure in any way that the window will be centered
2239 * @param[in] obj The object.
2240 * @param[in] h If @c true, center horizontally. If @c false, do not change
2241 * horizontal location.
2242 * @param[in] v If @c true, center vertically. If @c false, do not change
2243 * vertical location.
2245 * @ingroup Elm_Win_Group
2247 EAPI void elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v);
2254 * @brief Start moving or resizing the window.
2256 * The user can request the display server to start moving or resizing the
2257 * window by combining modes from @ref Efl_Ui_Win_Move_Resize_Mode. This API
2258 * can only be called if none of the following conditions is true:
2260 * 1. Called in the absence of a pointer down event, 2. Called more than once
2261 * before a pointer up event, 3. Called when the window is already being
2262 * resized or moved, 4. Called with an unsupported combination of modes.
2264 * Right usage: 1. Pointer (mouse or touch) down event, 2.
2265 * @ref elm_win_move_resize_start called only once with a supported mode, 3.
2266 * Pointer (mouse or touch) up event.
2268 * If a pointer up event occurs after calling the function, it automatically
2269 * ends the window move and resize operation.
2271 * Currently, only the following 9 combinations are allowed, and possibly more
2272 * combinations may be added in the future: 1. @ref ELM_WIN_MOVE_RESIZE_MOVE
2273 * 2. @ref ELM_WIN_MOVE_RESIZE_TOP 3. @ref ELM_WIN_MOVE_RESIZE_BOTTOM 4.
2274 * @ref ELM_WIN_MOVE_RESIZE_LEFT 5. @ref ELM_WIN_MOVE_RESIZE_RIGHT 6.
2275 * @ref ELM_WIN_MOVE_RESIZE_TOP | @ref ELM_WIN_MOVE_RESIZE_LEFT 7.
2276 * @ref ELM_WIN_MOVE_RESIZE_TOP | @ref ELM_WIN_MOVE_RESIZE_RIGHT 8.
2277 * @ref ELM_WIN_MOVE_RESIZE_BOTTOM | @ref ELM_WIN_MOVE_RESIZE_LEFT 9.
2278 * @ref ELM_WIN_MOVE_RESIZE_BOTTOM | @ref ELM_WIN_MOVE_RESIZE_RIGHT
2280 * In particular move and resize cannot happen simultaneously.
2282 * @note the result of this API can only guarantee that the request has been
2283 * forwarded to the server, but there is no guarantee that the request can be
2284 * processed by the display server.
2286 * @param[in] obj The object.
2287 * @param[in] mode The requested move or resize mode.
2289 * @return @c true if the request was successfully sent to the display server,
2290 * @c false in case of error.
2294 * @ingroup Elm_Win_Group
2296 EAPI Eina_Bool elm_win_move_resize_start(Evas_Object *obj, Elm_Win_Move_Resize_Mode mode);
2299 * @brief Set the animate status for the focus highlight for this window.
2301 * This function will enable or disable the animation of focus highlight only
2302 * for the given window, regardless of the global setting for it.
2304 * @param[in] animate The enabled value for the highlight animation.
2306 * @ingroup Elm_Win_Group
2308 EAPI void elm_win_focus_highlight_animate_set(Elm_Win *obj, Eina_Bool animate);
2311 * @brief Get the animate value of the focus highlight for this window.
2313 * @return The enabled value for the highlight animation.
2315 * @ingroup Elm_Win_Group
2317 EAPI Eina_Bool elm_win_focus_highlight_animate_get(const Elm_Win *obj);
2320 * @brief Set the enabled status for the focus highlight in a window.
2322 * This function will enable or disable the focus highlight only for the given
2323 * window, regardless of the global setting for it.
2325 * @param[in] enabled The enabled value for the highlight.
2327 * @ingroup Elm_Win_Group
2329 EAPI void elm_win_focus_highlight_enabled_set(Elm_Win *obj, Eina_Bool enabled);
2332 * @brief Get the enabled value of the focus highlight for this window.
2334 * @return The enabled value for the highlight.
2336 * @ingroup Elm_Win_Group
2338 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Elm_Win *obj);
2341 * @brief Set the style for the focus highlight on this window.
2343 * Sets the style to use for theming the highlight of focused objects on the
2344 * given window. If @c style is NULL, the default will be used.
2346 * @param[in] style The style or @c null if none.
2348 * @ingroup Elm_Win_Group
2350 EAPI Eina_Bool elm_win_focus_highlight_style_set(Elm_Win *obj, const char *style);
2353 * @brief Get the style set for the focus highlight object.
2355 * @return The style or @c null if none.
2357 * @ingroup Elm_Win_Group
2359 EAPI const char *elm_win_focus_highlight_style_get(const Elm_Win *obj);
2361 // TIZEN_ONLY(20230125): add minimum/maximum sizes set API.
2363 * @brief Sets the minimum size of window
2365 * @param[in] w The minimum width.
2366 * @param[in] h The minimum height.
2368 * @ingroup Elm_Win_Group
2370 EAPI void elm_win_minimum_size_set(Elm_Win *obj, int w, int h);
2373 * @brief Sets the maximum size of window
2375 * @param[in] w The maximum width.
2376 * @param[in] h The maximum height.
2378 * @ingroup Elm_Win_Group
2381 EAPI void elm_win_maximum_size_set(Elm_Win *obj, int w, int h);