#define DALI_TOOLKIT_INTERNAL_BUTTON_H
/*
- * Copyright (c) 2019 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 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.
#include <dali/public-api/animation/animation.h>
// INTERNAL INCLUDES
-#include <dali-toolkit/devel-api/visual-factory/visual-base.h>
#include <dali-toolkit/devel-api/controls/buttons/button-devel.h>
+#include <dali-toolkit/devel-api/controls/control-devel.h>
+#include <dali-toolkit/devel-api/visual-factory/visual-base.h>
#include <dali-toolkit/public-api/controls/control-impl.h>
namespace Dali
{
-
namespace Toolkit
{
-
class Button;
namespace Internal
{
-
/**
* @copydoc Toolkit::Button
*
*/
class Button : public Control
{
-
public:
-
/**
* Enum describing the position the text label can be in relation to the control (and foreground/icon)
*/
enum Align
{
- BEGIN, // At the start of the control before the foreground/icon
- END, // At the end of the control after the foreground/icon
- TOP, // At the top of the control above the foreground/icon
- BOTTOM // At the bottom of the control below the foreground/icon
+ BEGIN, // At the start of the control before the foreground/icon
+ END, // At the end of the control after the foreground/icon
+ TOP, // At the top of the control above the foreground/icon
+ BOTTOM // At the bottom of the control below the foreground/icon
};
public:
-
/**
* @brief Sets the button as \e disabled.
* @param[in] disabled Disabled property
*/
- void SetDisabled( bool disabled );
+ void SetDisabled(bool disabled);
/**
* @brief Returns if the button is disabled.
* @brief Sets the \e autorepeating property.
* @param[in] autoRepeating \e autorepeating property
*/
- void SetAutoRepeating( bool autoRepeating );
+ void SetAutoRepeating(bool autoRepeating);
/**
* @brief Sets the initial autorepeating delay.
* @param[in] initialAutoRepeatingDelay in seconds
*/
- void SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay );
+ void SetInitialAutoRepeatingDelay(float initialAutoRepeatingDelay);
/**
* @brief Sets the next autorepeating delay.
* @param[in] nextAutoRepeatingDelay in seconds
*/
- void SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay );
+ void SetNextAutoRepeatingDelay(float nextAutoRepeatingDelay);
/**
* @brief Sets the \e togglable property.
* @param[in] togglable Togglable property
*/
- void SetTogglableButton( bool togglable );
+ void SetTogglableButton(bool togglable);
/**
* @brief Sets the button as selected or unselected.
* @param[in] selected Selected property
*/
- void SetSelected( bool selected );
+ void SetSelected(bool selected);
/**
* @brief Returns if the selected property is set and the button is togglable.
* @param[in] properties A Property::Map of key-value pairs of properties to set.
* @param[out] properties A Property::Map of text visual properties to set after merging inMap with existing maps
*/
- void MergeWithExistingLabelProperties( const Property::Map& inMap, Property::Map& outMap );
+ void MergeWithExistingLabelProperties(const Property::Map& inMap, Property::Map& outMap);
/**
* Performs actions as requested using the action name.
* @param[in] attributes The attributes with which to perfrom this action.
* @return true if action has been accepted by this control
*/
- static bool DoAction( BaseObject* object, const std::string& actionName, const Property::Map& attributes );
+ static bool DoAction(BaseObject* object, const std::string& actionName, const Property::Map& attributes);
public:
-
/**
* Button's state
*/
enum State
{
- UNSELECTED_STATE, ///< The button is unselected.
- SELECTED_STATE, ///< The button is selected.
- DISABLED_UNSELECTED_STATE, ///< The button is disabled and unselected.
- DISABLED_SELECTED_STATE, ///< The button is disabled and selected.
- STATE_COUNT, ///< Number of States
+ UNSELECTED_STATE, ///< The button is unselected.
+ SELECTED_STATE, ///< The button is selected.
+ DISABLED_UNSELECTED_STATE, ///< The button is disabled and unselected.
+ DISABLED_SELECTED_STATE, ///< The button is disabled and selected.
+ STATE_COUNT, ///< Number of States
};
/**
};
protected:
-
/**
* Button press state which is not the same as the actual button's state.
* For example An UNSELECTED button can be DEPRESSED, but until released, the actual button state doesn't change to SELECTED
*/
enum PressState
{
- DEPRESSED, ///< The button is up.
- UNPRESSED, ///< The button is down.
- TOGGLE_DEPRESSED, ///< The button has been pressed down and will stay depressed when released.
+ DEPRESSED, ///< The button is up.
+ UNPRESSED, ///< The button is down.
+ TOGGLE_DEPRESSED, ///< The button has been pressed down and will stay depressed when released.
};
/**
Actor GetSelectedImage();
private:
-
/**
* Perform the click action to click the button.
* @param[in] attributes The attributes to perfrom this action.
* @return true if this control can perform action.
*/
- bool DoClickAction( const Property::Map& attributes );
+ bool DoClickAction(const Property::Map& attributes);
/**
* This method is called when the button is a Toggle button and released
/**
* This method is called when the \e selected property is changed.
*/
- virtual void OnStateChange( State newState ){}
+ virtual void OnStateChange(State newState)
+ {
+ }
/**
* This method is called when the \e disabled property is changed.
*/
- virtual void OnDisabled() {}
+ virtual void OnDisabled()
+ {
+ }
/**
* This method is called when the button is pressed.
*/
- virtual void OnPressed() {}
+ virtual void OnPressed()
+ {
+ }
/**
* This method is called when the button is released.
*/
- virtual void OnReleased() {}
+ virtual void OnReleased()
+ {
+ }
public:
-
/**
* @copydoc Dali::Toolkit::PushButton::PressedSignal()
*/
* @return True if the signal was connected.
* @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
*/
- static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
+ static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
// Properties
* @param[in] index The property index.
* @param[in] value The new property value.
*/
- static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
+ static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
/**
* Called to retrieve a property of an object of this type.
* @param[in] index The property index.
* @return The current value of the property.
*/
- static Property::Value GetProperty( BaseObject* object, Property::Index propertyIndex );
+ static Property::Value GetProperty(BaseObject* object, Property::Index propertyIndex);
protected: // From Control
-
/**
* @copydoc Toolkit::Control::OnInitialize()
* @note If overridden by deriving button classes, then an up-call to Button::OnInitialize MUST be made at the start.
*/
- virtual void OnInitialize();
+ void OnInitialize() override;
/**
* @copydoc Toolkit::Control::OnAccessibilityActivated()
*/
- virtual bool OnAccessibilityActivated();
+ bool OnAccessibilityActivated() override;
/**
* @copydoc Toolkit::Control::OnKeyboardEnter()
*/
- virtual bool OnKeyboardEnter();
+ bool OnKeyboardEnter() override;
/**
- * @copydoc Toolkit::Control::OnStageDisconnection()
- * @note If overridden by deriving button classes, then an up-call to Button::OnStageDisconnection MUST be made at the end.
+ * @copydoc Toolkit::Control::OnSceneDisconnection()
+ * @note If overridden by deriving button classes, then an up-call to Button::OnSceneDisconnection MUST be made at the end.
*/
- virtual void OnStageDisconnection();
+ void OnSceneDisconnection() override;
/**
- * @copydoc Toolkit::Control::OnStageConnnection()
+ * @copydoc Toolkit::Control::OnSceneConnection()
*/
- virtual void OnStageConnection( int depth );
+ void OnSceneConnection(int depth) override;
/**
* @copydoc Toolkit::Control::GetNaturalSize
*/
- virtual Vector3 GetNaturalSize();
+ Vector3 GetNaturalSize() override;
/**
* @copydoc Toolkit::Control::OnSetResizePolicy
*/
- virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
+ void OnSetResizePolicy(ResizePolicy::Type policy, Dimension::Type dimension) override;
/**
* @copydoc Toolkit::Control::OnRelayout
*/
- virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
+ void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
private:
-
/**
* @brief Handler for touch data
* @param[in] actor The touched actor.
* @param[in] touch The touch info.
* @return true, if consumed, false otherwise.
*/
- bool OnTouch( Actor actor, const TouchData& touch );
+ bool OnTouch(Actor actor, const TouchEvent& touch);
/**
* Handler for tap events.
* Sets up the autorepeating timer.
* @param[in] delay The delay time in seconds.
*/
- void SetUpTimer( float delay );
+ void SetUpTimer(float delay);
/**
* Button has been pressed
* @param[in] requestedState check if can transition to this state
* @return bool true if state change valid
*/
- bool ValidateState( State requestedState );
+ bool ValidateState(State requestedState);
/**
* Changes the button state when an action occurs on it
* @param[in] requestedState the state to change to
*/
- void ChangeState( State requestedState );
+ void ChangeState(State requestedState);
/**
* This method is called when the button is released.
void Released();
protected:
-
/**
* Set Text Label Padding
* @param[in] padding BEGIN END BOTTOM TOP
*/
- void SetLabelPadding( const Padding& padding );
+ void SetLabelPadding(const Padding& padding);
/**
* Get Text Label padding
* Set Foreground/icon Padding
* @param[in] padding BEGIN END BOTTOM TOP
*/
- void SetForegroundPadding( const Padding& padding);
+ void SetForegroundPadding(const Padding& padding);
/**
* Get Foreground padding
* @param[in] value the value to set on the component
* @param[in] visualDepth the depth of the visual if overlapping another
*/
- void CreateVisualsForComponent( Property::Index index, const Property::Value& value, const int visualDepth );
+ void CreateVisualsForComponent(Property::Index index, const Property::Value& value, const int visualDepth);
/**
* @brief Get the Property map for the given Visual
* @param[out] retreivedMap the property map used to construct the required visual
* @return bool success flag, true if visual found
*/
- bool GetPropertyMapForVisual( Property::Index visualIndex, Property::Map& retreivedMap ) const;
+ bool GetPropertyMapForVisual(Property::Index visualIndex, Property::Map& retreivedMap) const;
/**
* Returns the animation to be used for transition, creating the animation if needed.
* @return The initialised transition animation.
* @brief Set the position of the label relative to foreground/icon, if both present
* @param[in] labelAlignment given alignment setting
*/
- void SetLabelAlignment( Align labelAlignment);
+ void SetLabelAlignment(Align labelAlignment);
/**
* @brief Get set alignment of label in relation to foreground/icon
* define the required behaviour.
* Can decide to only remove specified visuals via index
*/
- virtual void OnButtonVisualRemoval( Property::Index visualIndex );
-
+ virtual void OnButtonVisualRemoval(Property::Index visualIndex);
private:
-
/**
* Removes the visual from the button and prepares it to be transitioned out
* @param[in] visualIndex the visual to remove
*/
- void RemoveVisual( Property::Index visualIndex );
+ void RemoveVisual(Property::Index visualIndex);
/**
* Adds the required visual to the button.
* @param[in] visualIndex The Property index of the visual required
*/
- void SelectRequiredVisual( Property::Index visualIndex );
+ void SelectRequiredVisual(Property::Index visualIndex);
// Undefined
- Button( const Button& );
+ Button(const Button&);
// Undefined
- Button& operator = ( const Button& );
+ Button& operator=(const Button&);
private:
-
// Signals
- Toolkit::Button::ButtonSignalType mPressedSignal; ///< Signal emitted when the button is pressed.
- Toolkit::Button::ButtonSignalType mReleasedSignal; ///< Signal emitted when the button is released.
- Toolkit::Button::ButtonSignalType mClickedSignal; ///< Signal emitted when the button is clicked.
- Toolkit::Button::ButtonSignalType mStateChangedSignal; ///< Signal emitted when the button's state is changed.
+ Toolkit::Button::ButtonSignalType mPressedSignal; ///< Signal emitted when the button is pressed.
+ Toolkit::Button::ButtonSignalType mReleasedSignal; ///< Signal emitted when the button is released.
+ Toolkit::Button::ButtonSignalType mClickedSignal; ///< Signal emitted when the button is clicked.
+ Toolkit::Button::ButtonSignalType mStateChangedSignal; ///< Signal emitted when the button's state is changed.
- Timer mAutoRepeatingTimer;
+ Timer mAutoRepeatingTimer;
- Actor mLabel; ///< Stores the button text label.
- Padding mLabelPadding; ///< The padding around the label (if present).
- Padding mForegroundPadding; ///< The padding around the foreground/icon visual (if present).
+ Actor mLabel; ///< Stores the button text label.
+ Padding mLabelPadding; ///< The padding around the label (if present).
+ Padding mForegroundPadding; ///< The padding around the foreground/icon visual (if present).
- Align mTextLabelAlignment; ///< Position of text label in relation to foreground/icon when both are present.
+ Align mTextLabelAlignment; ///< Position of text label in relation to foreground/icon when both are present.
TapGestureDetector mTapDetector;
- bool mAutoRepeating; ///< Stores the autorepeating property.
- bool mTogglableButton; ///< Stores the togglable property as a flag.
- bool mTextStringSetFlag; ///< Stores if text has been set. Required in relayout but don't want to calculate there.
+ bool mAutoRepeating; ///< Stores the autorepeating property.
+ bool mTogglableButton; ///< Stores the togglable property as a flag.
+ bool mTextStringSetFlag; ///< Stores if text has been set. Required in relayout but don't want to calculate there.
- float mInitialAutoRepeatingDelay; ///< Stores the initial autorepeating delay in seconds.
- float mNextAutoRepeatingDelay; ///< Stores the next autorepeating delay in seconds.
+ float mInitialAutoRepeatingDelay; ///< Stores the initial autorepeating delay in seconds.
+ float mNextAutoRepeatingDelay; ///< Stores the next autorepeating delay in seconds.
- float mAnimationTime;
+ float mAnimationTime;
- PressState mButtonPressedState; ///< In relation to the button being pressed/released
- State mButtonState;
- State mPreviousButtonState; ///< During a transition between two states, this stores the previous state so Visuals can be removed.
+ PressState mButtonPressedState; ///< In relation to the button being pressed/released
+ State mButtonState;
+ State mPreviousButtonState; ///< During a transition between two states, this stores the previous state so Visuals can be removed.
// Actions
- bool mClickActionPerforming; ///< Used to manage signal emissions during action
+ bool mClickActionPerforming; ///< Used to manage signal emissions during action
+
+protected:
+ struct AccessibleImpl : public DevelControl::ControlAccessible
+ {
+ using DevelControl::ControlAccessible::ControlAccessible;
+
+ Dali::Accessibility::States CalculateStates() override;
+ std::string GetNameRaw() const override;
+ Property::Index GetNamePropertyIndex() override;
+ };
};
} // namespace Internal
// Helpers for public-api forwarding methods
-inline Toolkit::Internal::Button& GetImplementation( Toolkit::Button& button )
+inline Toolkit::Internal::Button& GetImplementation(Toolkit::Button& button)
{
- DALI_ASSERT_ALWAYS( button );
+ DALI_ASSERT_ALWAYS(button);
Dali::RefObject& handle = button.GetImplementation();
- return static_cast<Toolkit::Internal::Button&>( handle );
+ return static_cast<Toolkit::Internal::Button&>(handle);
}
-inline const Toolkit::Internal::Button& GetImplementation( const Toolkit::Button& button )
+inline const Toolkit::Internal::Button& GetImplementation(const Toolkit::Button& button)
{
- DALI_ASSERT_ALWAYS( button );
+ DALI_ASSERT_ALWAYS(button);
const Dali::RefObject& handle = button.GetImplementation();
- return static_cast<const Toolkit::Internal::Button&>( handle );
+ return static_cast<const Toolkit::Internal::Button&>(handle);
}
} // namespace Toolkit
projects / platform / core / uifw / dali-toolkit.git / blobdiff