src/lib/elm_object_item.h

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