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