X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Fbuttons%2Fbutton-impl.h;h=f0884e193e07dcf8ebc9dc0aec40828209ff59af;hp=3881cc170ae2014f040fa536c492a9ba6c6f14bd;hb=8a647e87a01c5c78451653c1264a9eea81ac9b20;hpb=2ddfbb9e23a7c3fc30e604236c41e0ef6d2ed6a2 diff --git a/dali-toolkit/internal/controls/buttons/button-impl.h b/dali-toolkit/internal/controls/buttons/button-impl.h index 3881cc1..881b0a1 100644 --- a/dali-toolkit/internal/controls/buttons/button-impl.h +++ b/dali-toolkit/internal/controls/buttons/button-impl.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_INTERNAL_BUTTON_H__ -#define __DALI_TOOLKIT_INTERNAL_BUTTON_H__ +#ifndef DALI_TOOLKIT_INTERNAL_BUTTON_H +#define DALI_TOOLKIT_INTERNAL_BUTTON_H /* - * Copyright (c) 2014 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. @@ -18,10 +18,15 @@ * */ +// EXTERNAL INCLUDES +#include +#include + // INTERNAL INCLUDES -#include +#include +#include #include -#include "button-painter-impl.h" +#include namespace Dali { @@ -35,117 +40,247 @@ namespace Internal { /** + * @copydoc Toolkit::Button + * * Button is the base class implementation for all buttons. + * + * @note + * + * All Foreground/Icon visuals expected to be the same size. + * Background visuals will take the size of the control. + * Padding and struts take size precedence over visuals when available space is limited. + * Icon/Foreground visuals take size precedence over Labels when available space is limited. */ class Button : public Control { + public: - // Properties - enum + /** + * Enum describing the position the text label can be in relation to the control (and foreground/icon) + */ + enum Align { - BUTTON_PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, - BUTTON_PROPERTY_END_INDEX = BUTTON_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices + 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 }; -protected: +public: /** - * Construct a new Button. + * @brief Sets the button as \e disabled. + * @param[in] disabled Disabled property */ - Button(); + void SetDisabled( bool disabled ); /** - * A reference counted object may only be deleted by calling Unreference() + * @brief Returns if the button is disabled. + * @return \e true if the button is \e disabled */ - virtual ~Button(); + bool IsDisabled() const; + + /** + * @brief Sets the \e autorepeating property. + * @param[in] autoRepeating \e autorepeating property + */ + void SetAutoRepeating( bool autoRepeating ); + + /** + * @brief Sets the initial autorepeating delay. + * @param[in] initialAutoRepeatingDelay in seconds + */ + void SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay ); + + /** + * @brief Sets the next autorepeating delay. + * @param[in] nextAutoRepeatingDelay in seconds + */ + void SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay ); + + /** + * @brief Sets the \e togglable property. + * @param[in] togglable Togglable property + */ + void SetTogglableButton( bool togglable ); + + /** + * @brief Sets the button as selected or unselected. + * @param[in] selected Selected property + */ + void SetSelected( bool selected ); + + /** + * @brief Returns if the selected property is set and the button is togglable. + * @return \e true if the button is \e selected + */ + bool IsSelected() const; + + /** + * @brief Produces a Property::Map of Text properties to create a Text Visual, merging existing properties with supplied map + * If the label does not exist yet, it is created. + * The derived buttons are notified if any properties are changed. + * @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 ); + + /** + * 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. + * @return true if action has been accepted by this control + */ + static bool DoAction( BaseObject* object, const std::string& actionName, const Property::Map& attributes ); public: /** - * @copydoc Dali::Toolkit::Button::SetDisabled( bool disabled ) + * Button's state */ - void SetDisabled( bool disabled ); + 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 + }; /** - * @copydoc Dali::Toolkit::Button::IsDisabled() const + * Enum to distinguish the different style-able components of the button */ - bool IsDisabled() const; + enum Visuals + { + UNSELECTED_FOREGROUND = 0, + SELECTED_FOREGROUND, + DISABLED_SELECTED_FOREGROUND, + DISABLED_UNSELECTED_FOREGROUND, + UNSELECTED_BACKGROUND, + SELECTED_BACKGROUND, + DISABLED_UNSELECTED_BACKGROUND, + DISABLED_SELECTED_BACKGROUND, + VISUALS_COUNT + }; + + /** + * Enum to list types of visual a state can have. + */ + enum VisualState + { + BACKGROUND = 0, + FOREGROUND, + VISUAL_STATE_COUNT + }; + +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. + }; /** - * @copydoc Dali::Toolkit::Button::SetAnimationTime() + * Construct a new Button. */ - void SetAnimationTime( float animationTime ); + Button(); /** - * @copydoc Dali::Toolkit::Button::GetAnimationTime() + * A reference counted object may only be deleted by calling Unreference() */ - float GetAnimationTime() const; + virtual ~Button(); + /** + * @return A reference to the label actor. + */ + Actor& GetLabelActor(); + + /** + * @return A reference to the unselected button image. + */ + Actor GetUnselectedImage(); + + /** + * @return A reference to the selected image. + */ + Actor GetSelectedImage(); private: /** - * This method is called after the button initialization. - * Could be reimplemented in subclasses to provide specific behaviour. + * 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. */ - virtual void OnButtonInitialize() { } + bool DoClickAction( const Property::Map& attributes ); /** - * This method is called from the OnTouchEvent method when the button is down. + * This method is called when the button is a Toggle button and released * Could be reimplemented in subclasses to provide specific behaviour. + * @return bool returns true if state changed. */ - virtual void OnButtonDown(); + virtual bool OnToggleReleased(); /** - * This method is called from the OnTouchEvent method when the button is up. + * This method is called when touch leaves the boundary of the button or several touch points are received. * Could be reimplemented in subclasses to provide specific behaviour. */ - virtual void OnButtonUp(); + virtual void OnTouchPointLeave(); /** - * This method is called from the OnTouchEvent method when the touch point leaves the boundary of the button or - * more than one touch points are received. + * This method is called when the touch is interrupted. * Could be reimplemented in subclasses to provide specific behaviour. */ - virtual void OnTouchPointLeave() { } + virtual void OnTouchPointInterrupted(); /** - * This method is called from the OnTouchEvent method when the touch point is interrupted. - * Could be reimplemented in subclasses to provide specific behaviour. + * This method is called when the \e selected property is changed. */ - virtual void OnTouchPointInterrupted() { } + virtual void OnStateChange( State newState ){} /** - * This method is called when the animation time is set. - * Needs to be reimplemented in subclasses to set the animation time in different buttons. - * @param animationTime The animation time in seconds. + * This method is called when the \e disabled property is changed. */ - virtual void OnAnimationTimeSet( float animationTime ); + virtual void OnDisabled() {} /** - * This method is called when the animation time is requested. - * Needs to be reimplemented in subclases to return the animation time. - * @return The animation time in seconds. + * This method is called when the button is pressed. */ - virtual float OnAnimationTimeRequested() const; + virtual void OnPressed() {} /** - * This method is called when the button is removed from the stage. - * Could be reimplemented in subclasses to provide specific behaviour. + * This method is called when the button is released. */ - virtual void OnButtonStageDisconnection() { } + virtual void OnReleased() {} public: /** + * @copydoc Dali::Toolkit::PushButton::PressedSignal() + */ + Toolkit::Button::ButtonSignalType& PressedSignal(); + + /** + * @copydoc Dali::Toolkit::PushButton::ReleasedSignal() + */ + Toolkit::Button::ButtonSignalType& ReleasedSignal(); + + /** * @copydoc Dali::Toolkit::Button::ClickedSignal() */ - Toolkit::Button::ClickedSignalType& ClickedSignal(); + Toolkit::Button::ButtonSignalType& ClickedSignal(); /** * @copydoc Dali::Toolkit::Button::StateChangedSignal() */ - Toolkit::Button::StateChangedSignalType& StateChangedSignal(); + Toolkit::Button::ButtonSignalType& StateChangedSignal(); /** * Connects a callback function with the object's signals. @@ -176,34 +311,61 @@ public: */ static Property::Value GetProperty( BaseObject* object, Property::Index propertyIndex ); -protected: // From CustomActorImpl +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. + */ + void OnInitialize() override; /** - * @copydoc Dali::CustomActorImpl::OnTouchEvent( const TouchEvent& event ) + * @copydoc Toolkit::Control::OnAccessibilityActivated() */ - virtual bool OnTouchEvent( const TouchEvent& event ); + bool OnAccessibilityActivated() override; -private: // From Control + /** + * @copydoc Toolkit::Control::OnKeyboardEnter() + */ + bool OnKeyboardEnter() override; /** - * @copydoc Toolkit::Control::OnInitialize() + * @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 OnInitialize(); + void OnSceneDisconnection() override; /** - * @copydoc Toolkit::Control::OnControlSizeSet( const Vector3& targetSize ) + * @copydoc Toolkit::Control::OnSceneConnection() */ - virtual void OnControlSizeSet( const Vector3& targetSize ); + void OnSceneConnection( int depth ) override; /** - * Callback received when the button is disconnected from the stage. - * It resets the button status. + * @copydoc Toolkit::Control::GetNaturalSize */ - void OnControlStageDisconnection(); + Vector3 GetNaturalSize() override; + + /** + * @copydoc Toolkit::Control::OnSetResizePolicy + */ + void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) override; + + /** + * @copydoc Toolkit::Control::OnRelayout + */ + 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 TouchEvent& touch ); + + /** * Handler for tap events. * We do not actually do anything when we receive a tap as the button handles tap event through * the touch event system itself as it requires more than just tap handling (e.g. leave events). @@ -213,37 +375,185 @@ private: */ void OnTap(Actor actor, const TapGesture& tap); + /** + * Sets up the autorepeating timer. + * @param[in] delay The delay time in seconds. + */ + void SetUpTimer( float delay ); + + /** + * Button has been pressed + */ + void Pressed(); + + /** + * This method is called the button is down. + */ + void ButtonDown(); + + /** + * This method is called when the button is up. + */ + void ButtonUp(); + + /** + * Slot called when Dali::Timer::SignalTick signal. Resets the autorepeating timer. + */ + bool AutoRepeatingSlot(); + + /** + * Check the requested state is an allowed transition. + * Some states can not be transitioned to from certain states. + * @param[in] requestedState check if can transition to this state + * @return bool true if state change valid + */ + 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 ); + + /** + * 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 ); + + /** + * Get Text Label padding + * @return Padding + */ + Padding GetLabelPadding(); + + /** + * Set Foreground/icon Padding + * @param[in] padding BEGIN END BOTTOM TOP + */ + void SetForegroundPadding( const Padding& padding); + + /** + * Get Foreground padding + * @ return Padding + */ + Padding GetForegroundPadding(); + + /** + * @brief Setup the button components for example foregrounds and background + * @param[in] index the index of the visual to set + * @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 ); + + /** + * @brief Get the Property map for the given Visual + * @param[in] visualIndex visual index of the required 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; + /** + * Returns the animation to be used for transition, creating the animation if needed. + * @return The initialised transition animation. + */ + Dali::Animation GetTransitionAnimation(); + + /** + * @brief Set the position of the label relative to foreground/icon, if both present + * @param[in] labelAlignment given alignment setting + */ + void SetLabelAlignment( Align labelAlignment); + + /** + * @brief Get set alignment of label in relation to foreground/icon + * @return Set alignment value + */ + Align GetLabelAlignment(); + + /** + * Removes the visual from the button (un-staged) + * If the derived button does not want the visual removed then use this virtual function to + * define the required behaviour. + * Can decide to only remove specified visuals via index + */ + 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 ); + + /** + * Adds the required visual to the button. + * @param[in] visualIndex The Property index of the visual required + */ + void SelectRequiredVisual( Property::Index visualIndex ); + // Undefined Button( const Button& ); // Undefined Button& operator = ( const Button& ); -protected: +private: - enum ButtonState - { - ButtonUp, ///< The button is up. - ButtonDown, ///< The button is down. - }; + // 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. + + Timer mAutoRepeatingTimer; - ButtonPainterPtr mPainter; ///< Pointer to a ButtonPainter base class. + 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). - Toolkit::Button::ClickedSignalType mClickedSignal; ///< Signal emitted when the button is clicked. - Toolkit::Button::StateChangedSignalType mStateChangedSignal; ///< Signal emitted when the button's state is changed. + Align mTextLabelAlignment; ///< Position of text label in relation to foreground/icon when both are present. TapGestureDetector mTapDetector; - ButtonState mState; ///< Stores the button state. + 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 mDisabled; ///< Stores the disabled property. + float mInitialAutoRepeatingDelay; ///< Stores the initial autorepeating delay in seconds. + float mNextAutoRepeatingDelay; ///< Stores the next autorepeating delay in seconds. + + 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. + + // Actions + bool mClickActionPerforming; ///< Used to manage signal emissions during action + +protected: + struct AccessibleImpl : public Control::Impl::AccessibleImpl + { + using Control::Impl::AccessibleImpl::AccessibleImpl; + + Dali::Accessibility::States CalculateStates() override; + std::string GetNameRaw() override; + }; }; } // namespace Internal - // Helpers for public-api forwarding methods inline Toolkit::Internal::Button& GetImplementation( Toolkit::Button& button ) @@ -268,5 +578,4 @@ inline const Toolkit::Internal::Button& GetImplementation( const Toolkit::Button } // namespace Dali -#endif // __DALI_TOOLKIT_INTERNAL_BUTTON_H__ - +#endif // DALI_TOOLKIT_INTERNAL_BUTTON_H