X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=src%2Flib%2Felm_win.h;h=248b14a11e3d589fcfa01e6def501ae12d94f675;hb=17fe5c2b8b49941dbfac16a44ed1d240e982fc6d;hp=5db7f9b1ae3de03a38a2ee1b15b058f75aa96919;hpb=6db40d638af652e326bdb31cccc4090d5481942f;p=framework%2Fuifw%2Felementary.git diff --git a/src/lib/elm_win.h b/src/lib/elm_win.h index 5db7f9b..248b14a 100644 --- a/src/lib/elm_win.h +++ b/src/lib/elm_win.h @@ -1,5 +1,6 @@ -/* 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 @@ -78,6 +79,7 @@ * @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 @@ -144,9 +146,9 @@ typedef enum 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, + 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 + rendered to an image buffer and can be shown other process's plug image object*/ } Elm_Win_Type; @@ -156,7 +158,6 @@ typedef enum * 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_UNKNOWN, /**< Unknown keyboard state */ @@ -180,7 +181,7 @@ typedef enum /** * 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 @@ -194,6 +195,18 @@ typedef enum } 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 @@ -220,6 +233,8 @@ typedef enum * 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); @@ -237,6 +252,8 @@ EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, El * @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); @@ -266,6 +283,8 @@ EAPI Evas_Object *elm_win_util_standard_add(const char *name, const cha * * @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); @@ -279,6 +298,8 @@ EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Obje * * @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); @@ -287,6 +308,8 @@ EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Obje * * @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); @@ -299,6 +322,8 @@ EAPI void elm_win_title_set(Evas_Object *obj, const char *title * * @param obj The window object * @return The title + * + * @ingroup Win */ EAPI const char *elm_win_title_get(const Evas_Object *obj); @@ -307,6 +332,8 @@ EAPI const char *elm_win_title_get(const Evas_Object *obj); * * @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); @@ -319,6 +346,8 @@ EAPI void elm_win_icon_name_set(Evas_Object *obj, const char *i * * @param obj The window object * @return The icon name + * + * @ingroup Win */ EAPI const char *elm_win_icon_name_get(const Evas_Object *obj); @@ -327,6 +356,8 @@ EAPI const char *elm_win_icon_name_get(const Evas_Object *obj); * * @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); @@ -339,21 +370,25 @@ EAPI void elm_win_role_set(Evas_Object *obj, const char *role); * * @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); @@ -365,6 +400,8 @@ EAPI void elm_win_icon_object_set(Evas_Object *obj, Evas_Object * * @param obj The window object * @return The icon object set + * + * @ingroup Win */ EAPI const Evas_Object *elm_win_icon_object_get(const Evas_Object *obj); @@ -385,6 +422,8 @@ EAPI const Evas_Object *elm_win_icon_object_get(const Evas_Object *obj); * @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); @@ -395,6 +434,8 @@ EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autod * @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); @@ -410,6 +451,8 @@ EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj); * active one after it. * * @param obj The window object + * + * @ingroup Win */ EAPI void elm_win_activate(Evas_Object *obj); @@ -423,6 +466,8 @@ EAPI void elm_win_activate(Evas_Object *obj); * request. * * @param obj The window object + * + * @ingroup Win */ EAPI void elm_win_lower(Evas_Object *obj); @@ -436,6 +481,8 @@ EAPI void elm_win_lower(Evas_Object *obj); * request. * * @param obj The window object + * + * @ingroup Win */ EAPI void elm_win_raise(Evas_Object *obj); @@ -447,6 +494,8 @@ EAPI void elm_win_raise(Evas_Object *obj); * @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); @@ -458,6 +507,8 @@ EAPI void elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bo * * @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); @@ -466,6 +517,8 @@ EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool bo * * @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); @@ -483,6 +536,8 @@ EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj); * @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); @@ -493,6 +548,8 @@ EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped * @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); @@ -510,6 +567,8 @@ EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj); * @param alpha If true, the window has an alpha channel * * @see elm_win_alpha_set() + * + * @ingroup Win */ EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha); @@ -518,6 +577,8 @@ EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha); * * @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); @@ -536,6 +597,8 @@ EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj); * * @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); @@ -546,6 +609,8 @@ EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool over * @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); @@ -554,6 +619,8 @@ EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj); * * @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); @@ -562,6 +629,8 @@ EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fu * * @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); @@ -570,6 +639,8 @@ EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj); * * @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); @@ -578,6 +649,8 @@ EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool max * * @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); @@ -586,6 +659,8 @@ EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj); * * @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); @@ -594,6 +669,8 @@ EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool ico * * @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); @@ -602,6 +679,8 @@ EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj); * * @param obj The window object * @param withdrawn If true, the window is withdrawn + * + * @ingroup Win */ EAPI void elm_win_withdrawn_set(Evas_Object *obj, Eina_Bool withdrawn); @@ -610,14 +689,43 @@ EAPI void elm_win_withdrawn_set(Evas_Object *obj, Eina_Bool wit * * @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); @@ -626,6 +734,8 @@ EAPI void elm_win_urgent_set(Evas_Object *obj, Eina_Bool urgent * * @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); @@ -634,6 +744,8 @@ EAPI Eina_Bool elm_win_urgent_get(const Evas_Object *obj); * * @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); @@ -642,6 +754,8 @@ EAPI void elm_win_demand_attention_set(Evas_Object *obj, Eina_B * * @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); @@ -650,6 +764,8 @@ EAPI Eina_Bool elm_win_demand_attention_get(const Evas_Object *obj); * * @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); @@ -658,6 +774,8 @@ EAPI void elm_win_modal_set(Evas_Object *obj, Eina_Bool modal); * * @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); @@ -667,6 +785,8 @@ EAPI Eina_Bool elm_win_modal_get(const Evas_Object *obj); * @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); @@ -675,6 +795,8 @@ EAPI void elm_win_aspect_set(Evas_Object *obj, double aspect); * * @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); @@ -691,6 +813,8 @@ EAPI double elm_win_aspect_get(const Evas_Object *obj); * * @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); @@ -701,6 +825,8 @@ EAPI void elm_win_layer_set(Evas_Object *obj, int layer); * @return The layer of the window * * @see elm_win_layer_set() + * + * @ingroup Win */ EAPI int elm_win_layer_get(const Evas_Object *obj); @@ -717,6 +843,8 @@ EAPI int elm_win_layer_get(const Evas_Object *obj); * @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); @@ -729,6 +857,8 @@ EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation); * @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); @@ -740,6 +870,8 @@ EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, in * * @see elm_win_rotation_set() * @see elm_win_rotation_with_resize_set() + * + * @ingroup Win */ EAPI int elm_win_rotation_get(const Evas_Object *obj); @@ -751,6 +883,8 @@ EAPI int elm_win_rotation_get(const Evas_Object *obj); * * @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); @@ -761,6 +895,8 @@ EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky * @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); @@ -769,6 +905,8 @@ EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj); * * @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); @@ -777,6 +915,8 @@ EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool co * * @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); @@ -787,6 +927,8 @@ EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj); * * @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); @@ -795,6 +937,8 @@ EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool qu * * @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); @@ -803,6 +947,8 @@ EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj); * * @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); @@ -811,6 +957,8 @@ EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *ob * * @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); @@ -819,6 +967,8 @@ EAPI int elm_win_quickpanel_priority_major_get(const Evas_Obje * * @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); @@ -827,6 +977,8 @@ EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *ob * * @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); @@ -835,6 +987,8 @@ EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Obje * * @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); @@ -843,6 +997,8 @@ EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zon * * @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); @@ -864,6 +1020,8 @@ EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj); * * @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); @@ -880,6 +1038,8 @@ EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bo * @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); @@ -894,6 +1054,8 @@ EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Ill * * @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); @@ -901,6 +1063,8 @@ 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); @@ -910,6 +1074,8 @@ EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj); * 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); @@ -919,6 +1085,8 @@ EAPI void elm_win_screen_constrain_set(Evas_Object *obj, Eina_B * 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); @@ -929,6 +1097,8 @@ EAPI Eina_Bool elm_win_screen_constrain_get(Evas_Object *obj); * @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); @@ -940,6 +1110,8 @@ EAPI void elm_win_screen_size_get(const Evas_Object *obj, int * * * @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); @@ -949,6 +1121,8 @@ EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, * @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); @@ -960,6 +1134,8 @@ EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object * * @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); @@ -972,6 +1148,8 @@ EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, c * @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. + * + * @ingroup Win */ EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj); @@ -980,6 +1158,8 @@ EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object * * * @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); @@ -988,6 +1168,8 @@ EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_K * * @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); @@ -996,6 +1178,8 @@ EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj); * * @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); @@ -1004,6 +1188,8 @@ EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool * * @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); @@ -1012,23 +1198,55 @@ EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj); * * @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 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); @@ -1040,15 +1258,30 @@ EAPI void elm_win_screen_position_get(const Evas_Object *obj, i * @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 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 @@ -1097,8 +1330,9 @@ EAPI Eina_Bool elm_win_socket_listen(Evas_Object *obj, const char *s * * @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); /** @@ -1113,8 +1347,9 @@ EAPI Evas_Object *elm_win_inwin_add(Evas_Object *parent); * source "elm". * * @param obj The inwin to activate + * + * @ingroup Inwin */ -// XXX: deprecate this EAPI void elm_win_inwin_activate(Evas_Object *obj); /** @@ -1126,8 +1361,9 @@ EAPI void elm_win_inwin_activate(Evas_Object *obj); * * @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); /** @@ -1144,8 +1380,9 @@ EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *conte * * @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); /** @@ -1155,29 +1392,33 @@ EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj); * * @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); /** - * @} + * 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 - * - * @param obj The object + * Get the floating mode of a window. * - * @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); +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 +/** + * @} */ +