DALi Version 1.3.49
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / enums.h
1 #ifndef __DALI_TOOLKIT_ENUMS_H__
2 #define __DALI_TOOLKIT_ENUMS_H__
3
4 /*
5  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 // INTERNAL INCLUDES
22 #include <dali-toolkit/public-api/dali-toolkit-common.h>
23
24 namespace Dali
25 {
26 /**
27  * @brief DALi Toolkit namespace.
28  * @SINCE_1_0.0
29  */
30 namespace Toolkit
31 {
32 /**
33  * @addtogroup dali_toolkit_controls
34  * @{
35  */
36
37 /**
38  * @brief Control Orientation namespace.
39  * @SINCE_1_0.0
40  */
41 namespace ControlOrientation
42 {
43
44 /**
45  * @brief Enumeration for the internal orientation of a control.
46  * @SINCE_1_0.0
47  */
48 enum Type
49 {
50   Up,   ///< The contents of control are in a vertical layout, from top to bottom @SINCE_1_0.0
51   Left, ///< The contents of control are in a horizontal layout, from left to right @SINCE_1_0.0
52   Down, ///< The contents of control are in a vertical layout, from bottom to top @SINCE_1_0.0
53   Right ///< The contents of control are in a horizontal layout, from right to left @SINCE_1_0.0
54 };
55
56 } // namespace ControlOrientation
57
58 /**
59  * @brief Queries whether an orientation is vertical.
60  *
61  * @param[in] orientation The orientation
62  * @return true if the orientation is vertical
63  */
64 DALI_TOOLKIT_API bool IsVertical(ControlOrientation::Type orientation);
65
66 /**
67  * @brief Queries whether an orientation is horizontal.
68  *
69  * @SINCE_1_0.0
70  * @param[in] orientation The orientation
71  * @return true if the orientation is horizontal
72  */
73 DALI_TOOLKIT_API bool IsHorizontal(ControlOrientation::Type orientation);
74
75 /**
76  * @}
77  */
78 } // namespace Toolkit
79
80 } // namespace Dali
81
82 #endif // __DALI_TOOLKIT_ENUMS_H__