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=1e3110ff5f6b5cf1f71a884ed300422cadb5a55b;hp=b8ae6bb013d4eb7555f062591165ef7f5ee4983d;hb=4d3140d11ea9df2cf933d32419f49fc5e63fa4a9;hpb=daa53bafd34781116b8cb3a2a8c54475a932ba21 diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h index b8ae6bb..1e3110f 100644 --- a/dali-toolkit/public-api/controls/control-impl.h +++ b/dali-toolkit/public-api/controls/control-impl.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_CONTROL_IMPL_H__ -#define __DALI_TOOLKIT_CONTROL_IMPL_H__ +#ifndef DALI_TOOLKIT_CONTROL_IMPL_H +#define DALI_TOOLKIT_CONTROL_IMPL_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2019 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,11 +32,11 @@ namespace Dali { - namespace Toolkit { + /** - * @addtogroup dali-toolkit-controls + * @addtogroup dali_toolkit_controls * @{ */ @@ -44,14 +44,16 @@ class StyleManager; namespace Internal { + /** * @brief This is the internal base class for all controls. * * It will provide some common functionality required by all controls. * Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will * 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: @@ -60,18 +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. - * @return A handle to the ControlImpl instance. + * 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 */ static Toolkit::Control New(); +protected: /** * @brief Virtual destructor. + * @SINCE_1_0.0 */ virtual ~Control(); +public: // Styling /** @@ -92,19 +98,28 @@ public: void SetBackgroundColor( const Vector4& color ); /** - * @copydoc Dali::Toolkit::Control::GetBackgroundColor + * @brief Sets the background with a property map. + * + * @SINCE_1_0.0 + * @param[in] map The background property map */ - Vector4 GetBackgroundColor() const; + void SetBackground(const Property::Map& map); /** - * @copydoc Dali::Toolkit::Control::SetBackgroundImage + * @copydoc Dali::Toolkit::Control::ClearBackground */ - void SetBackgroundImage( Image image ); + void ClearBackground(); /** - * @copydoc Dali::Toolkit::Control::ClearBackground + * @brief Sets the shadow with a property map. + * @param[in] map The shadow property map */ - void ClearBackground(); + void SetShadow(const Property::Map& map); + + /** + * @brief Clear the shadow. + */ + void ClearShadow(); // Gesture Detection @@ -115,7 +130,8 @@ public: * @code * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan)); * @endcode - * @param[in] type The gesture type(s) to enable. + * @SINCE_1_0.0 + * @param[in] type The gesture type(s) to enable */ void EnableGestureDetection( Gesture::Type type ); @@ -123,17 +139,19 @@ public: * @brief Allows deriving classes to disable any of the gesture detectors. * * Like EnableGestureDetection, this can also be called using bitwise or. - * @param[in] type The gesture type(s) to disable. + * @SINCE_1_0.0 + * @param[in] type The gesture type(s) to disable * @see EnableGetureDetection */ void DisableGestureDetection( Gesture::Type 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. * - * @return The pinch gesture detector. + * @SINCE_1_0.0 + * @return The pinch gesture detector * @pre Pinch detection should have been enabled via EnableGestureDetection(). * @see EnableGestureDetection */ @@ -141,10 +159,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. * - * @return The pan gesture detector. + * @SINCE_1_0.0 + * @return The pan gesture detector * @pre Pan detection should have been enabled via EnableGestureDetection(). * @see EnableGestureDetection */ @@ -152,10 +171,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. * - * @return The tap gesture detector. + * @SINCE_1_0.0 + * @return The tap gesture detector * @pre Tap detection should have been enabled via EnableGestureDetection(). * @see EnableGestureDetection */ @@ -163,10 +183,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. * - * @return The long press gesture detector. + * @SINCE_1_0.0 + * @return The long press gesture detector * @pre Long press detection should have been enabled via EnableGestureDetection(). * @see EnableGestureDetection */ @@ -180,14 +201,16 @@ public: * keyboard focus movement between its child actors). * * The control doesn't support it by default. - * @param[in] isSupported Whether this control supports two dimensional keyboard navigation. + * @SINCE_1_0.0 + * @param[in] isSupported Whether this control supports two dimensional keyboard navigation */ void SetKeyboardNavigationSupport( bool isSupported ); /** * @brief Gets whether this control supports two dimensional keyboard navigation. * - * @return true if this control supports two dimensional keyboard navigation. + * @SINCE_1_0.0 + * @return true if this control supports two dimensional keyboard navigation */ bool IsKeyboardNavigationSupported(); @@ -214,27 +237,33 @@ 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. - * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation. + * 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 */ void SetAsKeyboardFocusGroup( bool isFocusGroup ); /** * @brief Gets whether this control is a focus group for keyboard navigation. * - * @return true if this control is set as a focus group for keyboard navigation. + * @SINCE_1_0.0 + * @return true if this control is set as a focus group for keyboard navigation */ bool IsKeyboardFocusGroup(); + /// @cond internal /** * @brief Called by the AccessibilityManager to activate the Control. + * @SINCE_1_0.0 */ DALI_INTERNAL void AccessibilityActivate(); /** * @brief Called by the KeyboardFocusManager. + * @SINCE_1_0.0 */ DALI_INTERNAL void KeyboardEnter(); + /// @endcond // Signals @@ -253,21 +282,25 @@ public: */ Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal(); + /// @cond internal /** * @brief Called by the KeyInputFocusManager to emit key event signals. * - * @param[in] event The key event. - * @return True if the event was consumed. + * @SINCE_1_0.0 + * @param[in] event The key event + * @return True if the event was consumed */ DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event ); + /// @endcond protected: // For derived classes to call /** - * @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. * + * @SINCE_1_0.0 * @param[in] focusGained True if gained, False if lost */ void EmitKeyInputFocusSignal( bool focusGained ); @@ -276,31 +309,43 @@ protected: // From CustomActorImpl, not to be used by application developers /** * @copydoc CustomActorImpl::OnStageConnection() + * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the end. */ virtual void OnStageConnection( int depth ); /** * @copydoc CustomActorImpl::OnStageDisconnection() + * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end. */ virtual void OnStageDisconnection(); /** * @copydoc CustomActorImpl::OnChildAdd() + * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the end. */ virtual void OnChildAdd( Actor& child ); /** * @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::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 ); + + /** * @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 ); /** * @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 ); @@ -373,11 +418,17 @@ protected: // Helpers for deriving classes // Construction - // 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 - REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation + 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 LAST_CONTROL_BEHAVIOUR_FLAG }; @@ -385,14 +436,16 @@ 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 */ Control( ControlBehaviour behaviourFlags ); /** * @brief Second phase initialization. + * @SINCE_1_0.0 */ void Initialize(); @@ -404,34 +457,42 @@ public: // API for derived classes to override * @brief This method is called after the Control has been initialized. * * Derived classes should do any second phase initialization by overriding this method. + * @SINCE_1_0.0 */ 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. * - * @param[in] child The added actor. + * @SINCE_1_0.0 + * @param[in] child The added actor */ - virtual void OnControlChildAdd( Actor& child ); + virtual void OnControlChildAdd( Actor& child ) DALI_DEPRECATED_API; /** + * @DEPRECATED_1_1.30. Override OnChildRemove instead. + * * @brief Called whenever an Actor is removed from the control. * * Could be overridden by derived classes. * - * @param[in] child The removed actor. + * @SINCE_1_0.0 + * @param[in] child The removed actor */ - virtual void OnControlChildRemove( Actor& child ); + virtual void OnControlChildRemove( Actor& child ) DALI_DEPRECATED_API; // Styling /** * @brief This method should be overridden by deriving classes requiring notifications when the style changes. * - * @param[in] styleManager The StyleManager object. - * @param[in] change Information denoting what has changed. + * @SINCE_1_0.0 + * @param[in] styleManager The StyleManager object + * @param[in] change Information denoting what has changed */ virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change ); @@ -441,7 +502,8 @@ public: // API for derived classes to override * @brief This method is called when the control is accessibility activated. * * Derived classes should override this to perform custom accessibility activation. - * @return true if this control can perform accessibility activation. + * @SINCE_1_0.0 + * @return true if this control can perform accessibility activation */ virtual bool OnAccessibilityActivated(); @@ -449,7 +511,8 @@ public: // API for derived classes to override * @brief This method should be overridden by deriving classes when they wish to respond the accessibility * pan gesture. * - * @param[in] gesture The pan gesture. + * @SINCE_1_0.0 + * @param[in] gesture The pan gesture * @return true if the pan gesture has been consumed by this control */ virtual bool OnAccessibilityPan( PanGesture gesture ); @@ -458,7 +521,8 @@ public: // API for derived classes to override * @brief This method should be overridden by deriving classes when they wish to respond the accessibility * touch event. * - * @param[in] touchEvent The 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 ); @@ -467,6 +531,7 @@ public: // API for derived classes to override * @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). * + * @SINCE_1_0.0 * @param[in] isIncrease Whether the value should be increased or decreased * @return true if the value changed action has been consumed by this control */ @@ -474,8 +539,9 @@ public: // API for derived classes to override /** * @brief This method should be overridden by deriving classes when they wish to respond - * the accessibility zoom action + * the accessibility zoom action. * + * @SINCE_1_0.0 * @return true if the zoom action has been consumed by this control */ virtual bool OnAccessibilityZoom(); @@ -486,6 +552,7 @@ public: // API for derived classes to override * @brief Called when the control gains key input focus. * * Should be overridden by derived classes if they need to customize what happens when focus is gained. + * @SINCE_1_0.0 */ virtual void OnKeyInputFocusGained(); @@ -493,6 +560,7 @@ public: // API for derived classes to override * @brief Called when the control loses key input focus. * * Should be overridden by derived classes if they need to customize what happens when focus is lost. + * @SINCE_1_0.0 */ virtual void OnKeyInputFocusLost(); @@ -500,20 +568,22 @@ public: // API for derived classes to override * @brief Gets the next keyboard focusable actor in this control towards the given direction. * * A control needs to override this function in order to support two dimensional keyboard navigation. - * @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. + * @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 */ 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. * - * @param[in] commitedFocusableActor The commited focusable actor. + * @SINCE_1_0.0 + * @param[in] commitedFocusableActor The commited focusable actor */ virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor ); @@ -521,7 +591,8 @@ public: // API for derived classes to override * @brief This method is called when the control has enter pressed on it. * * Derived classes should override this to perform custom actions. - * @return true if this control supported this action. + * @SINCE_1_0.0 + * @return true if this control supported this action */ virtual bool OnKeyboardEnter(); @@ -534,9 +605,10 @@ public: // API for derived classes to override * is enabled. The default behaviour is to scale the control by the * pinch scale. * - * @note If overridden, then the default behaviour will not occur. + * @SINCE_1_0.0 + * @param[in] pinch The pinch gesture + * @note If overridden, then the default behavior will not occur. * @note Pinch detection should be enabled via EnableGestureDetection(). - * @param[in] pinch The pinch gesture. * @see EnableGestureDetection */ virtual void OnPinch( const PinchGesture& pinch ); @@ -547,9 +619,10 @@ public: // API for derived classes to override * This should be overridden by deriving classes when pan detection * is enabled. * - * @note There is no default behaviour with panning. + * @SINCE_1_0.0 + * @param[in] pan The pan gesture + * @note There is no default behavior with panning. * @note Pan detection should be enabled via EnableGestureDetection(). - * @param[in] pan The pan gesture. * @see EnableGestureDetection */ virtual void OnPan( const PanGesture& pan ); @@ -560,9 +633,10 @@ public: // API for derived classes to override * This should be overridden by deriving classes when tap detection * is enabled. * - * @note There is no default behaviour with a tap. + * @SINCE_1_0.0 + * @param[in] tap The tap gesture + * @note There is no default behavior with a tap. * @note Tap detection should be enabled via EnableGestureDetection(). - * @param[in] tap The tap gesture. * @see EnableGestureDetection */ virtual void OnTap( const TapGesture& tap ); @@ -573,9 +647,10 @@ public: // API for derived classes to override * This should be overridden by deriving classes when long press * detection is enabled. * + * @SINCE_1_0.0 + * @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(). - * @param[in] longPress The long press gesture. * @see EnableGestureDetection */ virtual void OnLongPress( const LongPressGesture& longPress ); @@ -593,8 +668,9 @@ public: // API for derived classes to override virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback ); /** - * Retrieve the extension for this control + * @brief Retrieves the extension for this control. * + * @SINCE_1_0.0 * @return The extension if available, NULL otherwise */ virtual Extension* GetControlExtension() @@ -604,32 +680,39 @@ public: // API for derived classes to override private: + /// @cond internal // Undefined DALI_INTERNAL Control( const Control& ); DALI_INTERNAL Control& operator=( const Control& ); - class Impl; +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. * - * @pre handle is initialized and points to a control + * @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. * - * @pre handle is initialized and points to a control + * @SINCE_1_0.0 * @param handle - * @return implementation + * @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 @@ -640,4 +723,4 @@ DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit: } // namespace Dali -#endif // __DALI_TOOLKIT_CONTROL_IMPL_H__ +#endif // DALI_TOOLKIT_CONTROL_IMPL_H