1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
#ifndef _ELM_HOVERSEL_EO_H_
#define _ELM_HOVERSEL_EO_H_
#ifndef _ELM_HOVERSEL_EO_CLASS_TYPE
#define _ELM_HOVERSEL_EO_CLASS_TYPE
typedef Eo Elm_Hoversel;
#endif
#ifndef _ELM_HOVERSEL_EO_TYPES
#define _ELM_HOVERSEL_EO_TYPES
#endif
/** Elementary hoversel class
*
* @ingroup Elm_Hoversel
*/
#define ELM_HOVERSEL_CLASS elm_hoversel_class_get()
EWAPI const Efl_Class *elm_hoversel_class_get(void) EINA_CONST;
/**
* @brief Control if the hoversel should expand horizontally.
*
* @note The initial button will display horizontally regradless of this
* setting.
*
* @param[in] obj The object.
* @param[in] horizontal If @c true, the hover will expand horizontally to the
* right.
*
* @ingroup Elm_Hoversel
*/
EOAPI void elm_obj_hoversel_horizontal_set(Eo *obj, Eina_Bool horizontal);
/**
* @brief Control if the hoversel should expand horizontally.
*
* @note The initial button will display horizontally regradless of this
* setting.
*
* @param[in] obj The object.
*
* @return If @c true, the hover will expand horizontally to the right.
*
* @ingroup Elm_Hoversel
*/
EOAPI Eina_Bool elm_obj_hoversel_horizontal_get(const Eo *obj);
/**
* @brief Control the hover parent.
*
* Sets the hover parent object, the area that will be darkened when the
* hoversel is clicked. Should probably be the window that the hoversel is in.
*
* @param[in] obj The object.
* @param[in] parent The parent to use
*
* @ingroup Elm_Hoversel
*/
EOAPI void elm_obj_hoversel_hover_parent_set(Eo *obj, Efl_Canvas_Object *parent);
/**
* @brief Control the hover parent.
*
* Sets the hover parent object, the area that will be darkened when the
* hoversel is clicked. Should probably be the window that the hoversel is in.
*
* @param[in] obj The object.
*
* @return The parent to use
*
* @ingroup Elm_Hoversel
*/
EOAPI Efl_Canvas_Object *elm_obj_hoversel_hover_parent_get(const Eo *obj);
/**
* @brief Returns whether the hoversel is expanded.
*
* @param[in] obj The object.
*
* @return @c true if the hoversel is expanded or @c false otherwise
*
* @ingroup Elm_Hoversel
*/
EOAPI Eina_Bool elm_obj_hoversel_expanded_get(const Eo *obj);
/**
* @brief Get the list of items within the given hoversel.
*
* @param[in] obj The object.
*
* @return List of items
*
* @ingroup Elm_Hoversel
*/
EOAPI const Eina_List *elm_obj_hoversel_items_get(const Eo *obj);
/**
* @brief Update icon and text of hoversel same to those of selected item
* automatically.
*
* @param[in] obj The object.
* @param[in] auto_update @c true if hoversel is updated automatically or
* @c false otherwise
*
* @ingroup Elm_Hoversel
*/
EOAPI void elm_obj_hoversel_auto_update_set(Eo *obj, Eina_Bool auto_update);
/**
* @brief Update icon and text of hoversel same to those of selected item
* automatically.
*
* @param[in] obj The object.
*
* @return @c true if hoversel is updated automatically or @c false otherwise
*
* @ingroup Elm_Hoversel
*/
EOAPI Eina_Bool elm_obj_hoversel_auto_update_get(const Eo *obj);
/** This triggers the hoversel popup from code, the same as if the user had
* clicked the button.
*
* @ingroup Elm_Hoversel
*/
EOAPI void elm_obj_hoversel_hover_begin(Eo *obj);
/**
* @brief This will remove all the children items from the hoversel.
*
* Warning Should *not* be called while the hoversel is active; use
* @ref elm_obj_hoversel_expanded_get to check first.
* @param[in] obj The object.
*
* @ingroup Elm_Hoversel
*/
EOAPI void elm_obj_hoversel_clear(Eo *obj);
/** This dismisses the hoversel popup as if the user had clicked outside the
* hover.
*
* @ingroup Elm_Hoversel
*/
EOAPI void elm_obj_hoversel_hover_end(Eo *obj);
/**
* @brief Add an item to the hoversel button
*
* This adds an item to the hoversel to show when it is clicked. Note: if you
* need to use an icon from an edje file then use Elm.Hoversel.Item.icon.set
* right after this function, and set icon_file to @c null here.
*
* @param[in] obj The object.
* @param[in] label The text label to use for the item (NULL if not desired)
* @param[in] icon_file An image file path on disk to use for the icon or
* standard icon name (NULL if not desired)
* @param[in] icon_type The icon type if relevant
* @param[in] func Convenience function to call when this item is selected. The
* last parameter @c event_info of @c func is the selected item pointer.
* @param[in] data Data to pass to item-related functions
*
* @return A handle to the added item.
*
* @ingroup Elm_Hoversel
*/
EOAPI Elm_Widget_Item *elm_obj_hoversel_item_add(Eo *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data);
EWAPI extern const Efl_Event_Description _ELM_HOVERSEL_EVENT_DISMISSED;
/** Called when hoversel is dismissed
*
* @ingroup Elm_Hoversel
*/
#define ELM_HOVERSEL_EVENT_DISMISSED (&(_ELM_HOVERSEL_EVENT_DISMISSED))
EWAPI extern const Efl_Event_Description _ELM_HOVERSEL_EVENT_EXPANDED;
/** Called when hoversel is expanded
*
* @ingroup Elm_Hoversel
*/
#define ELM_HOVERSEL_EVENT_EXPANDED (&(_ELM_HOVERSEL_EVENT_EXPANDED))
EWAPI extern const Efl_Event_Description _ELM_HOVERSEL_EVENT_ITEM_FOCUSED;
/** Called when hoversel item got focus
* @return Efl_Object *
*
* @ingroup Elm_Hoversel
*/
#define ELM_HOVERSEL_EVENT_ITEM_FOCUSED (&(_ELM_HOVERSEL_EVENT_ITEM_FOCUSED))
EWAPI extern const Efl_Event_Description _ELM_HOVERSEL_EVENT_ITEM_UNFOCUSED;
/** Called when hoversel item lost focus
* @return Efl_Object *
*
* @ingroup Elm_Hoversel
*/
#define ELM_HOVERSEL_EVENT_ITEM_UNFOCUSED (&(_ELM_HOVERSEL_EVENT_ITEM_UNFOCUSED))
#endif
|
