src/lib/elm_separator.h

   1 /**
   2  * @defgroup Separator Separator
   3  * @ingroup Elementary
   4  *
   5  * @image html separator_inheritance_tree.png
   6  * @image latex separator_inheritance_tree.eps
   7  *
   8  * @brief Separator is a very thin object used to separate other objects.
   9  *
  10  * A separator can be vertical or horizontal.
  11  *
  12  * This widget inherits from the @ref Layout one, so that all the
  13  * functions acting on it also work for separator objects.
  14  *
  15  * This widget emits the signals coming from @ref Layout.
  16  *
  17  * @ref tutorial_separator is a good example of how to use a separator.
  18  * @{
  19  */
  20
  21 /**
  22  * @brief Add a separator object to @p parent
  23  *
  24  * @param parent The parent object
  25  *
  26  * @return The separator object, or NULL upon failure
  27  *
  28  * @ingroup Separator
  29  */
  30 EAPI Evas_Object *elm_separator_add(Evas_Object *parent);
  31
  32 /**
  33  * @brief Set the horizontal mode of a separator object
  34  *
  35  * @param obj The separator object
  36  * @param horizontal If true, the separator is horizontal
  37  *
  38  * @ingroup Separator
  39  */
  40 EAPI void      elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal);
  41
  42 /**
  43  * @brief Get the horizontal mode of a separator object
  44  *
  45  * @param obj The separator object
  46  * @return If true, the separator is horizontal
  47  *
  48  * @see elm_separator_horizontal_set()
  49  *
  50  * @ingroup Separator
  51  */
  52 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj);
  53
  54 /**
  55  * @}
  56  */