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 /**
  38  * @brief Add a new Check object
  39  *
  40  * @param parent The parent object
  41  * @return The new object or NULL if it cannot be created
  42  */
  43 EAPI Evas_Object *                elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
  44
  45 /**
  46  * @brief Set the on/off state of the check object
  47  *
  48  * @param obj The check object
  49  * @param state The state to use (1 == on, 0 == off)
  50  *
  51  * This sets the state of the check. If set
  52  * with elm_check_state_pointer_set() the state of that variable is also
  53  * changed. Calling this @b doesn't cause the "changed" signal to be emited.
  54  */
  55 EAPI void                         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
  56
  57 /**
  58  * @brief Get the state of the check object
  59  *
  60  * @param obj The check object
  61  * @return The boolean state
  62  */
  63 EAPI Eina_Bool                    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
  64
  65 /**
  66  * @brief Set a convenience pointer to a boolean to change
  67  *
  68  * @param obj The check object
  69  * @param statep Pointer to the boolean to modify
  70  *
  71  * This sets a pointer to a boolean, that, in addition to the check objects
  72  * state will also be modified directly. To stop setting the object pointed
  73  * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
  74  * then when this is called, the check objects state will also be modified to
  75  * reflect the value of the boolean @p statep points to, just like calling
  76  * elm_check_state_set().
  77  */
  78 EAPI void                         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
  79
  80 /**
  81  * @}
  82  */