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=95ea1529985a7b977ce9f6b74eff5b30b8c9edda;hp=aa86d6a609672280072623045729679bab0a76ec;hb=c8c89602dd8734c4fba423047b6a07c7c005b423;hpb=a41be0bf03293b22c95b2fa206aa87357e0d406a diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h index aa86d6a..95ea152 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) 2016 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,24 +32,32 @@ namespace Dali { - namespace Toolkit { + /** * @addtogroup dali_toolkit_controls * @{ */ class StyleManager; +class TransitionData; + +namespace Visual +{ +class Base; +} 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 { @@ -63,15 +71,11 @@ public: * @brief Create 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. + * @SINCE_1_0.0 * @return A handle to the ControlImpl instance. */ static Toolkit::Control New(); - /** - * @brief Virtual destructor. - */ - virtual ~Control(); - // Styling /** @@ -104,6 +108,7 @@ public: /** * @brief Set the background with a property map. * + * @SINCE_1_0.0 * @param[in] map The background property map. */ void SetBackground(const Property::Map& map); @@ -122,6 +127,7 @@ public: * @code * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan)); * @endcode + * @SINCE_1_0.0 * @param[in] type The gesture type(s) to enable. */ void EnableGestureDetection( Gesture::Type type ); @@ -130,6 +136,7 @@ public: * @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. * @see EnableGetureDetection */ @@ -140,6 +147,7 @@ public: * detection then they can access the gesture detector through this * API and modify the detection. * + * @SINCE_1_0.0 * @return The pinch gesture detector. * @pre Pinch detection should have been enabled via EnableGestureDetection(). * @see EnableGestureDetection @@ -151,6 +159,7 @@ public: * detection then they can access the gesture detector through this * API and modify the detection. * + * @SINCE_1_0.0 * @return The pan gesture detector. * @pre Pan detection should have been enabled via EnableGestureDetection(). * @see EnableGestureDetection @@ -162,6 +171,7 @@ public: * detection then they can access the gesture detector through this * API and modify the detection. * + * @SINCE_1_0.0 * @return The tap gesture detector. * @pre Tap detection should have been enabled via EnableGestureDetection(). * @see EnableGestureDetection @@ -173,6 +183,7 @@ public: * 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. * @pre Long press detection should have been enabled via EnableGestureDetection(). * @see EnableGestureDetection @@ -187,6 +198,7 @@ public: * keyboard focus movement between its child actors). * * The control doesn't support it by default. + * @SINCE_1_0.0 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation. */ void SetKeyboardNavigationSupport( bool isSupported ); @@ -194,6 +206,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. */ bool IsKeyboardNavigationSupported(); @@ -222,6 +235,7 @@ public: * * (i.e. the scope of keyboard focus movement * can be limitied 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 ); @@ -229,19 +243,24 @@ 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. */ 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 @@ -260,21 +279,104 @@ public: */ Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal(); + /// @cond internal /** * @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. */ DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event ); + /// @endcond protected: // For derived classes to call /** + * @brief Register a visual by Property Index, linking an Actor to visual when required. + * In the case of the visual being an actor or control deeming visual not required then visual 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] visual The visual to register + * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage. + * Use below API with enabled set to false if derived class wishes to control when visual is staged. + */ + void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual ); + + /** + * @brief Register a visual by Property Index, linking an Actor to visual when required. + * In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle. + * If enabled is false then the visual is not set on stage until enabled by the derived class. + * @see EnableVisual + * + * @SINCE_1_2.11 + * + * @param[in] index The Property index of the visual, used to reference visual + * @param[in] visual The visual to register + * @param[in] enabled false if derived class wants to control when visual is set on stage. + * + */ + void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled ); + + /** + * @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 Sets the given visual to be displayed or not when parent staged. + * + * @SINCE_1_2.11 + * + * @param[in] index The Property index of the visual + * @param[in] enable flag to set enabled or disabled. + */ + void EnableVisual( Property::Index index, bool enable ); + + /** + * @brief Queries if the given visual is to be displayed when parent staged. + * + * @SINCE_1_2.11 + * + * @param[in] index The Property index of the visual + * @return bool whether visual is enabled or not + */ + bool IsVisualEnabled( Property::Index index ) const; + + /** + * @brief Create a transition effect on the control. + * + * @SINCE_1_2.12 + * + * @param[in] transitionData The transition data describing the effect to create + * @return A handle to an animation defined with the given effect, or an empty + * handle if no properties match. + */ + Dali::Animation CreateTransition( const Toolkit::TransitionData& transitionData ); + + /** * @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 ); @@ -283,31 +385,37 @@ 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 start. */ 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 start. */ 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::OnSizeSet() + * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start. */ virtual void OnSizeSet( const Vector3& targetSize ); /** * @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 ); @@ -380,11 +488,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 }; @@ -394,12 +508,20 @@ protected: // Helpers for deriving classes /** * @brief Control constructor * + * @SINCE_1_0.0 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum */ Control( ControlBehaviour behaviourFlags ); /** + * @brief Virtual destructor. + * @SINCE_1_0.0 + */ + virtual ~Control(); + + /** * @brief Second phase initialization. + * @SINCE_1_0.0 */ void Initialize(); @@ -411,23 +533,30 @@ 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. * + * @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 ); @@ -437,6 +566,7 @@ public: // API for derived classes to override /** * @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. */ @@ -448,6 +578,7 @@ 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. + * @SINCE_1_0.0 * @return true if this control can perform accessibility activation. */ virtual bool OnAccessibilityActivated(); @@ -456,6 +587,7 @@ 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. * + * @SINCE_1_0.0 * @param[in] gesture The pan gesture. * @return true if the pan gesture has been consumed by this control */ @@ -465,6 +597,7 @@ 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. * + * @SINCE_1_0.0 * @param[in] touchEvent The touch event. * @return true if the touch event has been consumed by this control */ @@ -474,6 +607,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 */ @@ -481,8 +615,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(); @@ -493,6 +628,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(); @@ -500,6 +636,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(); @@ -507,6 +644,7 @@ 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. + * @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. @@ -520,6 +658,7 @@ public: // API for derived classes to override * This allows the application to preform 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. */ virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor ); @@ -528,6 +667,7 @@ 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. + * @SINCE_1_0.0 * @return true if this control supported this action. */ virtual bool OnKeyboardEnter(); @@ -541,9 +681,10 @@ public: // API for derived classes to override * is enabled. The default behaviour is to scale the control by the * pinch scale. * + * @SINCE_1_0.0 + * @param[in] pinch The pinch gesture. * @note If overridden, then the default behaviour 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 ); @@ -554,9 +695,10 @@ public: // API for derived classes to override * This should be overridden by deriving classes when pan detection * is enabled. * + * @SINCE_1_0.0 + * @param[in] pan The pan gesture. * @note There is no default behaviour with panning. * @note Pan detection should be enabled via EnableGestureDetection(). - * @param[in] pan The pan gesture. * @see EnableGestureDetection */ virtual void OnPan( const PanGesture& pan ); @@ -567,9 +709,10 @@ public: // API for derived classes to override * This should be overridden by deriving classes when tap detection * is enabled. * + * @SINCE_1_0.0 + * @param[in] tap The tap gesture. * @note There is no default behaviour 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 ); @@ -580,9 +723,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 ); @@ -600,8 +744,9 @@ public: // API for derived classes to override virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback ); /** - * Retrieve the extension for this control + * @brief Retrieve the extension for this control * + * @SINCE_1_0.0 * @return The extension if available, NULL otherwise */ virtual Extension* GetControlExtension() @@ -611,30 +756,34 @@ public: // API for derived classes to override private: + /// @cond internal // Undefined DALI_INTERNAL Control( const Control& ); DALI_INTERNAL Control& operator=( const Control& ); class Impl; Impl* mImpl; + /// @endcond }; /** - * @brief Get implementation from the handle + * @brief Get implementation from the handle. * - * @pre handle is initialized and points to a control + * @SINCE_1_0.0 * @param handle * @return implementation + * @pre handle is initialized and points to a control */ DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle ); /** - * @brief Get implementation from the handle + * @brief Get implementation from the handle. * - * @pre handle is initialized and points to a control + * @SINCE_1_0.0 * @param handle * @return implementation + * @pre handle is initialized and points to a control */ DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle ); @@ -647,4 +796,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