4 * @image html img/widget/win/preview-00.png
5 * @image latex img/widget/win/preview-00.eps
7 * The window class of Elementary. Contains functions to manipulate
8 * windows. The Evas engine used to render the window contents is specified
9 * in the system or user elementary config files (whichever is found last),
10 * and can be overridden with the ELM_ENGINE environment variable for
11 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
12 * compilation setup and modules actually installed at runtime) are (listed
13 * in order of best supported and most likely to be complete and work to
16 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
17 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
19 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
21 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
23 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
25 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
26 * rendering using SDL as the buffer)
27 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
29 * @li "dfb", "directfb" (Rendering to a DirectFB window)
30 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
31 * grayscale using dedicated 8bit software engine in X11)
32 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
33 * X11 using 16bit software engine)
34 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
35 * (Windows CE rendering via GDI with 16bit software renderer)
36 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
37 * buffer with 16bit software renderer)
38 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
39 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
40 * @li "psl1ght" (PS3 rendering using PSL1GHT)
42 * All engines use a simple string to select the engine to render, EXCEPT
43 * the "shot" engine. This actually encodes the output of the virtual
44 * screenshot and how long to delay in the engine string. The engine string
45 * is encoded in the following way:
47 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
49 * Where options are separated by a ":" char if more than one option is
50 * given, with delay, if provided being the first option and file the last
51 * (order is important). The delay specifies how long to wait after the
52 * window is shown before doing the virtual "in memory" rendering and then
53 * save the output to the file specified by the file option (and then exit).
54 * If no delay is given, the default is 0.5 seconds. If no file is given the
55 * default output file is "out.png". Repeat option is for continous
56 * capturing screenshots. Repeat range is from 1 to 999 and filename is
57 * fixed to "out001.png" Some examples of using the shot engine:
59 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
60 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
61 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
62 * ELM_ENGINE="shot:delay=2.0" elementary_test
63 * ELM_ENGINE="shot:" elementary_test
65 * Signals that you can add callbacks for are:
67 * @li "delete,request": the user requested to close the window. See
68 * elm_win_autodel_set().
69 * @li "focus,in": window got focus
70 * @li "focus,out": window lost focus
71 * @li "moved": window that holds the canvas was moved
74 * @li @ref win_example_01
79 * Defines the types of window that can be created
81 * These are hints set on the window so that a running Window Manager knows
82 * how the window should be handled and/or what kind of decorations it
85 * Currently, only the X11 backed engines use them.
89 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
90 window. Almost every window will be created with this
92 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
93 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
94 window holding desktop icons. */
95 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
96 be kept on top of any other window by the Window
98 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
100 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
101 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
103 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
104 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
105 entry in a menubar is clicked. Typically used
106 with elm_win_override_set(). This hint exists
107 for completion only, as the EFL way of
108 implementing a menu would not normally use a
109 separate window for its contents. */
110 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
111 triggered by right-clicking an object. */
112 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
113 explanatory text that typically appear after the
114 mouse cursor hovers over an object for a while.
115 Typically used with elm_win_override_set() and also
116 not very commonly used in the EFL. */
117 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
118 battery life or a new E-Mail received. */
119 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
120 usually used in the EFL. */
121 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
122 object being dragged across different windows, or even
123 applications. Typically used with
124 elm_win_override_set(). */
125 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
126 buffer. No actual window is created for this
127 type, instead the window and all of its
128 contents will be rendered to an image buffer.
129 This allows to have children window inside a
130 parent one just like any other object would
131 be, and do other things like applying @c
132 Evas_Map effects to it. This is the only type
133 of window that requires the @c parent
134 parameter of elm_win_add() to be a valid @c
136 ELM_WIN_SOCKET_IMAGE,/**< The window is rendered onto an image buffer
137 and can be shown other process's plug image object.
138 No actural window is created for this type,
139 instead the window and all of its contents will be
140 rendered to an image buffer and can be shown
141 other process's plug image object*/
145 * The different layouts that can be requested for the virtual keyboard.
147 * When the application window is being managed by Illume, it may request
148 * any of the following layouts for the virtual keyboard.
150 // XXX: remove this as it conflicts with input panel
153 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
154 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
155 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
156 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
157 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
158 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
159 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
160 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
161 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
162 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
163 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
164 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
165 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
166 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
167 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
168 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
169 } Elm_Win_Keyboard_Mode;
172 * Available commands that can be sent to the Illume manager.
174 * When running under an Illume session, a window may send commands to the
175 * Illume manager to perform different actions.
179 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous window */
180 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window in the list */
181 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home screen */
182 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
183 } Elm_Illume_Command;
186 * Adds a window object. If this is the first window created, pass NULL as
189 * @param parent Parent object to add the window to, or NULL
190 * @param name The name of the window
191 * @param type The window type, one of #Elm_Win_Type.
193 * The @p parent paramter can be @c NULL for every window @p type except
194 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
195 * which the image object will be created.
197 * @return The created object, or NULL on failure
199 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
202 * Adds a window object with standard setup
204 * @param name The name of the window
205 * @param title The title for the window
207 * This creates a window like elm_win_add() but also puts in a standard
208 * background with elm_bg_add(), as well as setting the window title to
209 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
210 * as the parent widget.
212 * @return The created object, or NULL on failure
216 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
219 * Add @p subobj as a resize object of window @p obj.
222 * Setting an object as a resize object of the window means that the
223 * @p subobj child's size and position will be controlled by the window
224 * directly. That is, the object will be resized to match the window size
225 * and should never be moved or resized manually by the developer.
227 * In addition, resize objects of the window control what the minimum size
228 * of it will be, as well as whether it can or not be resized by the user.
230 * For the end user to be able to resize a window by dragging the handles
231 * or borders provided by the Window Manager, or using any other similar
232 * mechanism, all of the resize objects in the window should have their
233 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
235 * Also notice that the window can get resized to the current size of the
236 * object if the EVAS_HINT_EXPAND is set @b after the call to
237 * elm_win_resize_object_add(). So if the object should get resized to the
238 * size of the window, set this hint @b before adding it as a resize object
239 * (this happens because the size of the window and the object are evaluated
240 * as soon as the object is added to the window).
242 * @param obj The window object
243 * @param subobj The resize object to add
245 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj);
248 * Delete @p subobj as a resize object of window @p obj.
250 * This function removes the object @p subobj from the resize objects of
251 * the window @p obj. It will not delete the object itself, which will be
252 * left unmanaged and should be deleted by the developer, manually handled
253 * or set as child of some other container.
255 * @param obj The window object
256 * @param subobj The resize object to add
258 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj);
261 * Set the title of the window
263 * @param obj The window object
264 * @param title The title to set
266 EAPI void elm_win_title_set(Evas_Object *obj, const char *title);
269 * Get the title of the window
271 * The returned string is an internal one and should not be freed or
272 * modified. It will also be rendered invalid if a new title is set or if
273 * the window is destroyed.
275 * @param obj The window object
278 EAPI const char *elm_win_title_get(const Evas_Object *obj);
281 * Set the window's autodel state.
283 * When closing the window in any way outside of the program control, like
284 * pressing the X button in the titlebar or using a command from the
285 * Window Manager, a "delete,request" signal is emitted to indicate that
286 * this event occurred and the developer can take any action, which may
287 * include, or not, destroying the window object.
289 * When the @p autodel parameter is set, the window will be automatically
290 * destroyed when this event occurs, after the signal is emitted.
291 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
292 * and is up to the program to do so when it's required.
294 * @param obj The window object
295 * @param autodel If true, the window will automatically delete itself when
298 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel);
301 * Get the window's autodel state.
303 * @param obj The window object
304 * @return If the window will automatically delete itself when closed
306 * @see elm_win_autodel_set()
308 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj);
311 * Activate a window object.
313 * This function sends a request to the Window Manager to activate the
314 * window pointed by @p obj. If honored by the WM, the window will receive
315 * the keyboard focus.
317 * @note This is just a request that a Window Manager may ignore, so calling
318 * this function does not ensure in any way that the window will be the
319 * active one after it.
321 * @param obj The window object
323 EAPI void elm_win_activate(Evas_Object *obj);
326 * Lower a window object.
328 * Places the window pointed by @p obj at the bottom of the stack, so that
329 * no other window is covered by it.
331 * If elm_win_override_set() is not set, the Window Manager may ignore this
334 * @param obj The window object
336 EAPI void elm_win_lower(Evas_Object *obj);
339 * Raise a window object.
341 * Places the window pointed by @p obj at the top of the stack, so that it's
342 * not covered by any other window.
344 * If elm_win_override_set() is not set, the Window Manager may ignore this
347 * @param obj The window object
349 EAPI void elm_win_raise(Evas_Object *obj);
352 * Center a window on its screen
354 * This function centers window @p obj horizontally and/or vertically based on the values
356 * @param obj The window object
357 * @param h If true, center horizontally. If false, do not change horizontal location.
358 * @param v If true, center vertically. If false, do not change vertical location.
360 EAPI void elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v);
363 * Set the borderless state of a window.
365 * This function requests the Window Manager to not draw any decoration
368 * @param obj The window object
369 * @param borderless If true, the window is borderless
371 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless);
374 * Get the borderless state of a window.
376 * @param obj The window object
377 * @return If true, the window is borderless
379 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj);
382 * Set the shaped state of a window.
384 * Shaped windows, when supported, will render the parts of the window that
385 * has no content, transparent.
387 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
388 * background object or cover the entire window in any other way, or the
389 * parts of the canvas that have no data will show framebuffer artifacts.
391 * @param obj The window object
392 * @param shaped If true, the window is shaped
394 * @see elm_win_alpha_set()
396 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped);
399 * Get the shaped state of a window.
401 * @param obj The window object
402 * @return If true, the window is shaped
404 * @see elm_win_shaped_set()
406 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj);
409 * Set the alpha channel state of a window.
411 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
412 * possibly making parts of the window completely or partially transparent.
413 * This is also subject to the underlying system supporting it, like for
414 * example, running under a compositing manager. If no compositing is
415 * available, enabling this option will instead fallback to using shaped
416 * windows, with elm_win_shaped_set().
418 * @param obj The window object
419 * @param alpha If true, the window has an alpha channel
421 * @see elm_win_alpha_set()
423 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha);
426 * Get the transparency state of a window.
428 * @param obj The window object
429 * @return If true, the window is transparent
431 * @see elm_win_transparent_set()
433 // XXX: deprecate this
434 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj);
437 * Set the transparency state of a window.
439 * Use elm_win_alpha_set() instead.
441 * @param obj The window object
442 * @param transparent If true, the window is transparent
444 * @see elm_win_alpha_set()
446 // XXX: deprecate this
447 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent);
450 * Get the alpha channel state of a window.
452 * @param obj The window object
453 * @return If true, the window has an alpha channel
455 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj);
458 * Set the override state of a window.
460 * A window with @p override set to EINA_TRUE will not be managed by the
461 * Window Manager. This means that no decorations of any kind will be shown
462 * for it, moving and resizing must be handled by the application, as well
463 * as the window visibility.
465 * This should not be used for normal windows, and even for not so normal
466 * ones, it should only be used when there's a good reason and with a lot
467 * of care. Mishandling override windows may result situations that
468 * disrupt the normal workflow of the end user.
470 * @param obj The window object
471 * @param override If true, the window is overridden
473 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override);
476 * Get the override state of a window.
478 * @param obj The window object
479 * @return If true, the window is overridden
481 * @see elm_win_override_set()
483 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj);
486 * Set the fullscreen state of a window.
488 * @param obj The window object
489 * @param fullscreen If true, the window is fullscreen
491 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen);
494 * Get the fullscreen state of a window.
496 * @param obj The window object
497 * @return If true, the window is fullscreen
499 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj);
502 * Set the maximized state of a window.
504 * @param obj The window object
505 * @param maximized If true, the window is maximized
507 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized);
510 * Get the maximized state of a window.
512 * @param obj The window object
513 * @return If true, the window is maximized
515 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj);
518 * Set the iconified state of a window.
520 * @param obj The window object
521 * @param iconified If true, the window is iconified
523 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified);
526 * Get the iconified state of a window.
528 * @param obj The window object
529 * @return If true, the window is iconified
531 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj);
534 * Set the layer of the window.
536 * What this means exactly will depend on the underlying engine used.
538 * In the case of X11 backed engines, the value in @p layer has the
539 * following meanings:
540 * @li < 3: The window will be placed below all others.
541 * @li > 5: The window will be placed above all others.
542 * @li other: The window will be placed in the default layer.
544 * @param obj The window object
545 * @param layer The layer of the window
547 EAPI void elm_win_layer_set(Evas_Object *obj, int layer);
550 * Get the layer of the window.
552 * @param obj The window object
553 * @return The layer of the window
555 * @see elm_win_layer_set()
557 EAPI int elm_win_layer_get(const Evas_Object *obj);
560 * Set the rotation of the window.
562 * Most engines only work with multiples of 90.
564 * This function is used to set the orientation of the window @p obj to
565 * match that of the screen. The window itself will be resized to adjust
566 * to the new geometry of its contents. If you want to keep the window size,
567 * see elm_win_rotation_with_resize_set().
569 * @param obj The window object
570 * @param rotation The rotation of the window, in degrees (0-360),
573 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation);
576 * Rotates the window and resizes it.
578 * Like elm_win_rotation_set(), but it also resizes the window's contents so
579 * that they fit inside the current window geometry.
581 * @param obj The window object
582 * @param rotation The rotation of the window in degrees (0-360),
585 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation);
588 * Get the rotation of the window.
590 * @param obj The window object
591 * @return The rotation of the window in degrees (0-360)
593 * @see elm_win_rotation_set()
594 * @see elm_win_rotation_with_resize_set()
596 EAPI int elm_win_rotation_get(const Evas_Object *obj);
599 * Set the sticky state of the window.
601 * Hints the Window Manager that the window in @p obj should be left fixed
602 * at its position even when the virtual desktop it's on moves or changes.
604 * @param obj The window object
605 * @param sticky If true, the window's sticky state is enabled
607 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky);
610 * Get the sticky state of the window.
612 * @param obj The window object
613 * @return If true, the window's sticky state is enabled
615 * @see elm_win_sticky_set()
617 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj);
620 * Set if this window is an illume conformant window
622 * @param obj The window object
623 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
625 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant);
628 * Get if this window is an illume conformant window
630 * @param obj The window object
631 * @return A boolean if this window is illume conformant or not
633 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj);
636 * Set a window to be an illume quickpanel window
638 * By default window objects are not quickpanel windows.
640 * @param obj The window object
641 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
643 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel);
646 * Get if this window is a quickpanel or not
648 * @param obj The window object
649 * @return A boolean if this window is a quickpanel or not
651 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj);
654 * Set the major priority of a quickpanel window
656 * @param obj The window object
657 * @param priority The major priority for this quickpanel
659 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority);
662 * Get the major priority of a quickpanel window
664 * @param obj The window object
665 * @return The major priority of this quickpanel
667 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj);
670 * Set the minor priority of a quickpanel window
672 * @param obj The window object
673 * @param priority The minor priority for this quickpanel
675 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority);
678 * Get the minor priority of a quickpanel window
680 * @param obj The window object
681 * @return The minor priority of this quickpanel
683 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj);
686 * Set which zone this quickpanel should appear in
688 * @param obj The window object
689 * @param zone The requested zone for this quickpanel
691 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone);
694 * Get which zone this quickpanel should appear in
696 * @param obj The window object
697 * @return The requested zone for this quickpanel
699 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj);
702 * Set the window to be skipped by keyboard focus
704 * This sets the window to be skipped by normal keyboard input. This means
705 * a window manager will be asked to not focus this window as well as omit
706 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
708 * Call this and enable it on a window BEFORE you show it for the first time,
709 * otherwise it may have no effect.
711 * Use this for windows that have only output information or might only be
712 * interacted with by the mouse or fingers, and never for typing input.
713 * Be careful that this may have side-effects like making the window
714 * non-accessible in some cases unless the window is specially handled. Use
717 * @param obj The window object
718 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
720 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip);
723 * Send a command to the windowing environment
725 * This is intended to work in touchscreen or small screen device
726 * environments where there is a more simplistic window management policy in
727 * place. This uses the window object indicated to select which part of the
728 * environment to control (the part that this window lives in), and provides
729 * a command and an optional parameter structure (use NULL for this if not
732 * @param obj The window object that lives in the environment to control
733 * @param command The command to send
734 * @param params Optional parameters for the command
736 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params);
739 * Get the inlined image object handle
741 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
742 * then the window is in fact an evas image object inlined in the parent
743 * canvas. You can get this object (be careful to not manipulate it as it
744 * is under control of elementary), and use it to do things like get pixel
745 * data, save the image to a file, etc.
747 * @param obj The window object to get the inlined image from
748 * @return The inlined image object, or NULL if none exists
750 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
753 * Determine whether a window has focus
754 * @param obj The window to query
755 * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
757 EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj);
760 * Constrain the maximum width and height of a window to the width and height of its screen
762 * When @p constrain is true, @p obj will never resize larger than the screen.
763 * @param obj The window object
764 * @param constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
766 EAPI void elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain);
769 * Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen
771 * When this function returns true, @p obj will never resize larger than the screen.
772 * @param obj The window object
773 * @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
775 EAPI Eina_Bool elm_win_screen_constrain_get(Evas_Object *obj);
778 * Get screen geometry details for the screen that a window is on
779 * @param obj The window to query
780 * @param x where to return the horizontal offset value. May be NULL.
781 * @param y where to return the vertical offset value. May be NULL.
782 * @param w where to return the width value. May be NULL.
783 * @param h where to return the height value. May be NULL.
785 EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h);
788 * Set the enabled status for the focus highlight in a window
790 * This function will enable or disable the focus highlight only for the
791 * given window, regardless of the global setting for it
793 * @param obj The window where to enable the highlight
794 * @param enabled The enabled value for the highlight
796 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled);
799 * Get the enabled value of the focus highlight for this window
801 * @param obj The window in which to check if the focus highlight is enabled
803 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
805 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj);
808 * Set the style for the focus highlight on this window
810 * Sets the style to use for theming the highlight of focused objects on
811 * the given window. If @p style is NULL, the default will be used.
813 * @param obj The window where to set the style
814 * @param style The style to set
816 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style);
819 * Get the style set for the focus highlight object
821 * Gets the style set for this windows highilght object, or NULL if none
824 * @param obj The window to retrieve the highlights style from
826 * @return The style set or NULL if none was. Default is used in that case.
828 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj);
829 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
830 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
832 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
833 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
834 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
835 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
836 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
837 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
838 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
840 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
841 * (blank mouse, private mouse obj, defaultmouse)
846 * Sets the keyboard mode of the window.
848 * @param obj The window object
849 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
851 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode);
854 * Gets the keyboard mode of the window.
856 * @param obj The window object
857 * @return The mode, one of #Elm_Win_Keyboard_Mode
859 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj);
862 * Sets whether the window is a keyboard.
864 * @param obj The window object
865 * @param is_keyboard If true, the window is a virtual keyboard
867 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard);
870 * Gets whether the window is a keyboard.
872 * @param obj The window object
873 * @return If the window is a virtual keyboard
875 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj);
878 * Get the screen position of a window.
880 * @param obj The window object
881 * @param x The int to store the x coordinate to
882 * @param y The int to store the y coordinate to
884 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y);
887 * Create a socket to provide the service for Plug widget
889 * @param obj The window object
890 * @param svcname The name of the service to be advertised. ensure that it is unique (when combined with @p svcnum) otherwise creation may fail.
891 * @param svcnum A number (any value, 0 beig the common default) to differentiate multiple instances of services with the same name.
892 * @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.
893 * @return If socket creation is successful
895 EAPI Eina_Bool elm_win_socket_listen(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys);
902 * @defgroup Inwin Inwin
904 * @image html img/widget/inwin/preview-00.png
905 * @image latex img/widget/inwin/preview-00.eps
906 * @image html img/widget/inwin/preview-01.png
907 * @image latex img/widget/inwin/preview-01.eps
908 * @image html img/widget/inwin/preview-02.png
909 * @image latex img/widget/inwin/preview-02.eps
911 * An inwin is a window inside a window that is useful for a quick popup.
914 * It works by creating an object that will occupy the entire window, so it
915 * must be created using an @ref Win "elm_win" as parent only. The inwin
916 * object can be hidden or restacked below every other object if it's
917 * needed to show what's behind it without destroying it. If this is done,
918 * the elm_win_inwin_activate() function can be used to bring it back to
919 * full visibility again.
921 * There are three styles available in the default theme. These are:
922 * @li default: The inwin is sized to take over most of the window it's
924 * @li minimal: The size of the inwin will be the minimum necessary to show
926 * @li minimal_vertical: Horizontally, the inwin takes as much space as
927 * possible, but it's sized vertically the most it needs to fit its\
930 * Some examples of Inwin can be found in the following:
931 * @li @ref inwin_example_01
937 * Adds an inwin to the current window
939 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
940 * Never call this function with anything other than the top-most window
941 * as its parameter, unless you are fond of undefined behavior.
943 * After creating the object, the widget will set itself as resize object
944 * for the window with elm_win_resize_object_add(), so when shown it will
945 * appear to cover almost the entire window (how much of it depends on its
946 * content and the style used). It must not be added into other container
947 * objects and it needs not be moved or resized manually.
949 * @param parent The parent object
950 * @return The new object or NULL if it cannot be created
952 // XXX: deprecate this
953 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *parent);
956 * Activates an inwin object, ensuring its visibility
958 * This function will make sure that the inwin @p obj is completely visible
959 * by calling evas_object_show() and evas_object_raise() on it, to bring it
960 * to the front. It also sets the keyboard focus to it, which will be passed
963 * The object's theme will also receive the signal "elm,action,show" with
966 * @param obj The inwin to activate
968 // XXX: deprecate this
969 EAPI void elm_win_inwin_activate(Evas_Object *obj);
972 * Set the content of an inwin object.
974 * Once the content object is set, a previously set one will be deleted.
975 * If you want to keep that old content object, use the
976 * elm_win_inwin_content_unset() function.
978 * @param obj The inwin object
979 * @param content The object to set as content
981 // XXX: deprecate this
982 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content);
985 * Get the content of an inwin object.
987 * Return the content object which is set for this widget.
989 * The returned object is valid as long as the inwin is still alive and no
990 * other content is set on it. Deleting the object will notify the inwin
991 * about it and this one will be left empty.
993 * If you need to remove an inwin's content to be reused somewhere else,
994 * see elm_win_inwin_content_unset().
996 * @param obj The inwin object
997 * @return The content that is being used
999 // XXX: deprecate this
1000 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj);
1003 * Unset the content of an inwin object.
1005 * Unparent and return the content object which was set for this widget.
1007 * @param obj The inwin object
1008 * @return The content that was being used
1010 // XXX: deprecate this
1011 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj);
1016 /* X specific calls - won't work on non-x engines (return 0) */
1019 * Get the Ecore_X_Window of an Evas_Object
1021 * @param obj The object
1023 * @return The Ecore_X_Window of @p obj
1027 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj);
1029 /* smart callbacks called:
1030 * "delete,request" - the user requested to delete the window
1031 * "focus,in" - window got focus
1032 * "focus,out" - window lost focus
1033 * "moved" - window that holds the canvas was moved