dali-toolkit/devel-api/controls/buttons/button-devel.h

   1 #ifndef __DALI_TOOLKIT_BUTTON_DEVEL_H__
   2 #define __DALI_TOOLKIT_BUTTON_DEVEL_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/controls/buttons/button.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace DevelButton
  31 {
  32 /**
  33  *
  34  * @section ButtonProperties Properties
  35  * |%Property enum                                         |String name                             |Type          |Writable|Animatable|
  36  * |-------------------------------------------------------|----------------------------------------|--------------|--------|----------|
  37  * | Property::DISABLED                                    | disabled                               |  BOOLEAN     | Y      | N        |
  38  * | Property::AUTO_REPEATING                              | autoRepeating                          |  BOOLEAN     | Y      | N        |
  39  * | Property::INITIAL_AUTO_REPEATING_DELAY                | initialAutoRepeatingDelay              |  FLOAT       | Y      | N        |
  40  * | Property::NEXT_AUTO_REPEATING_DELAY                   | nextAutoRepeatingDelay                 |  FLOAT       | Y      | N        |
  41  * | Property::TOGGLABLE                                   | togglable                              |  BOOLEAN     | Y      | N        |
  42  * | Property::SELECTED                                    | selected                               |  BOOLEAN     | Y      | N        |
  43  * | Property::LABEL                                       | label                                  |  MAP         | Y      | N        |
  44  * | Property::UNSELECTED_STATE_VISUAL                     | unselectedVisual                       |  MAP         | Y      | N        |
  45  * | Property::SELECTED_VISUAL                             | selectedVisual                         |  MAP         | Y      | N        |
  46  * | Property::DISABLED_SELECTED_VISUAL                    | disabledSelectedVisual                 |  MAP         | Y      | N        |
  47  * | Property::DISABLED_UNSELECTED_VISUAL                  | disabledUnselectedVisual               |  MAP         | Y      | N        |
  48  * | Property::UNSELECTED_BACKGROUND_VISUAL                | unselectedBackgroundVisual             |  MAP         | Y      | N        |
  49  * | Property::SELECTED_BACKGROUND_VISUAL                  | selectedBackgroundVisual               |  MAP         | Y      | N        |
  50  * | Property::DISABLED_UNSELECTED_BACKGROUND_VISUAL       | disabledUnselectedBackgroundVisual     |  MAP         | Y      | N        |
  51  * | Property::DISABLED_SELECTED_BACKGROUND_VISUAL         | disabledSelectedBackgroundVisual       |  MAP         | Y      | N        |
  52  * | Property::LABEL_RELATIVE_ALIGNMENT                    | labelRelativeAlignment                 |  STRING      | Y      | N        |
  53  * -------------------------------------------------------------------------------------------------------------------------------------
  54  *
  55  *
  56  */
  57
  58   namespace Property
  59   {
  60     enum Type
  61     {
  62       DISABLED = Dali::Toolkit::Button::Property::DISABLED,
  63       AUTO_REPEATING = Dali::Toolkit::Button::Property::AUTO_REPEATING,
  64       INITIAL_AUTO_REPEATING_DELAY = Dali::Toolkit::Button::Property::INITIAL_AUTO_REPEATING_DELAY,
  65       NEXT_AUTO_REPEATING_DELAY = Dali::Toolkit::Button::Property:: NEXT_AUTO_REPEATING_DELAY,
  66       TOGGLABLE = Dali::Toolkit::Button::Property::TOGGLABLE,
  67       SELECTED = Dali::Toolkit::Button::Property::SELECTED,
  68       UNSELECTED_STATE_IMAGE = Dali::Toolkit::Button::Property::UNSELECTED_STATE_IMAGE,
  69       SELECTED_STATE_IMAGE = Dali::Toolkit::Button::Property::SELECTED_STATE_IMAGE,
  70       DISABLED_STATE_IMAGE = Dali::Toolkit::Button::Property::DISABLED_STATE_IMAGE,
  71       UNSELECTED_COLOR = Dali::Toolkit::Button::Property::UNSELECTED_COLOR,
  72       SELECTED_COLOR = Dali::Toolkit::Button::Property::SELECTED_COLOR,
  73       LABEL = Dali::Toolkit::Button::Property::LABEL,
  74       LABEL_TEXT = Dali::Toolkit::Button::Property::LABEL_TEXT,
  75
  76       /**
  77        * @brief name "unselectedVisual", type string if it is a url, map otherwise
  78        * @details Sets the unselected button foreground/icon visual
  79        */
  80       UNSELECTED_VISUAL = LABEL_TEXT + 1,
  81
  82       /**
  83        * @brief name "selectedImage", type string if it is a url, map otherwise
  84        * @details Sets the selected button foreground/icon visual
  85        * @SINCE_1_2.18
  86        */
  87       SELECTED_VISUAL,
  88
  89       /**
  90        * @brief name "disabledSelectedVisual", type string if it is a url, map otherwise
  91        * @details Sets the disabled selected state foreground/icon button visual
  92        */
  93       DISABLED_SELECTED_VISUAL,
  94
  95       /**
  96        * @brief name "disabledUnSelectedVisual", type string if it is a url, map otherwise
  97        * @details Sets the disabled unselected state foreground/icon visual
  98        */
  99       DISABLED_UNSELECTED_VISUAL,
 100
 101       /**
 102        * @brief name "unselectedBackgroundVisual", type string if it is a url, map otherwise
 103        * @details Sets the disabled in the unselected state background, button visual
 104        */
 105       UNSELECTED_BACKGROUND_VISUAL,
 106
 107       /**
 108        * @brief name "selectedBackgroundVisual", type string if it is a url, map otherwise
 109        * @details Sets the selected background button visual
 110        */
 111       SELECTED_BACKGROUND_VISUAL,
 112
 113       /**
 114        * @brief name "disabledUnselectedBackgroundVisual", type string if it is a url, map otherwise
 115        * @details Sets the disabled while unselected background button visual
 116        */
 117       DISABLED_UNSELECTED_BACKGROUND_VISUAL,
 118
 119       /**
 120        * @brief name "disabledSelectedBackgroundVisual", type string if it is a url, map otherwise
 121        * @details Sets the disabled while selected background button visual
 122        */
 123       DISABLED_SELECTED_BACKGROUND_VISUAL,
 124
 125       /**
 126        * @brief name "labelRelativeAlignment", type STRING
 127        * @details Sets the position of the the label in relation to the foreground/icon if both present
 128        */
 129       LABEL_RELATIVE_ALIGNMENT,
 130
 131       /**
 132        * @brief name "labelPadding", type Vector4
 133        * @details Sets the padding around the text
 134        */
 135       LABEL_PADDING,
 136
 137       /**
 138        * @brief name "visualPadding", type Vector4
 139        * @details Sets the padding around the foreground visual
 140        */
 141       VISUAL_PADDING
 142     };
 143   } // namespace Property
 144
 145 } // namespace DevelButton
 146
 147 } // namespace Toolkit
 148
 149 } // namespace Dali
 150
 151 #endif // __DALI_TOOLKIT_BUTTON_DEVEL_H__