Merge "Fixed Control and Magnifier API" into tizen
[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) 2015 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/public-api/common/dali-common.h>
23
24 namespace Dali
25 {
26
27 /**
28  * @brief DALi Toolkit namespace.
29  */
30 namespace Toolkit
31 {
32
33 /**
34  * @brief Control Orientation namespace.
35  */
36 namespace ControlOrientation
37 {
38
39 /**
40  * @brief The internal orientation of a control.
41  */
42 enum Type
43 {
44   Up,   ///< The contents of control are in a vertical layout, from top to bottom
45   Left, ///< The contents of control are in a horizontal layout, from left to right
46   Down, ///< The contents of control are in a vertical layout, from bottom to top
47   Right ///< The contents of control are in a horizontal layout, from right to left
48 };
49
50 } // namespace ControlOrientation
51
52 /**
53  * @brief Query whether an orientation is vertical.
54  *
55  * @param[in] orientation The orientation.
56  * @return True if the orientation is vertical.
57  */
58 DALI_IMPORT_API bool IsVertical(ControlOrientation::Type orientation);
59
60 /**
61  * @brief Query whether an orientation is horizontal.
62  *
63  * @param[in] orientation The orientation.
64  * @return True if the orientation is horizontal.
65  */
66 DALI_IMPORT_API bool IsHorizontal(ControlOrientation::Type orientation);
67
68 } // namespace Toolkit
69
70 } // namespace Dali
71
72 #endif // __DALI_TOOLKIT_ENUMS_H__