5f5204d7d552d884d27ff5743841ecb34d4d42c7
[framework/uifw/elementary.git] / src / lib / elm_separator.h
1 /**
2  * @defgroup Separator Separator
3  *
4  * @brief Separator is a very thin object used to separate other objects.
5  *
6  * A separator can be vertical or horizontal.
7  *
8  * @ref tutorial_separator is a good example of how to use a separator.
9  * @{
10  */
11 /**
12  * @brief Add a separator object to @p parent
13  *
14  * @param parent The parent object
15  *
16  * @return The separator object, or NULL upon failure
17  */
18 EAPI Evas_Object *
19                elm_separator_add(Evas_Object *parent)
20 EINA_ARG_NONNULL(1);
21 /**
22  * @brief Set the horizontal mode of a separator object
23  *
24  * @param obj The separator object
25  * @param horizontal If true, the separator is horizontal
26  */
27 EAPI void      elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
28 /**
29  * @brief Get the horizontal mode of a separator object
30  *
31  * @param obj The separator object
32  * @return If true, the separator is horizontal
33  *
34  * @see elm_separator_horizontal_set()
35  */
36 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
37 /**
38  * @}
39  */