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