X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=src%2Flib%2Felm_win.h;h=0cf2810e7c9e80816a612ef0f1392270ddb34154;hb=410399e14d0af5480d3e1e5af0cf8773d20c077b;hp=36179a22bc39d557b7e0666caa5802a710919f0d;hpb=5b96d24ce4c8b276e2b820584c64da03e1aa6ac6;p=framework%2Fuifw%2Felementary.git diff --git a/src/lib/elm_win.h b/src/lib/elm_win.h index 36179a2..0cf2810 100644 --- a/src/lib/elm_win.h +++ b/src/lib/elm_win.h @@ -1,10 +1,11 @@ -/* 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 @@ -52,7 +53,7 @@ * 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: * @@ -69,6 +70,15 @@ * @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 * * Examples: * @li @ref win_example_01 @@ -99,7 +109,7 @@ typedef enum 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 @@ -133,15 +143,20 @@ typedef enum 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_UNKNOWN, /**< Unknown keyboard state */ @@ -152,7 +167,7 @@ typedef enum 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 */ @@ -163,6 +178,34 @@ typedef enum } 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 @@ -173,7 +216,7 @@ 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; /** @@ -184,11 +227,13 @@ typedef enum * @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); @@ -206,6 +251,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); @@ -235,6 +282,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); @@ -248,6 +297,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); @@ -256,6 +307,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); @@ -268,10 +321,90 @@ 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); /** + * 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 Evas_Object *elm_win_icon_object_get(const Evas_Object *obj); + +/** * Set the window's autodel state. * * When closing the window in any way outside of the program control, like @@ -288,6 +421,8 @@ EAPI const char *elm_win_title_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); @@ -298,6 +433,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); @@ -313,6 +450,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); @@ -326,6 +465,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); @@ -339,6 +480,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); @@ -346,10 +489,12 @@ 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); @@ -361,6 +506,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); @@ -369,6 +516,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); @@ -378,7 +527,7 @@ EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj); * 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. * @@ -386,6 +535,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); @@ -396,6 +547,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); @@ -413,38 +566,18 @@ 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() - */ -EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha); - -/** - * 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); - -/** - * 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); +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); @@ -463,6 +596,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); @@ -473,6 +608,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); @@ -481,6 +618,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); @@ -489,6 +628,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); @@ -497,6 +638,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); @@ -505,6 +648,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); @@ -513,6 +658,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); @@ -521,10 +668,113 @@ 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); /** + * Set the withdrawn state of a window. + * + * @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); + +/** + * 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 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. * * What this means exactly will depend on the underlying engine used. @@ -537,6 +787,8 @@ EAPI Eina_Bool elm_win_iconified_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); @@ -547,6 +799,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); @@ -563,6 +817,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); @@ -575,6 +831,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); @@ -586,6 +844,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); @@ -597,6 +857,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); @@ -607,6 +869,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); @@ -615,6 +879,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); @@ -623,6 +889,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); @@ -633,6 +901,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); @@ -641,6 +911,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); @@ -649,6 +921,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); @@ -657,6 +931,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); @@ -665,6 +941,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); @@ -673,6 +951,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); @@ -681,6 +961,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); @@ -689,6 +971,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); @@ -710,6 +994,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); @@ -726,6 +1012,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); @@ -740,6 +1028,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); @@ -747,6 +1037,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); @@ -756,6 +1048,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); @@ -765,6 +1059,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); @@ -775,6 +1071,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); @@ -786,6 +1084,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); @@ -795,6 +1095,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); @@ -806,40 +1108,32 @@ 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); /** * 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); - -/*... - * 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); @@ -848,6 +1142,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); @@ -856,6 +1152,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); @@ -864,24 +1162,94 @@ 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); /** + * 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); + +/** + * 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); + +/** + * 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); /** + * 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 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 @@ -930,8 +1298,9 @@ EAPI void elm_win_screen_position_get(const Evas_Object *obj, i * * @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); /** @@ -946,8 +1315,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); /** @@ -959,14 +1329,15 @@ 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); /** * 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 @@ -977,8 +1348,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); /** @@ -988,29 +1360,12 @@ 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); /** * @} */ -/* 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); -/* 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 - */