/usr/include/elementary-1/elm_toolbar_common.h is in libelementary-dev 1.8.5-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 | /**
* @enum Elm_Toolbar_Shrink_Mode
* @typedef Elm_Toolbar_Shrink_Mode
*
* Set toolbar's items display behavior, it can be scrollable,
* show a menu with exceeding items, or simply hide them.
*
* @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
* from elm config.
*
* Values <b> don't </b> work as bitmask, only one can be chosen.
*
* @see elm_toolbar_shrink_mode_set()
* @see elm_toolbar_shrink_mode_get()
*
* @ingroup Toolbar
*/
typedef enum
{
ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimum size to fit all the items. */
ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
ELM_TOOLBAR_SHRINK_EXPAND, /**< Expand all items according the size of the toolbar. */
ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
} Elm_Toolbar_Shrink_Mode;
/**
* Defines where to position the item in the toolbar.
*
* @ingroup Toolbar
*/
typedef enum
{
ELM_TOOLBAR_ITEM_SCROLLTO_NONE = 0, /**< no scrollto */
ELM_TOOLBAR_ITEM_SCROLLTO_IN = (1 << 0), /**< to the nearest viewport */
ELM_TOOLBAR_ITEM_SCROLLTO_FIRST = (1 << 1), /**< to the first of viewport */
ELM_TOOLBAR_ITEM_SCROLLTO_MIDDLE = (1 << 2), /**< to the middle of viewport */
ELM_TOOLBAR_ITEM_SCROLLTO_LAST = (1 << 3) /**< to the last of viewport */
} Elm_Toolbar_Item_Scrollto_Type;
typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /**< State of a Elm_Toolbar_Item. Can be created with elm_toolbar_item_state_add() and removed with elm_toolbar_item_state_del(). */
/**
* Get the item after @p item in toolbar.
*
* @param it The toolbar item.
* @return The item after @p item, or @c NULL if none or on failure.
*
* @note If it is the last item, @c NULL will be returned.
*
* @see elm_toolbar_item_append()
*
* @ingroup Toolbar
*/
EAPI Elm_Object_Item *elm_toolbar_item_next_get(const Elm_Object_Item *it);
/**
* Get the item before @p item in toolbar.
*
* @param it The toolbar item.
* @return The item before @p item, or @c NULL if none or on failure.
*
* @note If it is the first item, @c NULL will be returned.
*
* @see elm_toolbar_item_prepend()
*
* @ingroup Toolbar
*/
EAPI Elm_Object_Item *elm_toolbar_item_prev_get(const Elm_Object_Item *it);
/**
* Set the priority of a toolbar item.
*
* @param it The toolbar item.
* @param priority The item priority. The default is zero.
*
* This is used only when the toolbar shrink mode is set
* to #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
* When space is less than required, items with low priority
* will be removed from the toolbar and added to a dynamically-created menu,
* while items with higher priority will remain on the toolbar,
* with the same order they were added.
*
* @see elm_toolbar_item_priority_get()
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_priority_set(Elm_Object_Item *it, int priority);
/**
* Get the priority of a toolbar item.
*
* @param it The toolbar item.
* @return The @p item priority, or @c 0 on failure.
*
* @see elm_toolbar_item_priority_set() for details.
*
* @ingroup Toolbar
*/
EAPI int elm_toolbar_item_priority_get(const Elm_Object_Item *it);
/**
* Get whether the @p item is selected or not.
*
* @param it The toolbar item.
* @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
* it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
*
* @see elm_toolbar_selected_item_set() for details.
* @see elm_toolbar_item_selected_get()
*
* @ingroup Toolbar
*/
EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Object_Item *it);
/**
* Set the selected state of an item.
*
* @param it The toolbar item
* @param selected The selected state
*
* This sets the selected state of the given item @p it.
* @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
*
* If a new item is selected the previously selected will be unselected.
* Previously selected item can be get with function
* elm_toolbar_selected_item_get().
*
* Selected items will be highlighted.
*
* @see elm_toolbar_item_selected_get()
* @see elm_toolbar_selected_item_get()
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_selected_set(Elm_Object_Item *it, Eina_Bool selected);
/**
* Set the icon associated with @p item.
*
* @param it The toolbar item.
* @param icon A string with icon name or the absolute path of an image file.
*
* Toolbar will load icon image from fdo or current theme.
* This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
* If an absolute path is provided it will load it direct from a file.
*
* @note This function does not accept relative icon path.
*
* @see elm_toolbar_icon_order_lookup_set()
* @see elm_toolbar_icon_order_lookup_get()
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_icon_set(Elm_Object_Item *it, const char *icon);
/**
* Get the string used to set the icon of @p item.
*
* @param it The toolbar item.
* @return The string associated with the icon object.
*
* @see elm_toolbar_item_icon_set() for details.
*
* @ingroup Toolbar
*/
EAPI const char *elm_toolbar_item_icon_get(const Elm_Object_Item *it);
/**
* Get the real Evas(Edje) object created to implement the view of a given
* toolbar @p item.
*
* @param it The toolbar item.
* @return The base Edje object associated with @p it.
*
* @ingroup Toolbar
*/
EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Object_Item *it);
/**
* Get the icon object of @p item.
*
* @param it The toolbar item.
* @return The icon object
*
* @see elm_toolbar_item_icon_set(), elm_toolbar_item_icon_file_set(),
* or elm_toolbar_item_icon_memfile_set() for details.
*
* @ingroup Toolbar
*/
EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Object_Item *it);
/**
* Set the icon associated with @p item to an image in a binary buffer.
*
* @param it The toolbar item.
* @param img The binary data that will be used as an image
* @param size The size of binary data @p img
* @param format Optional format of @p img to pass to the image loader
* @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
*
* @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
*
* @note The icon image set by this function can be changed by
* elm_toolbar_item_icon_set().
*
* @ingroup Toolbar
*/
EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Object_Item *it, const void *img, size_t size, const char *format, const char *key);
/**
* Set the icon associated with @p item to an image in a binary buffer.
*
* @param it The toolbar item.
* @param file The file that contains the image
* @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
*
* @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
*
* @note The icon image set by this function can be changed by
* elm_toolbar_item_icon_set().
*
* @ingroup Toolbar
*/
EAPI Eina_Bool elm_toolbar_item_icon_file_set(Elm_Object_Item *it, const char *file, const char *key);
/**
* Set or unset item as a separator.
*
* @param it The toolbar item.
* @param separator @c EINA_TRUE to set item @p item as separator or
* @c EINA_FALSE to unset, i.e., item will be used as a regular item.
*
* Items aren't set as separator by default.
*
* If set as separator it will display separator theme, so won't display
* icons or label.
*
* @see elm_toolbar_item_separator_get()
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_separator_set(Elm_Object_Item *it, Eina_Bool separator);
/**
* Get a value whether item is a separator or not.
*
* @param it The toolbar item.
* @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
* indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
*
* @see elm_toolbar_item_separator_set() for details.
*
* @ingroup Toolbar
*/
EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Object_Item *it);
/**
* Set whether the toolbar item opens a menu.
*
* @param it The toolbar item.
* @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
*
* A toolbar item can be set to be a menu, using this function.
*
* Once it is set to be a menu, it can be manipulated through the
* menu-like function elm_toolbar_menu_parent_set() and the other
* elm_menu functions, using the Evas_Object @c menu returned by
* elm_toolbar_item_menu_get().
*
* So, items to be displayed in this item's menu should be added with
* elm_menu_item_add().
*
* The following code exemplifies the most basic usage:
* @code
* tb = elm_toolbar_add(win)
* item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
* elm_toolbar_item_menu_set(item, EINA_TRUE);
* elm_toolbar_menu_parent_set(tb, win);
* menu = elm_toolbar_item_menu_get(item);
* elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
* menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
* NULL);
* @endcode
*
* @see elm_toolbar_item_menu_get()
*
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_menu_set(Elm_Object_Item *it, Eina_Bool menu);
/**
* Get toolbar item's menu.
*
* @param it The toolbar item.
* @return Item's menu object or @c NULL on failure.
*
* If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
* this function will set it.
*
* @see elm_toolbar_item_menu_set() for details.
*
* @ingroup Toolbar
*/
EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Object_Item *it);
/**
* Add a new state to @p item.
*
* @param it The toolbar item.
* @param icon A string with icon name or the absolute path of an image file.
* @param label The label of the new state.
* @param func The function to call when the item is clicked when this
* state is selected.
* @param data The data to associate with the state.
* @return The toolbar item state, or @c NULL upon failure.
*
* Toolbar will load icon image from fdo or current theme.
* This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
* If an absolute path is provided it will load it direct from a file.
*
* States created with this function can be removed with
* elm_toolbar_item_state_del().
*
* @see elm_toolbar_item_state_del()
* @see elm_toolbar_item_state_sel()
* @see elm_toolbar_item_state_get()
*
* @ingroup Toolbar
*/
EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_add(Elm_Object_Item *it, const char *icon, const char *label, Evas_Smart_Cb func, const void *data);
/**
* Delete a previously added state to @p item.
*
* @param it The toolbar item.
* @param state The state to be deleted.
* @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
*
* @see elm_toolbar_item_state_add()
*/
EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Object_Item *it, Elm_Toolbar_Item_State *state);
/**
* Set @p state as the current state of @p it.
*
* @param it The toolbar item.
* @param state The state to use.
* @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
*
* If @p state is @c NULL, it won't select any state and the default item's
* icon and label will be used. It's the same behaviour than
* elm_toolbar_item_state_unset().
*
* @see elm_toolbar_item_state_unset()
*
* @ingroup Toolbar
*/
EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Object_Item *it, Elm_Toolbar_Item_State *state);
/**
* Unset the state of @p it.
*
* @param it The toolbar item.
*
* 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);
/**
* Get the current state of @p it.
*
* @param it The toolbar item.
* @return The selected state or @c NULL if none is selected or on failure.
*
* @see elm_toolbar_item_state_set() for details.
* @see elm_toolbar_item_state_unset()
* @see elm_toolbar_item_state_add()
*
* @ingroup Toolbar
*/
EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Object_Item *it);
/**
* Get the state after selected state in toolbar's @p item.
*
* @param it The toolbar item to change state.
* @return The state after current state, or @c NULL on failure.
*
* If last state is selected, this function will return first state.
*
* @see elm_toolbar_item_state_set()
* @see elm_toolbar_item_state_add()
*
* @ingroup Toolbar
*/
EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Object_Item *it);
/**
* Get the state before selected state in toolbar's @p item.
*
* @param it The toolbar item to change state.
* @return The state before current state, or @c NULL on failure.
*
* If first state is selected, this function will return last state.
*
* @see elm_toolbar_item_state_set()
* @see elm_toolbar_item_state_add()
*
* @ingroup Toolbar
*/
EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *it);
/**
* Show a specific item, when the toolbar can be scrolled.
*
* @param it the toolbar item
*
* see elm_toolbar_item_bring_in()
*
* @since 1.8
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_show(Elm_Object_Item *it, Elm_Toolbar_Item_Scrollto_Type type);
/**
* Show a specific item with scroll animation, when the toolbar can be scrolled.
*
* @param it the toolbar item
*
* see elm_toolbar_item_show()
*
* @since 1.8
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_bring_in(Elm_Object_Item *it, Elm_Toolbar_Item_Scrollto_Type type);
|