forked from enlightenment/efl
elm: Fixed some typos in the documentations.
- Put @c in front of constants on doxygen. - Used @p for the parameter. - Put comma(,) in appropriate places.
This commit is contained in:
parent
db892d4ba3
commit
cf3399ffd6
|
@ -86,8 +86,8 @@ EAPI void elm_hoversel_hover_end(Evas_Object *obj);
|
||||||
* @brief Returns whether the hoversel is expanded.
|
* @brief Returns whether the hoversel is expanded.
|
||||||
*
|
*
|
||||||
* @param obj The hoversel object
|
* @param obj The hoversel object
|
||||||
* @return This will return EINA_TRUE if the hoversel is expanded or
|
* @return This will return @c EINA_TRUE if the hoversel is expanded or
|
||||||
* EINA_FALSE if it is not expanded.
|
* @c EINA_FALSE if it is not expanded.
|
||||||
*
|
*
|
||||||
* @ingroup Hoversel
|
* @ingroup Hoversel
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -6,8 +6,8 @@
|
||||||
* @param item_data data specific to this item.
|
* @param item_data data specific to this item.
|
||||||
* @param data data specific to the multibuttonentry.
|
* @param data data specific to the multibuttonentry.
|
||||||
*
|
*
|
||||||
* @return EINA_TRUE
|
* @return @c EINA_TRUE
|
||||||
* EINA_FALSE otherwise.
|
* @c EINA_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* @ingroup Multibuttonentry
|
* @ingroup Multibuttonentry
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -25,7 +25,7 @@ EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object
|
||||||
* Otherwise, only single line of the entry will be displayed.
|
* Otherwise, only single line of the entry will be displayed.
|
||||||
*
|
*
|
||||||
* @param obj The multibuttonentry object
|
* @param obj The multibuttonentry object
|
||||||
* @return EINA_TRUE if the widget is in expanded state. EINA_FALSE if not.
|
* @return @c EINA_TRUE if the widget is in expanded state. @c EINA_FALSE if not.
|
||||||
*
|
*
|
||||||
* @ingroup Multibuttonentry
|
* @ingroup Multibuttonentry
|
||||||
*/
|
*/
|
||||||
|
@ -38,7 +38,7 @@ EAPI Eina_Bool elm_multibuttonentry_expanded_get(const Evas_Obj
|
||||||
*
|
*
|
||||||
* @param obj The multibuttonentry object
|
* @param obj The multibuttonentry object
|
||||||
* @param expanded the value of expanded state.
|
* @param expanded the value of expanded state.
|
||||||
* Set this to EINA_TRUE for expanded state.
|
* Set this to @c EINA_TRUE for expanded state.
|
||||||
* Set this to EINA_FALSE for single line state.
|
* Set this to EINA_FALSE for single line state.
|
||||||
*
|
*
|
||||||
* @ingroup Multibuttonentry
|
* @ingroup Multibuttonentry
|
||||||
|
@ -152,7 +152,7 @@ EAPI Elm_Object_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *
|
||||||
* Set the selected state of an item
|
* Set the selected state of an item
|
||||||
*
|
*
|
||||||
* @param it The item
|
* @param it The item
|
||||||
* @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
|
* @param selected if it's @c EINA_TRUE, select the item otherwise, unselect the item
|
||||||
*
|
*
|
||||||
* @ingroup Multibuttonentry
|
* @ingroup Multibuttonentry
|
||||||
*/
|
*/
|
||||||
|
@ -163,7 +163,7 @@ EAPI void elm_multibuttonentry_item_selected_set(Elm_Objec
|
||||||
* Get the selected state of an item
|
* Get the selected state of an item
|
||||||
*
|
*
|
||||||
* @param it The item
|
* @param it The item
|
||||||
* @return EINA_TRUE if the item is selected, EINA_FALSE otherwise.
|
* @return @c EINA_TRUE if the item is selected, @c EINA_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* @ingroup Multibuttonentry
|
* @ingroup Multibuttonentry
|
||||||
*/
|
*/
|
||||||
|
@ -270,7 +270,7 @@ elm_multibuttonentry_format_function_set(Evas_Object *obj,
|
||||||
* Sets if the multibuttonentry is to be editable or not.
|
* Sets if the multibuttonentry is to be editable or not.
|
||||||
*
|
*
|
||||||
* @param obj The multibuttonentry object
|
* @param obj The multibuttonentry object
|
||||||
* @param editable If EINA_TRUE, user can add/delete item in multibuttonentry, if not, the multibuttonentry is non-editable.
|
* @param editable If @c EINA_TRUE, user can add/delete item in multibuttonentry, if not, the multibuttonentry is non-editable.
|
||||||
*
|
*
|
||||||
* @ingroup Multibuttonentry
|
* @ingroup Multibuttonentry
|
||||||
*
|
*
|
||||||
|
@ -282,7 +282,7 @@ EAPI void elm_multibuttonentry_editable_set(Evas_Object *obj, Eina_Bool editable
|
||||||
* Get whether the multibuttonentry is editable or not.
|
* Get whether the multibuttonentry is editable or not.
|
||||||
*
|
*
|
||||||
* @param obj The multibuttonentry object
|
* @param obj The multibuttonentry object
|
||||||
* @return EINA_TRUE if the multibuttonentry is editable by the user. EINA_FALSE if not.
|
* @return @c EINA_TRUE if the multibuttonentry is editable by the user. @c EINA_FALSE if not.
|
||||||
*
|
*
|
||||||
* @ingroup Multibuttonentry
|
* @ingroup Multibuttonentry
|
||||||
*
|
*
|
||||||
|
|
|
@ -122,7 +122,7 @@ EAPI void elm_naviframe_item_simple_promote(Evas_Object *obj, Evas_O
|
||||||
* @brief preserve the content objects when items are popped.
|
* @brief preserve the content objects when items are popped.
|
||||||
*
|
*
|
||||||
* @param obj The naviframe object
|
* @param obj The naviframe object
|
||||||
* @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
|
* @param preserve Enable the preserve mode if @c EINA_TRUE, disable otherwise
|
||||||
*
|
*
|
||||||
* @see also elm_naviframe_content_preserve_on_pop_get()
|
* @see also elm_naviframe_content_preserve_on_pop_get()
|
||||||
*
|
*
|
||||||
|
@ -207,7 +207,7 @@ EAPI Eina_List *elm_naviframe_items_get(const Evas_Object *obj) EINA_MALLOC EINA
|
||||||
/**
|
/**
|
||||||
* @brief Set the event enabled when pushing/popping items
|
* @brief Set the event enabled when pushing/popping items
|
||||||
*
|
*
|
||||||
* If @c enabled is EINA_TRUE, the contents of the naviframe item will
|
* If @p enabled is @c EINA_TRUE, the contents of the naviframe item will
|
||||||
* receives events from mouse and keyboard during view changing such as
|
* receives events from mouse and keyboard during view changing such as
|
||||||
* item push/pop.
|
* item push/pop.
|
||||||
*
|
*
|
||||||
|
@ -229,7 +229,7 @@ EAPI void elm_naviframe_event_enabled_set(Evas_Object *obj, Eina_Boo
|
||||||
* @brief Get the value of event enabled status.
|
* @brief Get the value of event enabled status.
|
||||||
*
|
*
|
||||||
* @param obj The naviframe object
|
* @param obj The naviframe object
|
||||||
* @return EINA_TRUE, when event is enabled
|
* @return @c EINA_TRUE, when event is enabled
|
||||||
*
|
*
|
||||||
* @see elm_naviframe_event_enabled_set()
|
* @see elm_naviframe_event_enabled_set()
|
||||||
*
|
*
|
||||||
|
|
|
@ -94,7 +94,7 @@ EAPI double elm_popup_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
|
||||||
* @brief Sets whether events should be passed to by a click outside.
|
* @brief Sets whether events should be passed to by a click outside.
|
||||||
*
|
*
|
||||||
* @param obj The popup object
|
* @param obj The popup object
|
||||||
* @param allow EINA_TRUE Events are passed to lower objects, else not
|
* @param allow @c EINA_TRUE Events are passed to lower objects, else not
|
||||||
*
|
*
|
||||||
* Enabling allow event will remove the Blocked event area and events will
|
* Enabling allow event will remove the Blocked event area and events will
|
||||||
* pass to the lower layer objects otherwise they are blocked.
|
* pass to the lower layer objects otherwise they are blocked.
|
||||||
|
@ -109,7 +109,7 @@ EAPI void elm_popup_allow_events_set(Evas_Object *obj, Eina_Bool allow);
|
||||||
* @brief Returns value indicating whether allow event is enabled or not
|
* @brief Returns value indicating whether allow event is enabled or not
|
||||||
*
|
*
|
||||||
* @param obj The popup object
|
* @param obj The popup object
|
||||||
* @return EINA_FALSE if Blocked event area is present else EINA_TRUE
|
* @return @c EINA_FALSE if Blocked event area is present else @c EINA_TRUE
|
||||||
*
|
*
|
||||||
* @ingroup Popup
|
* @ingroup Popup
|
||||||
* @see elm_popup_allow_events_set()
|
* @see elm_popup_allow_events_set()
|
||||||
|
|
|
@ -102,7 +102,7 @@ typedef enum _Elm_Highlight_Direction Elm_Highlight_Direction;
|
||||||
*
|
*
|
||||||
* @param data user data
|
* @param data user data
|
||||||
* @param action_info information to classify the action
|
* @param action_info information to classify the action
|
||||||
* Returns EINA_TRUE on success, EINA FALSE otherwise
|
* Returns @c EINA_TRUE on success, @c EINA FALSE otherwise
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
typedef Eina_Bool (*Elm_Access_Action_Cb)(void *data, Evas_Object *obj, Elm_Access_Action_Info *action_info);
|
typedef Eina_Bool (*Elm_Access_Action_Cb)(void *data, Evas_Object *obj, Elm_Access_Action_Info *action_info);
|
||||||
|
|
|
@ -114,7 +114,7 @@ typedef Elm_App_Server_View *(*Elm_App_Server_Create_View_Cb)(Elm_App_Server *ap
|
||||||
* If view id is available and unique, return the full DBus object path of view
|
* If view id is available and unique, return the full DBus object path of view
|
||||||
*
|
*
|
||||||
* @param[in] id view identifier
|
* @param[in] id view identifier
|
||||||
* @param[out] ret EINA_TRUE if id is valid or EINA_FALSE if not
|
* @param[out] ret @c EINA_TRUE if id is valid or @c EINA_FALSE if not
|
||||||
*/
|
*/
|
||||||
#define elm_app_server_view_check(id, ret) ELM_APP_SERVER_ID(ELM_APP_SERVER_SUB_ID_VIEW_CHECK), EO_TYPECHECK(const char *, id), EO_TYPECHECK(Eina_Bool *, ret)
|
#define elm_app_server_view_check(id, ret) ELM_APP_SERVER_ID(ELM_APP_SERVER_SUB_ID_VIEW_CHECK), EO_TYPECHECK(const char *, id), EO_TYPECHECK(Eina_Bool *, ret)
|
||||||
|
|
||||||
|
|
|
@ -15,14 +15,14 @@ EAPI Evas_Object *elm_box_add(Evas_Object *parent);
|
||||||
*
|
*
|
||||||
* By default, box object arranges their contents vertically from top to
|
* By default, box object arranges their contents vertically from top to
|
||||||
* bottom.
|
* bottom.
|
||||||
* By calling this function with @p horizontal as EINA_TRUE, the box will
|
* By calling this function with @p horizontal as @c EINA_TRUE, the box will
|
||||||
* become horizontal, arranging contents from left to right.
|
* become horizontal, arranging contents from left to right.
|
||||||
*
|
*
|
||||||
* @note This flag is ignored if a custom layout function is set.
|
* @note This flag is ignored if a custom layout function is set.
|
||||||
*
|
*
|
||||||
* @param obj The box object
|
* @param obj The box object
|
||||||
* @param horizontal The horizontal flag (EINA_TRUE = horizontal,
|
* @param horizontal The horizontal flag (@c EINA_TRUE = horizontal,
|
||||||
* EINA_FALSE = vertical)
|
* @c EINA_FALSE = vertical)
|
||||||
*
|
*
|
||||||
* @ingroup Box
|
* @ingroup Box
|
||||||
*/
|
*/
|
||||||
|
@ -32,7 +32,7 @@ EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool hori
|
||||||
* Get the horizontal orientation
|
* Get the horizontal orientation
|
||||||
*
|
*
|
||||||
* @param obj The box object
|
* @param obj The box object
|
||||||
* @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
|
* @return @c EINA_TRUE if the box is set to horizontal mode, @c EINA_FALSE otherwise
|
||||||
*/
|
*/
|
||||||
EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj);
|
EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj);
|
||||||
|
|
||||||
|
@ -55,7 +55,7 @@ EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool hom
|
||||||
* Get whether the box is using homogeneous mode or not
|
* Get whether the box is using homogeneous mode or not
|
||||||
*
|
*
|
||||||
* @param obj The box object
|
* @param obj The box object
|
||||||
* @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
|
* @return @c EINA_TRUE if it's homogeneous, @c EINA_FALSE otherwise
|
||||||
*
|
*
|
||||||
* @ingroup Box
|
* @ingroup Box
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -31,7 +31,7 @@ EAPI void elm_button_autorepeat_set(Evas_Object *obj, Ei
|
||||||
* Get whether the autorepeat feature is enabled
|
* Get whether the autorepeat feature is enabled
|
||||||
*
|
*
|
||||||
* @param obj The button object
|
* @param obj The button object
|
||||||
* @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
|
* @return @c EINA_TRUE if autorepeat is on, @c EINA_FALSE otherwise
|
||||||
*
|
*
|
||||||
* @see elm_button_autorepeat_set()
|
* @see elm_button_autorepeat_set()
|
||||||
*
|
*
|
||||||
|
|
|
@ -2,10 +2,12 @@
|
||||||
* @defgroup CopyPaste CopyPaste
|
* @defgroup CopyPaste CopyPaste
|
||||||
* @ingroup Elementary
|
* @ingroup Elementary
|
||||||
*
|
*
|
||||||
|
* Copy and paste feature implementations.
|
||||||
|
*
|
||||||
* Implements the following functionality
|
* Implements the following functionality
|
||||||
* a. select, copy/cut and paste
|
* a. select, copy/cut and paste
|
||||||
* b. clipboard
|
* b. clipboard
|
||||||
* c. drag and drop
|
* c. drag and drop
|
||||||
* in order to share data across application windows.
|
* in order to share data across application windows.
|
||||||
*
|
*
|
||||||
* Contains functions to select text or a portion of data,
|
* Contains functions to select text or a portion of data,
|
||||||
|
@ -207,7 +209,7 @@ typedef void (*Elm_Drag_Start) (void *data, Evas_Object *obj);
|
||||||
* @param format Selection format
|
* @param format Selection format
|
||||||
* @param buf The data selected
|
* @param buf The data selected
|
||||||
* @param buflen The size of @p buf
|
* @param buflen The size of @p buf
|
||||||
* @return If EINA_TRUE, setting data was successful.
|
* @return If @c EINA_TRUE, setting data was successful.
|
||||||
*
|
*
|
||||||
* @ingroup CopyPaste
|
* @ingroup CopyPaste
|
||||||
*
|
*
|
||||||
|
@ -231,7 +233,7 @@ EAPI Eina_Bool elm_cnp_selection_set(Evas_Object *obj, Elm_Sel_Type selection,
|
||||||
* @param obj The source widget
|
* @param obj The source widget
|
||||||
* @param datacb The user data callback if the target widget isn't elm_entry
|
* @param datacb The user data callback if the target widget isn't elm_entry
|
||||||
* @param udata The user data pointer for @p datacb
|
* @param udata The user data pointer for @p datacb
|
||||||
* @return If EINA_TRUE, getting selection data was successful.
|
* @return If @c EINA_TRUE, getting selection data was successful.
|
||||||
*
|
*
|
||||||
* @ingroup CopyPaste
|
* @ingroup CopyPaste
|
||||||
*/
|
*/
|
||||||
|
@ -248,7 +250,7 @@ EAPI Eina_Bool elm_cnp_selection_get(Evas_Object *obj, Elm_Sel_Type selection,
|
||||||
*
|
*
|
||||||
* @param obj The source widget
|
* @param obj The source widget
|
||||||
* @param selection Selection type for copying and pasting
|
* @param selection Selection type for copying and pasting
|
||||||
* @return If EINA_TRUE, clearing data was successful.
|
* @return If @c EINA_TRUE, clearing data was successful.
|
||||||
*
|
*
|
||||||
* @ingroup CopyPaste
|
* @ingroup CopyPaste
|
||||||
*
|
*
|
||||||
|
@ -301,7 +303,7 @@ EAPI void elm_cnp_selection_loss_callback_set(Evas_Object *obj, Elm_Sel_Type sel
|
||||||
* @param posdata The application data to pass to posdata
|
* @param posdata The application data to pass to posdata
|
||||||
* @param dropcb The function to call when a drop has occurred
|
* @param dropcb The function to call when a drop has occurred
|
||||||
* @param dropdata The application data to pass to dropcb
|
* @param dropdata The application data to pass to dropcb
|
||||||
* @return Returns EINA_TRUE, if successful, or EINA_FALSE if not.
|
* @return Returns @c EINA_TRUE, if successful, or @c EINA_FALSE if not.
|
||||||
*
|
*
|
||||||
* @ingroup CopyPaste
|
* @ingroup CopyPaste
|
||||||
*
|
*
|
||||||
|
@ -326,7 +328,7 @@ EAPI Eina_Bool elm_drop_target_add(Evas_Object *obj, Elm_Sel_Format format,
|
||||||
* @param posdata The application data to pass to posdata
|
* @param posdata The application data to pass to posdata
|
||||||
* @param dropcb The function to call when a drop has occurred
|
* @param dropcb The function to call when a drop has occurred
|
||||||
* @param dropdata The application data to pass to dropcb
|
* @param dropdata The application data to pass to dropcb
|
||||||
* @return Returns EINA_TRUE, if successful, or EINA_FALSE if not.
|
* @return Returns @c EINA_TRUE, if successful, or @c EINA_FALSE if not.
|
||||||
*
|
*
|
||||||
* @ingroup CopyPaste
|
* @ingroup CopyPaste
|
||||||
*
|
*
|
||||||
|
@ -354,7 +356,7 @@ EAPI Eina_Bool elm_drop_target_del(Evas_Object *obj, Elm_Sel_Format format,
|
||||||
* @param acceptdata Application data passed to @p acceptcb
|
* @param acceptdata Application data passed to @p acceptcb
|
||||||
* @param dragdone Function to call when drag is done
|
* @param dragdone Function to call when drag is done
|
||||||
* @param donecbdata Application data to pass to @p dragdone
|
* @param donecbdata Application data to pass to @p dragdone
|
||||||
* @return Returns EINA_TRUE, if successful, or EINA_FALSE if not.
|
* @return Returns @c EINA_TRUE, if successful, or @c EINA_FALSE if not.
|
||||||
*
|
*
|
||||||
* @ingroup CopyPaste
|
* @ingroup CopyPaste
|
||||||
*
|
*
|
||||||
|
@ -374,7 +376,7 @@ EAPI Eina_Bool elm_drag_start(Evas_Object *obj, Elm_Sel_Format format,
|
||||||
* It can only be initiated from the source window.
|
* It can only be initiated from the source window.
|
||||||
*
|
*
|
||||||
* @param obj The source of the current drag.
|
* @param obj The source of the current drag.
|
||||||
* @return Returns EINA_TRUE, if successful, or EINA_FALSE if not.
|
* @return Returns @c EINA_TRUE, if successful, or @c EINA_FALSE if not.
|
||||||
*
|
*
|
||||||
* @ingroup CopyPaste
|
* @ingroup CopyPaste
|
||||||
*
|
*
|
||||||
|
@ -387,7 +389,7 @@ EAPI Eina_Bool elm_drag_cancel(Evas_Object *obj);
|
||||||
*
|
*
|
||||||
* @param obj The source of a drag if a drag is underway
|
* @param obj The source of a drag if a drag is underway
|
||||||
* @param action The drag action to be done
|
* @param action The drag action to be done
|
||||||
* @return Returns EINA_TRUE, if successful, or EINA_FALSE if not.
|
* @return Returns @c EINA_TRUE, if successful, or @c EINA_FALSE if not.
|
||||||
*
|
*
|
||||||
* @ingroup CopyPaste
|
* @ingroup CopyPaste
|
||||||
*
|
*
|
||||||
|
@ -463,7 +465,7 @@ struct _Elm_Drag_User_Info
|
||||||
*
|
*
|
||||||
* @param obj The container object
|
* @param obj The container object
|
||||||
* @param it The Elm_Object_Item pointer where drag-start
|
* @param it The Elm_Object_Item pointer where drag-start
|
||||||
* @return Returns EINA_TRUE, if successful, or EINA_FALSE if not.
|
* @return Returns @c EINA_TRUE, if successful, or @c EINA_FALSE if not.
|
||||||
*/
|
*/
|
||||||
typedef Eina_Bool (*Elm_Item_Container_Data_Get_Cb)(
|
typedef Eina_Bool (*Elm_Item_Container_Data_Get_Cb)(
|
||||||
Evas_Object *obj,
|
Evas_Object *obj,
|
||||||
|
@ -478,7 +480,7 @@ typedef Eina_Bool (*Elm_Item_Container_Data_Get_Cb)(
|
||||||
* @param tm_to_drag Time period to wait before start dragging.
|
* @param tm_to_drag Time period to wait before start dragging.
|
||||||
* @param itemgetcb Callback to get Evas_Object pointer for item at (x,y)
|
* @param itemgetcb Callback to get Evas_Object pointer for item at (x,y)
|
||||||
* @param data_get Callback to get drag info
|
* @param data_get Callback to get drag info
|
||||||
* @return Returns EINA_TRUE, if successful, or EINA_FALSE if not.
|
* @return Returns @c EINA_TRUE, if successful, or @c EINA_FALSE if not.
|
||||||
*
|
*
|
||||||
* @ingroup CopyPaste
|
* @ingroup CopyPaste
|
||||||
*
|
*
|
||||||
|
@ -490,7 +492,7 @@ EAPI Eina_Bool elm_drag_item_container_add(Evas_Object *obj, double tm_to_anim,
|
||||||
* @brief Deletes a item container from drag-source list
|
* @brief Deletes a item container from drag-source list
|
||||||
*
|
*
|
||||||
* @param obj The target object
|
* @param obj The target object
|
||||||
* @return Returns EINA_TRUE, if successful, or EINA_FALSE if not.
|
* @return Returns @c EINA_TRUE, if successful, or @c EINA_FALSE if not.
|
||||||
*
|
*
|
||||||
* @ingroup CopyPaste
|
* @ingroup CopyPaste
|
||||||
*
|
*
|
||||||
|
@ -512,7 +514,7 @@ EAPI Eina_Bool elm_drag_item_container_del(Evas_Object *obj);
|
||||||
* @param posdata The application data to pass to posdata
|
* @param posdata The application data to pass to posdata
|
||||||
* @param dropcb The function to call when a drop has occurred
|
* @param dropcb The function to call when a drop has occurred
|
||||||
* @param dropdata The application data to pass to dropcb
|
* @param dropdata The application data to pass to dropcb
|
||||||
* @return Returns EINA_TRUE, if successful, or EINA_FALSE if not.
|
* @return Returns @c EINA_TRUE, if successful, or @c EINA_FALSE if not.
|
||||||
*
|
*
|
||||||
* @ingroup CopyPaste
|
* @ingroup CopyPaste
|
||||||
*
|
*
|
||||||
|
@ -530,7 +532,7 @@ EAPI Eina_Bool elm_drop_item_container_add(Evas_Object *obj,
|
||||||
* @brief Removes a container from list of drop targets.
|
* @brief Removes a container from list of drop targets.
|
||||||
*
|
*
|
||||||
* @param obj The container object
|
* @param obj The container object
|
||||||
* @return Returns EINA_TRUE, if successful, or EINA_FALSE if not.
|
* @return Returns EINA_TRUE, if successful, or @c EINA_FALSE if not.
|
||||||
*
|
*
|
||||||
* @ingroup CopyPaste
|
* @ingroup CopyPaste
|
||||||
*
|
*
|
||||||
|
|
|
@ -614,7 +614,7 @@ EAPI double elm_config_tooltip_delay_get(void);
|
||||||
/**
|
/**
|
||||||
* Set the duration after which tooltip will be shown.
|
* Set the duration after which tooltip will be shown.
|
||||||
*
|
*
|
||||||
* @return EINA_TRUE if value is set.
|
* @return @c EINA_TRUE if value is set.
|
||||||
*/
|
*/
|
||||||
EAPI void elm_config_tooltip_delay_set(double delay);
|
EAPI void elm_config_tooltip_delay_set(double delay);
|
||||||
|
|
||||||
|
@ -693,7 +693,7 @@ EAPI Eina_Bool elm_config_password_show_last_get(void);
|
||||||
*
|
*
|
||||||
* This enables or disables show last setting of password mode.
|
* This enables or disables show last setting of password mode.
|
||||||
*
|
*
|
||||||
* @param password_show_last If EINA_TRUE enables "show last" in password mode.
|
* @param password_show_last If @c EINA_TRUE, enables "show last" in password mode.
|
||||||
* @see elm_config_password_show_last_timeout_set()
|
* @see elm_config_password_show_last_timeout_set()
|
||||||
* @ingroup Password_last_show
|
* @ingroup Password_last_show
|
||||||
*/
|
*/
|
||||||
|
@ -889,7 +889,7 @@ EAPI Eina_Bool elm_config_access_get(void);
|
||||||
/**
|
/**
|
||||||
* Set access mode
|
* Set access mode
|
||||||
*
|
*
|
||||||
* @param is_accesss If EINA_TRUE enables access mode
|
* @param is_accesss If @c EINA_TRUE, enables access mode
|
||||||
*
|
*
|
||||||
* @note Elementary objects may have information (e.g. label on the elm_button)
|
* @note Elementary objects may have information (e.g. label on the elm_button)
|
||||||
* to be read. This information is read by access module when an object
|
* to be read. This information is read by access module when an object
|
||||||
|
@ -919,7 +919,7 @@ EAPI Eina_Bool elm_config_selection_unfocused_clear_get(void);
|
||||||
/**
|
/**
|
||||||
* Set whether selection should be cleared when entry widget is unfocused.
|
* Set whether selection should be cleared when entry widget is unfocused.
|
||||||
*
|
*
|
||||||
* @param enabled If EINA_TRUE clear selection when unfocus,
|
* @param enabled If @c EINA_TRUE, clear selection when unfocus,
|
||||||
* otherwise does not clear selection when unfocus.
|
* otherwise does not clear selection when unfocus.
|
||||||
*
|
*
|
||||||
* @since 1.7
|
* @since 1.7
|
||||||
|
@ -1129,7 +1129,7 @@ EAPI Eina_Bool elm_config_focus_highlight_enabled_get(void);
|
||||||
/**
|
/**
|
||||||
* Set the enable status of the focus highlight
|
* Set the enable status of the focus highlight
|
||||||
*
|
*
|
||||||
* @param enable Enable highlight if EINA_TRUE, disable otherwise
|
* @param enable Enable highlight if @c EINA_TRUE, disable otherwise
|
||||||
*
|
*
|
||||||
* Set whether to show or not the highlight on focused objects
|
* Set whether to show or not the highlight on focused objects
|
||||||
*
|
*
|
||||||
|
@ -1157,7 +1157,7 @@ EAPI Eina_Bool elm_config_focus_highlight_animate_get(void);
|
||||||
/**
|
/**
|
||||||
* Set the enable status of the highlight animation
|
* Set the enable status of the highlight animation
|
||||||
*
|
*
|
||||||
* @param animate Enable animation if EINA_TRUE, disable otherwise
|
* @param animate Enable animation if @c EINA_TRUE, disable otherwise
|
||||||
*
|
*
|
||||||
* Set whether the focus highlight, if enabled, will animate its switch from
|
* Set whether the focus highlight, if enabled, will animate its switch from
|
||||||
* one object to the next
|
* one object to the next
|
||||||
|
@ -1175,7 +1175,7 @@ EAPI void elm_config_focus_highlight_animate_set(Eina_Bool anima
|
||||||
* Get the system mirrored mode. This determines the default mirrored mode
|
* Get the system mirrored mode. This determines the default mirrored mode
|
||||||
* of widgets.
|
* of widgets.
|
||||||
*
|
*
|
||||||
* @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
|
* @return @c EINA_TRUE if mirrored is set, @c EINA_FALSE otherwise
|
||||||
*/
|
*/
|
||||||
EAPI Eina_Bool elm_config_mirrored_get(void);
|
EAPI Eina_Bool elm_config_mirrored_get(void);
|
||||||
|
|
||||||
|
@ -1183,23 +1183,23 @@ EAPI Eina_Bool elm_config_mirrored_get(void);
|
||||||
* Set the system mirrored mode. This determines the default mirrored mode
|
* Set the system mirrored mode. This determines the default mirrored mode
|
||||||
* of widgets.
|
* of widgets.
|
||||||
*
|
*
|
||||||
* @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
|
* @param mirrored @c EINA_TRUE to set mirrored mode, @c EINA_FALSE to unset it.
|
||||||
*/
|
*/
|
||||||
EAPI void elm_config_mirrored_set(Eina_Bool mirrored);
|
EAPI void elm_config_mirrored_set(Eina_Bool mirrored);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the clouseau state. EINA_TRUE if clouseau was tried to be run.
|
* Get the clouseau state. @c EINA_TRUE if clouseau was tried to be run.
|
||||||
*
|
*
|
||||||
* @since 1.8
|
* @since 1.8
|
||||||
* @return EINA_TRUE if clouseau was tried to run, EINA_FALSE otherwise
|
* @return @c EINA_TRUE if clouseau was tried to run, @c EINA_FALSE otherwise
|
||||||
*/
|
*/
|
||||||
EAPI Eina_Bool elm_config_clouseau_enabled_get(void);
|
EAPI Eina_Bool elm_config_clouseau_enabled_get(void);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the clouseau state. EINA_TRUE if clouseau should be attempted to be run.
|
* Get the clouseau state. @c EINA_TRUE if clouseau should be attempted to be run.
|
||||||
*
|
*
|
||||||
* @since 1.8
|
* @since 1.8
|
||||||
* @param enabled EINA_TRUE to try and run clouseau, EINA_FALSE otherwise.
|
* @param enabled @c EINA_TRUE to try and run clouseau, @c EINA_FALSE otherwise.
|
||||||
*/
|
*/
|
||||||
EAPI void elm_config_clouseau_enabled_set(Eina_Bool enabled);
|
EAPI void elm_config_clouseau_enabled_set(Eina_Bool enabled);
|
||||||
|
|
||||||
|
|
|
@ -108,7 +108,7 @@ EAPI void elm_object_cursor_theme_search_enabled_set(Evas_Object *obj, Eina_Bool
|
||||||
* Get if the cursor set should be searched on the theme for this object cursor.
|
* Get if the cursor set should be searched on the theme for this object cursor.
|
||||||
*
|
*
|
||||||
* @param obj an object with cursor already set.
|
* @param obj an object with cursor already set.
|
||||||
* @return EINA_TRUE if the cursor set should be searched on widget's theme,
|
* @return @c EINA_TRUE if the cursor set should be searched on widget's theme,
|
||||||
* EINA_FALSE otherwise.
|
* EINA_FALSE otherwise.
|
||||||
*
|
*
|
||||||
* @ingroup Cursors
|
* @ingroup Cursors
|
||||||
|
|
|
@ -258,7 +258,7 @@ EAPI void elm_datetime_field_limit_set(Evas_Object *obj, Elm_Datetime_Field
|
||||||
*
|
*
|
||||||
* @param obj The datetime object.
|
* @param obj The datetime object.
|
||||||
* @param currtime Time structure.
|
* @param currtime Time structure.
|
||||||
* @return EINA_TRUE if current time is returned successfully.
|
* @return @c EINA_TRUE if current time is returned successfully.
|
||||||
*
|
*
|
||||||
* @see elm_datetime_value_set()
|
* @see elm_datetime_value_set()
|
||||||
* @ingroup Datetime
|
* @ingroup Datetime
|
||||||
|
@ -282,7 +282,7 @@ EAPI Eina_Bool elm_datetime_value_get(const Evas_Object *obj, struct tm *currtim
|
||||||
*
|
*
|
||||||
* @param obj The datetime object.
|
* @param obj The datetime object.
|
||||||
* @param newtime Time structure filled with values to be set.
|
* @param newtime Time structure filled with values to be set.
|
||||||
* @return EINA_TRUE if current time is set successfully.
|
* @return @c EINA_TRUE if current time is set successfully.
|
||||||
*
|
*
|
||||||
* @see elm_datetime_value_set()
|
* @see elm_datetime_value_set()
|
||||||
* @ingroup Datetime
|
* @ingroup Datetime
|
||||||
|
@ -305,7 +305,7 @@ EAPI Eina_Bool elm_datetime_value_set(Evas_Object *obj, const struct tm *newtime
|
||||||
*
|
*
|
||||||
* @param obj The datetime object
|
* @param obj The datetime object
|
||||||
* @param mintime Time structure.
|
* @param mintime Time structure.
|
||||||
* @return EINA_TRUE if minimum value is successfully returned.
|
* @return @c EINA_TRUE if minimum value is successfully returned.
|
||||||
*
|
*
|
||||||
* @see elm_datetime_value_min_set()
|
* @see elm_datetime_value_min_set()
|
||||||
* @ingroup Datepicker
|
* @ingroup Datepicker
|
||||||
|
@ -328,7 +328,7 @@ EAPI Eina_Bool elm_datetime_value_min_get(const Evas_Object *obj, struct tm *min
|
||||||
*
|
*
|
||||||
* @param obj The datetime object.
|
* @param obj The datetime object.
|
||||||
* @param mintime Time structure containing the minimum time value.
|
* @param mintime Time structure containing the minimum time value.
|
||||||
* @return EINA_TRUE if minimum value is accepted.
|
* @return @c EINA_TRUE if minimum value is accepted.
|
||||||
*
|
*
|
||||||
* @see elm_datetime_value_min_get()
|
* @see elm_datetime_value_min_get()
|
||||||
* @ingroup Datetime
|
* @ingroup Datetime
|
||||||
|
@ -351,7 +351,7 @@ EAPI Eina_Bool elm_datetime_value_min_set(Evas_Object *obj, const struct tm *min
|
||||||
*
|
*
|
||||||
* @param obj The datetime object
|
* @param obj The datetime object
|
||||||
* @param maxtime Time structure containing the maximum time value.
|
* @param maxtime Time structure containing the maximum time value.
|
||||||
* @return EINA_TRUE if maximum value is returned successfully.
|
* @return @c EINA_TRUE if maximum value is returned successfully.
|
||||||
*
|
*
|
||||||
* @see elm_datetime_value_max_set()
|
* @see elm_datetime_value_max_set()
|
||||||
* @ingroup Datetime
|
* @ingroup Datetime
|
||||||
|
@ -374,7 +374,7 @@ EAPI Eina_Bool elm_datetime_value_max_get(const Evas_Object *obj, struct tm *max
|
||||||
*
|
*
|
||||||
* @param obj The datetime object
|
* @param obj The datetime object
|
||||||
* @param maxtime Time structure containing the maximum time value.
|
* @param maxtime Time structure containing the maximum time value.
|
||||||
* @return EINA_TRUE if maximum value is accepted.
|
* @return @c EINA_TRUE if maximum value is accepted.
|
||||||
*
|
*
|
||||||
* @see elm_datetime_value_max_get()
|
* @see elm_datetime_value_max_get()
|
||||||
* @ingroup Datetime
|
* @ingroup Datetime
|
||||||
|
|
Loading…
Reference in New Issue