dali-toolkit/public-api/enums.h

   1 #ifndef DALI_TOOLKIT_ENUMS_H
   2 #define DALI_TOOLKIT_ENUMS_H
   3
   4 /*
   5  * Copyright (c) 2020 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  * @brief Enumeration for the internal orientation of a control.
  45  * @SINCE_1_0.0
  46  */
  47 enum Type
  48 {
  49   Up,   ///< The contents of control are in a vertical layout, from top to bottom @SINCE_1_0.0
  50   Left, ///< The contents of control are in a horizontal layout, from left to right @SINCE_1_0.0
  51   Down, ///< The contents of control are in a vertical layout, from bottom to top @SINCE_1_0.0
  52   Right ///< The contents of control are in a horizontal layout, from right to left @SINCE_1_0.0
  53 };
  54
  55 } // namespace ControlOrientation
  56
  57 /**
  58  * @brief Queries whether an orientation is vertical.
  59  *
  60  * @param[in] orientation The orientation
  61  * @return true if the orientation is vertical
  62  */
  63 DALI_TOOLKIT_API bool IsVertical(ControlOrientation::Type orientation);
  64
  65 /**
  66  * @brief Queries whether an orientation is horizontal.
  67  *
  68  * @SINCE_1_0.0
  69  * @param[in] orientation The orientation
  70  * @return true if the orientation is horizontal
  71  */
  72 DALI_TOOLKIT_API bool IsHorizontal(ControlOrientation::Type orientation);
  73
  74 /**
  75  * @}
  76  */
  77 } // namespace Toolkit
  78
  79 } // namespace Dali
  80
  81 #endif // DALI_TOOLKIT_ENUMS_H