dimmus
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

elm: Clean-up and fix a lot of doxygen for elementary headers. 

- Keep consistency.
- Use addtogroup that works well and convenient.
- Make struct/enum/union look correctly on the doxygen.
This commit is contained in:
Daniel Juyung Seo 2014-11-22 00:39:43 +09:00
parent 2b40551740 78fea1b7f5
commit 1f550e0beb
31 changed files with 437 additions and 441 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
legacy/elementary/src/lib/elm_actionslider_common.h
View File

@ -1,7 +1,11 @@
/**
* @addtogroup Actionslider
*
* @{
*/
/**
* A position for indicators, magnets, and enabled items.
*
* @ingroup Actionslider
*/
typedef enum
{
@ -11,3 +15,7 @@ typedef enum
ELM_ACTIONSLIDER_RIGHT = 1 << 2, /**< right position */
ELM_ACTIONSLIDER_ALL = (1 << 3) - 1 /**< all positions for left/center/right */
} Elm_Actionslider_Pos;
/**
* @}
*/

13
legacy/elementary/src/lib/elm_app_common.h
View File

@ -1,3 +1,12 @@
/**
* @addtogroup App
*
* @{
*/
/**
* Elm_App_View_State
*/
typedef enum
{
ELM_APP_VIEW_STATE_UNKNOWN = 0,
@ -7,6 +16,10 @@ typedef enum
ELM_APP_VIEW_STATE_SHALLOW
} Elm_App_View_State;
/**
* @}
*/
char *_dbus_package_to_path(const char *package);
Elm_App_View_State _string_state_to_id(const char *state);

12
legacy/elementary/src/lib/elm_bg_common.h
View File

@ -1,11 +1,15 @@
/**
* @addtogroup Bg
*
* @{
*/
/**
* Identifiers on how a background widget is to display its image --
* if it was set to use an image file.
*
* @see elm_bg_option_set()
* @see elm_bg_option_get()
*
* @ingroup Bg
*/
typedef enum
{
@ -16,3 +20,7 @@ typedef enum
ELM_BG_OPTION_LAST /**< sentinel value, also used to indicate errors */
} Elm_Bg_Option;
/**
* @}
*/

16
legacy/elementary/src/lib/elm_box_common.h
View File

@ -1,3 +1,9 @@
/**
* @addtogroup Box
*
* @{
*/
/**
* @typedef Elm_Box_Transition
*
@ -41,8 +47,6 @@ typedef struct _Elm_Box_Transition Elm_Box_Transition;
* @see elm_box_transition_new
* @see elm_box_transition_free
* @see elm_box_layout_set
*
* @ingroup Box
*/
EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
@ -76,8 +80,6 @@ EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object
*
* @see elm_box_transition_new
* @see elm_box_layout_transition
*
* @ingroup Box
*/
EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Object_Box_Layout start_layout, void *start_layout_data, Ecore_Cb start_layout_free_data, Evas_Object_Box_Layout end_layout, void *end_layout_data, Ecore_Cb end_layout_free_data, Ecore_Cb transition_end_cb, void *transition_end_data);
@ -91,7 +93,9 @@ EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Obje
*
* @see elm_box_transition_new
* @see elm_box_layout_transition
*
* @ingroup Box
*/
EAPI void elm_box_transition_free(void *data);
/**
* @}
*/

9
legacy/elementary/src/lib/elm_bubble_common.h
View File

@ -1,3 +1,9 @@
/**
* @addtogroup Bubble
*
* @{
*/
/**
* Defines the corner values for a bubble.
*
@ -13,3 +19,6 @@ typedef enum
ELM_BUBBLE_POS_BOTTOM_RIGHT, /**< the arrow of the bubble points to the bottom right corner. */
} Elm_Bubble_Pos;
/**
* @}
*/

92
legacy/elementary/src/lib/elm_calendar_common.h
View File

@ -1,17 +1,10 @@
typedef enum
{
ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
ELM_CALENDAR_DAILY, /**< Marks will be displayed every day after event day (inclusive). */
ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
ELM_CALENDAR_MONTHLY, /**< Marks will be displayed every month day that coincides to event day. E.g.: if an event is set to 30th Jan, no marks will be displayed on Feb, but will be displayed on 30th Mar*/
ELM_CALENDAR_ANNUALLY, /**< Marks will be displayed every year that coincides to event day (and month). E.g. an event added to 30th Jan 2012 will be repeated on 30th Jan 2013. */
ELM_CALENDAR_LAST_DAY_OF_MONTH /**< Marks will be displayed every last day of month after event day (inclusive). @since 1.7 */
} _Elm_Calendar_Mark_Repeat_Type;
/**
* @enum _Elm_Calendar_Mark_Repeat_Type
* @typedef Elm_Calendar_Mark_Repeat_Type
* @addtogroup Calendar
*
* @{
*/
/**
* @enum Elm_Calendar_Mark_Repeat_Type
* Event periodicity, used to define if a mark should be repeated
* @b beyond event's day. It's set when a mark is added.
*
@ -22,11 +15,23 @@ typedef enum
* Values don't work as bitmask, only one can be chosen.
*
* @see elm_calendar_mark_add()
*
* @ingroup Calendar
*/
typedef _Elm_Calendar_Mark_Repeat_Type Elm_Calendar_Mark_Repeat_Type;
typedef enum
{
ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
ELM_CALENDAR_DAILY, /**< Marks will be displayed every day after event day (inclusive). */
ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
ELM_CALENDAR_MONTHLY, /**< Marks will be displayed every month day that coincides to event day. E.g.: if an event is set to 30th Jan, no marks will be displayed on Feb, but will be displayed on 30th Mar*/
ELM_CALENDAR_ANNUALLY, /**< Marks will be displayed every year that coincides to event day (and month). E.g. an event added to 30th Jan 2012 will be repeated on 30th Jan 2013. */
ELM_CALENDAR_LAST_DAY_OF_MONTH /**< Marks will be displayed every last day of month after event day (inclusive). @since 1.7 */
} Elm_Calendar_Mark_Repeat_Type;
/**
* @enum Elm_Calendar_Weekday
* A weekday
*
* @see elm_calendar_first_day_of_week_set()
*/
typedef enum
{
ELM_DAY_SUNDAY,
@ -37,68 +42,44 @@ typedef enum
ELM_DAY_FRIDAY,
ELM_DAY_SATURDAY,
ELM_DAY_LAST
} _Elm_Calendar_Weekday;
} Elm_Calendar_Weekday;
/**
* @enum _Elm_Calendar_Weekday
* @typedef Elm_Calendar_Weekday
* @enum Elm_Calendar_Select_Mode
*
* a weekday
* The mode, who determine how user could select a day
*
* @see elm_calendar_first_day_of_week_set()
*
* @ingroup Calendar
* @see elm_calendar_select_mode_set()
*/
typedef _Elm_Calendar_Weekday Elm_Calendar_Weekday;
typedef enum
{
ELM_CALENDAR_SELECT_MODE_DEFAULT = 0, /**< Default value. a day is always selected. */
ELM_CALENDAR_SELECT_MODE_ALWAYS, /**< a day is always selected. */
ELM_CALENDAR_SELECT_MODE_NONE, /**< None of the days can be selected. */
ELM_CALENDAR_SELECT_MODE_ONDEMAND /**< User may have selected a day or not. */
} _Elm_Calendar_Select_Mode;
} Elm_Calendar_Select_Mode;
/**
* @enum _Elm_Calendar_Select_Mode
* @typedef Elm_Calendar_Select_Mode
* @Elm_Calendar_Selectable
*
* the mode, who determine how user could select a day
* A bitmask used to define which fields of a @b tm struct will be taken into
* account, when elm_calendar_selected_time_set() is invoked.
*
* @see elm_calendar_select_mode_set()
*
* @ingroup Calendar
* @see elm_calendar_selectable_set()
* @see elm_calendar_selected_time_set()
* @since 1.8
*/
typedef _Elm_Calendar_Select_Mode Elm_Calendar_Select_Mode;
typedef enum
{
ELM_CALENDAR_SELECTABLE_NONE = 0,
ELM_CALENDAR_SELECTABLE_YEAR = (1 << 0),
ELM_CALENDAR_SELECTABLE_MONTH = (1 << 1),
ELM_CALENDAR_SELECTABLE_DAY = (1 << 2)
} _Elm_Calendar_Selectable;
/**
* @enum _Elm_Calendar_Selectable
* @typedef Elm_Calendar_Selectable
*
* A bitmask used to define which fields of a @b tm struct will be taken into
* account, when elm_calendar_selected_time_set() is invoked.
*
* @ingroup Calendar
* @see elm_calendar_selectable_set()
* @see elm_calendar_selected_time_set()
* @since 1.8
*/
typedef _Elm_Calendar_Selectable Elm_Calendar_Selectable;
} Elm_Calendar_Selectable;
typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark; /**< Item handle for a calendar mark. Created with elm_calendar_mark_add() and deleted with elm_calendar_mark_del(). */
/**
* @typedef Elm_Calendar_Format_Cb
*
* This callback type is used to format the string that will be used
* to display month and year.
*
@ -106,8 +87,6 @@ typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark; /**< Item handle for a c
* @return String representing time that will be set to calendar's text.
*
* @see elm_calendar_format_function_set()
*
* @ingroup Calendar
*/
typedef char * (*Elm_Calendar_Format_Cb)(struct tm *stime);
@ -137,8 +116,6 @@ typedef char * (*Elm_Calendar_Format_Cb)(struct tm *stime);
* @see elm_calendar_weekdays_name_get()
*
* @ref calendar_example_02
*
* @ingroup Calendar
*/
EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]);
@ -153,8 +130,9 @@ EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, cons
* @see elm_calendar_mark_add()
*
* @ref calendar_example_06
*
* @ingroup Calendar
*/
EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark);
/**
* @}
*/

11
legacy/elementary/src/lib/elm_clock_common.h
View File

@ -1,4 +1,12 @@
/**
* @addtogroup Clock
*
* @{
*/
/**
* @enum Elm_Clock_Edit_Mode
*
* Identifiers for which clock digits should be editable, when a
* clock widget is in edition mode. Values may be OR-ed together to
* make a mask, naturally.
@ -18,3 +26,6 @@ typedef enum
ELM_CLOCK_EDIT_ALL = (1 << 6) - 1 /**< All digits should be editable */
} Elm_Clock_Edit_Mode;
/**
* @}
*/

22
legacy/elementary/src/lib/elm_colorselector_common.h
View File

@ -1,20 +1,28 @@
typedef struct _Elm_Color_RGBA
/**
* @addtogroup Colorselector
*
* @{
*/
typedef struct _Elm_Color_RGBA Elm_Color_RGBA;
struct _Elm_Color_RGBA
{
unsigned int r;
unsigned int g;
unsigned int b;
unsigned int a;
} Elm_Color_RGBA;
};
typedef struct _Elm_Custom_Palette
typedef struct _Elm_Custom_Palette Elm_Custom_Palette;
struct _Elm_Custom_Palette
{
const char *palette_name;
Eina_List *color_list;
} Elm_Custom_Palette;
};
/**
* @enum Elm_Colorselector_Mode
* @typedef Elm_Colorselector_Mode
*
* Different modes supported by Colorselector
*
@ -37,3 +45,7 @@ EAPI void elm_colorselector_palette_item_color_set(Elm_Object_Item *it, int r, i
EAPI Eina_Bool elm_colorselector_palette_item_selected_get(const Elm_Object_Item *it);
EAPI void elm_colorselector_palette_item_selected_set(Elm_Object_Item *it, Eina_Bool selected);
/**
* @}
*/

12
legacy/elementary/src/lib/elm_datetime_common.h
View File

@ -1,9 +1,14 @@
/**
* @addtogroup Datetime
*
* @{
*/
/**
* Identifies a Datetime field, The widget supports 6 fields : Year, month,
* Date, Hour, Minute, AM/PM
*
*/
typedef enum _Elm_Datetime_Field_Type
typedef enum
{
ELM_DATETIME_YEAR = 0, /**< Indicates Year field */
ELM_DATETIME_MONTH = 1, /**< Indicates Month field */
@ -13,3 +18,6 @@ typedef enum _Elm_Datetime_Field_Type
ELM_DATETIME_AMPM = 5, /**< Indicates AM/PM field */
} Elm_Datetime_Field_Type;
/**
* @}
*/

9
legacy/elementary/src/lib/elm_dayselector_common.h
View File

@ -1,3 +1,9 @@
/**
* @addtogroup Dayselector
*
* @{
*/
/**
* Identifies the day of the week.
* API can call the selection/unselection of day with this as a parameter.
@ -17,3 +23,6 @@ typedef enum
ELM_DAYSELECTOR_MAX /**< Sentinel value, @b don't use */
} Elm_Dayselector_Day;
/**
* @}
*/

57
legacy/elementary/src/lib/elm_entry_common.h
View File

@ -1,6 +1,10 @@
/**
* @typedef Elm_Text_Format
* @addtogroup Entry
*
* @{
*/
/**
* Text Format types.
*
* @see elm_entry_file_set()
@ -12,8 +16,6 @@ typedef enum
} Elm_Text_Format;
/**
* @typedef Elm_Wrap_Type
*
* Line wrapping types.
*
* @see elm_entry_line_wrap_set()
@ -28,8 +30,6 @@ typedef enum
} Elm_Wrap_Type; /**< Type of word or character wrapping to use */
/**
* @typedef Elm_Input_Panel_Layout
*
* Input panel (virtual keyboard) layout types.
*
* @see elm_entry_input_panel_layout_set()
@ -74,8 +74,6 @@ enum
};
/**
* @typedef Elm_Input_Panel_Lang
*
* Input panel (virtual keyboard) language modes.
*
* @see elm_entry_input_panel_language_set()
@ -87,8 +85,6 @@ typedef enum
} Elm_Input_Panel_Lang;
/**
* @typedef Elm_Autocapital_Type
*
* Autocapitalization Types.
*
* @see elm_entry_autocapital_type_set()
@ -102,8 +98,6 @@ typedef enum
} Elm_Autocapital_Type; /**< Choose method of auto-capitalization */
/**
* @typedef Elm_Input_Panel_Return_Key_Type
*
* "Return" Key types on the input panel (virtual keyboard).
*
* @see elm_entry_input_panel_return_key_type_set()
@ -122,7 +116,6 @@ typedef enum
} Elm_Input_Panel_Return_Key_Type;
/**
* @typedef Elm_Input_Hints
* @brief Enumeration that defines the types of Input Hints.
* @since 1.12
*/
@ -134,16 +127,12 @@ typedef enum
} Elm_Input_Hints;
/**
* @typedef Elm_Entry_Anchor_Info
*
* The info sent in the callback for the "anchor,clicked" signals emitted
* by entries.
*/
typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
/**
* @struct _Elm_Entry_Anchor_Info
*
* The info sent in the callback for the "anchor,clicked" signals emitted
* by entries.
*/
@ -158,24 +147,18 @@ struct _Elm_Entry_Anchor_Info
};
/**
* @typedef Elm_Entry_Anchor_Hover_Info
*
* The info sent in the callback for "anchor,clicked" signals emitted by
* the Anchor_Hover widget.
*/
typedef struct _Elm_Entry_Anchor_Hover_Info Elm_Entry_Anchor_Hover_Info;
/**
* @typedef Elm_Entry_Context_Menu_Item
*
* Type of contextual item that can be added in to long press menu.
* @since 1.8
*/
typedef struct _Elm_Entry_Context_Menu_Item Elm_Entry_Context_Menu_Item;
/**
* @struct _Elm_Entry_Anchor_Hover_Info
*
* The info sent in the callback for "anchor,clicked" signals emitted by
* the Anchor_Hover widget.
*/
@ -209,7 +192,6 @@ struct _Elm_Entry_Anchor_Hover_Info
};
/**
* @typedef Elm_Entry_Item_Provider_Cb
* This callback type is used to provide items.
* If it returns an object handle other than NULL (it should create an
* object to do this), then this object is used to replace the current item.
@ -226,7 +208,6 @@ struct _Elm_Entry_Anchor_Hover_Info
typedef Evas_Object * (*Elm_Entry_Item_Provider_Cb)(void *data, Evas_Object * entry, const char *item);
/**
* @typedef Elm_Entry_Filter_Cb
* This callback type is used by entry filters to modify text.
* @param data The data specified as the last param when adding the filter
* @param entry The entry object
@ -238,7 +219,6 @@ typedef Evas_Object * (*Elm_Entry_Item_Provider_Cb)(void *data, Evas_Object * en
typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
/**
* @typedef Elm_Entry_Change_Info
* This corresponds to Edje_Entry_Change_Info. Includes information about
* a change in the entry.
*/
@ -252,8 +232,6 @@ typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
*
* @param s The string (in markup) to be converted
* @return The converted string (in UTF-8). It should be freed.
*
* @ingroup Entry
*/
EAPI char *elm_entry_markup_to_utf8(const char *s);
@ -270,8 +248,6 @@ EAPI char *elm_entry_markup_to_utf8(const char *s);
* "&lt;align=center&gt;hello&lt;/align&gt; &amp;gt;". This is useful when you
* want to display "&" in label, entry, and some widgets which use textblock
* internally.
*
* @ingroup Entry
*/
EAPI char *elm_entry_utf8_to_markup(const char *s);
@ -280,15 +256,11 @@ EAPI char *elm_entry_utf8_to_markup(const char *s);
/* pre-made filters for entries */
/**
* @typedef Elm_Entry_Filter_Limit_Size
*
* Data for the elm_entry_filter_limit_size() entry filter.
*/
typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
/**
* @struct _Elm_Entry_Filter_Limit_Size
*
* Data for the elm_entry_filter_limit_size() entry filter.
*/
struct _Elm_Entry_Filter_Limit_Size
@ -320,21 +292,15 @@ struct _Elm_Entry_Filter_Limit_Size
*
* This filter, like any others, does not apply when setting the entry text
* directly with elm_object_text_set().
*
* @ingroup Entry
*/
EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text);
/**
* @typedef Elm_Entry_Filter_Accept_Set
*
* Data for the elm_entry_filter_accept_set() entry filter.
*/
typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
/**
* @struct _Elm_Entry_Filter_Accept_Set
*
* Data for the elm_entry_filter_accept_set() entry filter.
*/
struct _Elm_Entry_Filter_Accept_Set
@ -361,13 +327,10 @@ struct _Elm_Entry_Filter_Accept_Set
*
* This filter, like any others, does not apply when setting the entry text
* directly with elm_object_text_set()
*
* @ingroup Entry
*/
EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text);
/**
* @typedef Elm_Cnp_Mode
* Enum of entry's copy & paste policy.
*
* @see elm_entry_cnp_mode_set()
@ -380,22 +343,17 @@ typedef enum {
} Elm_Cnp_Mode;
/**
* Get the text of the contextual menu item.
*
* Get the text of the contextual menu item of entry.
*
* @param item The item to get the label
* @return The text of contextual menu item
*
* @see elm_entry_context_menu_item_add()
* @ingroup Entry
* @since 1.8
*/
EAPI const char *elm_entry_context_menu_item_label_get(const Elm_Entry_Context_Menu_Item *item);
/**
* Get the icon object of the contextual menu item.
*
* Get the icon object packed in the contextual menu item of entry.
*
* @param item The item to get the icon from
@ -406,8 +364,11 @@ EAPI const char *elm_entry_context_menu_item_label_get(const El
* @param icon_type The icon type
*
* @see elm_entry_context_menu_item_add()
* @ingroup Entry
* @since 1.8
*/
EAPI void elm_entry_context_menu_item_icon_get(const Elm_Entry_Context_Menu_Item *item, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type);
/**
* @}
*/

10
legacy/elementary/src/lib/elm_flip_common.h
View File

@ -1,3 +1,6 @@
/**
* @ingroup Flip
*/
typedef enum
{
ELM_FLIP_ROTATE_Y_CENTER_AXIS,
@ -14,6 +17,9 @@ typedef enum
ELM_FLIP_PAGE_DOWN
} Elm_Flip_Mode;
/**
* @ingroup Flip
*/
typedef enum
{
ELM_FLIP_INTERACTION_NONE,
@ -22,6 +28,9 @@ typedef enum
ELM_FLIP_INTERACTION_PAGE
} Elm_Flip_Interaction;
/**
* @ingroup Flip
*/
typedef enum
{
ELM_FLIP_DIRECTION_UP = 0, /**< Allows interaction with the top of the widget */
@ -29,4 +38,3 @@ typedef enum
ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
} Elm_Flip_Direction;

157
legacy/elementary/src/lib/elm_gesture_layer_common.h
View File

@ -1,10 +1,13 @@
/**
* @enum _Elm_Gesture_Type
* Enum of supported gesture types.
* @ingroup Elm_Gesture_Layer
* @addtogroup Elm_Gesture_Layer
*
* @{
*/
enum _Elm_Gesture_Type
/**
* Enum of supported gesture types.
*/
typedef enum
{
ELM_GESTURE_FIRST = 0,
@ -22,44 +25,27 @@ enum _Elm_Gesture_Type
ELM_GESTURE_ROTATE, /**< Rotate */
ELM_GESTURE_LAST
};
} Elm_Gesture_Type;
/**
* @typedef Elm_Gesture_Type
* Convenient macro around #_Elm_Gesture_Type
*
* @ingroup Elm_Gesture_Layer
*/
typedef enum _Elm_Gesture_Type Elm_Gesture_Type;
/**
* @enum _Elm_Gesture_State
* Enum of gesture states.
*
* @ingroup Elm_Gesture_Layer
*/
enum _Elm_Gesture_State
typedef enum
{
ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
ELM_GESTURE_STATE_START, /**< Gesture STARTed */
ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
ELM_GESTURE_STATE_END, /**< Gesture completed */
ELM_GESTURE_STATE_ABORT /**< Ongoing gesture was ABORTed */
};
} Elm_Gesture_State;
/**
* @typedef Elm_Gesture_State
* Convenient macro around #_Elm_Gesture_State
*
* @ingroup Elm_Gesture_Layer
* Holds taps info for user
*/
typedef enum _Elm_Gesture_State Elm_Gesture_State;
typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
/**
* @struct _Elm_Gesture_Taps_Info
* Struct holds taps info for user
*
* @ingroup Elm_Gesture_Layer
*/
struct _Elm_Gesture_Taps_Info
{
@ -69,70 +55,54 @@ struct _Elm_Gesture_Taps_Info
};
/**
* @typedef Elm_Gesture_Taps_Info
* holds taps info for user
*
* @ingroup Elm_Gesture_Layer
* holds momentum info for user
*/
typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
/**
* @struct _Elm_Gesture_Momentum_Info
* Struct holds momentum info for user
* x1 and y1 are not necessarily in sync
* x1 holds x value of x direction starting point
* and same holds for y1.
* This is noticeable when doing V-shape movement
*
* @ingroup Elm_Gesture_Layer
*/
struct _Elm_Gesture_Momentum_Info /* Report line ends, timestamps, and momentum computed */
{Evas_Coord x1; /**< Final-swipe direction starting point on X */
Evas_Coord y1; /**< Final-swipe direction starting point on Y */
Evas_Coord x2; /**< Final-swipe direction ending point on X */
Evas_Coord y2; /**< Final-swipe direction ending point on Y */
{
Evas_Coord x1; /**< Final-swipe direction starting point on X */
Evas_Coord y1; /**< Final-swipe direction starting point on Y */
Evas_Coord x2; /**< Final-swipe direction ending point on X */
Evas_Coord y2; /**< Final-swipe direction ending point on Y */
unsigned int tx; /**< Timestamp of start of final x-swipe */
unsigned int ty; /**< Timestamp of start of final y-swipe */
unsigned int tx; /**< Timestamp of start of final x-swipe */
unsigned int ty; /**< Timestamp of start of final y-swipe */
Evas_Coord mx; /**< Momentum on X */
Evas_Coord my; /**< Momentum on Y */
Evas_Coord mx; /**< Momentum on X */
Evas_Coord my; /**< Momentum on Y */
unsigned int n; /**< Number of fingers */
unsigned int n; /**< Number of fingers */
};
/**
* @typedef Elm_Gesture_Momentum_Info
* holds momentum info for user
*
* @ingroup Elm_Gesture_Layer
*/
typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
/**
* @struct _Elm_Gesture_Line_Info
* Struct holds line info for user
*
* @ingroup Elm_Gesture_Layer
*/
struct _Elm_Gesture_Line_Info /* Report line ends, timestamps, and momentum computed */
{Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
double angle; /**< Angle (direction) of lines */
};
/**
* @typedef Elm_Gesture_Line_Info
* Holds line info for user
*
* @ingroup Elm_Gesture_Layer
*/
typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
/**
* @struct _Elm_Gesture_Zoom_Info
* Struct holds line info for user
*/
struct _Elm_Gesture_Line_Info /* Report line ends, timestamps, and momentum computed */
{
Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
double angle; /**< Angle (direction) of lines */
};
/**
* Holds zoom info for user
*/
typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
/**
* Struct holds zoom info for user
*
* @ingroup Elm_Gesture_Layer
*/
struct _Elm_Gesture_Zoom_Info
{
@ -143,18 +113,12 @@ struct _Elm_Gesture_Zoom_Info
};
/**
* @typedef Elm_Gesture_Zoom_Info
* Holds zoom info for user
*
* @ingroup Elm_Gesture_Layer
* Holds rotation info for user
*/
typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
/**
* @struct _Elm_Gesture_Rotate_Info
* Struct holds rotation info for user
*
* @ingroup Elm_Gesture_Layer
*/
struct _Elm_Gesture_Rotate_Info
{
@ -166,23 +130,12 @@ struct _Elm_Gesture_Rotate_Info
};
/**
* @typedef Elm_Gesture_Rotate_Info
* Holds rotation info for user
*
* @ingroup Elm_Gesture_Layer
*/
typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
/**
* @typedef Elm_Gesture_Event_Cb
* User callback used to stream gesture info from gesture layer
* @param data user data
* @param event_info gesture report info
* Returns a flag field to be applied on the causing event.
* You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
* upon the event, in an irreversible way.
*
* @ingroup Elm_Gesture_Layer
*/
typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb)(void *data, void *event_info);
@ -193,7 +146,6 @@ typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb)(void *data, void *event_info);
* @param line_min_length the length.
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_line_min_length_set(Evas_Object *obj, int line_min_length);
@ -204,7 +156,6 @@ EAPI void elm_gesture_layer_line_min_length_set(Evas_Object *obj, int line_min_l
* @return the length.
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI int elm_gesture_layer_line_min_length_get(const Evas_Object *obj);
@ -215,7 +166,6 @@ EAPI int elm_gesture_layer_line_min_length_get(const Evas_Object *obj);
* @param zoom_distance_tolerance zoom distance tolerance
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_zoom_distance_tolerance_set(Evas_Object *obj, Evas_Coord zoom_distance_tolerance);
@ -226,7 +176,6 @@ EAPI void elm_gesture_layer_zoom_distance_tolerance_set(Evas_Object *obj, Evas_C
* @return zoom distance tolerance
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI Evas_Coord elm_gesture_layer_zoom_distance_tolerance_get(const Evas_Object *obj);
@ -237,7 +186,6 @@ EAPI Evas_Coord elm_gesture_layer_zoom_distance_tolerance_get(const Evas_Object
* @param line_distance_tolerance line distance tolerance
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_line_distance_tolerance_set(Evas_Object *obj, Evas_Coord line_distance_tolerance);
@ -248,7 +196,6 @@ EAPI void elm_gesture_layer_line_distance_tolerance_set(Evas_Object *obj, Evas_C
* @return line distance tolerance
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI Evas_Coord elm_gesture_layer_line_distance_tolerance_get(const Evas_Object *obj);
@ -259,7 +206,6 @@ EAPI Evas_Coord elm_gesture_layer_line_distance_tolerance_get(const Evas_Object
* @param line_angular_tolerance line angular tolerance
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_line_angular_tolerance_set(Evas_Object *obj, double line_angular_tolerance);
@ -270,7 +216,6 @@ EAPI void elm_gesture_layer_line_angular_tolerance_set(Evas_Object *obj, double
* @return line angular tolerance
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI double elm_gesture_layer_line_angular_tolerance_get(const Evas_Object *obj);
@ -281,7 +226,6 @@ EAPI double elm_gesture_layer_line_angular_tolerance_get(const Evas_Object *obj)
* @param zoom_wheel_factor zoom wheel factor
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_zoom_wheel_factor_set(Evas_Object *obj, double zoom_wheel_factor);
@ -292,7 +236,6 @@ EAPI void elm_gesture_layer_zoom_wheel_factor_set(Evas_Object *obj, double zoom_
* @return zoom wheel factor
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI double elm_gesture_layer_zoom_wheel_factor_get(const Evas_Object *obj);
@ -303,7 +246,6 @@ EAPI double elm_gesture_layer_zoom_wheel_factor_get(const Evas_Object *obj);
* @param zoom_finger_factor zoom finger factor
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_zoom_finger_factor_set(Evas_Object *obj, double zoom_finger_factor);
@ -314,7 +256,6 @@ EAPI void elm_gesture_layer_zoom_finger_factor_set(Evas_Object *obj, double zoom
* @return zoom finger factor
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI double elm_gesture_layer_zoom_finger_factor_get(const Evas_Object *obj);
@ -325,7 +266,6 @@ EAPI double elm_gesture_layer_zoom_finger_factor_get(const Evas_Object *obj);
* @param rotate_angular_tolerance rotate angular tolerance
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_rotate_angular_tolerance_set(Evas_Object *obj, double rotate_angular_tolerance);
@ -336,7 +276,6 @@ EAPI void elm_gesture_layer_rotate_angular_tolerance_set(Evas_Object *obj, doubl
* @return rotate angular tolerance
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI double elm_gesture_layer_rotate_angular_tolerance_get(const Evas_Object *obj);
@ -347,7 +286,6 @@ EAPI double elm_gesture_layer_rotate_angular_tolerance_get(const Evas_Object *ob
* @param flick_time_limit_ms flick time limit (in ms)
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_flick_time_limit_ms_set(Evas_Object *obj, unsigned int flick_time_limit_ms);
@ -358,7 +296,6 @@ EAPI void elm_gesture_layer_flick_time_limit_ms_set(Evas_Object *obj, unsigned i
* @return flick time limit (in ms)
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI unsigned int elm_gesture_layer_flick_time_limit_ms_get(const Evas_Object *obj);
@ -369,7 +306,6 @@ EAPI unsigned int elm_gesture_layer_flick_time_limit_ms_get(const Evas_Object *o
* @param long_tap_start_timeout long tap start timeout
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_long_tap_start_timeout_set(Evas_Object *obj, double long_tap_start_timeout);
@ -380,7 +316,6 @@ EAPI void elm_gesture_layer_long_tap_start_timeout_set(Evas_Object *obj, double
* @return long tap start timeout
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI double elm_gesture_layer_long_tap_start_timeout_get(const Evas_Object *obj);
@ -391,7 +326,6 @@ EAPI double elm_gesture_layer_long_tap_start_timeout_get(const Evas_Object *obj)
* @param continues_enable continues enable
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_continues_enable_set(Evas_Object *obj, Eina_Bool continues_enable);
@ -402,7 +336,6 @@ EAPI void elm_gesture_layer_continues_enable_set(Evas_Object *obj, Eina_Bool con
* @return continues enable
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI Eina_Bool elm_gesture_layer_continues_enable_get(const Evas_Object *obj);
@ -413,7 +346,6 @@ EAPI Eina_Bool elm_gesture_layer_continues_enable_get(const Evas_Object *obj);
* @param double_tap_timeout double tap timeout
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_double_tap_timeout_set(Evas_Object *obj, double double_tap_timeout);
@ -424,7 +356,6 @@ EAPI void elm_gesture_layer_double_tap_timeout_set(Evas_Object *obj, double doub
* @return double tap timeout
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI double elm_gesture_layer_double_tap_timeout_get(const Evas_Object *obj);
@ -437,7 +368,6 @@ EAPI double elm_gesture_layer_double_tap_timeout_get(const Evas_Object *obj);
* @param sz Finger size
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_tap_finger_size_set(Evas_Object *obj, Evas_Coord sz);
@ -448,6 +378,9 @@ EAPI void elm_gesture_layer_tap_finger_size_set(Evas_Object *obj, Evas_Coord sz)
* @return Finger size that is currently used by Gesture Layer for taps.
*
* @since 1.8
* @ingroup Elm_Gesture_Layer
*/
EAPI Evas_Coord elm_gesture_layer_tap_finger_size_get(const Evas_Object *obj);
/**
* @}
*/

14
legacy/elementary/src/lib/elm_glview_common.h
View File

@ -1,3 +1,9 @@
/**
* @addtogroup GLView
*
* @{
*/
typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
/**
@ -16,9 +22,8 @@ typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
*
* @see elm_glview_mode_set
* @see @ref elm_opengl_page
* @ingroup GLView
*/
typedef enum _Elm_GLView_Mode
typedef enum
{
ELM_GLVIEW_NONE = 0,
// 0x1 is reserved for future use
@ -55,7 +60,6 @@ typedef enum _Elm_GLView_Mode
* scaled.
*
* @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
* @ingroup GLView
*/
typedef enum
{
@ -72,7 +76,6 @@ typedef enum
* only when it is visible.
*
* @note Default is ELM_GLVIEW_RENDER_POLICY_ON_DEMAND
* @ingroup GLView
*/
typedef enum
{
@ -80,3 +83,6 @@ typedef enum
ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
} Elm_GLView_Render_Policy;
/**
* @}
*/

9
legacy/elementary/src/lib/elm_hover_common.h
View File

@ -1,6 +1,10 @@
/**
* @typedef Elm_Hover_Axis
* @addtogroup Hover
*
* @{
*/
/**
* The orientation axis for the hover object
*/
typedef enum
@ -11,3 +15,6 @@ typedef enum
ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
} Elm_Hover_Axis;
/**
* @}
*/

6
legacy/elementary/src/lib/elm_icon_common.h
View File

@ -1,5 +1,6 @@
/**
* @addtogroup Icon
*
* @{
*/
@ -16,8 +17,6 @@ typedef enum
*
* Lookup order used by elm_icon_standard_set(). Should look for icons in the
* theme, FDO paths, or both?
*
* @ingroup Icon
*/
typedef enum
{
@ -27,3 +26,6 @@ typedef enum
ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
} Elm_Icon_Lookup_Order;
/**
* @}
*/

20
legacy/elementary/src/lib/elm_image_common.h
View File

@ -1,10 +1,14 @@
/**
* @addtogroup Image
*
* @{
*/
/**
* Possible orientation options for elm_image_orient_set().
*
* @image html elm_image_orient_set.png
* @image latex elm_image_orient_set.eps width=\textwidth
*
* @ingroup Image
*/
typedef enum
{
@ -24,22 +28,30 @@ typedef enum
* @since 1.8
*/
typedef struct _Elm_Image_Progress Elm_Image_Progress;
/**
* Structure associated with smart callback 'download,progress'.
*/
struct _Elm_Image_Progress
{
double now;
double total;
};
/**
* Structre associated with smart callback 'download,error'
* @since 1.8
*/
typedef struct _Elm_Image_Error Elm_Image_Error;
/**
* Structure associated with smart callback 'download,progress'.
*/
struct _Elm_Image_Error
{
int status;
Eina_Bool open_error;
};
/**
* @}
*/

12
legacy/elementary/src/lib/elm_label_common.h
View File

@ -1,3 +1,12 @@
/**
* @addtogroup Label
*
* @{
*/
/**
* Slide mode of a label widget
*/
typedef enum
{
ELM_LABEL_SLIDE_MODE_NONE = 0, /**< no slide effect */
@ -5,3 +14,6 @@ typedef enum
ELM_LABEL_SLIDE_MODE_ALWAYS /**< slide always */
} Elm_Label_Slide_Mode;
/**
* @}
*/

19
legacy/elementary/src/lib/elm_layout_common.h
View File

@ -1,10 +1,12 @@
/**
* @typedef Elm_Layout_Part_Alias_Description
* @addtogroup Layout
*
* @{
*/
/**
* A layout part aliasing (proxying) description, used to get part
* names aliasing independently of a widgets theme.
*
* @ingroup Widget
*/
typedef struct _Elm_Layout_Part_Alias_Description Elm_Layout_Part_Alias_Description;
@ -12,8 +14,6 @@ typedef struct _Elm_Layout_Part_Alias_Description Elm_Layout_Part_Alias_Descript
* @def elm_layout_icon_set
* Convenience macro to set the icon object in a layout that follows the
* Elementary naming convention for its parts.
*
* @ingroup Layout
*/
#define elm_layout_icon_set(_ly, _obj) \
do { \
@ -28,8 +28,6 @@ typedef struct _Elm_Layout_Part_Alias_Description Elm_Layout_Part_Alias_Descript
* @def elm_layout_icon_get
* Convenience macro to get the icon object from a layout that follows the
* Elementary naming convention for its parts.
*
* @ingroup Layout
*/
#define elm_layout_icon_get(_ly) \
elm_layout_content_get((_ly), "elm.swallow.icon")
@ -38,8 +36,6 @@ typedef struct _Elm_Layout_Part_Alias_Description Elm_Layout_Part_Alias_Descript
* @def elm_layout_end_set
* Convenience macro to set the end object in a layout that follows the
* Elementary naming convention for its parts.
*
* @ingroup Layout
*/
#define elm_layout_end_set(_ly, _obj) \
do { \
@ -54,9 +50,10 @@ typedef struct _Elm_Layout_Part_Alias_Description Elm_Layout_Part_Alias_Descript
* @def elm_layout_end_get
* Convenience macro to get the end object in a layout that follows the
* Elementary naming convention for its parts.
*
* @ingroup Layout
*/
#define elm_layout_end_get(_ly) \
elm_layout_content_get((_ly), "elm.swallow.end")
/**
* @}
*/

11
legacy/elementary/src/lib/elm_list_common.h
View File

@ -1,3 +1,9 @@
/**
* @addtogroup List
*
* @{
*/
/**
* Set list's resizing behavior, transverse axis scrolling and items
* cropping. See each mode's description for more details.
@ -9,8 +15,6 @@
*
* @see elm_list_mode_set()
* @see elm_list_mode_get()
*
* @ingroup List
*/
typedef enum
{
@ -21,3 +25,6 @@ typedef enum
ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
} Elm_List_Mode;
/**
* @}
*/

101
legacy/elementary/src/lib/elm_map_common.h
View File

@ -1,3 +1,9 @@
/**
* @addtogroup Map
*
* @{
*/
/**
* Set map's zoom behavior. It can be set to manual or automatic.
*
@ -10,8 +16,6 @@
*
* @see elm_map_zoom_mode_set()
* @see elm_map_zoom_mode_get()
*
* @ingroup Map
*/
typedef enum
{
@ -27,8 +31,6 @@ typedef enum
* @see elm_map_sources_get()
* @see elm_map_source_get()
* @see elm_map_source_set()
*
* @ingroup Map
*/
typedef enum
{
@ -42,8 +44,6 @@ typedef enum
* Set type of transport used on route.
*
* @see elm_map_route_add()
*
* @ingroup Map
*/
typedef enum
{
@ -57,8 +57,6 @@ typedef enum
* Set the routing method, what should be prioritized, time or distance.
*
* @see elm_map_route_add()
*
* @ingroup Map
*/
typedef enum
{
@ -71,8 +69,6 @@ typedef enum
* Set the name search method.
*
* This is for name module interface.
*
* @ingroup Map
*/
typedef enum
{
@ -90,10 +86,8 @@ typedef enum
* @see elm_map_overlay_add()
* @see elm_map_overlay_class_add()
* @see elm_map_overlay_bubble_add()
*
* @ingroup Map
*/
typedef enum _Elm_Map_Overlay_Type
typedef enum
{
ELM_MAP_OVERLAY_TYPE_NONE = 0,
ELM_MAP_OVERLAY_TYPE_DEFAULT,
@ -135,8 +129,6 @@ typedef void (*Elm_Map_Route_Cb)(void *data, Evas_Object *
* @see elm_map_overlay_add()
* @see elm_map_overlay_class_add()
* @see elm_map_overlay_bubble_add()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_del(Elm_Map_Overlay *overlay);
@ -151,8 +143,6 @@ EAPI void elm_map_overlay_del(Elm_Map_Overlay *overlay);
* @see elm_map_overlay_add()
* @see elm_map_overlay_class_add()
* @see elm_map_overlay_bubble_add()
*
* @ingroup Map
*/
EAPI Elm_Map_Overlay_Type elm_map_overlay_type_get(const Elm_Map_Overlay *overlay);
@ -163,8 +153,6 @@ EAPI Elm_Map_Overlay_Type elm_map_overlay_type_get(const Elm_Map_Overlay *overl
* @param data A pointer of user data
*
* @see elm_map_overlay_data_get()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_data_set(Elm_Map_Overlay *overlay, void *data);
@ -176,8 +164,6 @@ EAPI void elm_map_overlay_data_set(Elm_Map_Overlay *overlay, vo
* or @c NULL, if none has been set.
*
* @see elm_map_overlay_data_set()
*
* @ingroup Map
*/
EAPI void * elm_map_overlay_data_get(const Elm_Map_Overlay *overlay);
@ -188,8 +174,6 @@ EAPI void * elm_map_overlay_data_get(const Elm_Map_Overlay *overl
* @param hide Use @c EINA_TRUE to hide the overlay or @c EINA_FALSE to show.
*
* @see elm_map_overlay_hide_get()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_hide_set(Elm_Map_Overlay *overlay, Eina_Bool hide);
@ -203,8 +187,6 @@ EAPI void elm_map_overlay_hide_set(Elm_Map_Overlay *overlay, Ei
* This gets the current hidden state for the overlay.
*
* @see elm_map_overlay_hide_set()
*
* @ingroup Map
*/
EAPI Eina_Bool elm_map_overlay_hide_get(const Elm_Map_Overlay *overlay);
@ -218,8 +200,6 @@ EAPI Eina_Bool elm_map_overlay_hide_get(const Elm_Map_Overlay *overl
* or bigger.
*
* @see elm_map_overlay_displayed_zoom_min_get()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_displayed_zoom_min_set(Elm_Map_Overlay *overlay, int zoom);
@ -230,8 +210,6 @@ EAPI void elm_map_overlay_displayed_zoom_min_set(Elm_Map_Overla
* @return zoom The minimum zoom.
*
* @see elm_map_overlay_displayed_zoom_min_set()
*
* @ingroup Map
*/
EAPI int elm_map_overlay_displayed_zoom_min_get(const Elm_Map_Overlay *overlay);
@ -251,8 +229,6 @@ EAPI int elm_map_overlay_displayed_zoom_min_get(const Elm_Map_
* even if map being scrolled or zoomed.
*
* @see elm_map_overlay_paused_get()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_paused_set(Elm_Map_Overlay *overlay, Eina_Bool paused);
@ -266,8 +242,6 @@ EAPI void elm_map_overlay_paused_set(Elm_Map_Overlay *overlay,
* This gets the current paused state for the overlay.
*
* @see elm_map_overlay_paused_set()
*
* @ingroup Map
*/
EAPI Eina_Bool elm_map_overlay_paused_get(const Elm_Map_Overlay *overlay);
@ -282,8 +256,6 @@ EAPI Eina_Bool elm_map_overlay_paused_get(const Elm_Map_Overlay *ove
* This value can be changed dynamically while zooming and panning
*
* @since 1.7
*
* @ingroup Map
*/
EAPI Eina_Bool elm_map_overlay_visible_get(const Elm_Map_Overlay *overlay);
@ -307,8 +279,6 @@ EAPI Eina_Bool elm_map_overlay_visible_get(const Elm_Map_Overlay *ov
* If @p obj is @c NULL, content inside the overlay is deleted.
*
* @see elm_map_overlay_content_get()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_content_set(Elm_Map_Overlay *overlay, Evas_Object *obj);
@ -328,8 +298,6 @@ EAPI void elm_map_overlay_content_set(Elm_Map_Overlay *overlay,
* The content can be set by elm_map_overlay_content_set().
*
* @see elm_map_overlay_content_set()
*
* @ingroup Map
*/
EAPI const Evas_Object * elm_map_overlay_content_get(const Elm_Map_Overlay *overlay);
@ -349,8 +317,6 @@ EAPI const Evas_Object * elm_map_overlay_content_get(const Elm_Map_Overlay *ov
* If @p icon is @c NULL, icon inside the overlay will be deleted.
*
* @see elm_map_overlay_icon_get()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_icon_set(Elm_Map_Overlay *overlay, Evas_Object *icon);
@ -369,8 +335,6 @@ EAPI void elm_map_overlay_icon_set(Elm_Map_Overlay *overlay, Ev
* The icon can be set by elm_map_overlay_icon_set().
*
* @see elm_map_overlay_icon_set()
*
* @ingroup Map
*/
EAPI const Evas_Object * elm_map_overlay_icon_get(const Elm_Map_Overlay *overlay);
@ -387,8 +351,6 @@ EAPI const Evas_Object * elm_map_overlay_icon_get(const Elm_Map_Overlay *overl
* get by elm_map_overlay_region_get().
*
* @see elm_map_overlay_region_get()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_region_set(Elm_Map_Overlay *overlay, double lon, double lat);
@ -405,8 +367,6 @@ EAPI void elm_map_overlay_region_set(Elm_Map_Overlay *overlay,
* set by elm_map_overlay_region_set().
*
* @see elm_map_overlay_region_set()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_region_get(const Elm_Map_Overlay *overlay, double *lon, double *lat);
@ -437,8 +397,6 @@ EAPI void elm_map_overlay_region_get(const Elm_Map_Overlay *ove
* and ELM_MAP_OVERLAY_TYPE_ROUTE Elm_Map_Overlay_Type types.
*
* @see elm_map_overlay_color_get()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_color_set(Elm_Map_Overlay *overlay, int r, int g, int b, int a);
@ -452,8 +410,6 @@ EAPI void elm_map_overlay_color_set(Elm_Map_Overlay *overlay, i
* @param a Pointer to store the alpha channel value.
*
* @see elm_map_overlay_color_set()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_color_get(const Elm_Map_Overlay *overlay, int *r, int *g, int *b, int *a);
@ -467,8 +423,6 @@ EAPI void elm_map_overlay_color_get(const Elm_Map_Overlay *over
* moved to the center of the map.
*
* @see elm_map_overlays_show() if more than one overlay need to be displayed.
*
* @ingroup Map
*/
EAPI void elm_map_overlay_show(Elm_Map_Overlay *overlay);
@ -484,8 +438,6 @@ EAPI void elm_map_overlay_show(Elm_Map_Overlay *overlay);
* @warning All the overlays should belong to the same map object.
*
* @see elm_map_overlay_show() to show a single overlay.
*
* @ingroup Map
*/
EAPI void elm_map_overlays_show(Eina_List *overlays);
@ -503,8 +455,6 @@ EAPI void elm_map_overlays_show(Eina_List *overlays);
* is clicked, callback will be called and return a virtual group overlays.
*
* You can delete this callback function by setting @c NULL.
*
* @ingroup Map
*/
EAPI void elm_map_overlay_get_cb_set(Elm_Map_Overlay *overlay, Elm_Map_Overlay_Get_Cb get_cb, void *data);
@ -521,8 +471,6 @@ EAPI void elm_map_overlay_get_cb_set(Elm_Map_Overlay *overlay,
* You can delete this callback function by setting @c NULL.
*
* @since 1.7
*
* @ingroup Map
*/
EAPI void elm_map_overlay_del_cb_set(Elm_Map_Overlay *overlay, Elm_Map_Overlay_Del_Cb del_cb, void *data);
@ -533,8 +481,6 @@ EAPI void elm_map_overlay_del_cb_set(Elm_Map_Overlay *overlay,
* @param overlay The overlay to be added to the class overlay.
*
* @see elm_map_overlay_class_remove()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_class_append(Elm_Map_Overlay *clas, Elm_Map_Overlay *overlay);
@ -545,8 +491,6 @@ EAPI void elm_map_overlay_class_append(Elm_Map_Overlay *clas, E
* @param overlay The overlay to be deleted from the class overlay.
*
* @see elm_map_overlay_class_append()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_class_remove(Elm_Map_Overlay *clas, Elm_Map_Overlay *overlay);
@ -561,8 +505,6 @@ EAPI void elm_map_overlay_class_remove(Elm_Map_Overlay *clas, E
* is displayed at less than @p zoom.
*
* @see elm_map_overlay_class_zoom_max_get()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_class_zoom_max_set(Elm_Map_Overlay *clas, int zoom);
@ -575,8 +517,6 @@ EAPI void elm_map_overlay_class_zoom_max_set(Elm_Map_Overlay *c
* @return The maximum zoom.
*
* @see elm_map_overlay_class_zoom_max_set()
*
* @ingroup Map
*/
EAPI int elm_map_overlay_class_zoom_max_get(const Elm_Map_Overlay *clas);
@ -596,8 +536,6 @@ EAPI int elm_map_overlay_class_zoom_max_get(const Elm_Map_Over
* Do not modifty the group overlay itself.
*
* @see elm_map_overlay_class_add()
*
* @ingroup Map
*/
EAPI Eina_List * elm_map_overlay_group_members_get(const Elm_Map_Overlay *grp);
@ -610,8 +548,6 @@ EAPI Eina_List * elm_map_overlay_group_members_get(const Elm_Map_Overl
* Bubble overlay will follow the parent overlay's movement (hide, show, move).
*
* @see elm_map_overlay_bubble_add()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_bubble_follow(Elm_Map_Overlay *bubble, const Elm_Map_Overlay *parent);
@ -624,8 +560,6 @@ EAPI void elm_map_overlay_bubble_follow(Elm_Map_Overlay *bubble
* Added contents will be displayed inside the bubble overlay.
*
* @see elm_map_overlay_bubble_content_clear()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_bubble_content_append(Elm_Map_Overlay *bubble, Evas_Object *content);
@ -637,8 +571,6 @@ EAPI void elm_map_overlay_bubble_content_append(Elm_Map_Overlay
* This will delete all contents inside the bubble overlay.
*
* @see elm_map_overlay_bubble_content_append()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_bubble_content_clear(Elm_Map_Overlay *bubble);
@ -655,8 +587,6 @@ EAPI void elm_map_overlay_bubble_content_clear(Elm_Map_Overlay
*
* @see elm_map_overlay_polygon_add()
* @see elm_map_overlay_del()
*
* @ingroup Map
*/
EAPI void elm_map_overlay_polygon_region_add(Elm_Map_Overlay *overlay, double lon, double lat);
@ -666,8 +596,6 @@ EAPI void elm_map_overlay_polygon_region_add(Elm_Map_Overlay *o
* @param route The route to remove.
*
* @see elm_map_route_add()
*
* @ingroup Map
*/
EAPI void elm_map_route_del(Elm_Map_Route *route);
@ -676,8 +604,6 @@ EAPI void elm_map_route_del(Elm_Map_Route *route);
*
* @param route The route object.
* @return The distance of route (unit : km).
*
* @ingroup Map
*/
EAPI double elm_map_route_distance_get(const Elm_Map_Route *route);
@ -686,8 +612,6 @@ EAPI double elm_map_route_distance_get(const Elm_Map_Route *route
*
* @param route The route object.
* @return Returns a string with the nodes of route.
*
* @ingroup Map
*/
EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route);
@ -696,8 +620,6 @@ EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route);
*
* @param route the route object.
* @return Returns a string with information about waypoint of route.
*
* @ingroup Map
*/
EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route);
@ -711,8 +633,6 @@ EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route
* conversion functions.
*
* @see elm_map_name_add()
*
* @ingroup Map
*/
EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name);
@ -727,8 +647,6 @@ EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name);
* conversion functions.
*
* @see elm_map_name_add()
*
* @ingroup Map
*/
EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat);
@ -741,8 +659,9 @@ EAPI void elm_map_name_region_get(const Elm_Map_Name *name, dou
* between address and coordinates will be lost.
*
* @see elm_map_name_add()
*
* @ingroup Map
*/
EAPI void elm_map_name_del(Elm_Map_Name *name);
/**
* @}
*/

23
legacy/elementary/src/lib/elm_panel_common.h
View File

@ -1,7 +1,11 @@
/**
* @addtogroup Panel
*
* @{
*/
/**
* Panel orientation mode
*
* @ingroup Panel
*/
typedef enum
{
@ -15,11 +19,20 @@ typedef enum
* Panel scroll information
*
* @since 1.11
* @ingroup Panel
*/
typedef struct _Elm_Panel_Scroll_Info
typedef struct _Elm_Panel_Scroll_Info Elm_Panel_Scroll_Info;
/**
* Panel scroll information
*
* @since 1.11
*/
struct _Elm_Panel_Scroll_Info
{
double rel_x; /**<content scrolled position (0.0 ~ 1.0) in the panel>*/
double rel_y; /**<content scrolled position (0.0 ~ 1.0) in the panel>*/
} Elm_Panel_Scroll_Info;
};
/**
* @}
*/

111
legacy/elementary/src/lib/elm_prefs_common.h
View File

@ -1,3 +1,9 @@
/**
* @addtogroup Prefs
*
* @{
*/
/**
* Modes of resetting a prefs widget.
*
@ -7,8 +13,8 @@
*/
typedef enum
{
ELM_PREFS_RESET_DEFAULTS, /** reset to default values, declared in its @b .epb file */
ELM_PREFS_RESET_LAST /** prefs will keep a small history of changes, so this resets back to last batch of changes on the UI elements. it does @b not work on autosave mode */
ELM_PREFS_RESET_DEFAULTS, /**< reset to default values, declared in its @b .epb file */
ELM_PREFS_RESET_LAST /**< prefs will keep a small history of changes, so this resets back to last batch of changes on the UI elements. it does @b not work on autosave mode */
} Elm_Prefs_Reset_Mode;
/**
@ -21,29 +27,33 @@ typedef enum
*/
EAPI Evas_Object *elm_prefs_add(Evas_Object *parent);
/* API for prefs interface modules, from now on */
typedef struct _Elm_Prefs_Item_Spec_Void
typedef struct _Elm_Prefs_Item_Spec_Void Elm_Prefs_Item_Spec_Void;
struct _Elm_Prefs_Item_Spec_Void
{
} Elm_Prefs_Item_Spec_Void;
};
typedef struct _Elm_Prefs_Item_Spec_Bool
typedef struct _Elm_Prefs_Item_Spec_Bool Elm_Prefs_Item_Spec_Bool;
struct _Elm_Prefs_Item_Spec_Bool
{
Eina_Bool def;
} Elm_Prefs_Item_Spec_Bool;
};
typedef struct _Elm_Prefs_Item_Spec_Int
typedef struct _Elm_Prefs_Item_Spec_Int Elm_Prefs_Item_Spec_Int;
struct _Elm_Prefs_Item_Spec_Int
{
int def, min, max;
} Elm_Prefs_Item_Spec_Int;
};
typedef struct _Elm_Prefs_Item_Spec_Float
typedef struct _Elm_Prefs_Item_Spec_Float Elm_Prefs_Item_Spec_Float;
struct _Elm_Prefs_Item_Spec_Float
{
float def, min, max;
} Elm_Prefs_Item_Spec_Float;
};
typedef struct _Elm_Prefs_Item_Spec_String
typedef struct _Elm_Prefs_Item_Spec_String Elm_Prefs_Item_Spec_String;
struct _Elm_Prefs_Item_Spec_String
{
const char *def;
const char *placeholder;
@ -54,9 +64,10 @@ typedef struct _Elm_Prefs_Item_Spec_String
{
int min, max;
} length;
} Elm_Prefs_Item_Spec_String;
};
typedef struct _Elm_Prefs_Item_Spec_Date
typedef struct _Elm_Prefs_Item_Spec_Date Elm_Prefs_Item_Spec_Date;
struct _Elm_Prefs_Item_Spec_Date
{
struct
{
@ -78,14 +89,16 @@ typedef struct _Elm_Prefs_Item_Spec_Date
unsigned char m; /* month*/
unsigned short y; /* year */
} max;
} Elm_Prefs_Item_Spec_Date;
};
typedef struct _Elm_Prefs_Item_Spec_Page
typedef struct _Elm_Prefs_Item_Spec_Page Elm_Prefs_Item_Spec_Page;
struct _Elm_Prefs_Item_Spec_Page
{
const char *source;
} Elm_Prefs_Item_Spec_Page;
};
typedef union _Elm_Prefs_Item_Spec
typedef union _Elm_Prefs_Item_Spec Elm_Prefs_Item_Spec;
union _Elm_Prefs_Item_Spec
{
Elm_Prefs_Item_Spec_Void v;
Elm_Prefs_Item_Spec_Bool b;
@ -94,24 +107,10 @@ typedef union _Elm_Prefs_Item_Spec
Elm_Prefs_Item_Spec_String s;
Elm_Prefs_Item_Spec_Date d;
Elm_Prefs_Item_Spec_Page p;
} Elm_Prefs_Item_Spec;
};
typedef struct _Elm_Prefs_Item_Iface Elm_Prefs_Item_Iface;
/**
* Convenience struct used to mass-register widgets implementing
* prefs @b items interfaces.
*
* To be used with elm_prefs_item_iface_register() and
* elm_prefs_item_iface_unregister().
*/
struct _Elm_Prefs_Item_Iface_Info
{
const char *widget_name; /**< The name of the widget implementing the interface, to be exposed on the prefs collections language. */
const Elm_Prefs_Item_Iface *info; /**< The type interface's implementation. */
};
typedef struct _Elm_Prefs_Item_Iface_Info Elm_Prefs_Item_Iface_Info;
typedef void (*Elm_Prefs_Item_Changed_Cb)(Evas_Object *it_obj); /**< Elementary prefs' item widget changed function signature */
/**
@ -168,6 +167,20 @@ struct _Elm_Prefs_Item_Iface
Eina_Bool (*expand_want)(Evas_Object *obj); /**< function to get wether the item implementation needs to be expanded in the page's longitudinal axis or not */
};
typedef struct _Elm_Prefs_Item_Iface_Info Elm_Prefs_Item_Iface_Info;
/**
* Convenience struct used to mass-register widgets implementing
* prefs @b items interfaces.
*
* To be used with elm_prefs_item_iface_register() and
* elm_prefs_item_iface_unregister().
*/
struct _Elm_Prefs_Item_Iface_Info
{
const char *widget_name; /**< The name of the widget implementing the interface, to be exposed on the prefs collections language. */
const Elm_Prefs_Item_Iface *info; /**< The type interface's implementation. */
};
/**
* Mass-register widgets implementing prefs @b items interfaces.
*
@ -203,21 +216,6 @@ EAPI Eina_Bool elm_prefs_item_widget_common_add(Evas_Object *prefs,
Evas_Object *obj);
typedef struct _Elm_Prefs_Page_Iface Elm_Prefs_Page_Iface;
/**
* Convenience struct used to mass-register widgets implementing
* prefs @b pages interfaces.
*
* To be used with elm_prefs_page_iface_register() and
* elm_prefs_page_iface_unregister().
*/
struct _Elm_Prefs_Page_Iface_Info
{
const char *widget_name; /**< The name of the widget implementing the interface, to be exposed on the prefs collections language. */
const Elm_Prefs_Page_Iface *info; /**< The interface's implementation. */
};
typedef struct _Elm_Prefs_Page_Iface_Info Elm_Prefs_Page_Iface_Info;
/**
* @struct _Elm_Prefs_Page_Iface
*
@ -283,6 +281,20 @@ struct _Elm_Prefs_Page_Iface
const Elm_Prefs_Item_Iface *iface);
};
typedef struct _Elm_Prefs_Page_Iface_Info Elm_Prefs_Page_Iface_Info;
/**
* Convenience struct used to mass-register widgets implementing
* prefs @b pages interfaces.
*
* To be used with elm_prefs_page_iface_register() and
* elm_prefs_page_iface_unregister().
*/
struct _Elm_Prefs_Page_Iface_Info
{
const char *widget_name; /**< The name of the widget implementing the interface, to be exposed on the prefs collections language. */
const Elm_Prefs_Page_Iface *info; /**< The interface's implementation. */
};
/**
* Mass-register widgets implementing prefs @b pages interfaces.
*
@ -314,3 +326,6 @@ EAPI void elm_prefs_page_iface_register(const Elm_Prefs_Page_Iface_Info *ar
*/
EAPI void elm_prefs_page_iface_unregister(const Elm_Prefs_Page_Iface_Info *array);
/**
* @}
*/

9
legacy/elementary/src/lib/elm_progressbar_common.h
View File

@ -1,3 +1,12 @@
/**
* @addtogroup Progressbar
*
* @{
*/
typedef char *(*progressbar_func_type)(double);
typedef void (*progressbar_freefunc_type)(char *);
/**
* @}
*/

10
legacy/elementary/src/lib/elm_scroller_common.h
View File

@ -1,3 +1,9 @@
/**
* @addtogroup Scroller
*
* @{
*/
/**
* @brief Type that controls when scrollbars should appear.
*
@ -38,4 +44,6 @@ typedef enum
ELM_SCROLLER_MOVEMENT_BLOCK_HORIZONTAL = 1 << 2 /**< Block horizontal movements */
} Elm_Scroller_Movement_Block;
/**
* @}
*/

9
legacy/elementary/src/lib/elm_slider_common.h
View File

@ -1,3 +1,12 @@
/**
* @addtogroup Slider
*
* @{
*/
typedef char *(*slider_func_type)(double);
typedef void (*slider_freefunc_type)(char *);
/**
* @}
*/

20
legacy/elementary/src/lib/elm_slideshow_common.h
View File

@ -1,8 +1,21 @@
typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
/**
* @addtogroup Slideshow
*
* @{
*/
typedef Evas_Object *(*SlideshowItemGetFunc)(void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
typedef void (*SlideshowItemDelFunc)(void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
/**
* Slideshow item class definition struct
*/
typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
/**
* Class functions for slideshow item classes.
*/
typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
/**
* @struct _Elm_Slideshow_Item_Class
*
@ -18,3 +31,6 @@ struct _Elm_Slideshow_Item_Class
} func;
}; /**< member definitions of #Elm_Slideshow_Item_Class */
/**
* @}
*/

13
legacy/elementary/src/lib/elm_thumb_common.h
View File

@ -1,10 +1,14 @@
/**
* @addtogroup Thumb
*
* @{
*/
/**
* @enum Elm_Thumb_Animation_Setting
* @typedef Elm_Thumb_Animation_Setting
*
* Used to set if a video thumbnail is animating or not.
*
* @ingroup Thumb
*/
typedef enum
{
@ -22,8 +26,6 @@ typedef enum
* The ethumb client handle returned may or may not be NULL. It may or may
* not survive into the future (ethumbd may become disconnected). Do not use
* this unless you know what you are doing.
*
* @ingroup Thumb
*/
EAPI void *elm_thumb_ethumb_client_get(void);
@ -35,3 +37,6 @@ EAPI void *elm_thumb_ethumb_client_get(void);
*/
EAPI Eina_Bool elm_thumb_ethumb_client_connected_get(void);
/**
* @}
*/

17
legacy/elementary/src/lib/elm_toolbar_common.h
View File

@ -1,7 +1,10 @@
/**
* @enum Elm_Toolbar_Shrink_Mode
* @typedef Elm_Toolbar_Shrink_Mode
* @addtogroup Toolbar
*
* @{
*/
/**
* Set toolbar's items display behavior, it can be scrollable,
* show a menu with exceeding items, or simply hide them.
*
@ -12,8 +15,6 @@
*
* @see elm_toolbar_shrink_mode_set()
* @see elm_toolbar_shrink_mode_get()
*
* @ingroup Toolbar
*/
typedef enum
{
@ -27,8 +28,6 @@ typedef enum
/**
* Defines where to position the item in the toolbar.
*
* @ingroup Toolbar
*/
typedef enum
{
@ -49,7 +48,9 @@ typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /**< State of
* The default icon and label from this item will be displayed.
*
* @see elm_toolbar_item_state_set() for more details.
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_state_unset(Elm_Object_Item *it);
/**
* @}
*/

31
legacy/elementary/src/lib/elm_web_common.h
View File

@ -1,3 +1,9 @@
/**
* @addtogroup Web
*
* @{
*/
/**
* Structure used to report load errors.
*
@ -70,8 +76,6 @@ struct _Elm_Web_Menu_Item
*
* @see elm_web_popup_selected_set()
* @see elm_web_popup_destroy()
*
* @ingroup Web
*/
typedef struct _Elm_Web_Menu Elm_Web_Menu;
@ -91,8 +95,6 @@ typedef struct _Elm_Web_Menu Elm_Web_Menu;
*
* @see elm_web_popup_selected_set()
* @see elm_web_popup_destroy()
*
* @ingroup Web
*/
struct _Elm_Web_Menu
{
@ -128,7 +130,6 @@ typedef enum
*/
typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
/**
* Definitions of web window features.
*
@ -159,8 +160,6 @@ typedef enum
* the request.
*
* @see elm_web_window_create_hook_set()
*
* @ingroup Web
*/
typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
@ -179,8 +178,6 @@ typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_B
* If the function returns @c NULL the popup will be ignored.
*
* @see elm_web_dialog_alert_hook_set()
*
* @ingroup Web
*/
typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
@ -201,8 +198,6 @@ typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const
* If the function returns @c NULL the popup will be ignored.
*
* @see elm_web_dialog_confirm_hook_set()
*
* @ingroup Web
*/
typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
@ -226,8 +221,6 @@ typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, con
* If the function returns @c NULL the popup will be ignored.
*
* @see elm_web_dialog_prompt_hook_set()
*
* @ingroup Web
*/
typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, const char **value, Eina_Bool *ret);
@ -252,8 +245,6 @@ typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, cons
* If the function returns @c NULL the popup will be ignored.
*
* @see elm_web_dialog_file selector_hook_set()
*
* @ingroup Web
*/
typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret);
@ -271,8 +262,6 @@ typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *ob
* @param source_id Source id.
*
* @see elm_web_console_message_hook_set()
*
* @ingroup Web
*/
typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
@ -284,8 +273,6 @@ typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char
* @param flag The web window feature flag whose value is required.
*
* @return @c EINA_TRUE if the flag is set, @c EINA_FALSE otherwise
*
* @ingroup Web
*/
EAPI Eina_Bool elm_web_window_features_property_get(const Elm_Web_Window_Features *wf, Elm_Web_Window_Feature_Flag flag);
@ -295,10 +282,12 @@ EAPI Eina_Bool elm_web_window_features_property_get(const Elm_Web_W
*
* @param wf The web window features object
* @param x, y, w, h - the co-ordinates of the web view window.
*
* @ingroup Web
*/
EAPI void elm_web_window_features_region_get(const Elm_Web_Window_Features *wf, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h);
EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
/**
* @}
*/

11
legacy/elementary/src/lib/elm_win_common.h
View File

@ -1,3 +1,9 @@
/**
* @addtogroup Win
*
* @{
*/
/**
* Defines the types of window that can be created
*
@ -110,7 +116,6 @@ typedef enum
/**
* Defines the opacity modes of indicator that can be shown
*/
typedef enum
{
ELM_WIN_INDICATOR_OPACITY_UNKNOWN, /**< Unknown indicator opacity mode */
@ -200,4 +205,6 @@ struct _Elm_Win_Trap
*/
EAPI Eina_Bool elm_win_trap_set(const Elm_Win_Trap *trap);
/**
* @}
*/