EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
- /* SegmentControl */
- typedef struct _Elm_Segment_Item Elm_Segment_Item;
+ /**
+ * @defgroup SegmentControl SegmentControl
+ * @ingroup Elementary
+ *
+ * @image html img/widget/segment_control/preview-00.png
+ * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
+ *
+ * @image html img/segment_control.png
+ * @image latex img/segment_control.eps width=\textwidth
+ *
+ * Segment control widget is a horizontal control made of multiple segment
+ * items, each segment item functioning similar to discrete two state button.
+ * A segment control groups the items together and provides compact
+ * single button with multiple equal size segments.
+ *
+ * Segment item size is determined by base widget
+ * size and the number of items added.
+ * Only one segment item can be at selected state. A segment item can display
+ * combination of Text and any Evas_Object like Images or other widget.
+ *
+ * Smart callbacks one can listen to:
+ * - "changed" - When the user clicks on a segment item which is not
+ * previously selected and get selected. The event_info parameter is the
+ * segment item pointer.
+ *
+ * Available styles for it:
+ * - @c "default"
+ *
+ * Here is an example on its usage:
+ * @li @ref segment_control_example
+ */
+
+ /**
+ * @addtogroup SegmentControl
+ * @{
+ */
+
+ typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
+
+ /**
+ * Add a new segment control widget to the given parent Elementary
+ * (container) object.
+ *
+ * @param parent The parent object.
+ * @return a new segment control widget handle or @c NULL, on errors.
+ *
+ * This function inserts a new segment control widget on the canvas.
+ *
+ * @ingroup SegmentControl
+ */
EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+
+ /**
+ * Append a new item to the segment control object.
+ *
+ * @param obj The segment control object.
+ * @param icon The icon object to use for the left side of the item. An
+ * icon can be any Evas object, but usually it is an icon created
+ * with elm_icon_add().
+ * @param label The label of the item.
+ * Note that, NULL is different from empty string "".
+ * @return The created item or @c NULL upon failure.
+ *
+ * A new item will be created and appended to the segment control, i.e., will
+ * be set as @b last item.
+ *
+ * If it should be inserted at another position,
+ * elm_segment_control_item_insert_at() should be used instead.
+ *
+ * Items created with this function can be deleted with function
+ * elm_segment_control_item_del() or elm_segment_control_item_del_at().
+ *
+ * @note @p label set to @c NULL is different from empty string "".
+ * If an item
+ * only has icon, it will be displayed bigger and centered. If it has
+ * icon and label, even that an empty string, icon will be smaller and
+ * positioned at left.
+ *
+ * Simple example:
+ * @code
+ * sc = elm_segment_control_add(win);
+ * ic = elm_icon_add(win);
+ * elm_icon_file_set(ic, "path/to/image", NULL);
+ * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
+ * elm_segment_control_item_add(sc, ic, "label");
+ * evas_object_show(sc);
+ * @endcode
+ *
+ * @see elm_segment_control_item_insert_at()
+ * @see elm_segment_control_item_del()
+ *
+ * @ingroup SegmentControl
+ */
EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
+
+ /**
+ * Insert a new item to the segment control object at specified position.
+ *
+ * @param obj The segment control object.
+ * @param icon The icon object to use for the left side of the item. An
+ * icon can be any Evas object, but usually it is an icon created
+ * with elm_icon_add().
+ * @param label The label of the item.
+ * @param index Item position. Value should be between 0 and items count.
+ * @return The created item or @c NULL upon failure.
+
+ * Index values must be between @c 0, when item will be prepended to
+ * segment control, and items count, that can be get with
+ * elm_segment_control_item_count_get(), case when item will be appended
+ * to segment control, just like elm_segment_control_item_add().
+ *
+ * Items created with this function can be deleted with function
+ * elm_segment_control_item_del() or elm_segment_control_item_del_at().
+ *
+ * @note @p label set to @c NULL is different from empty string "".
+ * If an item
+ * only has icon, it will be displayed bigger and centered. If it has
+ * icon and label, even that an empty string, icon will be smaller and
+ * positioned at left.
+ *
+ * @see elm_segment_control_item_add()
+ * @see elm_segment_control_item_count_get()
+ * @see elm_segment_control_item_del()
+ *
+ * @ingroup SegmentControl
+ */
EAPI Elm_Segment_Item *elm_segment_control_item_insert_at(Evas_Object *obj, Evas_Object *icon, const char *label, int index) EINA_ARG_NONNULL(1);
+
+ /**
+ * Remove a segment control item from its parent, deleting it.
+ *
+ * @param it The item to be removed.
+ *
+ * Items can be added with elm_segment_control_item_add() or
+ * elm_segment_control_item_insert_at().
+ *
+ * @ingroup SegmentControl
+ */
EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
+
+ /**
+ * Remove a segment control item at given index from its parent,
+ * deleting it.
+ *
+ * @param obj The segment control object.
+ * @param index The position of the segment control item to be deleted.
+ *
+ * Items can be added with elm_segment_control_item_add() or
+ * elm_segment_control_item_insert_at().
+ *
+ * @ingroup SegmentControl
+ */
EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the Segment items count from segment control.
+ *
+ * @param obj The segment control object.
+ * @return Segment items count.
+ *
+ * It will just return the number of items added to segment control @p obj.
+ *
+ * @ingroup SegmentControl
+ */
EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the item placed at specified index.
+ *
+ * @param obj The segment control object.
+ * @param index The index of the segment item.
+ * @return The segment control item or @c NULL on failure.
+ *
+ * Index is the position of an item in segment control widget. Its
+ * range is from @c 0 to <tt> count - 1 </tt>.
+ * Count is the number of items, that can be get with
+ * elm_segment_control_item_count_get().
+ *
+ * @ingroup SegmentControl
+ */
EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the label of item.
+ *
+ * @param obj The segment control object.
+ * @param index The index of the segment item.
+ * @return The label of the item at @p index.
+ *
+ * The return value is a pointer to the label associated to the item when
+ * it was created, with function elm_segment_control_item_add(), or later
+ * with function elm_segment_control_item_label_set. If no label
+ * was passed as argument, it will return @c NULL.
+ *
+ * @see elm_segment_control_item_label_set() for more details.
+ * @see elm_segment_control_item_add()
+ *
+ * @ingroup SegmentControl
+ */
EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the label of item.
+ *
+ * @param it The item of segment control.
+ * @param text The label of item.
+ *
+ * The label to be displayed by the item.
+ * Label will be at right of the icon (if set).
+ *
+ * If a label was passed as argument on item creation, with function
+ * elm_control_segment_item_add(), it will be already
+ * displayed by the item.
+ *
+ * @see elm_segment_control_item_label_get()
+ * @see elm_segment_control_item_add()
+ *
+ * @ingroup SegmentControl
+ */
EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the icon associated to the item.
+ *
+ * @param obj The segment control object.
+ * @param index The index of the segment item.
+ * @return The left side icon associated to the item at @p index.
+ *
+ * The return value is a pointer to the icon associated to the item when
+ * it was created, with function elm_segment_control_item_add(), or later
+ * with function elm_segment_control_item_icon_set(). If no icon
+ * was passed as argument, it will return @c NULL.
+ *
+ * @see elm_segment_control_item_add()
+ * @see elm_segment_control_item_icon_set()
+ *
+ * @ingroup SegmentControl
+ */
EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the icon associated to the item.
+ *
+ * @param it The segment control item.
+ * @param icon The icon object to associate with @p it.
+ *
+ * The icon object to use at left side of the item. An
+ * icon can be any Evas object, but usually it is an icon created
+ * with elm_icon_add().
+ *
+ * Once the icon object is set, a previously set one will be deleted.
+ * @warning Setting the same icon for two items will cause the icon to
+ * dissapear from the first item.
+ *
+ * If an icon was passed as argument on item creation, with function
+ * elm_segment_control_item_add(), it will be already
+ * associated to the item.
+ *
+ * @see elm_segment_control_item_add()
+ * @see elm_segment_control_item_icon_get()
+ *
+ * @ingroup SegmentControl
+ */
EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the index of an item.
+ *
+ * @param it The segment control item.
+ * @return The position of item in segment control widget.
+ *
+ * Index is the position of an item in segment control widget. Its
+ * range is from @c 0 to <tt> count - 1 </tt>.
+ * Count is the number of items, that can be get with
+ * elm_segment_control_item_count_get().
+ *
+ * @ingroup SegmentControl
+ */
EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the base object of the item.
+ *
+ * @param it The segment control item.
+ * @return The base object associated with @p it.
+ *
+ * Base object is the @c Evas_Object that represents that item.
+ *
+ * @ingroup SegmentControl
+ */
EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
+
+ /**
+ * Get the selected item.
+ *
+ * @param obj The segment control object.
+ * @return The selected item or @c NULL if none of segment items is
+ * selected.
+ *
+ * The selected item can be unselected with function
+ * elm_segment_control_item_selected_set().
+ *
+ * The selected item always will be highlighted on segment control.
+ *
+ * @ingroup SegmentControl
+ */
EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * Set the selected state of an item.
+ *
+ * @param it The segment control item
+ * @param select 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 previosly selected will be unselected.
+ * Previoulsy selected item can be get with function
+ * elm_segment_control_item_selected_get().
+ *
+ * The selected item always will be highlighted on segment control.
+ *
+ * @see elm_segment_control_item_selected_get()
+ *
+ * @ingroup SegmentControl
+ */
EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
- /* smart callbacks called:
- * "changed" -when the user clicks on a segment item which is not previously
- * selected and get selected. The event_info parameter is the
- * segment item index.
+
+ /**
+ * @}
*/
EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
projects / framework / uifw / elementary.git / commitdiff