src/lib/elm_check.h

   1    /**
   2     * @defgroup Check Check
   3     *
   4     * @image html img/widget/check/preview-00.png
   5     * @image latex img/widget/check/preview-00.eps
   6     * @image html img/widget/check/preview-01.png
   7     * @image latex img/widget/check/preview-01.eps
   8     * @image html img/widget/check/preview-02.png
   9     * @image latex img/widget/check/preview-02.eps
  10     *
  11     * @brief The check widget allows for toggling a value between true and
  12     * false.
  13     *
  14     * Check objects are a lot like radio objects in layout and functionality
  15     * except they do not work as a group, but independently and only toggle the
  16     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
  17     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
  18     * returns the current state. For convenience, like the radio objects, you
  19     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
  20     * for it to modify.
  21     *
  22     * Signals that you can add callbacks for are:
  23     * "changed" - This is called whenever the user changes the state of one of
  24     *             the check object(event_info is NULL).
  25     *
  26     * Default contents parts of the check widget that you can use for are:
  27     * @li "icon" - An icon of the check
  28     *
  29     * Default text parts of the check widget that you can use for are:
  30     * @li "elm.text" - Label of the check
  31     *
  32     * @ref tutorial_check should give you a firm grasp of how to use this widget
  33     * .
  34     * @{
  35     */
  36    /**
  37     * @brief Add a new Check object
  38     *
  39     * @param parent The parent object
  40     * @return The new object or NULL if it cannot be created
  41     */
  42    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
  43
  44    /**
  45     * @brief Set the text label of the check object
  46     *
  47     * @param obj The check object
  48     * @param label The text label string in UTF-8
  49     *
  50     * @deprecated use elm_object_text_set() instead.
  51     */
  52    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
  53
  54    /**
  55     * @brief Get the text label of the check object
  56     *
  57     * @param obj The check object
  58     * @return The text label string in UTF-8
  59     *
  60     * @deprecated use elm_object_text_get() instead.
  61     */
  62    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
  63
  64    /**
  65     * @brief Set the icon object of the check object
  66     *
  67     * @param obj The check object
  68     * @param icon The icon object
  69     *
  70     * Once the icon object is set, a previously set one will be deleted.
  71     * If you want to keep that old content object, use the
  72     * elm_object_content_unset() function.
  73     *
  74     * @deprecated use elm_object_part_content_set() instead.
  75     *
  76     */
  77    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
  78
  79    /**
  80     * @brief Get the icon object of the check object
  81     *
  82     * @param obj The check object
  83     * @return The icon object
  84     *
  85     * @deprecated use elm_object_part_content_get() instead.
  86     *
  87     */
  88    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
  89
  90    /**
  91     * @brief Unset the icon used for the check object
  92     *
  93     * @param obj The check object
  94     * @return The icon object that was being used
  95     *
  96     * Unparent and return the icon object which was set for this widget.
  97     *
  98     * @deprecated use elm_object_part_content_unset() instead.
  99     *
 100     */
 101    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
 102
 103    /**
 104     * @brief Set the on/off state of the check object
 105     *
 106     * @param obj The check object
 107     * @param state The state to use (1 == on, 0 == off)
 108     *
 109     * This sets the state of the check. If set
 110     * with elm_check_state_pointer_set() the state of that variable is also
 111     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
 112     */
 113    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
 114
 115    /**
 116     * @brief Get the state of the check object
 117     *
 118     * @param obj The check object
 119     * @return The boolean state
 120     */
 121    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 122
 123    /**
 124     * @brief Set a convenience pointer to a boolean to change
 125     *
 126     * @param obj The check object
 127     * @param statep Pointer to the boolean to modify
 128     *
 129     * This sets a pointer to a boolean, that, in addition to the check objects
 130     * state will also be modified directly. To stop setting the object pointed
 131     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
 132     * then when this is called, the check objects state will also be modified to
 133     * reflect the value of the boolean @p statep points to, just like calling
 134     * elm_check_state_set().
 135     */
 136    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
 137    EINA_DEPRECATED EAPI void         elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
 138    EINA_DEPRECATED EAPI void         elm_check_states_labels_get(const Evas_Object *obj, const char **ontext, const char **offtext) EINA_ARG_NONNULL(1,2,3);
 139
 140    /**
 141     * @}
 142     */
 143