Merge "Add Visual descriptions to generate doxygen page" into devel/master
[platform/core/uifw/dali-toolkit.git] / 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) 2016 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
27 namespace Toolkit
28 {
29
30 /**
31  * @addtogroup dali_toolkit_visuals
32  * @{
33  */
34
35 /**
36  * @brief BorderVisual is to render a solid color as an internal border to the control's quad.
37  * @SINCE_1_1.45
38  */
39 namespace BorderVisual
40 {
41
42 /**
43  * @brief BorderVisual Property
44  * @SINCE_1_1.45
45  */
46 namespace Property
47 {
48
49 /**
50  * @brief BorderVisual Property
51  * @SINCE_1_1.45
52  */
53 enum
54 {
55   /**
56    * @brief The color of the border.
57    * @details Name "borderColor", type Property::VECTOR4.
58    * @SINCE_1_1.45
59    * @note Mandatory.
60    */
61   COLOR = VISUAL_PROPERTY_START_INDEX,
62
63   /**
64    * @brief The width of the border (in pixels).
65    * @details Name "borderSize", type Property::FLOAT.
66    * @SINCE_1_1.45
67    * @note Mandatory.
68    */
69   SIZE,
70
71   /**
72    * @brief Whether anti-aliasing of the border is required.
73    * @details Name "antiAliasing", type Property::BOOLEAN.
74    * @SINCE_1_1.45
75    * @note Optional. If not supplied, default is false.
76    */
77   ANTI_ALIASING,
78 };
79
80 } // namespace Property
81
82 } // namespace BorderVisual
83
84 /**
85  * @}
86  */
87
88 } // namespace Toolkit
89
90 } // namespace Dali
91
92 #endif // DALI_TOOLKIT_BORDER_VISUAL_PROPERTIES_H