capi/dali-toolkit/public-api/enums.h

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