#define DALI_TOOLKIT_CONTROL_IMPL_H
/*
- * Copyright (c) 2017 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.
*/
class StyleManager;
-class TransitionData;
-
-namespace Visual
-{
-class Base;
-}
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:
void SetBackgroundColor( const Vector4& color );
/**
- * @copydoc Dali::Toolkit::Control::GetBackgroundColor
- */
- Vector4 GetBackgroundColor() const;
-
- /**
- * @copydoc Dali::Toolkit::Control::SetBackgroundImage
- */
- void SetBackgroundImage( Image image );
-
- /**
* @brief Sets the background with a property map.
*
* @SINCE_1_0.0
*
* 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.
* @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
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.
- *
- * Only generates an animation if the properties described in the transition
- * data are staged (e.g. the visual is Enabled and the control is on stage).
- * Otherwise the target values are stored, and will get set onto the properties
- * when the visual is next staged.
- *
- * @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.
*/
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
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
};
*/
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 ) 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.
- *
- * @SINCE_1_0.0
- * @param[in] child The removed actor
- */
- virtual void OnControlChildRemove( Actor& child ) DALI_DEPRECATED_API;
-
// Styling
/**
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).
*
*/
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
/**
/**
* @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.
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
* @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 Gets implementation from the handle.
* @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
projects / platform / core / uifw / dali-toolkit.git / blobdiff