summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Hacohen <tom@stosb.com>2015-08-06 14:47:09 +0100
committerTom Hacohen <tom@stosb.com>2015-08-06 14:47:09 +0100
commit3403056898a492fc14d8e712f660465ee5943286 (patch)
tree317a6c3fbf961221513f14245620b503c7840d17
parent48bdd7125acca41fb8fcef814e58f918a5229424 (diff)
Hoversel: migrate docs.
-rw-r--r--src/lib/elm_hoversel.eo141
1 files changed, 36 insertions, 105 deletions
diff --git a/src/lib/elm_hoversel.eo b/src/lib/elm_hoversel.eo
index 59b9beed9..324b4dad5 100644
--- a/src/lib/elm_hoversel.eo
+++ b/src/lib/elm_hoversel.eo
@@ -5,154 +5,85 @@ class Elm.Hoversel (Elm.Button, Evas.Selectable_Interface,
5 eo_prefix: elm_obj_hoversel; 5 eo_prefix: elm_obj_hoversel;
6 methods { 6 methods {
7 @property horizontal { 7 @property horizontal {
8 set { 8 [[Control if the hoversel should expand horizontally.
9 /*@
10 @brief This sets the hoversel to expand horizontally.
11
12 @note The initial button will display horizontally regardless of this
13 setting.
14 9
15 @ingroup Hoversel */ 10 Note: The initial button will display horizontally regradless of this setting.]]
11 set {
16 } 12 }
17 get { 13 get {
18 /*@
19 @brief This returns whether the hoversel is set to expand horizontally.
20
21 @return If true, the hover will expand horizontally to the right.
22
23 @see elm_hoversel_horizontal_set()
24
25 @ingroup Hoversel */
26 } 14 }
27 values { 15 values {
28 horizontal: bool; /*@ If true, the hover will expand horizontally to the 16 horizontal: bool; [[If $true, the hover will expand horizontally to the right.]]
29 right. */
30 } 17 }
31 } 18 }
32 @property hover_parent { 19 @property hover_parent {
33 set { 20 [[Control the hover parent.
34 /*@
35 @brief Set the Hover parent
36
37 Sets the hover parent object, the area that will be darkened when the
38 hoversel is clicked. Should probably be the window that the hoversel is
39 in. See @ref Hover objects for more information.
40 21
41 @ingroup Hoversel */ 22 Sets the hover parent object, the area that will be darkened when the
23 hoversel is clicked. Should probably be the window that the hoversel is
24 in.]]
25 set {
42 } 26 }
43 get { 27 get {
44 /*@
45 @brief Get the Hover parent
46
47 @return The used parent
48
49 Get the hover parent object.
50
51 @see elm_hoversel_hover_parent_set()
52
53 @ingroup Hoversel */
54 } 28 }
55 values { 29 values {
56 parent: Evas.Object * @nullable; /*@ The parent to use */ 30 parent: Evas.Object * @nullable; [[The parent to use]]
57 } 31 }
58 } 32 }
59 @property expanded { 33 @property expanded {
60 get { 34 get {
61 /*@ 35 [[Returns whether the hoversel is expanded.]]
62 @brief Returns whether the hoversel is expanded. 36 return: bool; [[$true if the hoversel is expanded or $false otherwise]]
63
64 @return This will return @c EINA_TRUE if the hoversel is expanded or
65 @c EINA_FALSE if it is not expanded.
66
67 @ingroup Hoversel */
68 return: bool;
69 } 37 }
70 } 38 }
71 @property items { 39 @property items {
72 get { 40 get {
73 /*@ 41 [[Get the list of items within the given hoversel.]]
74 @brief Get the list of items within the given hoversel.
75
76 @return Returns a list of Elm.Widget_Item
77
78 @see elm_hoversel_item_add()
79
80 @ingroup Hoversel */
81 return: const(list<Elm.Widget_Item *>)*; 42 return: const(list<Elm.Widget_Item *>)*;
82 } 43 }
83 } 44 }
84 @property scroll_enabled { 45 @property scroll_enabled {
85 get { 46 [[Control wether scrolling is enabled.
86 /*@
87 @brief Limit the size of contents and make them scrollable.
88 47
89 @ingroup Hoversel */ 48 This Limit the size of contents and make them scrollable.]]
49 get {
90 } 50 }
91 set { 51 set {
92 /*@
93 @brief Returns whether the contents of hoversel are scrollable or not.
94
95 @return @c EINA_TRUE scrollable. @c EINA_FALSE otherwise.
96
97 @ingroup Hoversel */
98 } 52 }
99 values { 53 values {
100 scroll_enabled: bool; 54 scroll_enabled: bool; [[$true if scrollable $false otherwise.]]
101 } 55 }
102 } 56 }
103 hover_begin { 57 hover_begin {
104 /*@ 58 [[This triggers the hoversel popup from code, the same as if the user had clicked the button.]]
105 @brief This triggers the hoversel popup from code, the same as if the user
106 had clicked the button.
107
108 @ingroup Hoversel */
109
110 } 59 }
111 clear { 60 clear {
112 /*@ 61 [[This will remove all the children items from the hoversel.
113 @brief This will remove all the children items from the hoversel.
114
115 @warning Should @b not be called while the hoversel is active; use
116 elm_hoversel_expanded_get() to check first.
117
118 @see elm_object_item_del()
119
120 @ingroup Hoversel */
121 62
63 Warning Should *not* be called while the hoversel is active; use
64 @Elm.Hoversel.expanded.get to check first.]]
122 } 65 }
123 hover_end { 66 hover_end {
124 /*@ 67 [[This dismisses the hoversel popup as if the user had clicked outside the hover.]]
125 @brief This dismisses the hoversel popup as if the user had clicked
126 outside the hover.
127
128 @ingroup Hoversel */
129
130 } 68 }
131 item_add { 69 item_add {
132 /*@ 70 [[Add an item to the hoversel button
133 @brief Add an item to the hoversel button
134
135 @return A handle to the item added.
136
137 This adds an item to the hoversel to show when it is clicked. Note: if you
138 need to use an icon from an edje file then use
139 elm_hoversel_item_icon_set() right after this function, and set
140 icon_file to NULL here.
141
142 For more information on what @p icon_file and @p icon_type are, see the
143 @ref Icon "icon documentation".
144 71
145 @ingroup Hoversel */ 72 This adds an item to the hoversel to show when it is clicked. Note: if you
73 need to use an icon from an edje file then use Elm.Hoversel_Item.icon.set
74 right after this function, and set icon_file to $null here.]]
146 75
147 return: Elm.Widget_Item *; 76 /* FIXME: Make the hoversel_item reference in the doc a real ref. */
77 /* FIXME-doc
78 For more information on what @p icon_file and @p icon_type are, see the
79 @ref Icon "icon documentation". */
80 return: Elm.Widget_Item *; [[A handle to the added item.]]
148 params { 81 params {
149 @in label: const(char)* @optional; /*@ The text label to use for the item (NULL if not desired) */ 82 @in label: const(char)* @optional; [[The text label to use for the item (NULL if not desired)]]
150 @in icon_file: const(char)* @optional; /*@ An image file path on disk to use for the icon or standard 83 @in icon_file: const(char)* @optional; [[An image file path on disk to use for the icon or standard icon name (NULL if not desired)]]
151 icon name (NULL if not desired) */ 84 @in icon_type: Elm_Icon_Type; [[The icon type if relevant]]
152 @in icon_type: Elm_Icon_Type; /*@ The icon type if relevant */ 85 @in func: Evas_Smart_Cb @optional; [[Convenience function to call when this item is selected. The last parameter $event_info of $func is the selected item pointer.]]
153 @in func: Evas_Smart_Cb @optional; /*@ Convenience function to call when this item is selected. The last 86 @in data: const(void)* @optional; [[Data to pass to item-related functions]]
154 parameter @p event_info of @c func is the selected item pointer. */
155 @in data: const(void)* @optional; /*@ Data to pass to item-related functions */
156 } 87 }
157 } 88 }
158 } 89 }