X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fcontrol-impl.h;h=611659e9dedfbd11be6b2a8fdb4527402ba521a0;hp=18346c4237ab62ce3c3354c12bf1083f5624a7d3;hb=01777a3489f027123010b281e58efbc9f0a93db7;hpb=8318ee011aae9d2a56018ea7da82b601e8250279 diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h index 18346c4..611659e 100644 --- a/dali-toolkit/public-api/controls/control-impl.h +++ b/dali-toolkit/public-api/controls/control-impl.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_CONTROL_IMPL_H /* - * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2020 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -32,9 +32,9 @@ namespace Dali { - namespace Toolkit { + /** * @addtogroup dali_toolkit_controls * @{ @@ -42,12 +42,9 @@ namespace Toolkit class StyleManager; -namespace Visual -{ -class Base; -} namespace Internal { + /** * @brief This is the internal base class for all controls. * @@ -56,7 +53,7 @@ namespace Internal * be disconnected automatically when the control is destroyed. * @SINCE_1_0.0 */ -class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface +class DALI_TOOLKIT_API Control : public CustomActorImpl, public ConnectionTrackerInterface { public: @@ -65,20 +62,22 @@ public: // Creation & Destruction /** - * @brief Create a new ControlImpl instance that does not require touch by default. + * @brief Creates a new ControlImpl instance that does not require touch by default. * - * If touch is required then the user can connect to this class' touch signal. + * If touch is required, then the user can connect to this class' touch signal. * @SINCE_1_0.0 - * @return A handle to the ControlImpl instance. + * @return A handle to the ControlImpl instance */ static Toolkit::Control New(); +protected: /** * @brief Virtual destructor. * @SINCE_1_0.0 */ virtual ~Control(); +public: // Styling /** @@ -99,20 +98,10 @@ public: void SetBackgroundColor( const Vector4& color ); /** - * @copydoc Dali::Toolkit::Control::GetBackgroundColor - */ - Vector4 GetBackgroundColor() const; - - /** - * @copydoc Dali::Toolkit::Control::SetBackgroundImage - */ - void SetBackgroundImage( Image image ); - - /** - * @brief Set the background with a property map. + * @brief Sets the background with a property map. * * @SINCE_1_0.0 - * @param[in] map The background property map. + * @param[in] map The background property map */ void SetBackground(const Property::Map& map); @@ -128,30 +117,30 @@ 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. + * @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. * * Like EnableGestureDetection, this can also be called using bitwise or. * @SINCE_1_0.0 - * @param[in] type The gesture type(s) to disable. + * @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 - * detection then they can access the gesture detector through this + * detection, then they can access the gesture detector through this * API and modify the detection. * * @SINCE_1_0.0 - * @return The pinch gesture detector. + * @return The pinch gesture detector * @pre Pinch detection should have been enabled via EnableGestureDetection(). * @see EnableGestureDetection */ @@ -159,11 +148,11 @@ public: /** * @brief If deriving classes wish to fine tune pan gesture - * detection then they can access the gesture detector through this + * detection, then they can access the gesture detector through this * API and modify the detection. * * @SINCE_1_0.0 - * @return The pan gesture detector. + * @return The pan gesture detector * @pre Pan detection should have been enabled via EnableGestureDetection(). * @see EnableGestureDetection */ @@ -171,11 +160,11 @@ public: /** * @brief If deriving classes wish to fine tune tap gesture - * detection then they can access the gesture detector through this + * detection, then they can access the gesture detector through this * API and modify the detection. * * @SINCE_1_0.0 - * @return The tap gesture detector. + * @return The tap gesture detector * @pre Tap detection should have been enabled via EnableGestureDetection(). * @see EnableGestureDetection */ @@ -183,11 +172,11 @@ public: /** * @brief If deriving classes wish to fine tune long press gesture - * detection then they can access the gesture detector through this + * detection, then they can access the gesture detector through this * API and modify the detection. * * @SINCE_1_0.0 - * @return The long press gesture detector. + * @return The long press gesture detector * @pre Long press detection should have been enabled via EnableGestureDetection(). * @see EnableGestureDetection */ @@ -202,7 +191,7 @@ public: * * The control doesn't support it by default. * @SINCE_1_0.0 - * @param[in] isSupported Whether this control supports two dimensional keyboard navigation. + * @param[in] isSupported Whether this control supports two dimensional keyboard navigation */ void SetKeyboardNavigationSupport( bool isSupported ); @@ -210,7 +199,7 @@ public: * @brief Gets whether this control supports two dimensional keyboard navigation. * * @SINCE_1_0.0 - * @return true if this control supports two dimensional keyboard navigation. + * @return true if this control supports two dimensional keyboard navigation */ bool IsKeyboardNavigationSupported(); @@ -237,9 +226,9 @@ public: * @brief Sets whether this control is a focus group for keyboard navigation. * * (i.e. the scope of keyboard focus movement - * can be limitied to its child actors). The control is not a focus group by default. + * can be limited to its child actors). The control is not a focus group by default. * @SINCE_1_0.0 - * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation. + * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation */ void SetAsKeyboardFocusGroup( bool isFocusGroup ); @@ -247,7 +236,7 @@ public: * @brief Gets whether this control is a focus group for keyboard navigation. * * @SINCE_1_0.0 - * @return true if this control is set as a focus group for keyboard navigation. + * @return true if this control is set as a focus group for keyboard navigation */ bool IsKeyboardFocusGroup(); @@ -287,8 +276,8 @@ public: * @brief Called by the KeyInputFocusManager to emit key event signals. * * @SINCE_1_0.0 - * @param[in] event The key event. - * @return True if the event was consumed. + * @param[in] event The key event + * @return True if the event was consumed */ DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event ); /// @endcond @@ -296,51 +285,7 @@ public: protected: // For derived classes to call /** - * @brief Register a visual by Property Index, linking an Actor to controlRenderer when required. - * In the case of the visual being an actor or control deeming controlRenderer not required then controlRenderer should be an empty handle. - * No parenting is done during registration, this should be done by derived class. - * - * @SINCE_1_2.0 - * - * @param[in] index The Property index of the visual, used to reference visual - * @param[in] placementActor The actor used to by the visual. - * @param[in] visual The visual to register - * @note Derived class must NOT call visual.SetOnStage(placementActor). It is the responsibility of the base class to connect/disconnect registered visual to stage. - */ - void RegisterVisual( Property::Index index, Actor& placementActor, Toolkit::Visual::Base& visual ); - - /** - * @brief Erase the entry matching the given index from the list of registered visuals - * @param[in] index The Property index of the visual, used to reference visual - * - * @SINCE_1_2.0 - */ - void UnregisterVisual( Property::Index index ); - - /** - * @brief Retrieve the visual associated with the given property index. - * - * @SINCE_1_2.2 - * - * @param[in] index The Property index of the visual. - * @return The registered visual if exist, otherwise empty handle. - * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count. - */ - Toolkit::Visual::Base GetVisual( Property::Index index ) const; - - /** - * @brief Retrieve the placement actor associated with the given index. - * - * @SINCE_1_2.2 - * - * @@param[in] index The Property index of the visual. - * @return Then placement actor if exist, otherwise empty handle. - * @note For managing object life-cycle, do not store the returned placement actor as a member which increments its reference count. - */ - Actor GetPlacementActor( Property::Index index ) const; - - /** - * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal + * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal. * * Should be called last by the control after it acts on the Input Focus change. * @@ -349,121 +294,110 @@ 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 start. + * @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 start. + * @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 ); - - /** - * @copydoc CustomActorImpl::OnSizeSet() - * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start. - */ - virtual void OnSizeSet( const Vector3& targetSize ); + virtual void OnChildRemove( Actor& child ) override; /** - * @copydoc CustomActorImpl::OnSizeAnimation() - * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the start. - */ - virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize ); - - /** - * @copydoc CustomActorImpl::OnTouchEvent() - */ - virtual bool OnTouchEvent( const TouchEvent& event ); - - /** - * @copydoc CustomActorImpl::OnHoverEvent() + * @copydoc CustomActorImpl::OnPropertySet() + * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end. */ - virtual bool OnHoverEvent( const HoverEvent& event ); + virtual void OnPropertySet( Property::Index index, Property::Value propertyValue ) override; /** - * @copydoc CustomActorImpl::OnKeyEvent() + * @copydoc CustomActorImpl::OnSizeSet() + * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the end. */ - virtual bool OnKeyEvent( const KeyEvent& event ); + virtual void OnSizeSet( const Vector3& targetSize ) override; /** - * @copydoc CustomActorImpl::OnWheelEvent() + * @copydoc CustomActorImpl::OnSizeAnimation() + * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the end. */ - 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 // Construction /** - * @brief Flags for the constructor + * @brief Flags for the constructor. * @SINCE_1_0.0 */ enum ControlBehaviour { - 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 - REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation @SINCE_1_0.0 + 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_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 }; @@ -471,7 +405,7 @@ protected: // Helpers for deriving classes static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags /** - * @brief Control constructor + * @brief Control constructor. * * @SINCE_1_0.0 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum @@ -496,38 +430,14 @@ public: // API for derived classes to override */ virtual void OnInitialize(); - /** - * @DEPRECATED_1_1.30. Override OnChildAdd instead. - * - * @brief Called whenever an Actor is added to the control. - * - * Could be overridden by derived classes. - * - * @SINCE_1_0.0 - * @param[in] child The added actor. - */ - virtual void OnControlChildAdd( Actor& child ); - - /** - * @DEPRECATED_1_1.30. Override OnChildRemove instead. - * - * @brief Called whenever an Actor is removed from the control. - * - * Could be overridden by derived classes. - * - * @SINCE_1_0.0 - * @param[in] child The removed actor. - */ - virtual void OnControlChildRemove( Actor& child ); - // Styling /** * @brief This method should be overridden by deriving classes requiring notifications when the style changes. * * @SINCE_1_0.0 - * @param[in] styleManager The StyleManager object. - * @param[in] change Information denoting what has changed. + * @param[in] styleManager The StyleManager object + * @param[in] change Information denoting what has changed */ virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change ); @@ -538,7 +448,7 @@ public: // API for derived classes to override * * Derived classes should override this to perform custom accessibility activation. * @SINCE_1_0.0 - * @return true if this control can perform accessibility activation. + * @return true if this control can perform accessibility activation */ virtual bool OnAccessibilityActivated(); @@ -547,22 +457,12 @@ public: // API for derived classes to override * pan gesture. * * @SINCE_1_0.0 - * @param[in] gesture The pan gesture. + * @param[in] gesture The pan gesture * @return true if the pan gesture has been consumed by this control */ 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). * @@ -604,21 +504,21 @@ public: // API for derived classes to override * * A control needs to override this function in order to support two dimensional keyboard navigation. * @SINCE_1_0.0 - * @param[in] currentFocusedActor The current focused actor. - * @param[in] direction The direction to move the focus towards. - * @param[in] loopEnabled Whether the focus movement should be looped within the control. - * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused. + * @param[in] currentFocusedActor The current focused actor + * @param[in] direction The direction to move the focus towards + * @param[in] loopEnabled Whether the focus movement should be looped within the control + * @return The next keyboard focusable actor in this control or an empty handle if no actor can be focused */ virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled ); /** * @brief Informs this control that its chosen focusable actor will be focused. * - * This allows the application to preform any actions if wishes + * This allows the application to perform any actions if wishes * before the focus is actually moved to the chosen actor. * * @SINCE_1_0.0 - * @param[in] commitedFocusableActor The commited focusable actor. + * @param[in] commitedFocusableActor The commited focusable actor */ virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor ); @@ -627,10 +527,19 @@ public: // API for derived classes to override * * Derived classes should override this to perform custom actions. * @SINCE_1_0.0 - * @return true if this control supported this action. + * @return true if this control supported this action */ 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 /** @@ -641,8 +550,8 @@ public: // API for derived classes to override * pinch scale. * * @SINCE_1_0.0 - * @param[in] pinch The pinch gesture. - * @note If overridden, then the default behaviour will not occur. + * @param[in] pinch The pinch gesture + * @note If overridden, then the default behavior will not occur. * @note Pinch detection should be enabled via EnableGestureDetection(). * @see EnableGestureDetection */ @@ -655,8 +564,8 @@ public: // API for derived classes to override * is enabled. * * @SINCE_1_0.0 - * @param[in] pan The pan gesture. - * @note There is no default behaviour with panning. + * @param[in] pan The pan gesture + * @note There is no default behavior with panning. * @note Pan detection should be enabled via EnableGestureDetection(). * @see EnableGestureDetection */ @@ -669,8 +578,8 @@ public: // API for derived classes to override * is enabled. * * @SINCE_1_0.0 - * @param[in] tap The tap gesture. - * @note There is no default behaviour with a tap. + * @param[in] tap The tap gesture + * @note There is no default behavior with a tap. * @note Tap detection should be enabled via EnableGestureDetection(). * @see EnableGestureDetection */ @@ -683,7 +592,7 @@ public: // API for derived classes to override * detection is enabled. * * @SINCE_1_0.0 - * @param[in] longPress The long press gesture. + * @param[in] longPress The long press gesture * @note There is no default behaviour associated with a long press. * @note Long press detection should be enabled via EnableGestureDetection(). * @see EnableGestureDetection @@ -695,15 +604,15 @@ 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 Retrieve the extension for this control + * @brief Retrieves the extension for this control. * * @SINCE_1_0.0 * @return The extension if available, NULL otherwise @@ -716,35 +625,41 @@ public: // API for derived classes to override private: /// @cond internal - // Undefined - DALI_INTERNAL Control( const Control& ); - DALI_INTERNAL Control& operator=( const Control& ); - class Impl; + // 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 + +private: Impl* mImpl; /// @endcond }; /** - * @brief Get implementation from the handle. + * @brief Gets implementation from the handle. * * @SINCE_1_0.0 * @param handle - * @return implementation + * @return Implementation * @pre handle is initialized and points to a control */ -DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle ); +DALI_TOOLKIT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle ); /** - * @brief Get implementation from the handle. + * @brief Gets implementation from the handle. * * @SINCE_1_0.0 * @param handle - * @return implementation - * @pre handle is initialized and points to a control + * @return Implementation + * @pre Handle is initialized and points to a control. */ -DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle ); +DALI_TOOLKIT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle ); } // namespace Internal