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