Merge "Removed REQUIRES_STYLE_CHANGE_SIGNALS" into devel/master
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / control-impl.h
index 56c358d..74117e9 100644 (file)
@@ -117,12 +117,12 @@ public:
    *
    * Gesture detection can be enabled one at a time or in bitwise format as shown:
    * @code
-   * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
+   * EnableGestureDetection(GestureType::Value(GestureType::PINCH | GestureType::TAP | GestureType::PAN));
    * @endcode
    * @SINCE_1_0.0
    * @param[in] type The gesture type(s) to enable
    */
-  void EnableGestureDetection( Gesture::Type type );
+  void EnableGestureDetection( GestureType::Value type );
 
   /**
    * @brief Allows deriving classes to disable any of the gesture detectors.
@@ -132,7 +132,7 @@ public:
    * @param[in] type The gesture type(s) to disable
    * @see EnableGetureDetection
    */
-  void DisableGestureDetection( Gesture::Type type );
+  void DisableGestureDetection( GestureType::Value type );
 
   /**
    * @brief If deriving classes wish to fine tune pinch gesture
@@ -294,114 +294,94 @@ protected: // For derived classes to call
    */
   void EmitKeyInputFocusSignal( bool focusGained );
 
-protected: // From CustomActorImpl, not to be used by application developers
+protected: // From CustomActorImpl
 
   /**
-   * @copydoc CustomActorImpl::OnStageConnection()
-   * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the end.
+   * @copydoc CustomActorImpl::OnSceneConnection()
+   * @note If overridden, then an up-call to Control::OnSceneConnection MUST be made at the end.
    */
-  virtual void OnStageConnection( int depth );
+  virtual void OnSceneConnection( int depth ) override;
 
   /**
-   * @copydoc CustomActorImpl::OnStageDisconnection()
-   * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end.
+   * @copydoc CustomActorImpl::OnSceneDisconnection()
+   * @note If overridden, then an up-call to Control::OnSceneDisconnection MUST be made at the end.
    */
-  virtual void OnStageDisconnection();
+  virtual void OnSceneDisconnection() override;
 
   /**
    * @copydoc CustomActorImpl::OnChildAdd()
    * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the end.
    */
-  virtual void OnChildAdd( Actor& child );
+  virtual void OnChildAdd( Actor& child ) override;
 
   /**
    * @copydoc CustomActorImpl::OnChildRemove()
    * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
    */
-  virtual void OnChildRemove( Actor& child );
+  virtual void OnChildRemove( Actor& child ) override;
 
   /**
    * @copydoc CustomActorImpl::OnPropertySet()
    * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
    */
-  virtual void OnPropertySet( Property::Index index, Property::Value propertyValue );
+  void OnPropertySet( Property::Index index, const Property::Value& propertyValue ) override;
 
   /**
    * @copydoc CustomActorImpl::OnSizeSet()
    * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the end.
    */
-  virtual void OnSizeSet( const Vector3& targetSize );
+  virtual void OnSizeSet( const Vector3& targetSize ) override;
 
   /**
    * @copydoc CustomActorImpl::OnSizeAnimation()
    * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the end.
    */
-  virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
-
-  /**
-   * @copydoc CustomActorImpl::OnTouchEvent()
-   */
-  virtual bool OnTouchEvent( const TouchEvent& event );
-
-  /**
-   * @copydoc CustomActorImpl::OnHoverEvent()
-   */
-  virtual bool OnHoverEvent( const HoverEvent& event );
-
-  /**
-   * @copydoc CustomActorImpl::OnKeyEvent()
-   */
-  virtual bool OnKeyEvent( const KeyEvent& event );
-
-  /**
-   * @copydoc CustomActorImpl::OnWheelEvent()
-   */
-  virtual bool OnWheelEvent( const WheelEvent& event );
+  virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize ) override;
 
   /**
    * @copydoc CustomActorImpl::OnRelayout()
    */
-  virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
+  virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ) override;
 
   /**
    * @copydoc CustomActorImpl::OnSetResizePolicy()
    */
-  virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
+  virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) override;
 
   /**
    * @copydoc CustomActorImpl::GetNaturalSize()
    */
-  virtual Vector3 GetNaturalSize();
+  virtual Vector3 GetNaturalSize() override;
 
   /**
    * @copydoc CustomActorImpl::CalculateChildSize()
    */
-  virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
+  virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ) override;
 
   /**
    * @copydoc CustomActorImpl::GetHeightForWidth()
    */
-  virtual float GetHeightForWidth( float width );
+  virtual float GetHeightForWidth( float width ) override;
 
   /**
    * @copydoc CustomActorImpl::GetWidthForHeight()
    */
-  virtual float GetWidthForHeight( float height );
+  virtual float GetWidthForHeight( float height ) override;
 
   /**
    * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
    */
-  virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
+  virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) override;
 
   /**
    * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
    */
-  virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
+  virtual void OnCalculateRelayoutSize( Dimension::Type dimension ) override;
 
   /**
    * @copydoc CustomActorImpl::OnLayoutNegotiated()
    */
-  virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
+  virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ) override;
 
 protected: // Helpers for deriving classes
 
@@ -414,10 +394,10 @@ protected: // Helpers for deriving classes
   enum ControlBehaviour
   {
     CONTROL_BEHAVIOUR_DEFAULT            = 0, ///< Default behaviour: Size negotiation is enabled & listens to Style Change signal, but doesn't receive event callbacks. @SINCE_1_2_10
-    REQUIRES_STYLE_CHANGE_SIGNALS        = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ),     ///< True if needs to monitor style change signals such as theme/font change @SINCE_1_0.0 @DEPRECATED_1_2_10
-    REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ),     ///< True if needs to support keyboard navigation @SINCE_1_0.0
 
-    DISABLE_STYLE_CHANGE_SIGNALS         = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 2 ),     ///< True if control should not monitor style change signals @SINCE_1_2_10
+    REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ),     ///< True if needs to support keyboard navigation @SINCE_1_0.0
+
+    DISABLE_STYLE_CHANGE_SIGNALS         = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ),     ///< True if control should not monitor style change signals @SINCE_1_2_10
 
     LAST_CONTROL_BEHAVIOUR_FLAG
   };
@@ -483,16 +463,6 @@ public: // API for derived classes to override
   virtual bool OnAccessibilityPan( PanGesture gesture );
 
   /**
-   * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
-   * touch event.
-   *
-   * @SINCE_1_0.0
-   * @param[in] touchEvent The touch event
-   * @return true if the touch event has been consumed by this control
-   */
-  virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
-
-  /**
    * @brief This method should be overridden by deriving classes when they wish to respond
    * the accessibility up and down action (i.e. value change of slider control).
    *
@@ -561,6 +531,15 @@ public: // API for derived classes to override
    */
   virtual bool OnKeyboardEnter();
 
+  /**
+   * @brief Called after a key-event is received by the actor that has had its focus set.
+   *
+   * @SINCE_1_0.0
+   * @param[in] event The Key Event
+   * @return True if the event should be consumed
+   */
+  virtual bool OnKeyEvent( const KeyEvent& event );
+
   // Gestures
 
   /**
@@ -625,12 +604,12 @@ public: // API for derived classes to override
   /**
    * @copydoc ConnectionTrackerInterface::SignalConnected
    */
-  virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
+  virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback ) override;
 
   /**
    * @copydoc ConnectionTrackerInterface::SignalDisconnected
    */
-  virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
+  virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback ) override;
 
   /**
    * @brief Retrieves the extension for this control.
@@ -646,9 +625,12 @@ public: // API for derived classes to override
 private:
 
   /// @cond internal
-  // Undefined
-  DALI_INTERNAL Control( const Control& );
-  DALI_INTERNAL Control& operator=( const Control& );
+
+  // Not copyable or movable
+  DALI_INTERNAL Control( const Control& ) = delete; ///< Deleted copy constructor.
+  DALI_INTERNAL Control( Control&& ) = delete; ///< Deleted move constructor.
+  DALI_INTERNAL Control& operator=( const Control& ) = delete; ///< Deleted copy assignment operator.
+  DALI_INTERNAL Control& operator=( Control&& ) = delete; ///< Deleted move assignment operator.
 
 public:
   class DALI_INTERNAL Impl; // Class declaration is public so we can internally add devel API's to the Controls Impl