tizen 2.4 release
[framework/uifw/elementary.git] / src / lib / elm_frame.h
1 /**
2  * @internal
3  * @defgroup Frame Frame
4  * @ingroup Elementary
5  *
6  * @image html frame_inheritance_tree.png
7  * @image latex frame_inheritance_tree.eps
8  *
9  *
10  * @brief Frame is a widget that holds some content and has a title.
11  *
12  * The default look is a frame with a title, but Frame supports multiple
13  * styles:
14  * @li default
15  * @li pad_small
16  * @li pad_medium
17  * @li pad_large
18  * @li pad_huge
19  * @li outdent_top
20  * @li outdent_bottom
21  *
22  * Of all this styles only default shows the title.
23  *
24  * This widget inherits from the @ref Layout one, so that all the
25  * functions acting on it also work for frame objects.
26  *
27  * This widget emits the following signals, besides the ones sent from
28  * @ref Layout:
29  * - @c "clicked" - The user has clicked the frame's label
30  * - @c "language,changed" - the program's language changed (since 1.9)
31  *
32  * Default content parts of the frame widget that you can use for are:
33  * @li "default" - A content of the frame
34  *
35  * Default text parts of the frame widget that you can use for are:
36  * @li "default" - A label of the frame
37  *
38  * Supported elm_object common APIs.
39  * @li @ref elm_object_part_text_set
40  * @li @ref elm_object_part_text_get
41  * @li @ref elm_object_part_content_set
42  * @li @ref elm_object_part_content_get
43  * @li @ref elm_object_part_content_unset
44  *
45  * @{
46  */
47
48 #ifdef EFL_EO_API_SUPPORT
49 #include "elm_frame_eo.h"
50 #endif
51 #ifndef EFL_NOLEGACY_API_SUPPORT
52 #include "elm_frame_legacy.h"
53 #endif
54 /**
55  * @}
56  */