-/* win */
-/** @defgroup Win Win
+/**
+ * @defgroup Win Win
+ * @ingroup Elementary
*
* @image html img/widget/win/preview-00.png
* @image latex img/widget/win/preview-00.eps
*
- * The window class of Elementary. Contains functions to manipulate
+ * The window class of Elementary. Contains functions to manipulate
* windows. The Evas engine used to render the window contents is specified
* in the system or user elementary config files (whichever is found last),
* and can be overridden with the ELM_ENGINE environment variable for
* window is shown before doing the virtual "in memory" rendering and then
* save the output to the file specified by the file option (and then exit).
* If no delay is given, the default is 0.5 seconds. If no file is given the
- * default output file is "out.png". Repeat option is for continous
+ * default output file is "out.png". Repeat option is for continuous
* capturing screenshots. Repeat range is from 1 to 999 and filename is
* fixed to "out001.png" Some examples of using the shot engine:
*
* @li "focus,in": window got focus
* @li "focus,out": window lost focus
* @li "moved": window that holds the canvas was moved
+ * @li "withdrawn": window is still managed normally but removed from view
+ * @li "iconified": window is minimized (perhaps into an icon or taskbar)
+ * @li "normal": window is in a normal state (not withdrawn or iconified)
+ * @li "stick": window has become sticky (shows on all desktops)
+ * @li "unstick": window has stopped being sticky
+ * @li "fullscreen": window has become fullscreen
+ * @li "unfullscreen": window has stopped being fullscreen
+ * @li "maximized": window has been maximized
+ * @li "unmaximized": window has stopped being maximized
+ * @li "profile,changed": window's profile has been changed
*
* Examples:
* @li @ref win_example_01
*
* Currently, only the X11 backed engines use them.
*/
-typedef enum _Elm_Win_Type
+typedef enum
{
ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
window. Almost every window will be created with this
similar. */
ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
- pallete. */
+ palette. */
ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
entry in a menubar is clicked. Typically used
of window that requires the @c parent
parameter of elm_win_add() to be a valid @c
Evas_Object. */
+ ELM_WIN_SOCKET_IMAGE,/**< The window is rendered onto an image buffer
+ and can be shown other process's plug image object.
+ No actual window is created for this type,
+ instead the window and all of its contents will be
+ rendered to an image buffer and can be shown
+ other process's plug image object*/
} Elm_Win_Type;
/**
- * The differents layouts that can be requested for the virtual keyboard.
+ * The different layouts that can be requested for the virtual keyboard.
*
* When the application window is being managed by Illume, it may request
* any of the following layouts for the virtual keyboard.
*/
-// XXX: remove this as it conflicts with input panel
-typedef enum _Elm_Win_Keyboard_Mode
+typedef enum
{
ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
- ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
+ ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QWERTY) keyboard layout */
ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
} Elm_Win_Keyboard_Mode;
/**
+ * In some environments, like phones, you may have an indicator that
+ * shows battery status, reception, time etc. This is the indicator.
+ *
+ * Sometimes you don't want it because you provide the same functionality
+ * inside your app, so this will request that the indicator is hidden in
+ * this circumstance if you use ELM_ILLUME_INDICATOR_HIDE. The default
+ * is to have the indicator shown.
+ */
+typedef enum
+{
+ ELM_WIN_INDICATOR_UNKNOWN, /**< Unknown indicator state */
+ ELM_WIN_INDICATOR_HIDE, /**< Hides the indicator */
+ ELM_WIN_INDICATOR_SHOW /**< Shows the indicator */
+} Elm_Win_Indicator_Mode;
+
+/**
+ * Defines the opacity modes of indicator that can be shown
+ */
+
+typedef enum
+{
+ ELM_WIN_INDICATOR_OPACITY_UNKNOWN, /**< Unknown indicator opacity mode */
+ ELM_WIN_INDICATOR_OPAQUE, /**< Opacifies the indicator */
+ ELM_WIN_INDICATOR_TRANSLUCENT, /**< Be translucent the indicator */
+ ELM_WIN_INDICATOR_TRANSPARENT /**< Transparentizes the indicator */
+} Elm_Win_Indicator_Opacity_Mode;
+
+/**
* Available commands that can be sent to the Illume manager.
*
* When running under an Illume session, a window may send commands to the
* Illume manager to perform different actions.
*/
-typedef enum _Elm_Illume_Command
+typedef enum
{
ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous window */
ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window in the list */
ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home screen */
- ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
+ ELM_ILLUME_COMMAND_CLOSE, /**< Closes the currently active window */
} Elm_Illume_Command;
/**
* @param name The name of the window
* @param type The window type, one of #Elm_Win_Type.
*
- * The @p parent paramter can be @c NULL for every window @p type except
+ * The @p parent parameter can be @c NULL for every window @p type except
* #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
* which the image object will be created.
*
* @return The created object, or NULL on failure
+ *
+ * @ingroup Win
*/
EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
* @return The created object, or NULL on failure
*
* @see elm_win_add()
+ *
+ * @ingroup Win
*/
EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
*
* @param obj The window object
* @param subobj The resize object to add
+ *
+ * @ingroup Win
*/
-EAPI void
- elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj)
-EINA_ARG_NONNULL(1);
+EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj);
/**
* Delete @p subobj as a resize object of window @p obj.
*
* @param obj The window object
* @param subobj The resize object to add
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
+EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj);
/**
* Set the title of the window
*
* @param obj The window object
* @param title The title to set
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
+EAPI void elm_win_title_set(Evas_Object *obj, const char *title);
/**
* Get the title of the window
*
* @param obj The window object
* @return The title
+ *
+ * @ingroup Win
+ */
+EAPI const char *elm_win_title_get(const Evas_Object *obj);
+
+/**
+ * Set the icon name of the window
+ *
+ * @param obj The window object
+ * @param icon_name The icon name to set
+ *
+ * @ingroup Win
+ */
+EAPI void elm_win_icon_name_set(Evas_Object *obj, const char *icon_name);
+
+/**
+ * Get the icon name of the window
+ *
+ * The returned string is an internal one and should not be freed or
+ * modified. It will also be rendered invalid if a new icon name is set or if
+ * the window is destroyed.
+ *
+ * @param obj The window object
+ * @return The icon name
+ *
+ * @ingroup Win
+ */
+EAPI const char *elm_win_icon_name_get(const Evas_Object *obj);
+
+/**
+ * Set the role of the window
+ *
+ * @param obj The window object
+ * @param role The role to set
+ *
+ * @ingroup Win
+ */
+EAPI void elm_win_role_set(Evas_Object *obj, const char *role);
+
+/**
+ * Get the role of the window
+ *
+ * The returned string is an internal one and should not be freed or
+ * modified. It will also be rendered invalid if a new role is set or if
+ * the window is destroyed.
+ *
+ * @param obj The window object
+ * @return The role
+ *
+ * @ingroup Win
+ */
+EAPI const char *elm_win_role_get(const Evas_Object *obj);
+
+/**
+ * Set the object to represent the window icon
+ *
+ * This sets an object that will be used as the icon for the window. The exact
+ * pixel dimensions of the object (not object size) will be used, and the
+ * image pixels will be used as-is when this function is called. If the
+ * image object has been updated, then call this function again to source
+ * the image pixels and put them on the window's icon. This has limitations
+ * as only image objects allowed at this stage. This may be lifted in future.
+ *
+ * @param obj The window object
+ * @param icon The object to use for an icon
+ *
+ * @ingroup Win
+ */
+EAPI void elm_win_icon_object_set(Evas_Object *obj, Evas_Object *icon);
+
+/**
+ * Get the icon object used for the window
+ *
+ * The object returns is the one marked by elm_win_icon_object_set() as the
+ * object to use for the window icon.
+ *
+ * @param obj The window object
+ * @return The icon object set
+ *
+ * @ingroup Win
*/
-EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI const Evas_Object *elm_win_icon_object_get(const Evas_Object *obj);
/**
* Set the window's autodel state.
* @param obj The window object
* @param autodel If true, the window will automatically delete itself when
* closed
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
+EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel);
/**
* Get the window's autodel state.
* @return If the window will automatically delete itself when closed
*
* @see elm_win_autodel_set()
+ *
+ * @ingroup Win
*/
-EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj);
/**
* Activate a window object.
* active one after it.
*
* @param obj The window object
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_win_activate(Evas_Object *obj);
/**
* Lower a window object.
* request.
*
* @param obj The window object
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_win_lower(Evas_Object *obj);
/**
* Raise a window object.
* request.
*
* @param obj The window object
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_win_raise(Evas_Object *obj);
/**
* Center a window on its screen
*
* This function centers window @p obj horizontally and/or vertically based on the values
- * of @p h and @v.
+ * of @p h and @p v.
* @param obj The window object
* @param h If true, center horizontally. If false, do not change horizontal location.
* @param v If true, center vertically. If false, do not change vertical location.
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v) EINA_ARG_NONNULL(1);
+EAPI void elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v);
/**
* Set the borderless state of a window.
*
* @param obj The window object
* @param borderless If true, the window is borderless
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
+EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless);
/**
* Get the borderless state of a window.
*
* @param obj The window object
* @return If true, the window is borderless
+ *
+ * @ingroup Win
*/
-EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj);
/**
* Set the shaped state of a window.
* Shaped windows, when supported, will render the parts of the window that
* has no content, transparent.
*
- * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
+ * If @p shaped is EINA_FALSE, then it is strongly advised to have some
* background object or cover the entire window in any other way, or the
* parts of the canvas that have no data will show framebuffer artifacts.
*
* @param shaped If true, the window is shaped
*
* @see elm_win_alpha_set()
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
+EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped);
/**
* Get the shaped state of a window.
* @return If true, the window is shaped
*
* @see elm_win_shaped_set()
+ *
+ * @ingroup Win
*/
-EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj);
/**
* Set the alpha channel state of a window.
* @param alpha If true, the window has an alpha channel
*
* @see elm_win_alpha_set()
- */
-EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
-
-/**
- * Get the transparency state of a window.
- *
- * @param obj The window object
- * @return If true, the window is transparent
- *
- * @see elm_win_transparent_set()
- */
-// XXX: deprecate this
-EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
-/**
- * Set the transparency state of a window.
- *
- * Use elm_win_alpha_set() instead.
- *
- * @param obj The window object
- * @param transparent If true, the window is transparent
*
- * @see elm_win_alpha_set()
+ * @ingroup Win
*/
-// XXX: deprecate this
-EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
+EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha);
/**
* Get the alpha channel state of a window.
*
* @param obj The window object
* @return If true, the window has an alpha channel
+ *
+ * @ingroup Win
*/
-EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj);
/**
* Set the override state of a window.
*
* @param obj The window object
* @param override If true, the window is overridden
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
+EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override);
/**
* Get the override state of a window.
* @return If true, the window is overridden
*
* @see elm_win_override_set()
+ *
+ * @ingroup Win
*/
-EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj);
/**
* Set the fullscreen state of a window.
*
* @param obj The window object
* @param fullscreen If true, the window is fullscreen
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
+EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen);
/**
* Get the fullscreen state of a window.
*
* @param obj The window object
* @return If true, the window is fullscreen
+ *
+ * @ingroup Win
*/
-EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj);
/**
* Set the maximized state of a window.
*
* @param obj The window object
* @param maximized If true, the window is maximized
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
+EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized);
/**
* Get the maximized state of a window.
*
* @param obj The window object
* @return If true, the window is maximized
+ *
+ * @ingroup Win
*/
-EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj);
/**
* Set the iconified state of a window.
*
* @param obj The window object
* @param iconified If true, the window is iconified
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
+EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified);
/**
* Get the iconified state of a window.
*
* @param obj The window object
* @return If true, the window is iconified
+ *
+ * @ingroup Win
+ */
+EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj);
+
+/**
+ * Set the withdrawn state of a window.
+ *
+ * @param obj The window object
+ * @param withdrawn If true, the window is withdrawn
+ *
+ * @ingroup Win
*/
-EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_win_withdrawn_set(Evas_Object *obj, Eina_Bool withdrawn);
+
+/**
+ * Get the withdrawn state of a window.
+ *
+ * @param obj The window object
+ * @return If true, the window is withdrawn
+ *
+ * @ingroup Win
+ */
+EAPI Eina_Bool elm_win_withdrawn_get(const Evas_Object *obj);
+
+/**
+ * Set the profile list of a window.
+ *
+ * @param obj The window object
+ * @param profiles The list of profile's name
+ * @param num_profiles The number of profile names
+ *
+ * @ingroup Win
+ */
+EAPI void elm_win_profiles_set(Evas_Object *obj, const char **profiles, unsigned int num_profiles);
+
+/**
+ * Get the profile of a window.
+ *
+ * The returned string is an internal one and should not be freed or
+ * modified. It will also be rendered invalid if a new role is set or if
+ * the window is destroyed.
+ *
+ * @param obj The window object
+ * @return The profile's name
+ *
+ * @ingroup Win
+ */
+EAPI const char *elm_win_profile_get(const Evas_Object *obj);
+
+/**
+ * Set the urgent state of a window.
+ *
+ * @param obj The window object
+ * @param urgent If true, the window is urgent
+ *
+ * @ingroup Win
+ */
+EAPI void elm_win_urgent_set(Evas_Object *obj, Eina_Bool urgent);
+
+/**
+ * Get the urgent state of a window.
+ *
+ * @param obj The window object
+ * @return If true, the window is urgent
+ *
+ * @ingroup Win
+ */
+EAPI Eina_Bool elm_win_urgent_get(const Evas_Object *obj);
+
+/**
+ * Set the demand_attention state of a window.
+ *
+ * @param obj The window object
+ * @param demand_attention If true, the window is demand_attention
+ *
+ * @ingroup Win
+ */
+EAPI void elm_win_demand_attention_set(Evas_Object *obj, Eina_Bool demand_attention);
+
+/**
+ * Get the demand_attention state of a window.
+ *
+ * @param obj The window object
+ * @return If true, the window is demand_attention
+ *
+ * @ingroup Win
+ */
+EAPI Eina_Bool elm_win_demand_attention_get(const Evas_Object *obj);
+
+/**
+ * Set the modal state of a window.
+ *
+ * @param obj The window object
+ * @param modal If true, the window is modal
+ *
+ * @ingroup Win
+ */
+EAPI void elm_win_modal_set(Evas_Object *obj, Eina_Bool modal);
+
+/**
+ * Get the modal state of a window.
+ *
+ * @param obj The window object
+ * @return If true, the window is modal
+ *
+ * @ingroup Win
+ */
+EAPI Eina_Bool elm_win_modal_get(const Evas_Object *obj);
+
+/**
+ * Set the aspect ratio of a window.
+ *
+ * @param obj The window object
+ * @param aspect If 0, the window has no aspect limits, otherwise it is
+ * width divided by height
+ *
+ * @ingroup Win
+ */
+EAPI void elm_win_aspect_set(Evas_Object *obj, double aspect);
+
+/**
+ * Get the aspect ratio of a window.
+ *
+ * @param obj The window object
+ * @return The aspect ratio set (0 by default)
+ *
+ * @ingroup Win
+ */
+EAPI double elm_win_aspect_get(const Evas_Object *obj);
/**
* Set the layer of the window.
*
* @param obj The window object
* @param layer The layer of the window
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
+EAPI void elm_win_layer_set(Evas_Object *obj, int layer);
/**
* Get the layer of the window.
* @return The layer of the window
*
* @see elm_win_layer_set()
+ *
+ * @ingroup Win
*/
-EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI int elm_win_layer_get(const Evas_Object *obj);
/**
* Set the rotation of the window.
* @param obj The window object
* @param rotation The rotation of the window, in degrees (0-360),
* counter-clockwise.
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
+EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation);
/**
* Rotates the window and resizes it.
* @param obj The window object
* @param rotation The rotation of the window in degrees (0-360),
* counter-clockwise.
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
+EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation);
/**
* Get the rotation of the window.
*
* @see elm_win_rotation_set()
* @see elm_win_rotation_with_resize_set()
+ *
+ * @ingroup Win
*/
-EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI int elm_win_rotation_get(const Evas_Object *obj);
/**
* Set the sticky state of the window.
*
* @param obj The window object
* @param sticky If true, the window's sticky state is enabled
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
+EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky);
/**
* Get the sticky state of the window.
* @return If true, the window's sticky state is enabled
*
* @see elm_win_sticky_set()
+ *
+ * @ingroup Win
*/
-EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj);
/**
* Set if this window is an illume conformant window
*
* @param obj The window object
* @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
+EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant);
/**
* Get if this window is an illume conformant window
*
* @param obj The window object
* @return A boolean if this window is illume conformant or not
+ *
+ * @ingroup Win
*/
-EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj);
/**
* Set a window to be an illume quickpanel window
*
* @param obj The window object
* @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
+EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel);
/**
* Get if this window is a quickpanel or not
*
* @param obj The window object
* @return A boolean if this window is a quickpanel or not
+ *
+ * @ingroup Win
*/
-EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj);
/**
* Set the major priority of a quickpanel window
*
* @param obj The window object
* @param priority The major priority for this quickpanel
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
+EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority);
/**
* Get the major priority of a quickpanel window
*
* @param obj The window object
* @return The major priority of this quickpanel
+ *
+ * @ingroup Win
*/
-EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj);
/**
* Set the minor priority of a quickpanel window
*
* @param obj The window object
* @param priority The minor priority for this quickpanel
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
+EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority);
/**
* Get the minor priority of a quickpanel window
*
* @param obj The window object
* @return The minor priority of this quickpanel
+ *
+ * @ingroup Win
*/
-EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj);
/**
* Set which zone this quickpanel should appear in
*
* @param obj The window object
* @param zone The requested zone for this quickpanel
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
+EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone);
/**
* Get which zone this quickpanel should appear in
*
* @param obj The window object
* @return The requested zone for this quickpanel
+ *
+ * @ingroup Win
*/
-EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj);
/**
* Set the window to be skipped by keyboard focus
*
* @param obj The window object
* @param skip The skip flag state (EINA_TRUE if it is to be skipped)
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
+EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip);
/**
* Send a command to the windowing environment
* @param obj The window object that lives in the environment to control
* @param command The command to send
* @param params Optional parameters for the command
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
+EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params);
/**
* Get the inlined image object handle
*
* @param obj The window object to get the inlined image from
* @return The inlined image object, or NULL if none exists
+ *
+ * @ingroup Win
*/
EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
* Determine whether a window has focus
* @param obj The window to query
* @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
+ *
+ * @ingroup Win
*/
-EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj);
/**
* Constrain the maximum width and height of a window to the width and height of its screen
* When @p constrain is true, @p obj will never resize larger than the screen.
* @param obj The window object
* @param constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain) EINA_ARG_NONNULL(1);
+EAPI void elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain);
/**
* Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen
* When this function returns true, @p obj will never resize larger than the screen.
* @param obj The window object
* @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
+ *
+ * @ingroup Win
*/
-EAPI Eina_Bool elm_win_screen_constrain_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_win_screen_constrain_get(Evas_Object *obj);
/**
* Get screen geometry details for the screen that a window is on
* @param y where to return the vertical offset value. May be NULL.
* @param w where to return the width value. May be NULL.
* @param h where to return the height value. May be NULL.
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
+EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h);
/**
* Set the enabled status for the focus highlight in a window
*
* @param obj The window where to enable the highlight
* @param enabled The enabled value for the highlight
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
+EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled);
/**
* Get the enabled value of the focus highlight for this window
* @param obj The window in which to check if the focus highlight is enabled
*
* @return EINA_TRUE if enabled, EINA_FALSE otherwise
+ *
+ * @ingroup Win
*/
-EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj);
/**
* Set the style for the focus highlight on this window
*
* @param obj The window where to set the style
* @param style The style to set
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
+EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style);
/**
* Get the style set for the focus highlight object
*
- * Gets the style set for this windows highilght object, or NULL if none
+ * Gets the style set for this windows highlight object, or NULL if none
* is set.
*
* @param obj The window to retrieve the highlights style from
*
* @return The style set or NULL if none was. Default is used in that case.
- */
-EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
-/*...
- * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
- * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
- * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
- * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
- * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
- * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
- * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
- *
- * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
- * (blank mouse, private mouse obj, defaultmouse)
*
+ * @ingroup Win
*/
+EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj);
/**
* Sets the keyboard mode of the window.
*
* @param obj The window object
* @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
+EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode);
/**
* Gets the keyboard mode of the window.
*
* @param obj The window object
* @return The mode, one of #Elm_Win_Keyboard_Mode
+ *
+ * @ingroup Win
*/
-EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj);
/**
* Sets whether the window is a keyboard.
*
* @param obj The window object
* @param is_keyboard If true, the window is a virtual keyboard
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
+EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard);
/**
* Gets whether the window is a keyboard.
*
* @param obj The window object
* @return If the window is a virtual keyboard
+ *
+ * @ingroup Win
+ */
+EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj);
+
+/**
+ * Sets the indicator mode of the window.
+ *
+ * @param obj The window object
+ * @param mode The mode to set, one of #Elm_Win_Indicator_Mode
+ *
+ * @ingroup Win
+ */
+EAPI void elm_win_indicator_mode_set(Evas_Object *obj, Elm_Win_Indicator_Mode mode);
+
+// WRAPPER: Temperary added.
+EAPI void elm_win_indicator_state_set(Evas_Object *obj, Elm_Win_Indicator_Mode mode);
+
+/**
+ * Gets the indicator mode of the window.
+ *
+ * @param obj The window object
+ * @return The mode, one of #Elm_Win_Indicator_Mode
+ *
+ * @ingroup Win
+ */
+EAPI Elm_Win_Indicator_Mode elm_win_indicator_mode_get(const Evas_Object *obj);
+
+// WRAPPER: Temperary added.
+EAPI Elm_Win_Indicator_Mode elm_win_indicator_state_get(const Evas_Object *obj);
+
+/**
+ * Sets the indicator opacity mode of the window.
+ *
+ * @param obj The window object
+ * @param mode The mode to set, one of #Elm_Win_Indicator_Opacity_Mode
+ *
+ * @ingroup Win
*/
-EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_win_indicator_opacity_set(Evas_Object *obj, Elm_Win_Indicator_Opacity_Mode mode);
+
+/**
+ * Gets the indicator opacity mode of the window.
+ *
+ * @param obj The window object
+ * @return The mode, one of #Elm_Win_Indicator_Opacity_Mode
+ *
+ * @ingroup Win
+ */
+EAPI Elm_Win_Indicator_Opacity_Mode elm_win_indicator_opacity_get(const Evas_Object *obj);
/**
* Get the screen position of a window.
* @param obj The window object
* @param x The int to store the x coordinate to
* @param y The int to store the y coordinate to
+ *
+ * @ingroup Win
+ */
+EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y);
+
+/**
+ * Create a socket to provide the service for Plug widget
+ *
+ * @param obj The window object
+ * @param svcname The name of the service to be advertised. ensure that it is unique (when combined with @p svcnum) otherwise creation may fail.
+ * @param svcnum A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.
+ * @param svcsys A boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user id that created the service.
+ * @return If socket creation is successful
+ *
+ * @ingroup Win
+ */
+EAPI Eina_Bool elm_win_socket_listen(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys);
+
+/* X specific calls - won't work on non-x engines (return 0) */
+/**
+ * Get the Ecore_X_Window of an Evas_Object
+ *
+ * @param obj The object
+ *
+ * @return The Ecore_X_Window of @p obj
+ *
+ * @ingroup Win
*/
-EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
+EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj);
/**
* @}
/**
* @defgroup Inwin Inwin
+ * @ingroup Win
*
* @image html img/widget/inwin/preview-00.png
* @image latex img/widget/inwin/preview-00.eps
*
* @param parent The parent object
* @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Inwin
*/
-// XXX: deprecate this
-EAPI Evas_Object *elm_win_inwin_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+EAPI Evas_Object *elm_win_inwin_add(Evas_Object *parent);
/**
* Activates an inwin object, ensuring its visibility
* source "elm".
*
* @param obj The inwin to activate
+ *
+ * @ingroup Inwin
*/
-// XXX: deprecate this
-EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_win_inwin_activate(Evas_Object *obj);
/**
* Set the content of an inwin object.
*
* @param obj The inwin object
* @param content The object to set as content
+ *
+ * @ingroup Inwin
*/
-// XXX: deprecate this
-EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
+EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content);
/**
* Get the content of an inwin object.
*
- * Return the content object which is set for this widget.
+ * Return the content object for this widget.
*
* The returned object is valid as long as the inwin is still alive and no
* other content is set on it. Deleting the object will notify the inwin
*
* @param obj The inwin object
* @return The content that is being used
+ *
+ * @ingroup Inwin
*/
-// XXX: deprecate this
-EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj);
/**
* Unset the content of an inwin object.
*
* @param obj The inwin object
* @return The content that was being used
+ *
+ * @ingroup Inwin
*/
-// XXX: deprecate this
-EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj);
/**
- * @}
+ * Set the floating mode of a window.
+ *
+ * @param obj The window object
+ * @param floating If true, the window is floating mode
+ *
+ * @ingroup Win
*/
-/* X specific calls - won't work on non-x engines (return 0) */
+EAPI void elm_win_floating_mode_set(Evas_Object *obj, Eina_Bool floating);
/**
- * Get the Ecore_X_Window of an Evas_Object
+ * Get the floating mode of a window.
*
- * @param obj The object
- *
- * @return The Ecore_X_Window of @p obj
+ * @param obj The window object
+ * @return If true, the window is floating mode
*
* @ingroup Win
*/
-EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_win_floating_mode_get(const Evas_Object *obj);
+
-/* smart callbacks called:
- * "delete,request" - the user requested to delete the window
- * "focus,in" - window got focus
- * "focus,out" - window lost focus
- * "moved" - window that holds the canvas was moved
+/**
+ * @}
*/
+
projects / framework / uifw / elementary.git / blobdiff