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) 2017 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 class TransitionData;
  31
  32 namespace Visual
  33 {
  34 class Base;
  35 }
  36
  37 namespace DevelControl
  38 {
  39
  40 enum State
  41 {
  42   NORMAL,
  43   FOCUSED,
  44   DISABLED
  45 };
  46
  47 namespace Property
  48 {
  49
  50 enum
  51 {
  52   STYLE_NAME        = Control::Property::STYLE_NAME,
  53   BACKGROUND_COLOR  = Control::Property::BACKGROUND_COLOR,
  54   BACKGROUND_IMAGE  = Control::Property::BACKGROUND_IMAGE,
  55   KEY_INPUT_FOCUS   = Control::Property::KEY_INPUT_FOCUS,
  56   BACKGROUND        = Control::Property::BACKGROUND,
  57
  58   /**
  59    * @brief Displays a tooltip when the control is hovered over.
  60    * @details Name "tooltip", type Property::STRING, Property::ARRAY or Property::MAP.
  61    *          If Property::STRING, then the style specified in the stylesheet is used.
  62    *          If Property::ARRAY of Visuals then all are displayed in one row.
  63    *          If Property::MAP, then it should be a map of Tooltip properties.
  64    * @note The tooltip is only activated if display content is received, i.e. a string (text) or visual to show.
  65    *       The rest is used to just build up the style of the tooltip (i.e. background, text color/point-size etc.)
  66    * @note When retrieved, a Property::MAP is returned.
  67    * @see Toolkit::Tooltip
  68    */
  69   TOOLTIP = BACKGROUND + 1,
  70
  71   /**
  72    * @brief The current state of the control.
  73    * @details Name "state", type DevelControl::State ( Property::INTEGER ) or Property::STRING
  74    *
  75    * @see DevelControl::State
  76    */
  77   STATE = BACKGROUND + 2,
  78
  79   /**
  80    * @brief The current sub state of the control.
  81    * @details Name "subState", type Property::INTEGER or Property::STRING. The enumeration used is dependent on the derived control.
  82    *
  83    * @see DevelControl::State
  84    */
  85   SUB_STATE = BACKGROUND + 3,
  86
  87   /**
  88    * @brief The actor ID of the left focusable control.
  89    * @details Name "leftFocusableActorId", type Property::INTEGER.
  90    *
  91    */
  92   LEFT_FOCUSABLE_ACTOR_ID = BACKGROUND + 4,
  93
  94   /**
  95    * @brief The actor ID of the right focusable control.
  96    * @details Name "rightFocusableActorId", type Property::INTEGER.
  97    *
  98    */
  99   RIGHT_FOCUSABLE_ACTOR_ID = BACKGROUND + 5,
 100
 101   /**
 102    * @brief The actor ID of the up focusable control.
 103    * @details Name "upFocusableActorId", type Property::INTEGER.
 104    *
 105    */
 106   UP_FOCUSABLE_ACTOR_ID = BACKGROUND + 6,
 107
 108   /**
 109    * @brief The actor ID of the down focusable control.
 110    * @details Name "downFocusableActorId", type Property::INTEGER.
 111    *
 112    */
 113   DOWN_FOCUSABLE_ACTOR_ID = BACKGROUND + 7
 114 };
 115
 116 } // namespace Property
 117
 118 /// @brief ResourceReady signal type;
 119 typedef Signal<void ( Control ) > ResourceReadySignalType;
 120
 121 /**
 122  * @brief This signal is emitted after all resources required
 123  * by a control are loaded and ready.
 124  * Most resources are only loaded when the control is placed on stage.
 125  *
 126  * A callback of the following type may be connected:
 127  * @code
 128  *   void YourCallbackName( Control control );
 129  * @endcode
 130  */
 131 DALI_IMPORT_API ResourceReadySignalType& ResourceReadySignal( Control& control );
 132
 133 /**
 134  * @brief Query if all resources required by a control are loaded and ready.
 135  * Most resources are only loaded when the control is placed on stage.
 136  * @return true if the resources are loaded and ready, false otherwise
 137  *
 138  */
 139 DALI_IMPORT_API bool IsResourceReady( const Control& control );
 140
 141 /**
 142  * @brief Register a visual by Property Index.
 143  *
 144  * @param[in] control The control
 145  * @param[in] index The Property index of the visual, used to reference visual
 146  * @param[in] visual The visual to register
 147  *
 148  * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
 149  *       Use below API with enabled set to false if derived class wishes to control when visual is staged.
 150  * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
 151  * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
 152  */
 153 DALI_IMPORT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual );
 154
 155 /**
 156  * @brief Register a visual by Property Index with a depth index.
 157  *
 158  * @param[in] control The control
 159  * @param[in] index The Property index of the visual, used to reference visual
 160  * @param[in] visual The visual to register
 161  * @param[in] depthIndex The visual's depth-index is set to this
 162  *
 163  * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
 164  *       Use below API with enabled set to false if derived class wishes to control when visual is staged.
 165  *
 166  * @see Visual::Base::GetDepthIndex()
 167  * @see Visual::Base::SetDepthIndex()
 168  */
 169 DALI_IMPORT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex );
 170
 171 /**
 172  * @brief Register a visual by Property Index with the option of enabling/disabling it.
 173  *
 174  * @param[in] control The control
 175  * @param[in] index The Property index of the visual, used to reference visual
 176  * @param[in] visual The visual to register
 177  * @param[in] enabled false if derived class wants to control when visual is set on stage.
 178  *
 179  * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
 180  * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
 181  *
 182  * @see EnableVisual()
 183  */
 184 DALI_IMPORT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled );
 185
 186 /**
 187  * @brief Register a visual by Property Index with a depth index with the option of enabling/disabling it.
 188  *
 189  * @param[in] control The control
 190  * @param[in] index The Property index of the visual, used to reference visual
 191  * @param[in] visual The visual to register
 192  * @param[in] enabled false if derived class wants to control when visual is set on stage.
 193  * @param[in] depthIndex The visual's depth-index is set to this
 194  *
 195  * @see EnableVisual()
 196  * @see Visual::Base::GetDepthIndex()
 197  * @see Visual::Base::SetDepthIndex()
 198  */
 199 DALI_IMPORT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex );
 200
 201 /**
 202  * @brief Erase the entry matching the given index from the list of registered visuals
 203  *
 204  * @param[in] control The control
 205  * @param[in] index The Property index of the visual, used to reference visual
 206  */
 207 DALI_IMPORT_API void UnregisterVisual( Internal::Control& control, Dali::Property::Index index );
 208
 209 /**
 210  * @brief Retrieve the visual associated with the given property index.
 211  *
 212  * @param[in] control The control
 213  * @param[in] index The Property index of the visual.
 214  * @return The registered visual if exist, otherwise empty handle.
 215  * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
 216  */
 217 DALI_IMPORT_API Toolkit::Visual::Base GetVisual( const Internal::Control& control, Dali::Property::Index index );
 218
 219 /**
 220  * @brief Sets the given visual to be displayed or not when parent staged.
 221  *
 222  * @param[in] control The control
 223  * @param[in] index The Property index of the visual
 224  * @param[in] enable flag to set enabled or disabled.
 225  */
 226 DALI_IMPORT_API void EnableVisual( Internal::Control& control, Dali::Property::Index index, bool enable );
 227
 228 /**
 229  * @brief Queries if the given visual is to be displayed when parent staged.
 230  *
 231  * @param[in] control The control
 232  * @param[in] index The Property index of the visual
 233  * @return bool whether visual is enabled or not
 234  */
 235 DALI_IMPORT_API bool IsVisualEnabled( const Internal::Control& control, Dali::Property::Index index );
 236
 237 /**
 238  * @brief Create a transition effect on the control.
 239  *
 240  * Only generates an animation if the properties described in the transition
 241  * data are staged (e.g. the visual is Enabled and the control is on stage).
 242  * Otherwise the target values are stored, and will get set onto the properties
 243  * when the visual is next staged.
 244  *
 245  * @param[in] control The control
 246  * @param[in] transitionData The transition data describing the effect to create
 247  * @return A handle to an animation defined with the given effect, or an empty
 248  * handle if no properties match.
 249  */
 250 DALI_IMPORT_API Dali::Animation CreateTransition( Internal::Control& control, const Toolkit::TransitionData& transitionData );
 251
 252 } // namespace DevelControl
 253
 254 } // namespace Toolkit
 255
 256 } // namespace Dali
 257
 258 #endif // DALI_TOOLKIT_CONTROL_DEVEL_H