dali-toolkit/internal/controls/control/control-data-impl.h

   1 #ifndef DALI_TOOLKIT_CONTROL_DATA_IMPL_H
   2 #define DALI_TOOLKIT_CONTROL_DATA_IMPL_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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/type-registry.h>
  23 #include <dali-toolkit/devel-api/controls/control-devel.h>
  24 #include <string>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/internal/visuals/visual-resource-observer.h>
  28 #include <dali-toolkit/public-api/controls/control-impl.h>
  29 #include <dali/devel-api/common/owner-container.h>
  30 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
  31 #include <dali-toolkit/internal/controls/tooltip/tooltip.h>
  32 #include <dali-toolkit/internal/builder/style.h>
  33 #include <dali-toolkit/internal/builder/dictionary.h>
  34 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  35
  36 namespace Dali
  37 {
  38
  39 namespace Toolkit
  40 {
  41
  42 namespace Internal
  43 {
  44
  45  /**
  46   * Struct used to store Visual within the control, index is a unique key for each visual.
  47   */
  48 struct RegisteredVisual
  49 {
  50   Property::Index index;
  51   Toolkit::Visual::Base visual;
  52   bool enabled : 1;
  53   bool pending : 1;
  54
  55   RegisteredVisual( Property::Index aIndex, Toolkit::Visual::Base &aVisual, bool aEnabled, bool aPendingReplacement )
  56   : index(aIndex), visual(aVisual), enabled(aEnabled), pending( aPendingReplacement )
  57   {
  58   }
  59 };
  60
  61 typedef Dali::OwnerContainer< RegisteredVisual* > RegisteredVisualContainer;
  62
  63
  64 /**
  65  * @brief Holds the Implementation for the internal control class
  66  */
  67 class Control::Impl : public ConnectionTracker, public Visual::ResourceObserver
  68 {
  69
  70 public:
  71
  72   /**
  73    * @brief Retrieves the implementation of the internal control class.
  74    * @param[in] internalControl A ref to the control whose internal implementation is required
  75    * @return The internal implementation
  76    */
  77   static Control::Impl& Get( Internal::Control& internalControl );
  78
  79   /**
  80    * @copydoc Get( Internal::Control& )
  81    */
  82   static const Control::Impl& Get( const Internal::Control& internalControl );
  83
  84   /**
  85    * @brief Constructor.
  86    * @param[in] controlImpl The control which own this implementation
  87    */
  88   Impl( Control& controlImpl );
  89
  90   /**
  91    * @brief Destructor.
  92    */
  93   ~Impl();
  94
  95   /**
  96    * @brief Called when a pinch is detected.
  97    * @param[in] actor The actor the pinch occurred on
  98    * @param[in] pinch The pinch gesture details
  99    */
 100   void PinchDetected(Actor actor, const PinchGesture& pinch);
 101
 102   /**
 103    * @brief Called when a pan is detected.
 104    * @param[in] actor The actor the pan occurred on
 105    * @param[in] pinch The pan gesture details
 106    */
 107   void PanDetected(Actor actor, const PanGesture& pan);
 108
 109   /**
 110    * @brief Called when a tap is detected.
 111    * @param[in] actor The actor the tap occurred on
 112    * @param[in] pinch The tap gesture details
 113    */
 114   void TapDetected(Actor actor, const TapGesture& tap);
 115
 116   /**
 117    * @brief Called when a long-press is detected.
 118    * @param[in] actor The actor the long-press occurred on
 119    * @param[in] pinch The long-press gesture details
 120    */
 121   void LongPressDetected(Actor actor, const LongPressGesture& longPress);
 122
 123   /**
 124    * @brief Called when a resource is ready.
 125    * @param[in] object The visual whose resources are ready
 126    * @note Overriding method in Visual::ResourceObserver.
 127    */
 128   virtual void ResourceReady( Visual::Base& object );
 129
 130   /**
 131    * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
 132    */
 133   void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual );
 134
 135   /**
 136    * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
 137    */
 138   void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, int depthIndex );
 139
 140   /**
 141    * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
 142    */
 143   void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled );
 144
 145   /**
 146    * @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
 147    */
 148   void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex );
 149
 150   /**
 151    * @copydoc Dali::Toolkit::DevelControl::UnregisterVisual()
 152    */
 153   void UnregisterVisual( Property::Index index );
 154
 155   /**
 156    * @copydoc Dali::Toolkit::DevelControl::GetVisual()
 157    */
 158   Toolkit::Visual::Base GetVisual( Property::Index index ) const;
 159
 160   /**
 161    * @copydoc Dali::Toolkit::DevelControl::EnableVisual()
 162    */
 163   void EnableVisual( Property::Index index, bool enable );
 164
 165   /**
 166    * @copydoc Dali::Toolkit::DevelControl::IsVisualEnabled()
 167    */
 168   bool IsVisualEnabled( Property::Index index ) const;
 169
 170   /**
 171    * @brief Stops observing the given visual.
 172    * @param[in] visual The visual to stop observing
 173    */
 174   void StopObservingVisual( Toolkit::Visual::Base& visual );
 175
 176   /**
 177    * @brief Starts observing the given visual.
 178    * @param[in] visual The visual to start observing
 179    */
 180   void StartObservingVisual( Toolkit::Visual::Base& visual);
 181
 182   /**
 183    * @copydoc Dali::Toolkit::DevelControl::GetVisualResourceStatus()
 184    */
 185   Toolkit::Visual::ResourceStatus GetVisualResourceStatus( Property::Index index ) const;
 186
 187   /**
 188    * @copydoc Dali::Toolkit::DevelControl::CreateTransition()
 189    */
 190   Dali::Animation CreateTransition( const Toolkit::TransitionData& transitionData );
 191
 192   /**
 193    * @copydoc Dali::Toolkit::DevelControl::DoAction()
 194    */
 195   void DoAction( Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes );
 196
 197   /**
 198    * @brief Function used to set control properties.
 199    * @param[in] object The object whose property to set
 200    * @param[in] index The index of the property to set
 201    * @param[in] value The value of the property to set
 202    */
 203   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
 204
 205   /**
 206    * @brief Function used to retrieve the value of control properties.
 207    * @param[in] object The object whose property to get
 208    * @param[in] index The index of the property to get
 209    * @return The value of the property
 210    */
 211   static Property::Value GetProperty( BaseObject* object, Property::Index index );
 212
 213   /**
 214    * @brief Sets the state of the control.
 215    * @param[in] newState The state to set
 216    * @param[in] withTransitions Whether to show a transition when changing to the new state
 217    */
 218   void SetState( DevelControl::State newState, bool withTransitions=true );
 219
 220   /**
 221    * @brief Sets the sub-state of the control.
 222    * @param[in] newState The sub-state to set
 223    * @param[in] withTransitions Whether to show a transition when changing to the new sub-state
 224    */
 225   void SetSubState( const std::string& subStateName, bool withTransitions=true );
 226
 227   /**
 228    * @brief Replaces visuals and properties from the old state to the new state.
 229    * @param[in] oldState The old state
 230    * @param[in] newState The new state
 231    * @param[in] subState The current sub state
 232    */
 233   void ReplaceStateVisualsAndProperties( const StylePtr oldState, const StylePtr newState, const std::string& subState );
 234
 235   /**
 236    * @brief Removes a visual from the control's container.
 237    * @param[in] visuals The container of visuals
 238    * @param[in] visualName The name of the visual to remove
 239    */
 240   void RemoveVisual( RegisteredVisualContainer& visuals, const std::string& visualName );
 241
 242   /**
 243    * @brief Removes several visuals from the control's container.
 244    * @param[in] visuals The container of visuals
 245    * @param[in] removeVisuals The visuals to remove
 246    */
 247   void RemoveVisuals( RegisteredVisualContainer& visuals, DictionaryKeys& removeVisuals );
 248
 249   /**
 250    * @brief Copies the visual properties that are specific to the control instance into the instancedProperties container.
 251    * @param[in] visuals The control's visual container
 252    * @param[out] instancedProperties The instanced properties are added to this container
 253    */
 254   void CopyInstancedProperties( RegisteredVisualContainer& visuals, Dictionary<Property::Map>& instancedProperties );
 255
 256   /**
 257    * @brief On state change, ensures visuals are moved or created appropriately.
 258    *
 259    * Go through the list of visuals that are common to both states.
 260    * If they are different types, or are both image types with different
 261    * URLs, then the existing visual needs moving and the new visual needs creating
 262    *
 263    * @param[in] stateVisualsToChange The visuals to change
 264    * @param[in] instancedProperties The instanced properties @see CopyInstancedProperties
 265    */
 266   void RecreateChangedVisuals( Dictionary<Property::Map>& stateVisualsToChange, Dictionary<Property::Map>& instancedProperties );
 267
 268   /**
 269    * @brief Whether the resource is ready
 270    * @return True if the resource is read.
 271    */
 272   bool IsResourceReady() const;
 273
 274   /**
 275    * @copydoc CustomActorImpl::OnStageDisconnection()
 276    */
 277   void OnStageDisconnection();
 278
 279   /**
 280    * @brief Sets the margin.
 281    * @param[in] margin Margin is a collections of extent ( start, end, top, bottom )
 282    */
 283   void SetMargin( Extents margin );
 284
 285   /**
 286    * @brief Returns the value of margin
 287    * @return The value of margin
 288    */
 289   Extents GetMargin() const;
 290
 291   /**
 292    * @brief Sets the padding.
 293    * @param[in] padding Padding is a collections of extent ( start, end, top, bottom ).
 294    */
 295   void SetPadding( Extents padding );
 296
 297   /**
 298    * @brief Returns the value of padding
 299    * @return The value of padding
 300    */
 301   Extents GetPadding() const;
 302
 303   /**
 304    * @brief Set the input method context.
 305    * @param[in] inputMethodContext The input method context.
 306    */
 307   void SetInputMethodContext( InputMethodContext& inputMethodContext );
 308
 309   /**
 310    * @brief Filter an key event.
 311    * @param[in] event The key to be filtered.
 312    * @return True if the key handled, otherwise false.
 313    */
 314   bool FilterKeyEvent( const KeyEvent& event );
 315
 316 private:
 317
 318   /**
 319    * Used as an alternative to boolean so that it is obvious whether a visual is enabled/disabled.
 320    */
 321   struct VisualState
 322   {
 323     enum Type
 324     {
 325       DISABLED = 0, ///< Visual disabled.
 326       ENABLED = 1   ///< Visual enabled.
 327     };
 328   };
 329
 330   /**
 331    * Used as an alternative to boolean so that it is obvious whether a visual's depth value has been set or not by the caller.
 332    */
 333   struct DepthIndexValue
 334   {
 335     enum Type
 336     {
 337       NOT_SET = 0, ///< Visual depth value not set by caller.
 338       SET = 1      ///< Visual depth value set by caller.
 339     };
 340   };
 341
 342   /**
 343    * @brief Adds the visual to the list of registered visuals.
 344    * @param[in] index The Property index of the visual, used to reference visual
 345    * @param[in,out] visual The visual to register, which can be altered in this function
 346    * @param[in] enabled false if derived class wants to control when visual is set on stage
 347    * @param[in] depthIndexValueSet Set to true if the depthIndex has actually been set manually
 348    * @param[in] depthIndex The visual's depth-index is set to this
 349    *
 350    * @note Registering a visual with an index that already has a registered visual will replace it. The replacement will
 351    *       occur once the replacement visual is ready (loaded).
 352    */
 353   void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, VisualState::Type enabled, DepthIndexValue::Type depthIndexValueSet, int depthIndex = 0 );
 354
 355 public:
 356
 357   Control& mControlImpl;
 358   DevelControl::State mState;
 359   std::string mSubStateName;
 360
 361   int mLeftFocusableActorId;       ///< Actor ID of Left focusable control.
 362   int mRightFocusableActorId;      ///< Actor ID of Right focusable control.
 363   int mUpFocusableActorId;         ///< Actor ID of Up focusable control.
 364   int mDownFocusableActorId;       ///< Actor ID of Down focusable control.
 365
 366   RegisteredVisualContainer mVisuals;     ///< Stores visuals needed by the control, non trivial type so std::vector used.
 367   std::string mStyleName;
 368   Vector4 mBackgroundColor;               ///< The color of the background visual
 369   Vector3* mStartingPinchScale;           ///< The scale when a pinch gesture starts, TODO: consider removing this
 370   Extents mMargin;                        ///< The margin values
 371   Extents mPadding;                       ///< The padding values
 372   Toolkit::Control::KeyEventSignalType mKeyEventSignal;
 373   Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusGainedSignal;
 374   Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusLostSignal;
 375   Toolkit::Control::ResourceReadySignalType mResourceReadySignal;
 376
 377   // Gesture Detection
 378   PinchGestureDetector mPinchGestureDetector;
 379   PanGestureDetector mPanGestureDetector;
 380   TapGestureDetector mTapGestureDetector;
 381   LongPressGestureDetector mLongPressGestureDetector;
 382
 383   // Tooltip
 384   TooltipPtr mTooltip;
 385
 386   InputMethodContext mInputMethodContext;
 387
 388   ControlBehaviour mFlags : CONTROL_BEHAVIOUR_FLAG_COUNT;    ///< Flags passed in from constructor.
 389   bool mIsKeyboardNavigationSupported :1;  ///< Stores whether keyboard navigation is supported by the control.
 390   bool mIsKeyboardFocusGroup :1;           ///< Stores whether the control is a focus group.
 391
 392   RegisteredVisualContainer mRemoveVisuals;         ///< List of visuals that are being replaced by another visual once ready
 393
 394   // Properties - these need to be members of Internal::Control::Impl as they access private methods/data of Internal::Control and Internal::Control::Impl.
 395   static const PropertyRegistration PROPERTY_1;
 396   static const PropertyRegistration PROPERTY_2;
 397   static const PropertyRegistration PROPERTY_3;
 398   static const PropertyRegistration PROPERTY_4;
 399   static const PropertyRegistration PROPERTY_5;
 400   static const PropertyRegistration PROPERTY_6;
 401   static const PropertyRegistration PROPERTY_7;
 402   static const PropertyRegistration PROPERTY_8;
 403   static const PropertyRegistration PROPERTY_9;
 404   static const PropertyRegistration PROPERTY_10;
 405   static const PropertyRegistration PROPERTY_11;
 406   static const PropertyRegistration PROPERTY_12;
 407   static const PropertyRegistration PROPERTY_13;
 408   static const PropertyRegistration PROPERTY_14;
 409 };
 410
 411
 412 } // namespace Internal
 413
 414 } // namespace Toolkit
 415
 416 } // namespace Dali
 417
 418 #endif // DALI_TOOLKIT_CONTROL_DATA_IMPL_H