Merge "Unchecked GetCharacter func when index is over string length" into tizen_2.2
[platform/framework/native/uifw.git] / inc / FUiCtrlControlsTypes.h
1 //
2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
4 //
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
8 //
9 //     http://www.apache.org/licenses/LICENSE-2.0/
10 //
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16 //
17 /**
18  * @file                FUiCtrlControlsTypes.h
19  * @brief               This is the header file for the enumerations.
20  *
21  * This header file contains the declarations of the enumerations.
22  */
23 #ifndef _FUI_CTRL_CONTROLS_TYPES_H_
24 #define _FUI_CTRL_CONTROLS_TYPES_H_
25
26 namespace Tizen { namespace Ui { namespace Controls
27 {
28
29 /**
30  * @enum MarginType
31  *
32  * Defines different margin types for a control.
33  *
34  * @since 2.0
35  */
36 enum MarginType
37 {
38         MARGIN_TYPE_LEFT,                                   /**< The left side of the margin */
39         MARGIN_TYPE_RIGHT,                                  /**< The right side of the margin */
40         MARGIN_TYPE_TOP,                                    /**< The top side of the margin */
41         MARGIN_TYPE_BOTTOM                                  /**< The bottom side of the margin */
42 };
43
44 /**
45  * @enum BackgroundStyle
46  *
47  * Defines the background style.
48  *
49  * @since               2.0
50  */
51 enum BackgroundStyle
52 {
53         BACKGROUND_STYLE_NONE = 0,                              /**< The image with no background */
54         BACKGROUND_STYLE_DEFAULT,                               /**< The default background image */
55 };
56
57 /**
58  * @enum  IconPosition
59  *
60  * Defines position of the text.
61  *
62  * @since       2.0
63  */
64 enum IconPosition
65 {
66         ICON_POSITION_LEFT,                 /**< The position of the icon is to the left of the object */
67         ICON_POSITION_RIGHT                 /**< The position of the icon is to the right of the object */
68 };
69
70 /**
71  * @enum HorizontalAlignment
72  *
73  * Defines horizontal alignment of the text.
74  *
75  * @since               2.0
76  */
77 enum HorizontalAlignment
78 {
79         ALIGNMENT_LEFT,                 /**< The text is left-aligned */
80         ALIGNMENT_CENTER,               /**< The text is center-aligned horizontally */
81         ALIGNMENT_RIGHT             /**< The text is right-aligned */
82 };
83
84 /**
85  * @enum VerticalAlignment
86  *
87  * Defines vertical alignment of the text.
88  *
89  * @since               2.0
90  */
91 enum VerticalAlignment
92 {
93         ALIGNMENT_TOP,                  /**< The text is top-aligned */
94         ALIGNMENT_MIDDLE,               /**< The text is center-aligned vertically */
95         ALIGNMENT_BOTTOM                /**< The text is bottom-aligned */
96 };
97
98 /**
99  * @enum GroupStyle
100  *
101  * Defines the table view style of a control's border.
102  *
103  * @since       2.0
104  */
105 enum GroupStyle
106 {
107         GROUP_STYLE_NONE,                   /**< A rectangle with no outline */
108         GROUP_STYLE_SINGLE,                 /**< A rectangle with all corners rounded */
109         GROUP_STYLE_TOP,                    /**< A rectangle with the two top corners rounded */
110         GROUP_STYLE_MIDDLE,                 /**< A rectangle positioned at the center of a group */
111         GROUP_STYLE_BOTTOM                  /**< A rectangle with the two bottom corners rounded */
112 };
113
114 }}}// Tizen::Ui::Controls
115
116 #endif //_FUI_CTRL_CONTROLS_TYPES_H_