summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Juyung Seo <seojuyung2@gmail.com>2014-11-21 16:28:39 +0900
committerDaniel Juyung Seo <seojuyung2@gmail.com>2014-11-22 00:38:44 +0900
commitf3f09ea2e566ae5c726529b976a96afbf7298189 (patch)
treedbf7d2577cb5844964701c2150db6b4d60c943eb
parentdd914ef0336ebdbe4024d6d365ad234b41c95b12 (diff)
colorselector, entry, flip: Fix and clean up doxygen documentation.
-rw-r--r--src/lib/elm_colorselector_common.h22
-rw-r--r--src/lib/elm_entry_common.h57
-rw-r--r--src/lib/elm_flip_common.h10
3 files changed, 35 insertions, 54 deletions
diff --git a/src/lib/elm_colorselector_common.h b/src/lib/elm_colorselector_common.h
index 00445bce5..18515d2f4 100644
--- a/src/lib/elm_colorselector_common.h
+++ b/src/lib/elm_colorselector_common.h
@@ -1,20 +1,28 @@
1typedef struct _Elm_Color_RGBA 1/**
2 * @addtogroup Colorselector
3 *
4 * @{
5 */
6
7typedef struct _Elm_Color_RGBA Elm_Color_RGBA;
8struct _Elm_Color_RGBA
2{ 9{
3 unsigned int r; 10 unsigned int r;
4 unsigned int g; 11 unsigned int g;
5 unsigned int b; 12 unsigned int b;
6 unsigned int a; 13 unsigned int a;
7} Elm_Color_RGBA; 14};
8 15
9typedef struct _Elm_Custom_Palette 16
17typedef struct _Elm_Custom_Palette Elm_Custom_Palette;
18struct _Elm_Custom_Palette
10{ 19{
11 const char *palette_name; 20 const char *palette_name;
12 Eina_List *color_list; 21 Eina_List *color_list;
13} Elm_Custom_Palette; 22};
14 23
15/** 24/**
16 * @enum Elm_Colorselector_Mode 25 * @enum Elm_Colorselector_Mode
17 * @typedef Elm_Colorselector_Mode
18 * 26 *
19 * Different modes supported by Colorselector 27 * Different modes supported by Colorselector
20 * 28 *
@@ -37,3 +45,7 @@ EAPI void elm_colorselector_palette_item_color_set(Elm_Object_Item *it, int r, i
37EAPI Eina_Bool elm_colorselector_palette_item_selected_get(const Elm_Object_Item *it); 45EAPI Eina_Bool elm_colorselector_palette_item_selected_get(const Elm_Object_Item *it);
38 46
39EAPI void elm_colorselector_palette_item_selected_set(Elm_Object_Item *it, Eina_Bool selected); 47EAPI void elm_colorselector_palette_item_selected_set(Elm_Object_Item *it, Eina_Bool selected);
48
49/**
50 * @}
51 */
diff --git a/src/lib/elm_entry_common.h b/src/lib/elm_entry_common.h
index 4b5215d36..48a9e8b56 100644
--- a/src/lib/elm_entry_common.h
+++ b/src/lib/elm_entry_common.h
@@ -1,6 +1,10 @@
1/** 1/**
2 * @typedef Elm_Text_Format 2 * @addtogroup Entry
3 * 3 *
4 * @{
5 */
6
7/**
4 * Text Format types. 8 * Text Format types.
5 * 9 *
6 * @see elm_entry_file_set() 10 * @see elm_entry_file_set()
@@ -12,8 +16,6 @@ typedef enum
12} Elm_Text_Format; 16} Elm_Text_Format;
13 17
14/** 18/**
15 * @typedef Elm_Wrap_Type
16 *
17 * Line wrapping types. 19 * Line wrapping types.
18 * 20 *
19 * @see elm_entry_line_wrap_set() 21 * @see elm_entry_line_wrap_set()
@@ -28,8 +30,6 @@ typedef enum
28} Elm_Wrap_Type; /**< Type of word or character wrapping to use */ 30} Elm_Wrap_Type; /**< Type of word or character wrapping to use */
29 31
30/** 32/**
31 * @typedef Elm_Input_Panel_Layout
32 *
33 * Input panel (virtual keyboard) layout types. 33 * Input panel (virtual keyboard) layout types.
34 * 34 *
35 * @see elm_entry_input_panel_layout_set() 35 * @see elm_entry_input_panel_layout_set()
@@ -74,8 +74,6 @@ enum
74}; 74};
75 75
76/** 76/**
77 * @typedef Elm_Input_Panel_Lang
78 *
79 * Input panel (virtual keyboard) language modes. 77 * Input panel (virtual keyboard) language modes.
80 * 78 *
81 * @see elm_entry_input_panel_language_set() 79 * @see elm_entry_input_panel_language_set()
@@ -87,8 +85,6 @@ typedef enum
87} Elm_Input_Panel_Lang; 85} Elm_Input_Panel_Lang;
88 86
89/** 87/**
90 * @typedef Elm_Autocapital_Type
91 *
92 * Autocapitalization Types. 88 * Autocapitalization Types.
93 * 89 *
94 * @see elm_entry_autocapital_type_set() 90 * @see elm_entry_autocapital_type_set()
@@ -102,8 +98,6 @@ typedef enum
102} Elm_Autocapital_Type; /**< Choose method of auto-capitalization */ 98} Elm_Autocapital_Type; /**< Choose method of auto-capitalization */
103 99
104/** 100/**
105 * @typedef Elm_Input_Panel_Return_Key_Type
106 *
107 * "Return" Key types on the input panel (virtual keyboard). 101 * "Return" Key types on the input panel (virtual keyboard).
108 * 102 *
109 * @see elm_entry_input_panel_return_key_type_set() 103 * @see elm_entry_input_panel_return_key_type_set()
@@ -122,7 +116,6 @@ typedef enum
122} Elm_Input_Panel_Return_Key_Type; 116} Elm_Input_Panel_Return_Key_Type;
123 117
124/** 118/**
125 * @typedef Elm_Input_Hints
126 * @brief Enumeration that defines the types of Input Hints. 119 * @brief Enumeration that defines the types of Input Hints.
127 * @since 1.12 120 * @since 1.12
128 */ 121 */
@@ -134,16 +127,12 @@ typedef enum
134} Elm_Input_Hints; 127} Elm_Input_Hints;
135 128
136/** 129/**
137 * @typedef Elm_Entry_Anchor_Info
138 *
139 * The info sent in the callback for the "anchor,clicked" signals emitted 130 * The info sent in the callback for the "anchor,clicked" signals emitted
140 * by entries. 131 * by entries.
141 */ 132 */
142typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info; 133typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
143 134
144/** 135/**
145 * @struct _Elm_Entry_Anchor_Info
146 *
147 * The info sent in the callback for the "anchor,clicked" signals emitted 136 * The info sent in the callback for the "anchor,clicked" signals emitted
148 * by entries. 137 * by entries.
149 */ 138 */
@@ -158,24 +147,18 @@ struct _Elm_Entry_Anchor_Info
158}; 147};
159 148
160/** 149/**
161 * @typedef Elm_Entry_Anchor_Hover_Info
162 *
163 * The info sent in the callback for "anchor,clicked" signals emitted by 150 * The info sent in the callback for "anchor,clicked" signals emitted by
164 * the Anchor_Hover widget. 151 * the Anchor_Hover widget.
165 */ 152 */
166typedef struct _Elm_Entry_Anchor_Hover_Info Elm_Entry_Anchor_Hover_Info; 153typedef struct _Elm_Entry_Anchor_Hover_Info Elm_Entry_Anchor_Hover_Info;
167 154
168/** 155/**
169 * @typedef Elm_Entry_Context_Menu_Item
170 *
171 * Type of contextual item that can be added in to long press menu. 156 * Type of contextual item that can be added in to long press menu.
172 * @since 1.8 157 * @since 1.8
173 */ 158 */
174typedef struct _Elm_Entry_Context_Menu_Item Elm_Entry_Context_Menu_Item; 159typedef struct _Elm_Entry_Context_Menu_Item Elm_Entry_Context_Menu_Item;
175 160
176/** 161/**
177 * @struct _Elm_Entry_Anchor_Hover_Info
178 *
179 * The info sent in the callback for "anchor,clicked" signals emitted by 162 * The info sent in the callback for "anchor,clicked" signals emitted by
180 * the Anchor_Hover widget. 163 * the Anchor_Hover widget.
181 */ 164 */
@@ -209,7 +192,6 @@ struct _Elm_Entry_Anchor_Hover_Info
209}; 192};
210 193
211/** 194/**
212 * @typedef Elm_Entry_Item_Provider_Cb
213 * This callback type is used to provide items. 195 * This callback type is used to provide items.
214 * If it returns an object handle other than NULL (it should create an 196 * If it returns an object handle other than NULL (it should create an
215 * object to do this), then this object is used to replace the current item. 197 * object to do this), then this object is used to replace the current item.
@@ -226,7 +208,6 @@ struct _Elm_Entry_Anchor_Hover_Info
226typedef Evas_Object * (*Elm_Entry_Item_Provider_Cb)(void *data, Evas_Object * entry, const char *item); 208typedef Evas_Object * (*Elm_Entry_Item_Provider_Cb)(void *data, Evas_Object * entry, const char *item);
227 209
228/** 210/**
229 * @typedef Elm_Entry_Filter_Cb
230 * This callback type is used by entry filters to modify text. 211 * This callback type is used by entry filters to modify text.
231 * @param data The data specified as the last param when adding the filter 212 * @param data The data specified as the last param when adding the filter
232 * @param entry The entry object 213 * @param entry The entry object
@@ -238,7 +219,6 @@ typedef Evas_Object * (*Elm_Entry_Item_Provider_Cb)(void *data, Evas_Object * en
238typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text); 219typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
239 220
240/** 221/**
241 * @typedef Elm_Entry_Change_Info
242 * This corresponds to Edje_Entry_Change_Info. Includes information about 222 * This corresponds to Edje_Entry_Change_Info. Includes information about
243 * a change in the entry. 223 * a change in the entry.
244 */ 224 */
@@ -252,8 +232,6 @@ typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
252 * 232 *
253 * @param s The string (in markup) to be converted 233 * @param s The string (in markup) to be converted
254 * @return The converted string (in UTF-8). It should be freed. 234 * @return The converted string (in UTF-8). It should be freed.
255 *
256 * @ingroup Entry
257 */ 235 */
258EAPI char *elm_entry_markup_to_utf8(const char *s); 236EAPI char *elm_entry_markup_to_utf8(const char *s);
259 237
@@ -270,8 +248,6 @@ EAPI char *elm_entry_markup_to_utf8(const char *s);
270 * "&lt;align=center&gt;hello&lt;/align&gt; &amp;gt;". This is useful when you 248 * "&lt;align=center&gt;hello&lt;/align&gt; &amp;gt;". This is useful when you
271 * want to display "&" in label, entry, and some widgets which use textblock 249 * want to display "&" in label, entry, and some widgets which use textblock
272 * internally. 250 * internally.
273 *
274 * @ingroup Entry
275 */ 251 */
276EAPI char *elm_entry_utf8_to_markup(const char *s); 252EAPI char *elm_entry_utf8_to_markup(const char *s);
277 253
@@ -280,15 +256,11 @@ EAPI char *elm_entry_utf8_to_markup(const char *s);
280/* pre-made filters for entries */ 256/* pre-made filters for entries */
281 257
282/** 258/**
283 * @typedef Elm_Entry_Filter_Limit_Size
284 *
285 * Data for the elm_entry_filter_limit_size() entry filter. 259 * Data for the elm_entry_filter_limit_size() entry filter.
286 */ 260 */
287typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size; 261typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
288 262
289/** 263/**
290 * @struct _Elm_Entry_Filter_Limit_Size
291 *
292 * Data for the elm_entry_filter_limit_size() entry filter. 264 * Data for the elm_entry_filter_limit_size() entry filter.
293 */ 265 */
294struct _Elm_Entry_Filter_Limit_Size 266struct _Elm_Entry_Filter_Limit_Size
@@ -320,21 +292,15 @@ struct _Elm_Entry_Filter_Limit_Size
320 * 292 *
321 * This filter, like any others, does not apply when setting the entry text 293 * This filter, like any others, does not apply when setting the entry text
322 * directly with elm_object_text_set(). 294 * directly with elm_object_text_set().
323 *
324 * @ingroup Entry
325 */ 295 */
326EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text); 296EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text);
327 297
328/** 298/**
329 * @typedef Elm_Entry_Filter_Accept_Set
330 *
331 * Data for the elm_entry_filter_accept_set() entry filter. 299 * Data for the elm_entry_filter_accept_set() entry filter.
332 */ 300 */
333typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set; 301typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
334 302
335/** 303/**
336 * @struct _Elm_Entry_Filter_Accept_Set
337 *
338 * Data for the elm_entry_filter_accept_set() entry filter. 304 * Data for the elm_entry_filter_accept_set() entry filter.
339 */ 305 */
340struct _Elm_Entry_Filter_Accept_Set 306struct _Elm_Entry_Filter_Accept_Set
@@ -361,13 +327,10 @@ struct _Elm_Entry_Filter_Accept_Set
361 * 327 *
362 * This filter, like any others, does not apply when setting the entry text 328 * This filter, like any others, does not apply when setting the entry text
363 * directly with elm_object_text_set() 329 * directly with elm_object_text_set()
364 *
365 * @ingroup Entry
366 */ 330 */
367EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text); 331EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text);
368 332
369/** 333/**
370 * @typedef Elm_Cnp_Mode
371 * Enum of entry's copy & paste policy. 334 * Enum of entry's copy & paste policy.
372 * 335 *
373 * @see elm_entry_cnp_mode_set() 336 * @see elm_entry_cnp_mode_set()
@@ -380,22 +343,17 @@ typedef enum {
380} Elm_Cnp_Mode; 343} Elm_Cnp_Mode;
381 344
382/** 345/**
383 * Get the text of the contextual menu item.
384 *
385 * Get the text of the contextual menu item of entry. 346 * Get the text of the contextual menu item of entry.
386 * 347 *
387 * @param item The item to get the label 348 * @param item The item to get the label
388 * @return The text of contextual menu item 349 * @return The text of contextual menu item
389 * 350 *
390 * @see elm_entry_context_menu_item_add() 351 * @see elm_entry_context_menu_item_add()
391 * @ingroup Entry
392 * @since 1.8 352 * @since 1.8
393 */ 353 */
394EAPI const char *elm_entry_context_menu_item_label_get(const Elm_Entry_Context_Menu_Item *item); 354EAPI const char *elm_entry_context_menu_item_label_get(const Elm_Entry_Context_Menu_Item *item);
395 355
396/** 356/**
397 * Get the icon object of the contextual menu item.
398 *
399 * Get the icon object packed in the contextual menu item of entry. 357 * Get the icon object packed in the contextual menu item of entry.
400 * 358 *
401 * @param item The item to get the icon from 359 * @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
406 * @param icon_type The icon type 364 * @param icon_type The icon type
407 * 365 *
408 * @see elm_entry_context_menu_item_add() 366 * @see elm_entry_context_menu_item_add()
409 * @ingroup Entry
410 * @since 1.8 367 * @since 1.8
411 */ 368 */
412EAPI 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); 369EAPI 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);
413 370
371
372/**
373 * @}
374 */
diff --git a/src/lib/elm_flip_common.h b/src/lib/elm_flip_common.h
index 00add71b6..eb81d2ee0 100644
--- a/src/lib/elm_flip_common.h
+++ b/src/lib/elm_flip_common.h
@@ -1,3 +1,6 @@
1/**
2 * @ingroup Flip
3 */
1typedef enum 4typedef enum
2{ 5{
3 ELM_FLIP_ROTATE_Y_CENTER_AXIS, 6 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
@@ -14,6 +17,9 @@ typedef enum
14 ELM_FLIP_PAGE_DOWN 17 ELM_FLIP_PAGE_DOWN
15} Elm_Flip_Mode; 18} Elm_Flip_Mode;
16 19
20/**
21 * @ingroup Flip
22 */
17typedef enum 23typedef enum
18{ 24{
19 ELM_FLIP_INTERACTION_NONE, 25 ELM_FLIP_INTERACTION_NONE,
@@ -22,6 +28,9 @@ typedef enum
22 ELM_FLIP_INTERACTION_PAGE 28 ELM_FLIP_INTERACTION_PAGE
23} Elm_Flip_Interaction; 29} Elm_Flip_Interaction;
24 30
31/**
32 * @ingroup Flip
33 */
25typedef enum 34typedef enum
26{ 35{
27 ELM_FLIP_DIRECTION_UP = 0, /**< Allows interaction with the top of the widget */ 36 ELM_FLIP_DIRECTION_UP = 0, /**< Allows interaction with the top of the widget */
@@ -29,4 +38,3 @@ typedef enum
29 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */ 38 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
30 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */ 39 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
31} Elm_Flip_Direction; 40} Elm_Flip_Direction;
32