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