dali-toolkit/devel-api/controls/control-devel.h

   1 #ifndef DALI_TOOLKIT_CONTROL_DEVEL_H
   2 #define DALI_TOOLKIT_CONTROL_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/control.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace DevelControl
  31 {
  32
  33 enum State
  34 {
  35   NORMAL,
  36   FOCUSED,
  37   DISABLED
  38 };
  39
  40 namespace Property
  41 {
  42
  43 enum
  44 {
  45   STYLE_NAME        = Control::Property::STYLE_NAME,
  46   BACKGROUND_COLOR  = Control::Property::BACKGROUND_COLOR,
  47   BACKGROUND_IMAGE  = Control::Property::BACKGROUND_IMAGE,
  48   KEY_INPUT_FOCUS   = Control::Property::KEY_INPUT_FOCUS,
  49   BACKGROUND        = Control::Property::BACKGROUND,
  50
  51   /**
  52    * @brief Displays a tooltip when the control is hovered over.
  53    * @details Name "tooltip", type Property::STRING, Property::ARRAY or Property::MAP.
  54    *          If Property::STRING, then the style specified in the stylesheet is used.
  55    *          If Property::ARRAY of Visuals then all are displayed in one row.
  56    *          If Property::MAP, then it should be a map of Tooltip properties.
  57    * @note The tooltip is only activated if display content is received, i.e. a string (text) or visual to show.
  58    *       The rest is used to just build up the style of the tooltip (i.e. background, text color/point-size etc.)
  59    * @note When retrieved, a Property::MAP is returned.
  60    * @see Toolkit::Tooltip
  61    */
  62   TOOLTIP = BACKGROUND + 1,
  63
  64   /**
  65    * @brief The current state of the control.
  66    * @details Name "state", type DevelControl::State ( Property::INTEGER ) or Property::STRING
  67    *
  68    * @see DevelControl::State
  69    */
  70   STATE = BACKGROUND + 2,
  71
  72   /**
  73    * @brief The current sub state of the control.
  74    * @details Name "subState", type Property::INTEGER or Property::STRING. The enumeration used is dependent on the derived control.
  75    *
  76    * @see DevelControl::State
  77    */
  78   SUB_STATE = BACKGROUND + 3
  79 };
  80
  81 } // namespace Property
  82
  83 } // namespace DevelControl
  84
  85 } // namespace Toolkit
  86
  87 } // namespace Dali
  88
  89 #endif // DALI_TOOLKIT_CONTROL_DEVEL_H