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) 2019 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 // EXTERNAL INCLUDES
  21 #include <dali/devel-api/adaptor-framework/input-method-context.h>
  22
  23 // INTERNAL INCLUDES
  24 #include <dali-toolkit/public-api/controls/control.h>
  25 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace Toolkit
  31 {
  32
  33 class TransitionData;
  34
  35 namespace Visual
  36 {
  37 class Base;
  38 }
  39
  40 namespace DevelControl
  41 {
  42
  43 enum State
  44 {
  45   NORMAL,
  46   FOCUSED,
  47   DISABLED
  48 };
  49
  50 namespace Property
  51 {
  52
  53 enum
  54 {
  55   STYLE_NAME            = Control::Property::STYLE_NAME,
  56   RESERVED_PROPERTY_01  = Control::Property::RESERVED_PROPERTY_01,
  57   RESERVED_PROPERTY_02  = Control::Property::RESERVED_PROPERTY_02,
  58   KEY_INPUT_FOCUS       = Control::Property::KEY_INPUT_FOCUS,
  59   BACKGROUND            = Control::Property::BACKGROUND,
  60   MARGIN                = Control::Property::MARGIN,
  61   PADDING               = Control::Property::PADDING,
  62
  63   /**
  64    * @brief Displays a tooltip when the control is hovered over.
  65    * @details Name "tooltip", type Property::STRING, Property::ARRAY or Property::MAP.
  66    *          If Property::STRING, then the style specified in the stylesheet is used.
  67    *          If Property::ARRAY of Visuals then all are displayed in one row.
  68    *          If Property::MAP, then it should be a map of Tooltip properties.
  69    * @note The tooltip is only activated if display content is received, i.e. a string (text) or visual to show.
  70    *       The rest is used to just build up the style of the tooltip (i.e. background, text color/point-size etc.)
  71    * @note When retrieved, a Property::MAP is returned.
  72    * @see Toolkit::Tooltip
  73    */
  74   TOOLTIP = PADDING + 1,
  75
  76   /**
  77    * @brief The current state of the control.
  78    * @details Name "state", type DevelControl::State ( Property::INTEGER ) or Property::STRING
  79    *
  80    * @see DevelControl::State
  81    */
  82   STATE = PADDING + 2,
  83
  84   /**
  85    * @brief The current sub state of the control.
  86    * @details Name "subState", type Property::INTEGER or Property::STRING. The enumeration used is dependent on the derived control.
  87    *
  88    * @see DevelControl::State
  89    */
  90   SUB_STATE = PADDING + 3,
  91
  92   /**
  93    * @brief The actor ID of the left focusable control.
  94    * @details Name "leftFocusableActorId", type Property::INTEGER.
  95    *
  96    */
  97   LEFT_FOCUSABLE_ACTOR_ID = PADDING + 4,
  98
  99   /**
 100    * @brief The actor ID of the right focusable control.
 101    * @details Name "rightFocusableActorId", type Property::INTEGER.
 102    *
 103    */
 104   RIGHT_FOCUSABLE_ACTOR_ID = PADDING + 5,
 105
 106   /**
 107    * @brief The actor ID of the up focusable control.
 108    * @details Name "upFocusableActorId", type Property::INTEGER.
 109    *
 110    */
 111   UP_FOCUSABLE_ACTOR_ID = PADDING + 6,
 112
 113   /**
 114    * @brief The actor ID of the down focusable control.
 115    * @details Name "downFocusableActorId", type Property::INTEGER.
 116    *
 117    */
 118   DOWN_FOCUSABLE_ACTOR_ID = PADDING + 7,
 119
 120   /**
 121    * @brief The shadow of the control.
 122    * @details Name "shadow", type Property::MAP.
 123    */
 124   SHADOW = PADDING + 8
 125 };
 126
 127 } // namespace Property
 128
 129 /**
 130  * @brief Register a visual by Property Index.
 131  *
 132  * @param[in] control The control
 133  * @param[in] index The Property index of the visual, used to reference visual
 134  * @param[in] visual The visual to register
 135  *
 136  * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
 137  *       Use below API with enabled set to false if derived class wishes to control when visual is staged.
 138  * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
 139  * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
 140  */
 141 DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual );
 142
 143 /**
 144  * @brief Register a visual by Property Index with a depth index.
 145  *
 146  * @param[in] control The control
 147  * @param[in] index The Property index of the visual, used to reference visual
 148  * @param[in] visual The visual to register
 149  * @param[in] depthIndex The visual's depth-index is set to this
 150  *
 151  * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
 152  *       Use below API with enabled set to false if derived class wishes to control when visual is staged.
 153  *
 154  * @see Visual::Base::GetDepthIndex()
 155  * @see Visual::Base::SetDepthIndex()
 156  */
 157 DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, int depthIndex );
 158
 159 /**
 160  * @brief Register a visual by Property Index with the option of enabling/disabling it.
 161  *
 162  * @param[in] control The control
 163  * @param[in] index The Property index of the visual, used to reference visual
 164  * @param[in] visual The visual to register
 165  * @param[in] enabled false if derived class wants to control when visual is set on stage.
 166  *
 167  * @note If the depth-index is not set on the visual, then it is set to be above the currently registered visuals.
 168  * @note If replacing a visual, then the depth-index of the visual being replaced is used for the visual.
 169  *
 170  * @see EnableVisual()
 171  */
 172 DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled );
 173
 174 /**
 175  * @brief Register a visual by Property Index with a depth index with the option of enabling/disabling it.
 176  *
 177  * @param[in] control The control
 178  * @param[in] index The Property index of the visual, used to reference visual
 179  * @param[in] visual The visual to register
 180  * @param[in] enabled false if derived class wants to control when visual is set on stage.
 181  * @param[in] depthIndex The visual's depth-index is set to this
 182  *
 183  * @see EnableVisual()
 184  * @see Visual::Base::GetDepthIndex()
 185  * @see Visual::Base::SetDepthIndex()
 186  */
 187 DALI_TOOLKIT_API void RegisterVisual( Internal::Control& control, Dali::Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex );
 188
 189 /**
 190  * @brief Erase the entry matching the given index from the list of registered visuals
 191  *
 192  * @param[in] control The control
 193  * @param[in] index The Property index of the visual, used to reference visual
 194  */
 195 DALI_TOOLKIT_API void UnregisterVisual( Internal::Control& control, Dali::Property::Index index );
 196
 197 /**
 198  * @brief Retrieve the visual associated with the given property index.
 199  *
 200  * @param[in] control The control
 201  * @param[in] index The Property index of the visual.
 202  * @return The registered visual if exist, otherwise empty handle.
 203  * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
 204  */
 205 DALI_TOOLKIT_API Toolkit::Visual::Base GetVisual( const Internal::Control& control, Dali::Property::Index index );
 206
 207 /**
 208  * @brief Sets the given visual to be displayed or not when parent staged.
 209  *
 210  * @param[in] control The control
 211  * @param[in] index The Property index of the visual
 212  * @param[in] enable flag to set enabled or disabled.
 213  */
 214 DALI_TOOLKIT_API void EnableVisual( Internal::Control& control, Dali::Property::Index index, bool enable );
 215
 216 /**
 217  * @brief Queries if the given visual is to be displayed when parent staged.
 218  *
 219  * @param[in] control The control
 220  * @param[in] index The Property index of the visual
 221  * @return bool whether visual is enabled or not
 222  */
 223 DALI_TOOLKIT_API bool IsVisualEnabled( const Internal::Control& control, Dali::Property::Index index );
 224
 225
 226 /**
 227  * @brief Add a transition effect on the control to the given animation
 228  *
 229  * Only generates an animator if the properties described in the transition
 230  * data are staged (e.g. the visual is Enabled and the control is on stage).
 231  * Otherwise the target values are stored, and will get set onto the properties
 232  * when the visual is next staged.
 233  *
 234  * @param[in] control The control
 235  * @param[in] animation The Animation to add valid transitions to
 236  * @param[in] transitionData The transition data describing the effect to create
 237  */
 238 DALI_TOOLKIT_API void AddTransitions( Internal::Control& control,
 239                                       Dali::Animation animation,
 240                                       const Toolkit::TransitionData& transitionData );
 241
 242 /**
 243  * @brief Create a transition effect on the control.
 244  *
 245  * Only generates an animation if the properties described in the transition
 246  * data are staged (e.g. the visual is Enabled and the control is on stage).
 247  * Otherwise the target values are stored, and will get set onto the properties
 248  * when the visual is next staged.
 249  *
 250  * @param[in] control The control
 251  * @param[in] transitionData The transition data describing the effect to create
 252  * @return A handle to an animation defined with the given effect, or an empty
 253  * handle if no properties match.
 254  */
 255 DALI_TOOLKIT_API Dali::Animation CreateTransition( Internal::Control& control,
 256                                                    const Toolkit::TransitionData& transitionData );
 257
 258 /**
 259  * @brief Perform an action on a visual registered to this control.
 260  *
 261  * Visuals will have actions, this API is used to perform one of these actions with the given attributes.
 262  *
 263  * @param[in] control The control.
 264  * @param[in] visualIndex The Property index of the visual.
 265  * @param[in] actionId The action to perform.  See Visual to find supported actions.
 266  * @param[in] attributes Optional attributes for the action.
 267  */
 268 DALI_TOOLKIT_API void DoAction( Control& control, Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes );
 269
 270 /**
 271  * @brief Set input method context.
 272  *
 273  * @param[in] control The control.
 274  * @param[in] inputMethodContext The input method context.
 275  */
 276 DALI_TOOLKIT_API void SetInputMethodContext( Internal::Control& control, InputMethodContext& inputMethodContext );
 277
 278 /**
 279  * @brief Visual Event signal type
 280  */
 281 using VisualEventSignalType = Signal< void ( Control, Dali::Property::Index, Dali::Property::Index ) >;
 282
 283 /**
 284  * @brief This signal is emitted when a visual has an event to notify.
 285  *
 286  * A callback of the following type may be connected:
 287  * @code
 288  *   void YourCallbackName( Control control, Dali::Property::Index visualIndex, Dali::Property::Index signalId );
 289  * @endcode
 290  * @return The signal to connect to
 291  */
 292 DALI_TOOLKIT_API VisualEventSignalType& VisualEventSignal( Control control );
 293
 294 } // namespace DevelControl
 295
 296 } // namespace Toolkit
 297
 298 } // namespace Dali
 299
 300 #endif // DALI_TOOLKIT_CONTROL_DEVEL_H