dali-toolkit/public-api/controls/control-impl.h

   1 #ifndef __DALI_TOOLKIT_CONTROL_IMPL_H__
   2 #define __DALI_TOOLKIT_CONTROL_IMPL_H__
   3
   4 /*
   5  * Copyright (c) 2014 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/adaptor-framework/style-change.h>
  23 #include <dali/public-api/common/vector-wrapper.h>
  24 #include <dali/public-api/events/long-press-gesture.h>
  25 #include <dali/public-api/events/pan-gesture.h>
  26 #include <dali/public-api/events/pinch-gesture.h>
  27 #include <dali/public-api/events/tap-gesture.h>
  28 #include <dali/public-api/object/property-index-ranges.h>
  29 #include <dali/public-api/object/type-info.h>
  30
  31 // INTERNAL INCLUDES
  32 #include <dali-toolkit/public-api/controls/control.h>
  33
  34 namespace Dali
  35 {
  36
  37 namespace Toolkit
  38 {
  39
  40 class StyleManager;
  41
  42 namespace Internal DALI_INTERNAL
  43 {
  44 class KeyInputFocusManager;
  45 }
  46
  47 namespace Internal
  48 {
  49
  50 /**
  51  * @brief This is the internal base class for all controls.
  52  *
  53  * It will provide some common functionality required by all controls.
  54  * Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
  55  * be disconnected automatically when the control is destroyed.
  56  */
  57 class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
  58 {
  59 public:
  60
  61   // Creation & Destruction
  62
  63   /**
  64    * @brief Create a new ControlImpl instance that does not require touch by default.
  65    *
  66    * If touch is required then the user can connect to this class' touch signal.
  67    * @return A handle to the ControlImpl instance.
  68    */
  69   static Toolkit::Control New();
  70
  71   /**
  72    * @brief Virtual destructor.
  73    */
  74   virtual ~Control();
  75
  76   // Size negotiation
  77
  78   /**
  79    * @copydoc Dali::CustomActorImpl::GetHeightForWidth()
  80    */
  81   virtual float GetHeightForWidth( float width );
  82
  83   /**
  84    * @copydoc Dali::CustomActorImpl::GetWidthForHeight()
  85    */
  86   virtual float GetWidthForHeight( float height );
  87
  88   /**
  89    * @copydoc Toolkit::Control::GetNaturalSize()
  90    */
  91   virtual Vector3 GetNaturalSize();
  92
  93   /**
  94    * @brief Retrieves the current Control's size.
  95    *
  96    * @return The control's size.
  97    */
  98   const Vector3& GetControlSize() const;
  99
 100   /**
 101    * @brief Retrieves the Control's size set by the Application / Control.
 102    *
 103    * @return The control's size.
 104    */
 105   const Vector3& GetSizeSet() const;
 106
 107   // Key Input
 108
 109   /**
 110    * @copydoc Toolkit::Control::SetKeyInputFocus()
 111    */
 112   void SetKeyInputFocus();
 113
 114   /**
 115    * @copydoc Toolkit::Control::HasKeyInputFocus()
 116    */
 117   bool HasKeyInputFocus();
 118
 119   /**
 120    * @copydoc Toolkit::Control::ClearKeyInputFocus()
 121    */
 122   void ClearKeyInputFocus();
 123
 124   // Gesture Detection
 125
 126   /**
 127    * @brief If deriving classes wish to fine tune pinch gesture
 128    * detection then they can access the gesture detector through this
 129    * API and modify the detection.
 130    *
 131    * @return The pinch gesture detector.
 132    * @pre Pinch detection should have been enabled via EnableGestureDetection().
 133    * @see EnableGestureDetection
 134    */
 135   PinchGestureDetector GetPinchGestureDetector() const;
 136
 137   /**
 138    * @brief If deriving classes wish to fine tune pan gesture
 139    * detection then they can access the gesture detector through this
 140    * API and modify the detection.
 141    *
 142    * @return The pan gesture detector.
 143    * @pre Pan detection should have been enabled via EnableGestureDetection().
 144    * @see EnableGestureDetection
 145    */
 146   PanGestureDetector GetPanGestureDetector() const;
 147
 148   /**
 149    * @brief If deriving classes wish to fine tune tap gesture
 150    * detection then they can access the gesture detector through this
 151    * API and modify the detection.
 152    *
 153    * @return The tap gesture detector.
 154    * @pre Tap detection should have been enabled via EnableGestureDetection().
 155    * @see EnableGestureDetection
 156    */
 157   TapGestureDetector GetTapGestureDetector() const;
 158
 159   /**
 160    * @brief If deriving classes wish to fine tune long press gesture
 161    * detection then they can access the gesture detector through this
 162    * API and modify the detection.
 163    *
 164    * @return The long press gesture detector.
 165    * @pre Long press detection should have been enabled via EnableGestureDetection().
 166    * @see EnableGestureDetection
 167    */
 168   LongPressGestureDetector GetLongPressGestureDetector() const;
 169
 170   // Background
 171
 172   /**
 173    * @copydoc Dali::Toolkit::Control::SetStyleName
 174    */
 175   void SetStyleName( const std::string& styleName );
 176
 177   /**
 178    * @copydoc Dali::Toolkit::Control::GetStyleName
 179    */
 180   const std::string& GetStyleName() const;
 181
 182   /**
 183    * @copydoc Dali::Toolkit::Control::SetBackgroundColor
 184    */
 185   void SetBackgroundColor( const Vector4& color );
 186
 187   /**
 188    * @copydoc Dali::Toolkit::Control::GetBackgroundColor
 189    */
 190   Vector4 GetBackgroundColor() const;
 191
 192   /**
 193    * @copydoc Dali::Toolkit::Control::SetBackgroundImage
 194    */
 195   void SetBackgroundImage( Image image );
 196
 197   /**
 198    * @copydoc Dali::Toolkit::Control::ClearBackground
 199    */
 200   void ClearBackground();
 201
 202   /**
 203    * @copydoc Dali::Toolkit::Control::GetBackgroundActor
 204    */
 205   Actor GetBackgroundActor() const;
 206
 207   // Keyboard Navigation
 208
 209   /**
 210    * @brief Sets whether this control supports two dimensional
 211    * keyboard navigation (i.e. whether it knows how to handle the
 212    * keyboardn focus movement between its child actors).
 213    *
 214    * The control doesn't support it by default.
 215    * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
 216    */
 217   void SetKeyboardNavigationSupport(bool isSupported);
 218
 219   /**
 220    * @brief Gets whether this control supports two dimensional keyboard navigation.
 221    *
 222    * @return true if this control supports two dimensional keyboard navigation.
 223    */
 224   bool IsKeyboardNavigationSupported();
 225
 226   // Called by Focus Managers
 227
 228   /**
 229    * @brief Called by the focus manager and keyboard focus manager to Activate the Control
 230    */
 231   DALI_INTERNAL void Activate();
 232
 233   /**
 234    * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
 235    * pan gesture.
 236    *
 237    * @param[in] gesture The pan gesture.
 238    * @return true if the pan gesture has been consumed by this control
 239    */
 240   virtual bool OnAccessibilityPan(PanGesture gesture);
 241
 242   /**
 243    * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
 244    * touch event.
 245    *
 246    * @param[in] touchEvent The touch event.
 247    * @return true if the touch event has been consumed by this control
 248    */
 249   virtual bool OnAccessibilityTouch(const TouchEvent& touchEvent);
 250
 251   /**
 252    * @brief This method should be overridden by deriving classes when they wish to respond
 253    * the accessibility up and down action (i.e. value change of slider control).
 254    *
 255    * @param[in] isIncrease Whether the value should be increased or decreased
 256    * @return true if the value changed action has been consumed by this control
 257    */
 258   virtual bool OnAccessibilityValueChange(bool isIncrease);
 259
 260   // Keyboard Focus
 261
 262   /**
 263    * @brief Sets whether this control is a focus group for keyboard navigation.
 264    *
 265    * (i.e. the scope of keyboard focus movement
 266    * can be limitied to its child actors). The control is not a focus group by default.
 267    * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation.
 268    */
 269   void SetAsKeyboardFocusGroup(bool isFocusGroup);
 270
 271   /**
 272    * @brief Gets whether this control is a focus group for keyboard navigation.
 273    *
 274    * @return true if this control is set as a focus group for keyboard navigation.
 275    */
 276   bool IsKeyboardFocusGroup();
 277
 278   /**
 279    * @brief Gets the next keyboard focusable actor in this control towards the given direction.
 280    *
 281    * A control needs to override this function in order to support two dimensional keyboard navigation.
 282    * @param[in] currentFocusedActor The current focused actor.
 283    * @param[in] direction The direction to move the focus towards.
 284    * @param[in] loopEnabled Whether the focus movement should be looped within the control.
 285    * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
 286    */
 287   virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
 288
 289   /**
 290    * @brief Informs this control that its chosen focusable actor will be focused.
 291    *
 292    * This allows the application to preform any actions if wishes
 293    * before the focus is actually moved to the chosen actor.
 294    *
 295    * @param[in] commitedFocusableActor The commited focusable actor.
 296    */
 297   virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
 298
 299   // Actions & Signals
 300
 301   /**
 302    * @brief Performs actions as requested using the action name.
 303    *
 304    * @param[in] object The object on which to perform the action.
 305    * @param[in] actionName The action to perform.
 306    * @param[in] attributes The attributes with which to perfrom this action.
 307    * @return true if action has been accepted by this control
 308    */
 309   static bool DoAction(BaseObject* object, const std::string& actionName, const PropertyValueContainer& attributes);
 310
 311   /**
 312    * Connects a callback function with the object's signals.
 313    * @param[in] object The object providing the signal.
 314    * @param[in] tracker Used to disconnect the signal.
 315    * @param[in] signalName The signal to connect to.
 316    * @param[in] functor A newly allocated FunctorDelegate.
 317    * @return True if the signal was connected.
 318    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 319    */
 320   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
 321
 322   /**
 323    * @copydoc Dali::Toolkit::Control::KeyEventSignal()
 324    */
 325   Toolkit::Control::KeyEventSignalType& KeyEventSignal();
 326
 327   /**
 328    * @brief Called by the KeyInputFocusManager to emit key event signals.
 329    *
 330    * @param[in] event The key event.
 331    * @return True if the event was consumed.
 332    */
 333   DALI_INTERNAL bool EmitKeyEventSignal(const KeyEvent& event);
 334
 335 protected:
 336
 337   // Construction
 338
 339   // Flags for the constructor
 340   enum ControlBehaviour
 341   {
 342     CONTROL_BEHAVIOUR_NONE        = 0,
 343     REQUIRES_TOUCH_EVENTS         = 1<<1,     ///< True if the OnTouchEvent() callback is required.
 344     REQUIRES_STYLE_CHANGE_SIGNALS = 1<<2,     ///< True if needs to monitor style change signals such as theme/font change
 345     NO_SIZE_NEGOTIATION           = 1<<3,     ///< True if control does not need size negotiation, i.e. it can be skipped in the algorithm
 346     REQUIRES_HOVER_EVENTS         = 1<<4,     ///< True if the OnHoverEvent() callback is required.
 347     REQUIRES_MOUSE_WHEEL_EVENTS   = 1<<5      ///< True if the OnMouseWheelEvent() callback is required.
 348   };
 349
 350   /**
 351    * @brief Create a Control.
 352    *
 353    * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
 354    */
 355   Control(ControlBehaviour behaviourFlags);
 356
 357   /**
 358    * @brief Second phase initialization.
 359    */
 360   void Initialize();
 361
 362   // Gesture Detection
 363
 364   /**
 365    * @brief Allows deriving classes to enable any of the gesture detectors that are available.
 366    *
 367    * Gesture detection can be enabled one at a time or in bitwise format as shown:
 368    * @code
 369    * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
 370    * @endcode
 371    * @param[in]  type  The gesture type(s) to enable.
 372    */
 373   void EnableGestureDetection(Gesture::Type type);
 374
 375   /**
 376    * @brief Allows deriving classes to disable any of the gesture detectors.
 377    *
 378    * Like EnableGestureDetection, this can also be called using bitwise or.
 379    * @param[in]  type  The gesture type(s) to disable.
 380    * @see EnableGetureDetection
 381    */
 382   void DisableGestureDetection(Gesture::Type type);
 383
 384   /**
 385    * @copydoc Dali::CustomActorImpl::RelayoutDependentOnChildren()
 386    */
 387   virtual bool RelayoutDependentOnChildren( Dimension dimension = ALL_DIMENSIONS );
 388
 389 private:
 390
 391   // For derived classes to override
 392
 393   /**
 394    * @brief This method is called after the Control has been initialized.
 395    *
 396    * Derived classes should do any second phase initialization by overriding this method.
 397    */
 398   virtual void OnInitialize();
 399
 400   /**
 401    * @brief This method is called when the control is activated.
 402    *
 403    * Derived classes should override this if they wish to be notified when they are activated.
 404    */
 405   virtual void OnActivated();
 406
 407   /**
 408    * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
 409    *
 410    * @param[in] styleManager  The StyleManager object.
 411    * @param[in] change  Information denoting what has changed.
 412    */
 413   virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange change );
 414
 415   /**
 416    * @brief Called whenever a pinch gesture is detected on this control.
 417    *
 418    * This can be overridden by deriving classes when pinch detection
 419    * is enabled.  The default behaviour is to scale the control by the
 420    * pinch scale.
 421    *
 422    * @note If overridden, then the default behaviour will not occur.
 423    * @note Pinch detection should be enabled via EnableGestureDetection().
 424    * @param[in]  pinch  The pinch gesture.
 425    * @see EnableGestureDetection
 426    */
 427   virtual void OnPinch(const PinchGesture& pinch);
 428
 429   /**
 430    * @brief Called whenever a pan gesture is detected on this control.
 431    *
 432    * This should be overridden by deriving classes when pan detection
 433    * is enabled.
 434    *
 435    * @note There is no default behaviour with panning.
 436    * @note Pan detection should be enabled via EnableGestureDetection().
 437    * @param[in]  pan  The pan gesture.
 438    * @see EnableGestureDetection
 439    */
 440   virtual void OnPan( const PanGesture& pan );
 441
 442   /**
 443    * @brief Called whenever a tap gesture is detected on this control.
 444    *
 445    * This should be overridden by deriving classes when tap detection
 446    * is enabled.
 447    *
 448    * @note There is no default behaviour with a tap.
 449    * @note Tap detection should be enabled via EnableGestureDetection().
 450    * @param[in]  tap  The tap gesture.
 451    * @see EnableGestureDetection
 452    */
 453   virtual void OnTap( const TapGesture& tap );
 454
 455   /**
 456    * @brief Called whenever a long press gesture is detected on this control.
 457    *
 458    * This should be overridden by deriving classes when long press
 459    * detection is enabled.
 460    *
 461    * @note There is no default behaviour associated with a long press.
 462    * @note Long press detection should be enabled via EnableGestureDetection().
 463    * @param[in]  longPress  The long press gesture.
 464    * @see EnableGestureDetection
 465    */
 466   virtual void OnLongPress( const LongPressGesture& longPress );
 467
 468   /**
 469    * @brief Called whenever the control is added to the stage.
 470    *
 471    * Could be overridden by derived classes.
 472    */
 473   virtual void OnControlStageConnection();
 474
 475   /**
 476    * @brief Called whenever the control is removed from the stage.
 477    *
 478    * Could be overridden by derived classes.
 479    */
 480   virtual void OnControlStageDisconnection();
 481
 482   /**
 483    * @brief Called whenever an Actor is added to the control.
 484    *
 485    * Could be overridden by derived classes.
 486    *
 487    * @param[in] child The added actor.
 488    */
 489   virtual void OnControlChildAdd( Actor& child );
 490
 491   /**
 492    * @brief Called whenever an Actor is removed from the control.
 493    *
 494    * Could be overridden by derived classes.
 495    *
 496    * @param[in] child The removed actor.
 497    */
 498   virtual void OnControlChildRemove( Actor& child );
 499
 500   /**
 501    * @brief Called whenever the Control's size is set.
 502    *
 503    * Could be overridden by derived classes.
 504    *
 505    * @param[in] size The new size.
 506    */
 507   virtual void OnControlSizeSet( const Vector3& size );
 508
 509   /**
 510    * @brief Called when the control gains key input focus.
 511    *
 512    * Should be overridden by derived classes if they need to customize what happens when focus is gained.
 513    */
 514   virtual void OnKeyInputFocusGained();
 515
 516   /**
 517    * @brief Called when the control loses key input focus.
 518    *
 519    * Should be overridden by derived classes if they need to customize what happens when focus is lost.
 520    */
 521   virtual void OnKeyInputFocusLost();
 522
 523   // From CustomActorImpl, derived classes can override these.
 524
 525   /**
 526    * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&)
 527    */
 528   virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize);
 529
 530   /**
 531    * @copydoc Dali::CustomActorImpl::OnTouchEvent(const TouchEvent&)
 532    */
 533   virtual bool OnTouchEvent(const TouchEvent& event);
 534
 535   /**
 536    * @copydoc Dali::CustomActorImpl::OnHoverEvent(const HoverEvent&)
 537    */
 538   virtual bool OnHoverEvent(const HoverEvent& event);
 539
 540   /**
 541    * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
 542    */
 543   virtual bool OnKeyEvent(const KeyEvent& event);
 544
 545   /**
 546    * @copydoc Dali::CustomActorImpl::OnMouseWheelEvent(const MouseWheelEvent&)
 547    */
 548   virtual bool OnMouseWheelEvent(const MouseWheelEvent& event);
 549
 550   /**
 551    * @copydoc Dali::CustomActorImpl::OnCalculateRelayoutSize()
 552    */
 553   virtual void OnCalculateRelayoutSize( Dimension dimension );
 554
 555   /**
 556    * @copydoc Dali::CustomActorImpl::OnLayoutNegotiated()
 557    */
 558   virtual void OnLayoutNegotiated( float size, Dimension dimension );
 559
 560   /**
 561    * @copydoc Dali::CustomActorImpl::OnRelayout()
 562    */
 563   virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
 564
 565   /**
 566    * @copydoc Dali::CustomActorImpl::OnSetResizePolicy()
 567    */
 568   virtual void OnSetResizePolicy( ResizePolicy policy, Dimension dimension );
 569
 570   /**
 571    * @copydoc Dali::CustomActorImpl::CalculateChildSize()
 572    */
 573   virtual float CalculateChildSize( const Dali::Actor& child, Dimension dimension );
 574
 575   // From CustomActorImpl, derived classes should NOT override these.
 576
 577   /**
 578    * @brief Sends a request to relayout this control.
 579    *
 580    * The control will be relaid out after the
 581    * Dali::Stage::SignalMessageQueueFlushed() signal is emitted.
 582    *
 583    * It calls OnControlStageConnection() to notify derived classes.
 584    *
 585    * @see Dali::CustomActorImpl::OnStageConnection()
 586    */
 587   virtual void OnStageConnection();
 588
 589   /**
 590    * @brief Calls OnControlStageDisconnection() to notify derived classed.
 591    *
 592    * @see Dali::CustomActorImpl::OnStageDisconnection()
 593    */
 594   virtual void OnStageDisconnection();
 595
 596   /**
 597    * @brief Sends a request to relayout this control.
 598    *
 599    * The control will be relaid out after the
 600    * Dali::Stage::SignalMessageQueueFlushed() signal is emitted.  It
 601    * calls OnControlChildAdd() to notify derived classes.
 602    *
 603    * @note This method shouldn't be overridden by derived classes.
 604    *
 605    * @param[in] child The added actor.
 606    *
 607    * @see Dali::CustomActorImpl::OnChildAdd(Actor&)
 608    */
 609   virtual void OnChildAdd(Actor& child);
 610
 611   /**
 612    * @brief Sends a request to relayout this control.
 613    *
 614    * The control will be relaid out after the
 615    * Dali::Stage::SignalMessageQueueFlushed() signal is emitted.  It
 616    * calls OnControlChildRemove() to notify derived classes.
 617    *
 618    * @note This method shouldn't be overridden by derived classes.
 619    *
 620    * @param[in] child The removed actor.
 621    *
 622    * @see Dali::CustomActorImpl::OnChildRemove(Actor&)
 623    */
 624   virtual void OnChildRemove(Actor& child);
 625
 626   /**
 627    * @brief It stores the size set by size negotiation and relayout.
 628    *
 629    * It also keeps a backup of the size set through the Actor's API used in the size negotiation.
 630    * It calls the OnControlSizeSet() to notify derived classes.
 631    *
 632    * @param[in] targetSize The new size.
 633    *
 634    * @see Dali::CustomActorImpl::OnSizeSet(const Vector3&)
 635    */
 636   virtual void OnSizeSet(const Vector3& targetSize);
 637
 638   // From ConnectionTrackerInterface
 639
 640   /**
 641    * @copydoc ConnectionTrackerInterface::SignalConnected
 642    */
 643   virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
 644
 645   /**
 646    * @copydoc ConnectionTrackerInterface::SignalDisconnected
 647    */
 648   virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
 649
 650 private:
 651
 652   // Undefined
 653   DALI_INTERNAL Control(const Control&);
 654   DALI_INTERNAL Control& operator=(const Control&);
 655
 656   class Impl;
 657   Impl* mImpl;
 658
 659   friend class Internal::KeyInputFocusManager;     ///< KeyInputFocusManager needs to call several methods which are private. // TODO: Remove
 660 };
 661
 662 } // namespace Internal
 663
 664 } // namespace Toolkit
 665
 666 } // namespace Dali
 667
 668 #endif // __DALI_TOOLKIT_CONTROL_IMPL_H__