src/lib/elm_object_item.h

   1 /**
   2  * Get the widget object's handle which contains a given item
   3  *
   4  * @param item The Elementary object item
   5  * @return The widget object
   6  *
   7  * @note This returns the widget object itself that an item belongs to.
   8  *
   9  * @ingroup General
  10  */
  11 EAPI Evas_Object *
  12                                   elm_object_item_object_get(const Elm_Object_Item *it)
  13 EINA_ARG_NONNULL(1);
  14
  15 /**
  16  * Set a content of an object item
  17  *
  18  * @param it The Elementary object item
  19  * @param part The content part name to set (NULL for the default content)
  20  * @param content The new content of the object item
  21  *
  22  * @note Elementary object items may have many contents
  23  * @deprecated Use elm_object_item_part_content_set instead.
  24  * @ingroup General
  25  */
  26 EINA_DEPRECATED EAPI void         elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
  27
  28 /**
  29  * Set a content of an object item
  30  *
  31  * @param it The Elementary object item
  32  * @param part The content part name to set (NULL for the default content)
  33  * @param content The new content of the object item
  34  *
  35  * @note Elementary object items may have many contents
  36  *
  37  * @ingroup General
  38  */
  39 EAPI void                         elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
  40
  41 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
  42
  43 /**
  44  * Get a content of an object item
  45  *
  46  * @param it The Elementary object item
  47  * @param part The content part name to unset (NULL for the default content)
  48  * @return content of the object item or NULL for any error
  49  *
  50  * @note Elementary object items may have many contents
  51  * @deprecated Use elm_object_item_part_content_get instead.
  52  * @ingroup General
  53  */
  54 EAPI Evas_Object                 *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
  55
  56 /**
  57  * Get a content of an object item
  58  *
  59  * @param it The Elementary object item
  60  * @param part The content part name to unset (NULL for the default content)
  61  * @return content of the object item or NULL for any error
  62  *
  63  * @note Elementary object items may have many contents
  64  *
  65  * @ingroup General
  66  */
  67 EAPI Evas_Object                 *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
  68
  69 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
  70
  71 /**
  72  * Unset a content of an object item
  73  *
  74  * @param it The Elementary object item
  75  * @param part The content part name to unset (NULL for the default content)
  76  *
  77  * @note Elementary object items may have many contents
  78  * @deprecated Use elm_object_item_part_content_unset instead.
  79  * @ingroup General
  80  */
  81 EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
  82
  83 /**
  84  * Unset a content of an object item
  85  *
  86  * @param it The Elementary object item
  87  * @param part The content part name to unset (NULL for the default content)
  88  *
  89  * @note Elementary object items may have many contents
  90  *
  91  * @ingroup General
  92  */
  93 EAPI Evas_Object                 *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
  94
  95 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
  96
  97 /**
  98  * Set a label of an object item
  99  *
 100  * @param it The Elementary object item
 101  * @param part The text part name to set (NULL for the default label)
 102  * @param label The new text of the label
 103  *
 104  * @note Elementary object items may have many labels
 105  * @deprecated Use elm_object_item_part_text_set instead.
 106  * @ingroup General
 107  */
 108 EINA_DEPRECATED EAPI void         elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
 109
 110 /**
 111  * Set a label of an object item
 112  *
 113  * @param it The Elementary object item
 114  * @param part The text part name to set (NULL for the default label)
 115  * @param label The new text of the label
 116  *
 117  * @note Elementary object items may have many labels
 118  *
 119  * @ingroup General
 120  */
 121 EAPI void                         elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
 122
 123 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
 124
 125 /**
 126  * Get a label of an object item
 127  *
 128  * @param it The Elementary object item
 129  * @param part The text part name to get (NULL for the default label)
 130  * @return text of the label or NULL for any error
 131  *
 132  * @note Elementary object items may have many labels
 133  * @deprecated Use elm_object_item_part_text_get instead.
 134  * @ingroup General
 135  */
 136 EINA_DEPRECATED EAPI const char  *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
 137 /**
 138  * Get a label of an object item
 139  *
 140  * @param it The Elementary object item
 141  * @param part The text part name to get (NULL for the default label)
 142  * @return text of the label or NULL for any error
 143  *
 144  * @note Elementary object items may have many labels
 145  *
 146  * @ingroup General
 147  */
 148 EAPI const char                  *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
 149
 150 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
 151
 152 /**
 153  * Set the text to read out when in accessibility mode
 154  *
 155  * @param it The object item which is to be described
 156  * @param txt The text that describes the widget to people with poor or no vision
 157  *
 158  * @ingroup General
 159  */
 160 EAPI void                         elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
 161
 162 /**
 163  * Get the data associated with an object item
 164  * @param it The Elementary object item
 165  * @return The data associated with @p it
 166  *
 167  * @ingroup General
 168  */
 169 EAPI void                        *elm_object_item_data_get(const Elm_Object_Item *it);
 170
 171 /**
 172  * Set the data associated with an object item
 173  * @param it The Elementary object item
 174  * @param data The data to be associated with @p it
 175  *
 176  * @ingroup General
 177  */
 178 EAPI void                         elm_object_item_data_set(Elm_Object_Item *it, void *data);
 179
 180 /**
 181  * Send a signal to the edje object of the widget item.
 182  *
 183  * This function sends a signal to the edje object of the obj item. An
 184  * edje program can respond to a signal by specifying matching
 185  * 'signal' and 'source' fields.
 186  *
 187  * @param it The Elementary object item
 188  * @param emission The signal's name.
 189  * @param source The signal's source.
 190  * @ingroup General
 191  */
 192 EAPI void                         elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
 193
 194 /**
 195  * Set the disabled state of an widget item.
 196  *
 197  * @param obj The Elementary object item
 198  * @param disabled The state to put in in: @c EINA_TRUE for
 199  *        disabled, @c EINA_FALSE for enabled
 200  *
 201  * Elementary object item can be @b disabled, in which state they won't
 202  * receive input and, in general, will be themed differently from
 203  * their normal state, usually greyed out. Useful for contexts
 204  * where you don't want your users to interact with some of the
 205  * parts of you interface.
 206  *
 207  * This sets the state for the widget item, either disabling it or
 208  * enabling it back.
 209  *
 210  * @ingroup Styles
 211  */
 212 EAPI void                         elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
 213
 214 /**
 215  * Get the disabled state of an widget item.
 216  *
 217  * @param obj The Elementary object
 218  * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
 219  *            if it's enabled (or on errors)
 220  *
 221  * This gets the state of the widget, which might be enabled or disabled.
 222  *
 223  * @ingroup Styles
 224  */
 225 EAPI Eina_Bool                    elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);