tizen 2.3.1 release
[framework/uifw/elementary.git] / src / lib / elm_separator.h
1 /**
2  * @internal
3  * @defgroup Separator Separator
4  * @ingroup elm_widget_group
5  *
6  * @image html separator_inheritance_tree.png
7  * @image latex separator_inheritance_tree.eps
8  *
9  * @brief Separator is a very thin object used to separate other objects.
10  *
11  * @remarks A separator can be vertical or horizontal.
12  *
13  * @remarks This widget inherits from the @ref Layout one, so that all the
14  *          functions acting on it also work for separator objects.
15  *
16  * @remarks This widget emits the signals coming from @ref Layout.
17  *
18  * @{
19  */
20
21 /**
22  * @brief Adds a separator object to @a parent.
23  *
24  * @param[in] parent The parent object
25  *
26  * @return The separator object, otherwise @c NULL on failure
27  */
28 EAPI Evas_Object *elm_separator_add(Evas_Object *parent);
29
30 /**
31  * @brief Sets the horizontal mode of a separator object.
32  *
33  * @param[in] obj The separator object
34  * @param[in] horizontal If @c true the separator is horizontal,
35  *                   otherwise @c false
36  */
37 EAPI void      elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal);
38
39 /**
40  * @brief Gets the horizontal mode of a separator object.
41  *
42  * @param[in] obj The separator object
43  * @return If @c true the separator is horizontal,
44  *         otherwise @c false
45  *
46  * @see elm_separator_horizontal_set()
47  */
48 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj);
49
50 /**
51  * @}
52  */