src/lib/elm_toolbar.h

   1 /**
   2  * @defgroup Toolbar Toolbar
   3  * @ingroup Elementary
   4  *
   5  * @image html img/widget/toolbar/preview-00.png
   6  * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
   7  *
   8  * @image html img/toolbar.png
   9  * @image latex img/toolbar.eps width=\textwidth
  10  *
  11  * A toolbar is a widget that displays a list of items inside
  12  * a box. It can be scrollable, show a menu with items that don't fit
  13  * to toolbar size or even crop them.
  14  *
  15  * Only one item can be selected at a time.
  16  *
  17  * Items can have multiple states, or show menus when selected by the user.
  18  *
  19  * Smart callbacks one can listen to:
  20  * - "clicked" - when the user clicks on a toolbar item and becomes selected.
  21  * - "language,changed" - when the program language changes
  22  *
  23  * Available styles for it:
  24  * - @c "default"
  25  * - @c "transparent" - no background or shadow, just show the content
  26  *
  27  * Default text parts of the toolbar items that you can use for are:
  28  * @li "default" - label of the toolbar item
  29  *
  30  * Supported elm_object_item common APIs.
  31  * @li elm_object_item_disabled_set
  32  * @li elm_object_item_disabled_get
  33  * @li elm_object_item_part_text_set
  34  * @li elm_object_item_part_text_get
  35  *
  36  * List of examples:
  37  * @li @ref toolbar_example_01
  38  * @li @ref toolbar_example_02
  39  * @li @ref toolbar_example_03
  40  */
  41
  42 /**
  43  * @addtogroup Toolbar
  44  * @{
  45  */
  46
  47 /**
  48  * @enum _Elm_Toolbar_Shrink_Mode
  49  * @typedef Elm_Toolbar_Shrink_Mode
  50  *
  51  * Set toolbar's items display behavior, it can be scrollabel,
  52  * show a menu with exceeding items, or simply hide them.
  53  *
  54  * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
  55  * from elm config.
  56  *
  57  * Values <b> don't </b> work as bitmask, only one can be choosen.
  58  *
  59  * @see elm_toolbar_shrink_mode_set()
  60  * @see elm_toolbar_shrink_mode_get()
  61  *
  62  * @ingroup Toolbar
  63  */
  64 typedef enum
  65 {
  66    ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
  67    ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
  68    ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
  69    ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
  70    ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
  71 } Elm_Toolbar_Shrink_Mode;
  72
  73 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(). */
  74
  75 /**
  76  * Add a new toolbar widget to the given parent Elementary
  77  * (container) object.
  78  *
  79  * @param parent The parent object.
  80  * @return a new toolbar widget handle or @c NULL, on errors.
  81  *
  82  * This function inserts a new toolbar widget on the canvas.
  83  *
  84  * @ingroup Toolbar
  85  */
  86 EAPI Evas_Object                 *elm_toolbar_add(Evas_Object *parent);
  87
  88 /**
  89  * Set the icon size, in pixels, to be used by toolbar items.
  90  *
  91  * @param obj The toolbar object
  92  * @param icon_size The icon size in pixels
  93  *
  94  * @note Default value is @c 32. It reads value from elm config.
  95  *
  96  * @see elm_toolbar_icon_size_get()
  97  *
  98  * @ingroup Toolbar
  99  */
 100 EAPI void                         elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size);
 101
 102 /**
 103  * Get the icon size, in pixels, to be used by toolbar items.
 104  *
 105  * @param obj The toolbar object.
 106  * @return The icon size in pixels.
 107  *
 108  * @see elm_toolbar_icon_size_set() for details.
 109  *
 110  * @ingroup Toolbar
 111  */
 112 EAPI int                          elm_toolbar_icon_size_get(const Evas_Object *obj);
 113
 114 /**
 115  * Sets icon lookup order, for toolbar items' icons.
 116  *
 117  * @param obj The toolbar object.
 118  * @param order The icon lookup order.
 119  *
 120  * Icons added before calling this function will not be affected.
 121  * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
 122  *
 123  * @see elm_toolbar_icon_order_lookup_get()
 124  *
 125  * @ingroup Toolbar
 126  */
 127 EAPI void                         elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order);
 128
 129 /**
 130  * Gets the icon lookup order.
 131  *
 132  * @param obj The toolbar object.
 133  * @return The icon lookup order.
 134  *
 135  * @see elm_toolbar_icon_order_lookup_set() for details.
 136  *
 137  * @ingroup Toolbar
 138  */
 139 EAPI Elm_Icon_Lookup_Order        elm_toolbar_icon_order_lookup_get(const Evas_Object *obj);
 140
 141 /**
 142  * Set whether the toolbar should always have an item selected.
 143  *
 144  * @param obj The toolbar object.
 145  * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
 146  * disable it.
 147  *
 148  * This will cause the toolbar to always have an item selected, and clicking
 149  * the selected item will not cause a selected event to be emitted. Enabling this mode
 150  * will immediately select the first toolbar item.
 151  *
 152  * Always-selected is disabled by default.
 153  *
 154  * @see elm_toolbar_always_select_mode_get().
 155  *
 156  * @ingroup Toolbar
 157  */
 158 EAPI void                         elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
 159
 160 /**
 161  * Get whether the toolbar should always have an item selected.
 162  *
 163  * @param obj The toolbar object.
 164  * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
 165  * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
 166  *
 167  * @see elm_toolbar_always_select_mode_set() for details.
 168  *
 169  * @ingroup Toolbar
 170  */
 171 EAPI Eina_Bool                    elm_toolbar_always_select_mode_get(const Evas_Object *obj);
 172
 173 /**
 174  * Set whether the toolbar items' should be selected by the user or not.
 175  *
 176  * @param obj The toolbar object.
 177  * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
 178  * enable it.
 179  *
 180  * This will turn off the ability to select items entirely and they will
 181  * neither appear selected nor emit selected signals. The clicked
 182  * callback function will still be called.
 183  *
 184  * Selection is enabled by default.
 185  *
 186  * @see elm_toolbar_no_select_mode_get().
 187  *
 188  * @ingroup Toolbar
 189  */
 190 EAPI void                         elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
 191
 192 /**
 193  * Set whether the toolbar items' should be selected by the user or not.
 194  *
 195  * @param obj The toolbar object.
 196  * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
 197  * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
 198  *
 199  * @see elm_toolbar_no_select_mode_set() for details.
 200  *
 201  * @ingroup Toolbar
 202  */
 203 EAPI Eina_Bool                    elm_toolbar_no_select_mode_get(const Evas_Object *obj);
 204
 205 /**
 206  * Append item to the toolbar.
 207  *
 208  * @param obj The toolbar object.
 209  * @param icon A string with icon name or the absolute path of an image file.
 210  * @param label The label of the item.
 211  * @param func The function to call when the item is clicked.
 212  * @param data The data to associate with the item for related callbacks.
 213  * @return The created item or @c NULL upon failure.
 214  *
 215  * A new item will be created and appended to the toolbar, i.e., will
 216  * be set as @b last item.
 217  *
 218  * Items created with this method can be deleted with
 219  * elm_object_item_del().
 220  *
 221  * Associated @p data can be properly freed when item is deleted if a
 222  * callback function is set with elm_object_item_del_cb_set().
 223  *
 224  * If a function is passed as argument, it will be called everytime this item
 225  * is selected, i.e., the user clicks over an unselected item.
 226  * If such function isn't needed, just passing
 227  * @c NULL as @p func is enough. The same should be done for @p data.
 228  *
 229  * Toolbar will load icon image from fdo or current theme.
 230  * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
 231  * If an absolute path is provided it will load it direct from a file.
 232  *
 233  * @see elm_toolbar_item_icon_set()
 234  * @see elm_object_item_del()
 235  *
 236  * @ingroup Toolbar
 237  */
 238 EAPI Elm_Object_Item             *elm_toolbar_item_append(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data);
 239
 240 /**
 241  * Prepend item to the toolbar.
 242  *
 243  * @param obj The toolbar object.
 244  * @param icon A string with icon name or the absolute path of an image file.
 245  * @param label The label of the item.
 246  * @param func The function to call when the item is clicked.
 247  * @param data The data to associate with the item for related callbacks.
 248  * @return The created item or @c NULL upon failure.
 249  *
 250  * A new item will be created and prepended to the toolbar, i.e., will
 251  * be set as @b first item.
 252  *
 253  * Items created with this method can be deleted with
 254  * elm_object_item_del().
 255  *
 256  * Associated @p data can be properly freed when item is deleted if a
 257  * callback function is set with elm_object_item_del_cb_set().
 258  *
 259  * If a function is passed as argument, it will be called everytime this item
 260  * is selected, i.e., the user clicks over an unselected item.
 261  * If such function isn't needed, just passing
 262  * @c NULL as @p func is enough. The same should be done for @p data.
 263  *
 264  * Toolbar will load icon image from fdo or current theme.
 265  * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
 266  * If an absolute path is provided it will load it direct from a file.
 267  *
 268  * @see elm_toolbar_item_icon_set()
 269  * @see elm_object_item_del()
 270  *
 271  * @ingroup Toolbar
 272  */
 273 EAPI Elm_Object_Item             *elm_toolbar_item_prepend(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data);
 274
 275 /**
 276  * Insert a new item into the toolbar object before item @p before.
 277  *
 278  * @param obj The toolbar object.
 279  * @param before The toolbar item to insert before.
 280  * @param icon A string with icon name or the absolute path of an image file.
 281  * @param label The label of the item.
 282  * @param func The function to call when the item is clicked.
 283  * @param data The data to associate with the item for related callbacks.
 284  * @return The created item or @c NULL upon failure.
 285  *
 286  * A new item will be created and added to the toolbar. Its position in
 287  * this toolbar will be just before item @p before.
 288  *
 289  * Items created with this method can be deleted with
 290  * elm_object_item_del().
 291  *
 292  * Associated @p data can be properly freed when item is deleted if a
 293  * callback function is set with elm_object_item_del_cb_set().
 294  *
 295  * If a function is passed as argument, it will be called everytime this item
 296  * is selected, i.e., the user clicks over an unselected item.
 297  * If such function isn't needed, just passing
 298  * @c NULL as @p func is enough. The same should be done for @p data.
 299  *
 300  * Toolbar will load icon image from fdo or current theme.
 301  * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
 302  * If an absolute path is provided it will load it direct from a file.
 303  *
 304  * @see elm_toolbar_item_icon_set()
 305  * @see elm_object_item_del()
 306  *
 307  * @ingroup Toolbar
 308  */
 309 EAPI Elm_Object_Item             *elm_toolbar_item_insert_before(Evas_Object *obj, Elm_Object_Item *before, const char *icon, const char *label, Evas_Smart_Cb func, const void *data);
 310
 311 /**
 312  * Insert a new item into the toolbar object after item @p after.
 313  *
 314  * @param obj The toolbar object.
 315  * @param after The toolbar item to insert after.
 316  * @param icon A string with icon name or the absolute path of an image file.
 317  * @param label The label of the item.
 318  * @param func The function to call when the item is clicked.
 319  * @param data The data to associate with the item for related callbacks.
 320  * @return The created item or @c NULL upon failure.
 321  *
 322  * A new item will be created and added to the toolbar. Its position in
 323  * this toolbar will be just after item @p after.
 324  *
 325  * Items created with this method can be deleted with
 326  * elm_object_item_del().
 327  *
 328  * Associated @p data can be properly freed when item is deleted if a
 329  * callback function is set with elm_object_item_del_cb_set().
 330  *
 331  * If a function is passed as argument, it will be called everytime this item
 332  * is selected, i.e., the user clicks over an unselected item.
 333  * If such function isn't needed, just passing
 334  * @c NULL as @p func is enough. The same should be done for @p data.
 335  *
 336  * Toolbar will load icon image from fdo or current theme.
 337  * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
 338  * If an absolute path is provided it will load it direct from a file.
 339  *
 340  * @see elm_toolbar_item_icon_set()
 341  * @see elm_object_item_del()
 342  *
 343  * @ingroup Toolbar
 344  */
 345 EAPI Elm_Object_Item             *elm_toolbar_item_insert_after(Evas_Object *obj, Elm_Object_Item *after, const char *icon, const char *label, Evas_Smart_Cb func, const void *data);
 346
 347 /**
 348  * Get the first item in the given toolbar widget's list of
 349  * items.
 350  *
 351  * @param obj The toolbar object
 352  * @return The first item or @c NULL, if it has no items (and on
 353  * errors)
 354  *
 355  * @see elm_toolbar_item_append()
 356  * @see elm_toolbar_last_item_get()
 357  *
 358  * @ingroup Toolbar
 359  */
 360 EAPI Elm_Object_Item             *elm_toolbar_first_item_get(const Evas_Object *obj);
 361
 362 /**
 363  * Get the last item in the given toolbar widget's list of
 364  * items.
 365  *
 366  * @param obj The toolbar object
 367  * @return The last item or @c NULL, if it has no items (and on
 368  * errors)
 369  *
 370  * @see elm_toolbar_item_prepend()
 371  * @see elm_toolbar_first_item_get()
 372  *
 373  * @ingroup Toolbar
 374  */
 375 EAPI Elm_Object_Item             *elm_toolbar_last_item_get(const Evas_Object *obj);
 376
 377 /**
 378  * Get the item after @p item in toolbar.
 379  *
 380  * @param it The toolbar item.
 381  * @return The item after @p item, or @c NULL if none or on failure.
 382  *
 383  * @note If it is the last item, @c NULL will be returned.
 384  *
 385  * @see elm_toolbar_item_append()
 386  *
 387  * @ingroup Toolbar
 388  */
 389 EAPI Elm_Object_Item             *elm_toolbar_item_next_get(const Elm_Object_Item *it);
 390
 391 /**
 392  * Get the item before @p item in toolbar.
 393  *
 394  * @param item The toolbar item.
 395  * @return The item before @p item, or @c NULL if none or on failure.
 396  *
 397  * @note If it is the first item, @c NULL will be returned.
 398  *
 399  * @see elm_toolbar_item_prepend()
 400  *
 401  * @ingroup Toolbar
 402  */
 403 EAPI Elm_Object_Item             *elm_toolbar_item_prev_get(const Elm_Object_Item *it);
 404
 405 /**
 406  * Set the priority of a toolbar item.
 407  *
 408  * @param it The toolbar item.
 409  * @param priority The item priority. The default is zero.
 410  *
 411  * This is used only when the toolbar shrink mode is set to
 412  * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
 413  * When space is less than required, items with low priority
 414  * will be removed from the toolbar and added to a dynamically-created menu,
 415  * while items with higher priority will remain on the toolbar,
 416  * with the same order they were added.
 417  *
 418  * @see elm_toolbar_item_priority_get()
 419  *
 420  * @ingroup Toolbar
 421  */
 422 EAPI void                         elm_toolbar_item_priority_set(Elm_Object_Item *it, int priority);
 423
 424 /**
 425  * Get the priority of a toolbar item.
 426  *
 427  * @param it The toolbar item.
 428  * @return The @p item priority, or @c 0 on failure.
 429  *
 430  * @see elm_toolbar_item_priority_set() for details.
 431  *
 432  * @ingroup Toolbar
 433  */
 434 EAPI int                          elm_toolbar_item_priority_get(const Elm_Object_Item *it);
 435
 436 /**
 437  * Returns a pointer to a toolbar item by its label.
 438  *
 439  * @param obj The toolbar object.
 440  * @param label The label of the item to find.
 441  *
 442  * @return The pointer to the toolbar item matching @p label or @c NULL
 443  * on failure.
 444  *
 445  * @ingroup Toolbar
 446  */
 447 EAPI Elm_Object_Item             *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label);
 448
 449 /*
 450  * Get whether the @p item is selected or not.
 451  *
 452  * @param it The toolbar item.
 453  * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
 454  * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
 455  *
 456  * @see elm_toolbar_selected_item_set() for details.
 457  * @see elm_toolbar_item_selected_get()
 458  *
 459  * @ingroup Toolbar
 460  */
 461 EAPI Eina_Bool                    elm_toolbar_item_selected_get(const Elm_Object_Item *it);
 462
 463 /**
 464  * Set the selected state of an item.
 465  *
 466  * @param it The toolbar item
 467  * @param selected The selected state
 468  *
 469  * This sets the selected state of the given item @p it.
 470  * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
 471  *
 472  * If a new item is selected the previosly selected will be unselected.
 473  * Previoulsy selected item can be get with function
 474  * elm_toolbar_selected_item_get().
 475  *
 476  * Selected items will be highlighted.
 477  *
 478  * @see elm_toolbar_item_selected_get()
 479  * @see elm_toolbar_selected_item_get()
 480  *
 481  * @ingroup Toolbar
 482  */
 483 EAPI void                         elm_toolbar_item_selected_set(Elm_Object_Item *it, Eina_Bool selected);
 484
 485 /**
 486  * Get the selected item.
 487  *
 488  * @param obj The toolbar object.
 489  * @return The selected toolbar item.
 490  *
 491  * The selected item can be unselected with function
 492  * elm_toolbar_item_selected_set().
 493  *
 494  * The selected item always will be highlighted on toolbar.
 495  *
 496  * @see elm_toolbar_selected_items_get()
 497  *
 498  * @ingroup Toolbar
 499  */
 500 EAPI Elm_Object_Item             *elm_toolbar_selected_item_get(const Evas_Object *obj);
 501
 502 /**
 503  * Set the icon associated with @p item.
 504  *
 505  * @param obj The parent of this item.
 506  * @param it The toolbar item.
 507  * @param icon A string with icon name or the absolute path of an image file.
 508  *
 509  * Toolbar will load icon image from fdo or current theme.
 510  * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
 511  * If an absolute path is provided it will load it direct from a file.
 512  *
 513  * @see elm_toolbar_icon_order_lookup_set()
 514  * @see elm_toolbar_icon_order_lookup_get()
 515  *
 516  * @ingroup Toolbar
 517  */
 518 EAPI void                         elm_toolbar_item_icon_set(Elm_Object_Item *it, const char *icon);
 519
 520 /**
 521  * Get the string used to set the icon of @p item.
 522  *
 523  * @param it The toolbar item.
 524  * @return The string associated with the icon object.
 525  *
 526  * @see elm_toolbar_item_icon_set() for details.
 527  *
 528  * @ingroup Toolbar
 529  */
 530 EAPI const char                  *elm_toolbar_item_icon_get(const Elm_Object_Item *it);
 531
 532 /**
 533  * Get the object of @p item.
 534  *
 535  * @param it The toolbar item.
 536  * @return The object
 537  *
 538  * @ingroup Toolbar
 539  */
 540 EAPI Evas_Object                 *elm_toolbar_item_object_get(const Elm_Object_Item *it);
 541
 542 /**
 543  * Get the icon object of @p item.
 544  *
 545  * @param it The toolbar item.
 546  * @return The icon object
 547  *
 548  * @see elm_toolbar_item_icon_set(), elm_toolbar_item_icon_file_set(),
 549  * or elm_toolbar_item_icon_memfile_set() for details.
 550  *
 551  * @ingroup Toolbar
 552  */
 553 EAPI Evas_Object                 *elm_toolbar_item_icon_object_get(Elm_Object_Item *it);
 554
 555 /**
 556  * Set the icon associated with @p item to an image in a binary buffer.
 557  *
 558  * @param it The toolbar item.
 559  * @param img The binary data that will be used as an image
 560  * @param size The size of binary data @p img
 561  * @param format Optional format of @p img to pass to the image loader
 562  * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
 563  *
 564  * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
 565  *
 566  * @note The icon image set by this function can be changed by
 567  * elm_toolbar_item_icon_set().
 568  *
 569  * @ingroup Toolbar
 570  */
 571 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);
 572
 573 /**
 574  * Set the icon associated with @p item to an image in a binary buffer.
 575  *
 576  * @param it The toolbar item.
 577  * @param file The file that contains the image
 578  * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
 579  *
 580  * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
 581  *
 582  * @note The icon image set by this function can be changed by
 583  * elm_toolbar_item_icon_set().
 584  *
 585  * @ingroup Toolbar
 586  */
 587 EAPI Eina_Bool                    elm_toolbar_item_icon_file_set(Elm_Object_Item *it, const char *file, const char *key);
 588
 589 /**
 590  * Set or unset item as a separator.
 591  *
 592  * @param it The toolbar item.
 593  * @param setting @c EINA_TRUE to set item @p item as separator or
 594  * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
 595  *
 596  * Items aren't set as separator by default.
 597  *
 598  * If set as separator it will display separator theme, so won't display
 599  * icons or label.
 600  *
 601  * @see elm_toolbar_item_separator_get()
 602  *
 603  * @ingroup Toolbar
 604  */
 605 EAPI void                         elm_toolbar_item_separator_set(Elm_Object_Item *it, Eina_Bool separator);
 606
 607 /**
 608  * Get a value whether item is a separator or not.
 609  *
 610  * @param it The toolbar item.
 611  * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
 612  * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
 613  *
 614  * @see elm_toolbar_item_separator_set() for details.
 615  *
 616  * @ingroup Toolbar
 617  */
 618 EAPI Eina_Bool                    elm_toolbar_item_separator_get(const Elm_Object_Item *it);
 619
 620 /**
 621  * Set the shrink state of toolbar @p obj.
 622  *
 623  * @param obj The toolbar object.
 624  * @param shrink_mode Toolbar's items display behavior.
 625  *
 626  * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
 627  * but will enforce a minimun size so all the items will fit, won't scroll
 628  * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
 629  * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
 630  * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
 631  *
 632  * @ingroup Toolbar
 633  */
 634 EAPI void                         elm_toolbar_shrink_mode_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode);
 635
 636 /**
 637  * Get the shrink mode of toolbar @p obj.
 638  *
 639  * @param obj The toolbar object.
 640  * @return Toolbar's items display behavior.
 641  *
 642  * @see elm_toolbar_shrink_mode_set() for details.
 643  *
 644  * @ingroup Toolbar
 645  */
 646 EAPI Elm_Toolbar_Shrink_Mode      elm_toolbar_shrink_mode_get(const Evas_Object *obj);
 647
 648 /**
 649  * Enable/disable homogeneous mode.
 650  *
 651  * @param obj The toolbar object
 652  * @param homogeneous Assume the items within the toolbar are of the
 653  * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
 654  *
 655  * This will enable the homogeneous mode where items are of the same size.
 656  * @see elm_toolbar_homogeneous_get()
 657  *
 658  * @ingroup Toolbar
 659  */
 660 EAPI void                         elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous);
 661
 662 /**
 663  * Get whether the homogeneous mode is enabled.
 664  *
 665  * @param obj The toolbar object.
 666  * @return Assume the items within the toolbar are of the same height
 667  * and width (EINA_TRUE = on, EINA_FALSE = off).
 668  *
 669  * @see elm_toolbar_homogeneous_set()
 670  *
 671  * @ingroup Toolbar
 672  */
 673 EAPI Eina_Bool                    elm_toolbar_homogeneous_get(const Evas_Object *obj);
 674
 675 /**
 676  * Set the parent object of the toolbar items' menus.
 677  *
 678  * @param obj The toolbar object.
 679  * @param parent The parent of the menu objects.
 680  *
 681  * Each item can be set as item menu, with elm_toolbar_item_menu_set().
 682  *
 683  * For more details about setting the parent for toolbar menus, see
 684  * elm_menu_parent_set().
 685  *
 686  * @see elm_menu_parent_set() for details.
 687  * @see elm_toolbar_item_menu_set() for details.
 688  *
 689  * @ingroup Toolbar
 690  */
 691 EAPI void                         elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent);
 692
 693 /**
 694  * Get the parent object of the toolbar items' menus.
 695  *
 696  * @param obj The toolbar object.
 697  * @return The parent of the menu objects.
 698  *
 699  * @see elm_toolbar_menu_parent_set() for details.
 700  *
 701  * @ingroup Toolbar
 702  */
 703 EAPI Evas_Object                 *elm_toolbar_menu_parent_get(const Evas_Object *obj);
 704
 705 /**
 706  * Set the alignment of the items.
 707  *
 708  * @param obj The toolbar object.
 709  * @param align The new alignment, a float between <tt> 0.0 </tt>
 710  * and <tt> 1.0 </tt>.
 711  *
 712  * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
 713  * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
 714  * items.
 715  *
 716  * Centered items by default.
 717  *
 718  * @see elm_toolbar_align_get()
 719  *
 720  * @ingroup Toolbar
 721  */
 722 EAPI void                         elm_toolbar_align_set(Evas_Object *obj, double align);
 723
 724 /**
 725  * Get the alignment of the items.
 726  *
 727  * @param obj The toolbar object.
 728  * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
 729  * <tt> 1.0 </tt>.
 730  *
 731  * @see elm_toolbar_align_set() for details.
 732  *
 733  * @ingroup Toolbar
 734  */
 735 EAPI double                       elm_toolbar_align_get(const Evas_Object *obj);
 736
 737 /**
 738  * Set whether the toolbar item opens a menu.
 739  *
 740  * @param it The toolbar item.
 741  * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
 742  *
 743  * A toolbar item can be set to be a menu, using this function.
 744  *
 745  * Once it is set to be a menu, it can be manipulated through the
 746  * menu-like function elm_toolbar_menu_parent_set() and the other
 747  * elm_menu functions, using the Evas_Object @c menu returned by
 748  * elm_toolbar_item_menu_get().
 749  *
 750  * So, items to be displayed in this item's menu should be added with
 751  * elm_menu_item_add().
 752  *
 753  * The following code exemplifies the most basic usage:
 754  * @code
 755  * tb = elm_toolbar_add(win)
 756  * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
 757  * elm_toolbar_item_menu_set(item, EINA_TRUE);
 758  * elm_toolbar_menu_parent_set(tb, win);
 759  * menu = elm_toolbar_item_menu_get(item);
 760  * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
 761  * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
 762  * NULL);
 763  * @endcode
 764  *
 765  * @see elm_toolbar_item_menu_get()
 766  *
 767  * @ingroup Toolbar
 768  */
 769 EAPI void                         elm_toolbar_item_menu_set(Elm_Object_Item *it, Eina_Bool menu);
 770
 771 /**
 772  * Get toolbar item's menu.
 773  *
 774  * @param it The toolbar item.
 775  * @return Item's menu object or @c NULL on failure.
 776  *
 777  * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
 778  * this function will set it.
 779  *
 780  * @see elm_toolbar_item_menu_set() for details.
 781  *
 782  * @ingroup Toolbar
 783  */
 784 EAPI Evas_Object                 *elm_toolbar_item_menu_get(const Elm_Object_Item *it);
 785
 786 /**
 787  * Add a new state to @p item.
 788  *
 789  * @param it The toolbar item.
 790  * @param icon A string with icon name or the absolute path of an image file.
 791  * @param label The label of the new state.
 792  * @param func The function to call when the item is clicked when this
 793  * state is selected.
 794  * @param data The data to associate with the state.
 795  * @return The toolbar item state, or @c NULL upon failure.
 796  *
 797  * Toolbar will load icon image from fdo or current theme.
 798  * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
 799  * If an absolute path is provided it will load it direct from a file.
 800  *
 801  * States created with this function can be removed with
 802  * elm_toolbar_item_state_del().
 803  *
 804  * @see elm_toolbar_item_state_del()
 805  * @see elm_toolbar_item_state_sel()
 806  * @see elm_toolbar_item_state_get()
 807  *
 808  * @ingroup Toolbar
 809  */
 810 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);
 811
 812 /**
 813  * Delete a previoulsy added state to @p item.
 814  *
 815  * @param it The toolbar item.
 816  * @param state The state to be deleted.
 817  * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
 818  *
 819  * @see elm_toolbar_item_state_add()
 820  */
 821 EAPI Eina_Bool                    elm_toolbar_item_state_del(Elm_Object_Item *it, Elm_Toolbar_Item_State *state);
 822
 823 /**
 824  * Set @p state as the current state of @p it.
 825  *
 826  * @param it The toolbar item.
 827  * @param state The state to use.
 828  * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
 829  *
 830  * If @p state is @c NULL, it won't select any state and the default item's
 831  * icon and label will be used. It's the same behaviour than
 832  * elm_toolbar_item_state_unser().
 833  *
 834  * @see elm_toolbar_item_state_unset()
 835  *
 836  * @ingroup Toolbar
 837  */
 838 EAPI Eina_Bool                    elm_toolbar_item_state_set(Elm_Object_Item *it, Elm_Toolbar_Item_State *state);
 839
 840 /**
 841  * Unset the state of @p it.
 842  *
 843  * @param it The toolbar item.
 844  *
 845  * The default icon and label from this item will be displayed.
 846  *
 847  * @see elm_toolbar_item_state_set() for more details.
 848  *
 849  * @ingroup Toolbar
 850  */
 851 EAPI void                         elm_toolbar_item_state_unset(Elm_Object_Item *it);
 852
 853 /**
 854  * Get the current state of @p it.
 855  *
 856  * @param it The toolbar item.
 857  * @return The selected state or @c NULL if none is selected or on failure.
 858  *
 859  * @see elm_toolbar_item_state_set() for details.
 860  * @see elm_toolbar_item_state_unset()
 861  * @see elm_toolbar_item_state_add()
 862  *
 863  * @ingroup Toolbar
 864  */
 865 EAPI Elm_Toolbar_Item_State      *elm_toolbar_item_state_get(const Elm_Object_Item *it);
 866
 867 /**
 868  * Get the state after selected state in toolbar's @p item.
 869  *
 870  * @param it The toolbar item to change state.
 871  * @return The state after current state, or @c NULL on failure.
 872  *
 873  * If last state is selected, this function will return first state.
 874  *
 875  * @see elm_toolbar_item_state_set()
 876  * @see elm_toolbar_item_state_add()
 877  *
 878  * @ingroup Toolbar
 879  */
 880 EAPI Elm_Toolbar_Item_State      *elm_toolbar_item_state_next(Elm_Object_Item *it);
 881
 882 /**
 883  * Get the state before selected state in toolbar's @p item.
 884  *
 885  * @param it The toolbar item to change state.
 886  * @return The state before current state, or @c NULL on failure.
 887  *
 888  * If first state is selected, this function will return last state.
 889  *
 890  * @see elm_toolbar_item_state_set()
 891  * @see elm_toolbar_item_state_add()
 892  *
 893  * @ingroup Toolbar
 894  */
 895 EAPI Elm_Toolbar_Item_State      *elm_toolbar_item_state_prev(Elm_Object_Item *it);
 896
 897 /**
 898  * Set the type of mouse pointer/cursor decoration to be shown,
 899  * when the mouse pointer is over the given toolbar widget item
 900  *
 901  * @param it toolbar item to customize cursor on
 902  * @param cursor the cursor type's name
 903  *
 904  * This function works analogously as elm_object_cursor_set(), but
 905  * here the cursor's changing area is restricted to the item's
 906  * area, and not the whole widget's. Note that that item cursors
 907  * have precedence over widget cursors, so that a mouse over an
 908  * item with custom cursor set will always show @b that cursor.
 909  *
 910  * If this function is called twice for an object, a previously set
 911  * cursor will be unset on the second call.
 912  *
 913  * @see elm_object_cursor_set()
 914  * @see elm_toolbar_item_cursor_get()
 915  * @see elm_toolbar_item_cursor_unset()
 916  *
 917  * @ingroup Toolbar
 918  */
 919 EAPI void                         elm_toolbar_item_cursor_set(Elm_Object_Item *it, const char *cursor);
 920
 921 /*
 922  * Get the type of mouse pointer/cursor decoration set to be shown,
 923  * when the mouse pointer is over the given toolbar widget item
 924  *
 925  * @param it toolbar item with custom cursor set
 926  * @return the cursor type's name or @c NULL, if no custom cursors
 927  * were set to @p item (and on errors)
 928  *
 929  * @see elm_object_cursor_get()
 930  * @see elm_toolbar_item_cursor_set()
 931  * @see elm_toolbar_item_cursor_unset()
 932  *
 933  * @ingroup Toolbar
 934  */
 935 EAPI const char                  *elm_toolbar_item_cursor_get(const Elm_Object_Item *it);
 936
 937 /**
 938  * Unset any custom mouse pointer/cursor decoration set to be
 939  * shown, when the mouse pointer is over the given toolbar widget
 940  * item, thus making it show the @b default cursor again.
 941  *
 942  * @param it a toolbar item
 943  *
 944  * Use this call to undo any custom settings on this item's cursor
 945  * decoration, bringing it back to defaults (no custom style set).
 946  *
 947  * @see elm_object_cursor_unset()
 948  * @see elm_toolbar_item_cursor_set()
 949  *
 950  * @ingroup Toolbar
 951  */
 952 EAPI void                         elm_toolbar_item_cursor_unset(Elm_Object_Item *it);
 953
 954 /**
 955  * Set a different @b style for a given custom cursor set for a
 956  * toolbar item.
 957  *
 958  * @param it toolbar item with custom cursor set
 959  * @param style the <b>theme style</b> to use (e.g. @c "default",
 960  * @c "transparent", etc)
 961  *
 962  * This function only makes sense when one is using custom mouse
 963  * cursor decorations <b>defined in a theme file</b>, which can have,
 964  * given a cursor name/type, <b>alternate styles</b> on it. It
 965  * works analogously as elm_object_cursor_style_set(), but here
 966  * applyed only to toolbar item objects.
 967  *
 968  * @warning Before you set a cursor style you should have definen a
 969  *       custom cursor previously on the item, with
 970  *       elm_toolbar_item_cursor_set()
 971  *
 972  * @see elm_toolbar_item_cursor_engine_only_set()
 973  * @see elm_toolbar_item_cursor_style_get()
 974  *
 975  * @ingroup Toolbar
 976  */
 977 EAPI void                         elm_toolbar_item_cursor_style_set(Elm_Object_Item *it, const char *style);
 978
 979 /**
 980  * Get the current @b style set for a given toolbar item's custom
 981  * cursor
 982  *
 983  * @param it toolbar item with custom cursor set.
 984  * @return style the cursor style in use. If the object does not
 985  *         have a cursor set, then @c NULL is returned.
 986  *
 987  * @see elm_toolbar_item_cursor_style_set() for more details
 988  *
 989  * @ingroup Toolbar
 990  */
 991 EAPI const char                  *elm_toolbar_item_cursor_style_get(const Elm_Object_Item *it);
 992
 993 /**
 994  * Set if the (custom)cursor for a given toolbar item should be
 995  * searched in its theme, also, or should only rely on the
 996  * rendering engine.
 997  *
 998  * @param it item with custom (custom) cursor already set on
 999  * @param engine_only Use @c EINA_TRUE to have cursors looked for
1000  * only on those provided by the rendering engine, @c EINA_FALSE to
1001  * have them searched on the widget's theme, as well.
1002  *
1003  * @note This call is of use only if you've set a custom cursor
1004  * for toolbar items, with elm_toolbar_item_cursor_set().
1005  *
1006  * @note By default, cursors will only be looked for between those
1007  * provided by the rendering engine.
1008  *
1009  * @ingroup Toolbar
1010  */
1011 EAPI void                         elm_toolbar_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only);
1012
1013 /**
1014  * Get if the (custom) cursor for a given toolbar item is being
1015  * searched in its theme, also, or is only relying on the rendering
1016  * engine.
1017  *
1018  * @param it a toolbar item
1019  * @return @c EINA_TRUE, if cursors are being looked for only on
1020  * those provided by the rendering engine, @c EINA_FALSE if they
1021  * are being searched on the widget's theme, as well.
1022  *
1023  * @see elm_toolbar_item_cursor_engine_only_set(), for more details
1024  *
1025  * @ingroup Toolbar
1026  */
1027 EAPI Eina_Bool                    elm_toolbar_item_cursor_engine_only_get(const Elm_Object_Item *it);
1028
1029 /**
1030  * Change a toolbar's orientation
1031  * @param obj The toolbar object
1032  * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
1033  * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
1034  * @ingroup Toolbar
1035  */
1036 EAPI void                         elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal);
1037
1038 /**
1039  * Get a toolbar's orientation
1040  * @param obj The toolbar object
1041  * @return If @c EINA_TRUE, the toolbar is horizontal
1042  * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
1043  * @ingroup Toolbar
1044  */
1045 EAPI Eina_Bool                    elm_toolbar_horizontal_get(const Evas_Object *obj);
1046
1047 /**
1048  * Get the number of items in a toolbar
1049  * @param obj The toolbar object
1050  * @return The number of items in @p obj toolbar
1051  * @ingroup Toolbar
1052  */
1053 EAPI unsigned int                 elm_toolbar_items_count(const Evas_Object *obj);
1054 /**
1055  * @}
1056  */