EAPI Evas_Object *elm_win_util_dialog_add(Evas_Object *parent, const char *name, const char *title);
/**
- * @brief Set the window's autodel state.
+ * @brief Sets the window's autodel state.
*
* When closing the window in any way outside of the program control, like
* pressing the X button in the titlebar or using a command from the Window
EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel);
/**
- * @brief Get the window's autodel state.
+ * @brief Gets the window's autodel state.
*
* @param[in] obj The object.
*
EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj);
/**
- * Set the floating mode of a window.
+ * @brief Sets the floating mode of a window.
*
* @param obj The window object
* @param floating If true, the window is floating mode
EAPI void elm_win_floating_mode_set(Evas_Object *obj, Eina_Bool floating);
/**
- * Get the floating mode of a window.
+ * @brief Gets the floating mode of a window.
*
* @param obj The window object
* @return If true, the window is floating mode
/* Wayland specific call - returns NULL on non-Wayland engines */
/**
- * Get the Ecore_Wl_Window of an Evas_Object
+ * @brief Gets the Ecore_Wl_Window of an Evas_Object
*
* Do not use this function if you'd like your application/library be portable.
* You have been warned.
/* Windows specific call - returns NULL on non-Windows engines */
/**
- * Get the Ecore_Win32_Window of an Evas_Object
+ * @brief Gets the Ecore_Win32_Window of an Evas_Object
*
* Do not use this function if you'd like your application/library be portable.
* You have been warned.
EAPI Ecore_Win32_Window *elm_win_win32_window_get(const Evas_Object *obj);
/**
- * Set the preferred rotation value.
+ * @brief Sets the preferred rotation value.
*
* This function is used to set the orientation of window @p obj to spicific angle fixed.
*
EAPI void elm_win_wm_rotation_preferred_rotation_set(Evas_Object *obj, int rotation);
/**
- * @brief Add @c subobj as a resize object of window @c obj.
+ * @brief Adds @c subobj as a resize object of window @c obj.
*
* Setting an object as a resize object of the window means that the @c subobj
* child's size and position will be controlled by the window directly. That
EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj);
/**
- * @brief Delete @c subobj as a resize object of window @c obj.
+ * @brief Deletes @c subobj as a resize object of window @c obj.
*
* This function removes the object @c subobj from the resize objects of the
* window @c obj. It will not delete the object itself, which will be left
*/
EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj);
-/** Get the Ecore_X_Window of an Evas_Object.
+/**
+ * @brief Gets the Ecore_X_Window of an Evas_Object.
*
* @ingroup Elm_Win
*/
EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj);
/**
- * @brief Get the Ecore_Win32_Window of an Evas_Object
+ * @brief Gets the Ecore_Win32_Window of an Evas_Object
*
* @return The Ecore_Win32_Window of @c obj.
*
EAPI Ecore_Win32_Window *elm_win_win32_window_get(const Evas_Object *obj);
/**
- * @brief Get the Ecore_Cocoa_Window of an Efl.Canvas.Object.
+ * @brief Gets the Ecore_Cocoa_Window of an Efl.Canvas.Object.
*
* @return The Ecore_Cocoa_Window of @c obj.
*
EAPI Ecore_Cocoa_Window *elm_win_cocoa_window_get(const Evas_Object *obj);
/**
- * @brief Get the trap data associated with a window.
+ * @brief Gets the trap data associated with a window.
*
* @return The trap data of the window.
*
EAPI void *elm_win_trap_data_get(const Evas_Object *obj);
/**
- * @brief Set the override state of a window.
+ * @brief Sets the override state of a window.
*
* A window with @c override set to true will not be managed by the Window
* Manager. This means that no decorations of any kind will be shown for it,
EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override);
/**
- * @brief Get the override state of a window.
+ * @brief Gets the override state of a window.
*
* @return If true, the window is overridden.
*
EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj);
/**
- * @brief Lower a window object.
+ * @brief Lowers a window object.
*
* Places the window pointed by @c obj at the bottom of the stack, so that no
* other window is covered by it.
EAPI void elm_win_lower(Evas_Object *obj);
/**
- * @brief Set a window to be an illume quickpanel window.
+ * @brief Sets a window to be an illume quickpanel window.
*
* By default window objects are not quickpanel windows.
*
EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel);
/**
- * @brief Get if this window is a quickpanel or not.
+ * @brief Gets if this window is a quickpanel or not.
*
* @return The quickpanel flag.
*
*/
EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj);
/**
- * @brief Set which zone this quickpanel should appear in.
+ * @brief Sets which zone this quickpanel should appear in.
*
* @param[in] zone The requested zone for this quickpanel.
*
EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone);
/**
- * @brief Get which zone this quickpanel should appear in.
+ * @brief Gets which zone this quickpanel should appear in.
*
* @return The requested zone for this quickpanel.
*
*/
EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj);
/**
- * @brief Set the major priority of a quickpanel window.
+ * @brief Sets the major priority of a quickpanel window.
*
* @param[in] priority The major priority for this quickpanel or -1.
*
EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority);
/**
- * @brief Get the major priority of a quickpanel window.
+ * @brief Gets the major priority of a quickpanel window.
*
* @return The major priority for this quickpanel or -1.
*
EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj);
/**
- * @brief Set the minor priority of a quickpanel window.
+ * @brief Sets the minor priority of a quickpanel window.
*
* @param[in] priority The minor priority for this quickpanel.
*
EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority);
/**
- * @brief Get the minor priority of a quickpanel window.
+ * @brief Gets the minor priority of a quickpanel window.
*
* @return The minor priority for this quickpanel.
*
EAPI void elm_win_indicator_mode_set(Evas_Object *obj, Elm_Win_Indicator_Mode mode);
/**
- * @brief Get the indicator mode of the window.
+ * @brief Gets the indicator mode of the window.
*
* @return The mode, one of #Elm_Win_Indicator_Mode.
*
EAPI void elm_win_indicator_opacity_set(Evas_Object *obj, Elm_Win_Indicator_Opacity_Mode mode);
/**
- * @brief Get the indicator opacity mode of the window.
+ * @brief Gets the indicator opacity mode of the window.
*
* @return The mode, one of #Elm_Win_Indicator_Opacity_Mode.
*
EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard);
/**
- * @brief Get whether the window is a keyboard
+ * @brief Gets whether the window is a keyboard
*
* @return The mode, If true, the window is a virtual keyboard..
*
EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj);
/**
- * @brief Set if this window is an illume conformant window.
+ * @brief Sets if this window is an illume conformant window.
*
* @param[in] conformant The conformant flag.
*
EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant);
/**
- * @brief Get if this window is an illume conformant window.
+ * @brief Gets if this window is an illume conformant window.
*
* @return The conformant flag.
*
EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj);
/**
- * @brief Set the manual rotation done mode.
+ * @brief Sets the manual rotation done mode.
*
* This function is used to set or reset the manual rotation done mode. the
* message of rotation done is sent to WM after rendering its canvas in
EAPI void elm_win_wm_rotation_manual_rotation_done_set(Evas_Object *obj, Eina_Bool set);
/**
- * @brief Get the state of manual rotation done mode.
+ * @brief Gets the state of manual rotation done mode.
*
* This function is used to get the state of manual rotation done mode.
*
EAPI void elm_win_wm_rotation_manual_rotation_done(Evas_Object *obj);
/**
- * @brief Set the rotation of the window.
+ * @brief Sets the rotation of the window.
*
* Most engines only work with multiples of 90.
*
EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation);
/**
- * @brief Get the rotation of the window.
+ * @brief Gets the rotation of the window.
*
* @return The rotation of the window, in degrees (0-360), counter-clockwise.
*
EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation);
/**
- * @brief Query whether window manager supports window rotation or not.
+ * @brief Queries whether window manager supports window rotation or not.
*
* The window manager rotation allows the WM to controls the rotation of
* application windows. It is designed to support synchronized rotation for the
EAPI Eina_Bool elm_win_wm_rotation_supported_get(const Evas_Object *obj);
/**
- * @brief Get the preferred rotation value.
+ * @brief Gets the preferred rotation value.
*
* This function is used to get the preferred rotation value.
*
/**
- * @brief Get the screen position of a window.
+ * @brief Gets the screen position of a window.
*
* @param[out] x The int to store the x coordinate to.
* @param[out] y The int to store the y coordinate to.
EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y);
/**
- * @brief Get screen geometry details for the screen that a window is on.
+ * @brief Gets screen geometry details for the screen that a window is on.
*
* @param[out] x Where to return the horizontal offset value. May be @c null.
* @param[out] y Where to return the vertical offset value. May be @c null.
EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h);
/**
- * @brief Get screen dpi for the screen that a window is on.
+ * @brief Gets screen dpi for the screen that a window is on.
*
* @param[out] xdpi Pointer to value to store return horizontal dpi. May be
* @c null.
EAPI void elm_win_screen_dpi_get(const Evas_Object *obj, int *xdpi, int *ydpi);
/**
- * @brief Set the icon name of the window.
+ * @brief Sets the icon name of the window.
*
* @param[in] icon_name The icon name to set.
*
EAPI void elm_win_icon_name_set(Evas_Object *obj, const char *icon_name);
/**
- * @brief Get the icon name of the window.
+ * @brief Gets the icon name of the window.
*
* The returned string is an internal one and should not be freed or modified.
* It will also be invalid if a new icon name is set or if the window is
EAPI const char *elm_win_icon_name_get(const Evas_Object *obj);
/**
- * @brief Set the withdrawn state of a window.
+ * @brief Sets the withdrawn state of a window.
*
* @param[in] withdrawn If true, the window is withdrawn.
*
EAPI void elm_win_withdrawn_set(Evas_Object *obj, Eina_Bool withdrawn);
/**
- * @brief Get the withdrawn state of a window.
+ * @brief Gets the withdrawn state of a window.
*
* @return If true, the window is withdrawn.
*
EAPI Eina_Bool elm_win_withdrawn_get(const Evas_Object *obj);
/**
- * @brief Set the urgent state of a window.
+ * @brief Sets the urgent state of a window.
*
* @param[in] urgent If true, the window is urgent.
*
EAPI void elm_win_urgent_set(Evas_Object *obj, Eina_Bool urgent);
/**
- * @brief Get the urgent state of a window.
+ * @brief Gets the urgent state of a window.
*
* @return If true, the window is urgent.
*
EAPI Eina_Bool elm_win_urgent_get(const Evas_Object *obj);
/**
- * @brief Set the demand_attention state of a window.
+ * @brief Sets the demand_attention state of a window.
*
* @param[in] demand_attention If true, the window is demand_attention.
*
EAPI void elm_win_demand_attention_set(Evas_Object *obj, Eina_Bool demand_attention);
/**
- * @brief Get the demand_attention state of a window.
+ * @brief Gets the demand_attention state of a window.
*
* @return If true, the window is demand_attention.
*
EAPI Eina_Bool elm_win_demand_attention_get(const Evas_Object *obj);
/**
- * @brief Set the modal state of a window.
+ * @brief Sets the modal state of a window.
*
* @param[in] modal If true, the window is modal.
*
EAPI void elm_win_modal_set(Evas_Object *obj, Eina_Bool modal);
/**
- * @brief Get the modal state of a window.
+ * @brief Gets the modal state of a window.
*
* @return If true, the window is modal.
*
EAPI Eina_Bool elm_win_modal_get(const Evas_Object *obj);
/**
- * @brief Set the shaped state of a window.
+ * @brief Sets the shaped state of a window.
*
* Shaped windows, when supported, will render the parts of the window that has
* no content, transparent.
EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped);
/**
- * @brief Get the shaped state of a window.
+ * @brief Gets the shaped state of a window.
*
* @return If @c true, the window is shaped.
*
EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj);
/**
- * @brief Set the title of the window.
+ * @brief Sets the title of the window.
*
* @param[in] title The title.
*
EAPI void elm_win_title_set(Evas_Object *obj, const char *title);
/**
- * @brief Get the title of the window.
+ * @brief Gets the title of the window.
*
* The returned string is an internal one and should not be freed or modified.
* It will also be invalid if a new title is set or if the window is destroyed.
EAPI const char *elm_win_title_get(const Evas_Object *obj);
/**
- * @brief Set the base window size used with stepping calculation
+ * @brief Sets the base window size used with stepping calculation
*
* Base size + stepping is what is calculated for window sizing restrictions.
*
EAPI void elm_win_size_base_set(Evas_Object *obj, int w, int h);
/**
- * @brief Get the base size of a window.
+ * @brief Gets the base size of a window.
*
* @param[out] w The base width.
* @param[out] h The base height.
EAPI void elm_win_size_base_get(const Evas_Object *obj, int *w, int *h);
/**
- * @brief Set the window stepping used with sizing calculation.
+ * @brief Sets the window stepping used with sizing calculation.
*
* Base size + stepping is what is calculated for window sizing restrictions.
*
EAPI void elm_win_size_step_set(Evas_Object *obj, int w, int h);
/**
- * @brief Get the stepping of a window.
+ * @brief Gets the stepping of a window.
*
* @param[out] w The stepping width (0 disables).
* @param[out] h The stepping height (0 disables).
EAPI void elm_win_size_step_get(const Evas_Object *obj, int *w, int *h);
/**
- * @brief Send a command to the windowing environment
+ * @brief Sends a command to the windowing environment
*
* This is intended to work in touchscreen or small screen device environments
* where there is a more simplistic window management policy in place. This
EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params);
/**
- * @brief Set the profile of a window.
+ * @brief Sets the profile of a window.
*
* @param[in] profile The string value of a window profile.
*
EAPI void elm_win_profile_set(Evas_Object *obj, const char *profile);
/**
- * @brief Get the profile of a window.
+ * @brief Gets the profile of a window.
*
* @return The string value of a window profile.
*
EAPI const char *elm_win_profile_get(const Evas_Object *obj);
/**
- * @brief Set the layer of the window.
+ * @brief Sets the layer of the window.
*
* What this means exactly will depend on the underlying engine used.
*
EAPI void elm_win_layer_set(Evas_Object *obj, int layer);
/**
- * @brief Get the layer of the window.
+ * @brief Gets the layer of the window.
*
* @return The layer of the window.
*
EAPI int elm_win_layer_get(const Evas_Object *obj);
/**
- * @brief Get the inlined image object handle
+ * @brief Gets the inlined image object handle
*
* When you create a window with elm_win_add() of type #ELM_WIN_INLINED_IMAGE,
* then the window is in fact an evas image object inlined in the parent
EAPI void elm_win_fake_canvas_set(Evas_Object *obj, Ecore_Evas *oee) EINA_DEPRECATED;
/**
- * Get the Ecore_Window of an Evas_Object
+ * @brief Gets the Ecore_Window of an Evas_Object
*
* When Elementary is using a Wayland engine, this function will return the surface id of the elm window's surface.
*
* @since 1.8
* @note Unless you are getting the window id for the purpose of communicating between client<->compositor over dbus,
* this is definitely not the function you are looking for.
+ *
+ * @if MOBILE @since_tizen 4.0
+ * @elseif WEARABLE @since_tizen 4.0
+ * @endif
*/
EAPI Ecore_Window elm_win_window_id_get(const Evas_Object *obj);
/**
* @internal
*
- * Sets the precreated object.
+ * @brief Sets the precreated object.
*
* @param obj The window object
*
/**
* @internal
*
- * Gets the precreated object.
+ * @brief Gets the precreated object.
*
* @return The precreated window object
*
//
/**
- * @brief Get the Main Menu of a window.
+ * @brief Gets the Main Menu of a window.
*
* @return The Main Menu of the window ($null on error).
*
EAPI void elm_win_keyboard_mode_set(Elm_Win *obj, Elm_Win_Keyboard_Mode mode);
/**
- * @brief Get the keyboard mode of the window.
+ * @brief Gets the keyboard mode of the window.
*
* @return The mode, one of #Elm_Win_Keyboard_Mode.
*
EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Elm_Win *obj);
/**
- * @brief Set the aspect ratio of a window.
+ * @brief Sets the aspect ratio of a window.
*
* @param[in] aspect If 0, the window has no aspect limits, otherwise it is
* width divided by height.
EAPI void elm_win_aspect_set(Elm_Win *obj, double aspect);
/**
- * @brief Get the aspect ratio of a window.
+ * @brief Gets the aspect ratio of a window.
*
* @return If 0, the window has no aspect limits, otherwise it is width divided
* by height.
EAPI double elm_win_aspect_get(const Elm_Win *obj);
/**
- * @brief Set keygrab value of the window
+ * @brief Sets keygrab value of the window
*
* This function grabs the @c key of window using @c grab_mode.
*
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);
/**
- * @brief Unset keygrab value of the window
+ * @brief Unsets keygrab value of the window
*
* This function unset keygrab value. Ungrab @c key of window.
*
EAPI Eina_Bool elm_win_keygrab_unset(Elm_Win *obj, const char *key, Evas_Modifier_Mask modifiers, Evas_Modifier_Mask not_modifiers);
/**
- * @brief Get the elm_win object from any child object
+ * @brief Gets the elm_win object from any child object
*
* @return The elm_win, or @c NULL on failure
* @since 1.20
EAPI Evas_Object *elm_win_get(Evas_Object *obj);
/**
- * @brief Create a socket to provide the service for Plug widget.
+ * @brief Creates a socket to provide the service for Plug widget.
*
* @param[in] svcname The name of the service to be advertised. Eensure that it
* is unique (when combined with @c svcnum) otherwise creation may fail.
EAPI Eina_Bool elm_win_socket_listen(Elm_Win *obj, const char *svcname, int svcnum, Eina_Bool svcsys);
/**
- * @brief Get whether a window has focus.
+ * @brief Gets whether a window has focus.
*
* @return @c true if window has focus, @c false otherwise
*
EAPI Eina_Bool elm_win_focus_get(const Elm_Win *obj);
/**
- * @brief Set the style for the focus highlight on this window.
+ * @brief Sets the style for the focus highlight on this window.
*
* Sets the style to use for theming the highlight of focused objects on the
* given window. If @c style is NULL, the default will be used.
EAPI void elm_win_focus_highlight_style_set(Elm_Win *obj, const char *style);
/**
- * @brief Get the style set for the focus highlight object.
+ * @brief Gets the style set for the focus highlight object.
*
* @return The style or @c null if none.
*
EAPI const char *elm_win_focus_highlight_style_get(const Elm_Win *obj);
/**
- * @brief Set the enabled status for the focus highlight in a window.
+ * @brief Sets the enabled status for the focus highlight in a window.
*
* This function will enable or disable the focus highlight only for the given
* window, regardless of the global setting for it.
EAPI void elm_win_focus_highlight_enabled_set(Elm_Win *obj, Eina_Bool enabled);
/**
- * @brief Get the enabled value of the focus highlight for this window.
+ * @brief Gets the enabled value of the focus highlight for this window.
*
* @return The enabled value for the highlight.
*
EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Elm_Win *obj);
/**
- * @brief Set the animate status for the focus highlight for this window.
+ * @brief Sets the animate status for the focus highlight for this window.
*
* This function will enable or disable the animation of focus highlight only
* for the given window, rof the global setting for it.
EAPI void elm_win_focus_highlight_animate_set(Elm_Win *obj, Eina_Bool animate);
/**
- * @brief Get the animate value of the focus highlight for this window.
+ * @brief Gets the animate value of the focus highlight for this window.
*
* @return The enabled value for the highlight animation.
*
EAPI Eina_Bool elm_win_focus_highlight_animate_get(const Elm_Win *obj);
/**
- * @brief Raise a window object.
+ * @brief Raises a window object.
*
* Places the window pointed by @c obj at the top of the stack, so that it's
* not covered by any other window.
EAPI void elm_win_raise(Elm_Win *obj);
/**
- * @brief Set the array of available profiles to a window.
+ * @brief Sets the array of available profiles to a window.
*
* @param[in] profiles The string array of available profiles.
* @param[in] count The number of members in profiles.
EAPI void elm_win_available_profiles_set(Elm_Win *obj, const char **profiles, unsigned int count);
/**
- * @brief Get the array of available profiles of a window.
+ * @brief Gets the array of available profiles of a window.
*
* @param[out] profiles The string array of available profiles.
* @param[out] count The number of members in profiles.
EAPI Eina_Bool elm_win_available_profiles_get(const Elm_Win *obj, char ***profiles, unsigned int *count);
/**
- * @brief Set the array of available window rotations.
+ * @brief Sets the array of available window rotations.
*
* This function is used to set the available rotations to give the hints to
* WM. WM will refer this hints and set the orientation window properly.
EAPI void elm_win_wm_rotation_available_rotations_set(Elm_Win *obj, const int *rotations, unsigned int count);
/**
- * @brief Get the array of available window rotations.
+ * @brief Gets the array of available window rotations.
*
* This function is used to get the available rotations.
*
projects / platform / upstream / efl.git / commitdiff