#define __DALI_TOOLKIT_CONTROL_IMPL_H__
/*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2015 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.
// EXTERNAL INCLUDES
#include <dali/public-api/adaptor-framework/style-change.h>
-#include <dali/public-api/common/vector-wrapper.h>
#include <dali/public-api/events/long-press-gesture.h>
#include <dali/public-api/events/pan-gesture.h>
#include <dali/public-api/events/pinch-gesture.h>
namespace Toolkit
{
-
class StyleManager;
-namespace Internal DALI_INTERNAL
-{
-class KeyInputFocusManager;
-}
-
namespace Internal
{
+class FocusManager;
+class KeyboardFocusManager;
+class KeyInputFocusManager;
/**
* @brief This is the internal base class for all controls.
{
public:
+ class Extension; ///< Forward declare future extension interface
+
// Creation & Destruction
/**
*/
virtual ~Control();
- // Size negotiation
-
- /**
- * @copydoc Dali::CustomActorImpl::GetHeightForWidth()
- */
- virtual float GetHeightForWidth( float width );
-
- /**
- * @copydoc Dali::CustomActorImpl::GetWidthForHeight()
- */
- virtual float GetWidthForHeight( float height );
-
- /**
- * @copydoc Toolkit::Control::GetNaturalSize()
- */
- virtual Vector3 GetNaturalSize();
-
- /**
- * @brief Retrieves the current Control's size.
- *
- * @return The control's size.
- */
- const Vector3& GetControlSize() const;
-
- /**
- * @brief Retrieves the Control's size set by the Application / Control.
- *
- * @return The control's size.
- */
- const Vector3& GetSizeSet() const;
-
// Key Input
/**
*/
LongPressGestureDetector GetLongPressGestureDetector() const;
- // Background
+ // Styling
/**
* @copydoc Dali::Toolkit::Control::SetStyleName
*/
const std::string& GetStyleName() const;
+ // Background
+
/**
* @copydoc Dali::Toolkit::Control::SetBackgroundColor
*/
*/
void ClearBackground();
- /**
- * @copydoc Dali::Toolkit::Control::GetBackgroundActor
- */
- Actor GetBackgroundActor() const;
-
// Keyboard Navigation
/**
* @brief Sets whether this control supports two dimensional
* keyboard navigation (i.e. whether it knows how to handle the
- * keyboardn focus movement between its child actors).
+ * 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.
*/
DALI_INTERNAL void Activate();
- /**
- * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
- * 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.
- *
- * @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).
- *
- * @param[in] isIncrease Whether the value should be increased or decreased
- * @return true if the value changed action has been consumed by this control
- */
- virtual bool OnAccessibilityValueChange(bool isIncrease);
-
// Keyboard Focus
/**
bool IsKeyboardFocusGroup();
/**
- * @brief Gets the next keyboard focusable actor in this control towards the given direction.
+ * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
*
- * 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.
- */
- virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection 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
- * before the focus is actually moved to the chosen actor.
+ * Should be called last by the control after it acts on the Input Focus change.
*
- * @param[in] commitedFocusableActor The commited focusable actor.
+ * @param[in] focusGained True if gained, False if lost
*/
- virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
+ void EmitKeyInputFocusSignal( bool focusGained );
// Actions & Signals
Toolkit::Control::KeyEventSignalType& KeyEventSignal();
/**
+ * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
+ */
+ Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
+
+ /**
+ * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
+ */
+ Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
+
+ /**
* @brief Called by the KeyInputFocusManager to emit key event signals.
*
* @param[in] event The key event.
*/
DALI_INTERNAL bool EmitKeyEventSignal(const KeyEvent& event);
-protected:
+protected: // From CustomActorImpl, not to be used by application developers
+
+ /**
+ * @copydoc CustomActorImpl::OnStageConnection()
+ */
+ virtual void OnStageConnection();
+
+ /**
+ * @copydoc CustomActorImpl::OnStageDisconnection()
+ */
+ virtual void OnStageDisconnection();
+
+ /**
+ * @copydoc CustomActorImpl::OnChildAdd()
+ */
+ virtual void OnChildAdd(Actor& child);
+
+ /**
+ * @copydoc CustomActorImpl::OnChildRemove()
+ */
+ virtual void OnChildRemove(Actor& child);
+
+ /**
+ * @copydoc CustomActorImpl::OnSizeSet()
+ */
+ virtual void OnSizeSet(const Vector3& targetSize);
+
+ /**
+ * @copydoc CustomActorImpl::OnSizeAnimation()
+ */
+ 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::OnMouseWheelEvent()
+ */
+ virtual bool OnMouseWheelEvent(const MouseWheelEvent& event);
+
+ /**
+ * @copydoc CustomActorImpl::OnRelayout()
+ */
+ virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
+
+ /**
+ * @copydoc CustomActorImpl::OnSetResizePolicy()
+ */
+ virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
+
+ /**
+ * @copydoc CustomActorImpl::GetNaturalSize()
+ */
+ virtual Vector3 GetNaturalSize();
+
+ /**
+ * @copydoc CustomActorImpl::CalculateChildSize()
+ */
+ virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
+
+ /**
+ * @copydoc CustomActorImpl::GetHeightForWidth()
+ */
+ virtual float GetHeightForWidth( float width );
+
+ /**
+ * @copydoc CustomActorImpl::GetWidthForHeight()
+ */
+ virtual float GetWidthForHeight( float height );
+
+ /**
+ * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
+ */
+ virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
+
+ /**
+ * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
+ */
+ virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
+
+ /**
+ * @copydoc CustomActorImpl::OnLayoutNegotiated()
+ */
+ virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
+
+protected: // Helpers for deriving classes
// Construction
// Flags for the constructor
enum ControlBehaviour
{
- CONTROL_BEHAVIOUR_NONE = 0,
- REQUIRES_TOUCH_EVENTS = 1<<1, ///< True if the OnTouchEvent() callback is required.
- REQUIRES_STYLE_CHANGE_SIGNALS = 1<<2, ///< True if needs to monitor style change signals such as theme/font change
- NO_SIZE_NEGOTIATION = 1<<3, ///< True if control does not need size negotiation, i.e. it can be skipped in the algorithm
- REQUIRES_HOVER_EVENTS = 1<<4, ///< True if the OnHoverEvent() callback is required.
- REQUIRES_MOUSE_WHEEL_EVENTS = 1<<5 ///< True if the OnMouseWheelEvent() callback is required.
+ 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
+
+ LAST_CONTROL_BEHAVIOUR_FLAG
};
+ static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
+
/**
- * @brief Create a Control.
+ * @brief Control constructor
*
* @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
*/
- Control(ControlBehaviour behaviourFlags);
+ Control( ControlBehaviour behaviourFlags );
/**
* @brief Second phase initialization.
* @endcode
* @param[in] type The gesture type(s) to enable.
*/
- void EnableGestureDetection(Gesture::Type type);
+ void EnableGestureDetection( Gesture::Type 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( Gesture::Type type );
- /**
- * @copydoc Dali::CustomActorImpl::RelayoutDependentOnChildren()
- */
- virtual bool RelayoutDependentOnChildren( Dimension dimension = ALL_DIMENSIONS );
+public: // API for derived classes to override
-private:
-
- // For derived classes to override
+ // Lifecycle
/**
* @brief This method is called after the Control has been initialized.
virtual void OnInitialize();
/**
- * @brief This method is called when the control is activated.
- *
- * Derived classes should override this if they wish to be notified when they are activated.
- */
- virtual void OnActivated();
-
- /**
- * @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.
- */
- virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange change );
-
- /**
- * @brief Called whenever a pinch gesture is detected on this control.
- *
- * This can be overridden by deriving classes when pinch detection
- * is enabled. The default behaviour is to scale the control by the
- * pinch scale.
- *
- * @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);
-
- /**
- * @brief Called whenever a pan gesture is detected on this control.
- *
- * This should be overridden by deriving classes when pan detection
- * is enabled.
- *
- * @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 );
-
- /**
- * @brief Called whenever a tap gesture is detected on this control.
- *
- * This should be overridden by deriving classes when tap detection
- * is enabled.
- *
- * @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 );
-
- /**
- * @brief Called whenever a long press gesture is detected on this control.
- *
- * This should be overridden by deriving classes when long press
- * detection is enabled.
- *
- * @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 );
-
- /**
* @brief Called whenever the control is added to the stage.
*
* Could be overridden by derived classes.
*/
virtual void OnControlChildRemove( Actor& child );
- /**
- * @brief Called whenever the Control's size is set.
- *
- * Could be overridden by derived classes.
- *
- * @param[in] size The new size.
- */
- virtual void OnControlSizeSet( const Vector3& size );
-
- /**
- * @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.
- */
- virtual void OnKeyInputFocusGained();
+ // Styling
/**
- * @brief Called when the control loses key input focus.
+ * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
*
- * Should be overridden by derived classes if they need to customize what happens when focus is lost.
+ * @param[in] styleManager The StyleManager object.
+ * @param[in] change Information denoting what has changed.
*/
- virtual void OnKeyInputFocusLost();
+ virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
- // From CustomActorImpl, derived classes can override these.
+ // Size negotiation
/**
- * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&)
+ * @brief Called whenever the Control's size is set.
+ *
+ * @param[in] size The new size.
*/
- virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize);
+ virtual void OnControlSizeSet( const Vector3& size );
- /**
- * @copydoc Dali::CustomActorImpl::OnTouchEvent(const TouchEvent&)
- */
- virtual bool OnTouchEvent(const TouchEvent& event);
+ // Accessibility
/**
- * @copydoc Dali::CustomActorImpl::OnHoverEvent(const HoverEvent&)
+ * @brief This method is called when the control is accessibility activated.
+ *
+ * Derived classes should override this to perform custom accessibility activation.
*/
- virtual bool OnHoverEvent(const HoverEvent& event);
+ virtual void OnAccessibilityActivated();
/**
- * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
+ * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
+ * pan gesture.
+ *
+ * @param[in] gesture The pan gesture.
+ * @return true if the pan gesture has been consumed by this control
*/
- virtual bool OnKeyEvent(const KeyEvent& event);
+ virtual bool OnAccessibilityPan(PanGesture gesture);
/**
- * @copydoc Dali::CustomActorImpl::OnMouseWheelEvent(const MouseWheelEvent&)
+ * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
+ * touch event.
+ *
+ * @param[in] touchEvent The touch event.
+ * @return true if the touch event has been consumed by this control
*/
- virtual bool OnMouseWheelEvent(const MouseWheelEvent& event);
+ virtual bool OnAccessibilityTouch(const TouchEvent& touchEvent);
/**
- * @copydoc Dali::CustomActorImpl::OnCalculateRelayoutSize()
+ * @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).
+ *
+ * @param[in] isIncrease Whether the value should be increased or decreased
+ * @return true if the value changed action has been consumed by this control
*/
- virtual void OnCalculateRelayoutSize( Dimension dimension );
+ virtual bool OnAccessibilityValueChange(bool isIncrease);
- /**
- * @copydoc Dali::CustomActorImpl::OnLayoutNegotiated()
- */
- virtual void OnLayoutNegotiated( float size, Dimension dimension );
+ // Keyboard focus
/**
- * @copydoc Dali::CustomActorImpl::OnRelayout()
+ * @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.
*/
- virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
+ virtual void OnKeyInputFocusGained();
/**
- * @copydoc Dali::CustomActorImpl::OnSetResizePolicy()
+ * @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.
*/
- virtual void OnSetResizePolicy( ResizePolicy policy, Dimension dimension );
+ virtual void OnKeyInputFocusLost();
/**
- * @copydoc Dali::CustomActorImpl::CalculateChildSize()
+ * @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.
*/
- virtual float CalculateChildSize( const Dali::Actor& child, Dimension dimension );
-
- // From CustomActorImpl, derived classes should NOT override these.
+ virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
/**
- * @brief Sends a request to relayout this control.
- *
- * The control will be relaid out after the
- * Dali::Stage::SignalMessageQueueFlushed() signal is emitted.
+ * @brief Informs this control that its chosen focusable actor will be focused.
*
- * It calls OnControlStageConnection() to notify derived classes.
+ * This allows the application to preform any actions if wishes
+ * before the focus is actually moved to the chosen actor.
*
- * @see Dali::CustomActorImpl::OnStageConnection()
+ * @param[in] commitedFocusableActor The commited focusable actor.
*/
- virtual void OnStageConnection();
+ virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
+
+ // Gestures
/**
- * @brief Calls OnControlStageDisconnection() to notify derived classed.
+ * @brief Called whenever a pinch gesture is detected on this control.
+ *
+ * This can be overridden by deriving classes when pinch detection
+ * is enabled. The default behaviour is to scale the control by the
+ * pinch scale.
*
- * @see Dali::CustomActorImpl::OnStageDisconnection()
+ * @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 OnStageDisconnection();
+ virtual void OnPinch(const PinchGesture& pinch);
/**
- * @brief Sends a request to relayout this control.
- *
- * The control will be relaid out after the
- * Dali::Stage::SignalMessageQueueFlushed() signal is emitted. It
- * calls OnControlChildAdd() to notify derived classes.
- *
- * @note This method shouldn't be overridden by derived classes.
+ * @brief Called whenever a pan gesture is detected on this control.
*
- * @param[in] child The added actor.
+ * This should be overridden by deriving classes when pan detection
+ * is enabled.
*
- * @see Dali::CustomActorImpl::OnChildAdd(Actor&)
+ * @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 OnChildAdd(Actor& child);
+ virtual void OnPan( const PanGesture& pan );
/**
- * @brief Sends a request to relayout this control.
- *
- * The control will be relaid out after the
- * Dali::Stage::SignalMessageQueueFlushed() signal is emitted. It
- * calls OnControlChildRemove() to notify derived classes.
- *
- * @note This method shouldn't be overridden by derived classes.
+ * @brief Called whenever a tap gesture is detected on this control.
*
- * @param[in] child The removed actor.
+ * This should be overridden by deriving classes when tap detection
+ * is enabled.
*
- * @see Dali::CustomActorImpl::OnChildRemove(Actor&)
+ * @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 OnChildRemove(Actor& child);
+ virtual void OnTap( const TapGesture& tap );
/**
- * @brief It stores the size set by size negotiation and relayout.
- *
- * It also keeps a backup of the size set through the Actor's API used in the size negotiation.
- * It calls the OnControlSizeSet() to notify derived classes.
+ * @brief Called whenever a long press gesture is detected on this control.
*
- * @param[in] targetSize The new size.
+ * This should be overridden by deriving classes when long press
+ * detection is enabled.
*
- * @see Dali::CustomActorImpl::OnSizeSet(const Vector3&)
+ * @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 OnSizeSet(const Vector3& targetSize);
+ virtual void OnLongPress( const LongPressGesture& longPress );
// From ConnectionTrackerInterface
*/
virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
+ /**
+ * Retrieve the extension for this control
+ *
+ * @return The extension if available, NULL otherwise
+ */
+ virtual Extension* GetControlExtension()
+ {
+ return NULL;
+ }
+
private:
// Undefined
class Impl;
Impl* mImpl;
- friend class Internal::KeyInputFocusManager; ///< KeyInputFocusManager needs to call several methods which are private. // TODO: Remove
};
+/**
+ * @brief Get implementation from the handle
+ *
+ * @pre handle is initialized and points to a control
+ * @param handle
+ * @return implementation
+ */
+Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
+
+/**
+ * @brief Get implementation from the handle
+ *
+ * @pre handle is initialized and points to a control
+ * @param handle
+ * @return implementation
+ */
+const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
+
} // namespace Internal
} // namespace Toolkit
projects / platform / core / uifw / dali-toolkit.git / blobdiff