//
/**
- * @addtogroup CAPI_DALI_FRAMEWORK
+ * @addtogroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE
* @{
*/
namespace Toolkit
{
+class StyleManager;
+
namespace Internal DALI_INTERNAL
{
class StyleChangeProcessor;
class KeyInputFocusManager;
}
-typedef std::pair< Actor, Vector2 > ActorSizePair;
-typedef std::vector< ActorSizePair > ActorSizeContainer;
+typedef std::pair< Actor, Vector2 > ActorSizePair; ///< Pair of actor and size
+typedef std::vector< ActorSizePair > ActorSizeContainer; ///< Container of actors and their sizes
+
+namespace Internal
+{
/**
- * This is the internal base class for all controls.
+ * @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.
*/
-class ControlImpl : public CustomActorImpl, public ConnectionTrackerInterface
+class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
{
public:
+ // Properties
+ enum
+ {
+ CONTROL_PROPERTY_START_INDEX = PROPERTY_REGISTRATION_START_INDEX,
+ CONTROL_PROPERTY_END_INDEX = CONTROL_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices
+ };
+
// Creation
/**
- * Create a new ControlImpl instance that does not require touch by default.
+ * @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.
* @return A handle to the ConntrolImpl instance.
*/
- static Control New();
+ static Toolkit::Control New();
// Destruction
/**
- * Virtual destructor
+ * @brief Virtual destructor.
*/
- virtual ~ControlImpl();
+ virtual ~Control();
// Actions
/**
- * This method should be overridden by deriving classes when they wish to be notified when they
+ * @brief This method should be overridden by deriving classes when they wish to be notified when they
* are activated.
*/
virtual void OnActivated() { }
/**
- * This method should be overridden by deriving classes when they wish to respond the accessibility
+ * @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);
/**
- * 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)
+ * @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);
/**
- * Sets whether this control supports two dimensional keyboard navigation (i.e. whether it knows how to handle the keyboard
- * focus movement between its child actors). The control doesn't support it by default.
+ * @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).
+ *
+ * The control doesn't support it by default.
* @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
*/
void SetKeyboardNavigationSupport(bool isSupported);
/**
- * Gets whether this control supports two dimensional keyboard navigation.
+ * @brief Gets whether this control supports two dimensional keyboard navigation.
+ *
* @return true if this control supports two dimensional keyboard navigation.
*/
bool IsKeyboardNavigationSupported();
/**
- * Sets whether this control is a focus group for keyboard navigation (i.e. the scope of keyboard focus movement
+ * @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.
*/
void SetAsKeyboardFocusGroup(bool isFocusGroup);
/**
- * Gets whether this control is a focus group for keyboard navigation.
+ * @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.
*/
bool IsKeyboardFocusGroup();
/**
- * Gets the next keyboard focusable actor in this control towards the given direction.
+ * @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 Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
+ virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
/**
- * 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.
+ * @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.
+ *
* @param[in] commitedFocusableActor The commited focusable actor.
*/
virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor) { }
/**
- * Performs actions as requested using the action name.
+ * @brief Performs actions as requested using the action name.
+ *
* @param[in] object The object on which to perform the action.
* @param[in] actionName The action to perform.
* @param[in] attributes The attributes with which to perfrom this action.
*/
static bool DoAction(BaseObject* object, const std::string& actionName, const std::vector<Property::Value>& attributes);
+ /**
+ * @brief If deriving classes wish to fine tune pinch gesture
+ * detection then they can access the gesture detector through this
+ * API and modify the detection.
+ *
+ * @return The pinch gesture detector.
+ * @pre Pinch detection should have been enabled via EnableGestureDetection().
+ * @see EnableGestureDetection
+ */
+ PinchGestureDetector GetPinchGestureDetector() const;
+
+ /**
+ * @brief If deriving classes wish to fine tune pan gesture
+ * detection then they can access the gesture detector through this
+ * API and modify the detection.
+ *
+ * @return The pan gesture detector.
+ * @pre Pan detection should have been enabled via EnableGestureDetection().
+ * @see EnableGestureDetection
+ */
+ PanGestureDetector GetPanGestureDetector() const;
+
+ /**
+ * @brief If deriving classes wish to fine tune tap gesture
+ * detection then they can access the gesture detector through this
+ * API and modify the detection.
+ *
+ * @return The tap gesture detector.
+ * @pre Tap detection should have been enabled via EnableGestureDetection().
+ * @see EnableGestureDetection
+ */
+ TapGestureDetector GetTapGestureDetector() const;
+
+ /**
+ * @brief If deriving classes wish to fine tune long press gesture
+ * detection then they can access the gesture detector through this
+ * API and modify the detection.
+ *
+ * @return The long press gesture detector.
+ * @pre Long press detection should have been enabled via EnableGestureDetection().
+ * @see EnableGestureDetection
+ */
+ LongPressGestureDetector GetLongPressGestureDetector() const;
+
+ // Background
+
+ /**
+ * @copydoc Dali::Toolkit::Control::SetBackgroundColor
+ */
+ void SetBackgroundColor( const Vector4& color );
+
+ /**
+ * @copydoc Dali::Toolkit::Control::GetBackgroundColor
+ */
+ Vector4 GetBackgroundColor() const;
+
+ /**
+ * @copydoc Dali::Toolkit::Control::SetBackground
+ */
+ void SetBackground( Image image );
+
+ /**
+ * @copydoc Dali::Toolkit::Control::ClearBackground
+ */
+ void ClearBackground();
+
+ /**
+ * @copydoc Dali::Toolkit::Control::GetBackgroundActor
+ */
+ Actor GetBackgroundActor() const;
+
public:
/**
// Construction
/**
- * Second phase initialization.
+ * @brief Second phase initialization.
*/
void Initialize();
// Gesture Detection
/**
- * Allows deriving classes to enable any of the gesture detectors that are available.
+ * @brief Allows deriving classes to enable any of the gesture detectors that are available.
+ *
* 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));
void EnableGestureDetection(Gesture::Type type);
/**
- * Allows deriving classes to disable any of the gesture detectors.
+ * @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.
* @see EnableGetureDetection
*/
void DisableGestureDetection(Gesture::Type type);
- /**
- * If deriving classes wish to fine tune pinch gesture detection then they can access the gesture
- * detector through this API and modify the detection.
- * @return The pinch gesture detector.
- * @pre Pinch detection should have been enabled via EnableGestureDetection().
- * @see EnableGestureDetection
- */
- PinchGestureDetector GetPinchGestureDetector() const;
-
- /**
- * If deriving classes wish to fine tune pan gesture detection then they can access the gesture
- * detector through this API and modify the detection.
- * @return The pan gesture detector.
- * @pre Pan detection should have been enabled via EnableGestureDetection().
- * @see EnableGestureDetection
- */
- PanGestureDetector GetPanGestureDetector() const;
-
- /**
- * If deriving classes wish to fine tune tap gesture detection then they can access the gesture
- * detector through this API and modify the detection.
- * @return The tap gesture detector.
- * @pre Tap detection should have been enabled via EnableGestureDetection().
- * @see EnableGestureDetection
- */
- TapGestureDetector GetTapGestureDetector() const;
-
- /**
- * If deriving classes wish to fine tune long press gesture detection then they can access the
- * gesture detector through this API and modify the detection.
- * @return The long press gesture detector.
- * @pre Long press detection should have been enabled via EnableGestureDetection().
- * @see EnableGestureDetection
- */
- LongPressGestureDetector GetLongPressGestureDetector() const;
-
private: // For derived classes to override
/**
- * This method is called after the Control has been initialized. Derived classes should do
- * any second phase initialization by overriding this method.
+ * @brief This method is called after the Control has been initialized.
+ *
+ * Derived classes should do any second phase initialization by
+ * overriding this method.
*/
virtual void OnInitialize() { }
/**
- * This method should be overridden by deriving classes when they wish to be notified when the
- * style changes.
+ * @brief This method should be overridden by deriving classes when
+ * they wish to be notified when the style changes.
+ *
* @param[in] change Information denoting what has changed.
*/
virtual void OnStyleChange(StyleChange change) { }
/**
- * 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.
+ * @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.
virtual void OnPinch(PinchGesture pinch);
/**
- * Called whenever a pan gesture is detected on this control. This should be overridden by
- * deriving classes when pan detection is enabled.
+ * @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.
virtual void OnPan(PanGesture pan) { }
/**
- * Called whenever a tap gesture is detected on this control. This should be overridden by
- * deriving classes when tap detection is enabled.
+ * @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.
virtual void OnTap(TapGesture tap) { }
/**
- * Called whenever a long press gesture is detected on this control. This should be overridden by
- * deriving classes when long press detection is enabled.
+ * @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.
virtual void OnLongPress(LongPressGesture longPress) { }
/**
- * Called whenever the control is added to the stage. Could be overridden by derived classes.
+ * @brief Called whenever the control is added to the stage.
+ *
+ * Could be overridden by derived classes.
*/
virtual void OnControlStageConnection() { }
/**
- * Called whenever the control is removed from the stage. Could be overridden by derived classes.
+ * @brief Called whenever the control is removed from the stage.
+ *
+ * Could be overridden by derived classes.
*/
virtual void OnControlStageDisconnection() { }
/**
- * Called whenever an Actor is added to the control. Could be overridden by derived classes.
+ * @brief Called whenever an Actor is added to the control.
+ *
+ * Could be overridden by derived classes.
*
* @param[in] child The added actor.
*/
virtual void OnControlChildAdd( Actor& child ) { }
/**
- * Called whenever an Actor is removed from the control. Could be overridden by derived classes.
+ * @brief Called whenever an Actor is removed from the control.
+ *
+ * Could be overridden by derived classes.
*
* @param[in] child The removed actor.
*/
virtual void OnControlChildRemove( Actor& child ) { }
/**
- * Called whenever the Control's size is set. Could be overridden by derived classes.
+ * @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 ) { }
/**
- * Called after the Dali::Stage::SignalMessageQueueFlushed() signal is emitted if this control requested to be relaid-out.
- * Should be overridden by derived classes if they need to layout actors differently after certain operations like add or
- * remove actors, resize or after changing especific properties.
+ * @brief Called after the Dali::Stage::SignalMessageQueueFlushed()
+ * signal is emitted if this control requested to be relaid-out.
+ *
+ * Should be overridden by derived classes if they need to layout
+ * actors differently after certain operations like add or remove
+ * actors, resize or after changing especific properties.
*
* @param[in] size The allocated size.
* @param[in,out] container The control should add actors to this container that it is not able
private: // From CustomActorImpl, derived classes can override these.
/**
- * Sends a request to relayout this control. The control will be relaid out after the Dali::Stage::SignalMessageQueueFlushed() signal is emitted.
+ * @brief Sends a request to relayout this control.
+ *
+ * The control will be relaid out after the
+ * Dali::Stage::SignalMessageQueueFlushed() signal is emitted.
*
* It calls OnControlStageConnection() to notify derived classes.
*
virtual void OnStageConnection();
/**
- * Calls OnControlStageDisconnection() to notify derived classed.
+ * @brief Calls OnControlStageDisconnection() to notify derived classed.
*
* @see Dali::CustomActorImpl::OnStageDisconnection()
*/
virtual void OnStageDisconnection();
/**
- * 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.
+ * @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.
*
virtual void OnChildAdd(Actor& child);
/**
- * 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.
+ * @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.
*
virtual void OnChildRemove(Actor& child);
/**
- * 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.
+ * @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.
*
* @param[in] targetSize The new size.
private:
/**
- * Perform the activated action.
+ * @brief Perform the activated action.
+ *
* @param[in] attributes The attributes to perfrom this action.
*/
void DoActivatedAction(const PropertyValueContainer& attributes);
protected: // Construction
/**
- * Create a ControlImpl.
+ * @brief Create a Control.
+ *
* @param[in] requiresTouchEvents True if the OnTouchEvent() callback is required.
*/
- ControlImpl(bool requiresTouchEvents);
+ Control(bool requiresTouchEvents);
public:
// Size negotiation
/**
- * @copydoc Control::SetSizePolicy()
+ * @copydoc Toolkit::Control::SetSizePolicy()
*/
- void SetSizePolicy( Control::SizePolicy widthPolicy, Control::SizePolicy heightPolicy );
+ void SetSizePolicy( Toolkit::Control::SizePolicy widthPolicy, Toolkit::Control::SizePolicy heightPolicy );
/**
- * @copydoc Control::GetSizePolicy()
+ * @copydoc Toolkit::Control::GetSizePolicy()
*/
- void GetSizePolicy( Control::SizePolicy& widthPolicy, Control::SizePolicy& heightPolicy ) const;
+ void GetSizePolicy( Toolkit::Control::SizePolicy& widthPolicy, Toolkit::Control::SizePolicy& heightPolicy ) const;
/**
- * @copydoc Control::SetMinimumSize()
+ * @copydoc Toolkit::Control::SetMinimumSize()
*/
void SetMinimumSize( const Vector3& size );
/**
- * @copydoc Control::GetMinimumSize()
+ * @copydoc Toolkit::Control::GetMinimumSize()
*/
const Vector3& GetMinimumSize() const;
/**
- * @copydoc Control::SetMaximumSize()
+ * @copydoc Toolkit::Control::SetMaximumSize()
*/
void SetMaximumSize( const Vector3& size );
/**
- * @copydoc Control::GetMaximumSize()
+ * @copydoc Toolkit::Control::GetMaximumSize()
*/
const Vector3& GetMaximumSize() const;
/**
- * @copydoc Control::GetNaturalSize()
+ * @copydoc Toolkit::Control::GetNaturalSize()
*/
virtual Vector3 GetNaturalSize();
/**
- * @copydoc Control::GetHeightForWidth()
+ * @copydoc Toolkit::Control::GetHeightForWidth()
*/
virtual float GetHeightForWidth( float width );
/**
- * @copydoc Control::GetWidthForHeight()
+ * @copydoc Toolkit::Control::GetWidthForHeight()
*/
virtual float GetWidthForHeight( float height );
/**
- * Retrieves the current Control's size.
+ * @brief Retrieves the current Control's size.
*
* @return The control's size.
*/
const Vector3& GetControlSize() const;
/**
- * Retrieves the Control's size set by the Application / Control.
+ * @brief Retrieves the Control's size set by the Application / Control.
+ *
* @return The control's size.
*/
const Vector3& GetSizeSet() const;
//KeyInput
/**
- * @copydoc Control::SetKeyInputFocus()
+ * @copydoc Toolkit::Control::SetKeyInputFocus()
*/
void SetKeyInputFocus();
/**
- * @copydoc Control::HasKeyInputFocus()
+ * @copydoc Toolkit::Control::HasKeyInputFocus()
*/
bool HasKeyInputFocus();
/**
- * @copydoc Control::ClearKeyInputFocus()
+ * @copydoc Toolkit::Control::ClearKeyInputFocus()
*/
void ClearKeyInputFocus();
protected:
/**
- * Sends a request to be relaid-out. This methos is called from OnStageConnection(), OnChildAdd(), OnChildRemove(), SetSizePolicy(), SetMinimumSize() and SetMaximumSize().
+ * @brief Sends a request to be relaid-out.
+ *
+ * This method is called from OnStageConnection(), OnChildAdd(),
+ * OnChildRemove(), SetSizePolicy(), SetMinimumSize() and
+ * SetMaximumSize().
*
- * This method could also be called from derived classes every time a control's poperty change and it needs to be relaid-out.
- * After the Dali::Stage::SignalMessageQueueFlushed() is emitted a relayout process starts and all controls which called this method will be relaid-out.
+ * This method could also be called from derived classes every time
+ * a control's poperty change and it needs to be relaid-out. After
+ * the Dali::Stage::SignalMessageQueueFlushed() is emitted a
+ * relayout process starts and all controls which called this method
+ * will be relaid-out.
*
- * @note RelayoutRequest() only sends a request per Control before the Dali::Stage::SignalMessageQueueFlushed() signal is emitted. That means a control will be relaid-out
- * only once, even if more than one request is sent between two consecutive signals.
+ * @note RelayoutRequest() only sends a request per Control before
+ * the Dali::Stage::SignalMessageQueueFlushed() signal is
+ * emitted. That means a control will be relaid-out only once, even
+ * if more than one request is sent between two consecutive signals.
*/
void RelayoutRequest();
/**
- * Helper method for controls to Relayout their children if they do not know whether that child is
- * a control or not.
+ * @brief Helper method for controls to Relayout their children if
+ * they do not know whether that child is a control or not.
*
* @param[in] actor The actor to relayout.
* @param[in] size The size to allocate to the actor.
private: // Used by the RelayoutController
/**
- * Called by the RelayoutController to negotiate the size of a control. The size allocated by the
- * the algorithm is passed in which the control must adhere to. A container is passed in as well
- * which the control should populate with actors it has not / or does not need to handle in its
- * size negotiation.
+ * @brief Called by the RelayoutController to negotiate the size of a control.
+ *
+ * The size allocated by the the algorithm is passed in which the
+ * control must adhere to. A container is passed in as well which
+ * the control should populate with actors it has not / or does not
+ * need to handle in its size negotiation.
*
* @param[in] size The allocated size.
* @param[in,out] container The container that holds actors that are fed back into the
private:
/**
- * Called by NegotiateSize when the size to allocate to the control has been calculated.
+ * @brief Called by NegotiateSize when the size to allocate to the control has been calculated.
+ *
* It calls the OnRelaidOut() method which can be overridden by derived classes.
*
* @param[in] size The allocated size.
void Relayout( Vector2 size, ActorSizeContainer& container );
/**
- * Used by the KeyInputFocusManager to emit key event signals.
+ * @brief Used by the KeyInputFocusManager to emit key event signals.
+ *
* @param[in] event The key event.
* @return True if the event was consumed.
*/
private:
// Undefined
- ControlImpl(const ControlImpl&);
- ControlImpl& operator=(const ControlImpl&);
+ Control(const Control&);
+ Control& operator=(const Control&);
class Impl;
Impl *mImpl;
friend class Internal::KeyInputFocusManager; ///< KeyInputFocusManager needs to call which is private.
};
+} // namespace Internal
+
+typedef Internal::Control ControlImpl; ///< @deprecated, Use Internal::Control
+
} // namespace Toolkit
} // namespace Dali
projects / platform / core / uifw / dali-toolkit.git / blobdiff