dali-toolkit/public-api/visuals/border-visual-properties.h

   1 #ifndef DALI_TOOLKIT_BORDER_VISUAL_PROPERTIES_H
   2 #define DALI_TOOLKIT_BORDER_VISUAL_PROPERTIES_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/toolkit-property-index-ranges.h>
  23
  24 namespace Dali
  25 {
  26 namespace Toolkit
  27 {
  28 /**
  29  * @addtogroup dali_toolkit_visuals
  30  * @{
  31  */
  32
  33 /**
  34  * @brief BorderVisual is to render a solid color as an internal border to the control's quad.
  35  * @SINCE_1_1.45
  36  */
  37 namespace BorderVisual
  38 {
  39 /**
  40  * @brief BorderVisual Property.
  41  * @SINCE_1_1.45
  42  */
  43 namespace Property
  44 {
  45 /**
  46  * @brief Enumeration for the instance of properties belonging to the BorderVisual.
  47  * @SINCE_1_1.45
  48  */
  49 enum
  50 {
  51   /**
  52    * @brief The color of the border.
  53    * @details Name "borderColor", type Property::VECTOR4.
  54    * @SINCE_1_1.45
  55    * @note Mandatory.
  56    */
  57   COLOR = VISUAL_PROPERTY_START_INDEX,
  58
  59   /**
  60    * @brief The width of the border (in pixels).
  61    * @details Name "borderSize", type Property::FLOAT.
  62    * @SINCE_1_1.45
  63    * @note Mandatory.
  64    */
  65   SIZE,
  66
  67   /**
  68    * @brief Whether anti-aliasing of the border is required.
  69    * @details Name "antiAliasing", type Property::BOOLEAN.
  70    * @SINCE_1_1.45
  71    * @note Optional. If not supplied, default is false.
  72    */
  73   ANTI_ALIASING,
  74 };
  75
  76 } // namespace Property
  77
  78 } // namespace BorderVisual
  79
  80 /**
  81  * @}
  82  */
  83
  84 } // namespace Toolkit
  85
  86 } // namespace Dali
  87
  88 #endif // DALI_TOOLKIT_BORDER_VISUAL_PROPERTIES_H