-#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.
#include <dali/public-api/animation/animation.h>
// INTERNAL INCLUDES
-#include <dali-toolkit/public-api/controls/buttons/button.h>
+#include <dali-toolkit/devel-api/visual-factory/visual-base.h>
+#include <dali-toolkit/devel-api/controls/buttons/button-devel.h>
#include <dali-toolkit/public-api/controls/control-impl.h>
namespace Dali
{
/**
+ * @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:
/**
+ * 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
+ };
+
+public:
+
+ /**
* @copydoc Dali::Toolkit::Button::SetDisabled
*/
void SetDisabled( bool disabled );
std::string GetLabelText() const;
/**
- * @copydoc Dali::Toolkit::PushButton::SetUnselectedImage
- */
- void SetUnselectedImage( const std::string& filename );
-
- /**
- * @copydoc Dali::Toolkit::PushButton::SetSelectedImage
- */
- void SetSelectedImage( const std::string& filename );
-
- /**
- * @copydoc Dali::Toolkit::PushButton::SetBackgroundImage
- */
- void SetBackgroundImage( const std::string& filename );
-
- /**
- * @copydoc Dali::Toolkit::PushButton::SetSelectedBackgroundImage
- */
- void SetSelectedBackgroundImage( const std::string& filename );
-
- /**
- * @copydoc Dali::Toolkit::PushButton::SetDisabledImage
- */
- void SetDisabledImage( const std::string& filename );
-
- /**
- * @copydoc Dali::Toolkit::CheckBoxButton::SetDisabledSelectedImage
- */
- void SetDisabledSelectedImage( const std::string& filename );
-
- /**
- * @copydoc Dali::Toolkit::PushButton::SetDisabledBackgroundImage
- */
- void SetDisabledBackgroundImage( const std::string& filename );
-
- /**
- * @return The filename used for the button image.
- */
- std::string GetUnselectedImageFilename() const;
-
- /**
- * @return The filename used for the selected image.
- */
- std::string GetSelectedImageFilename() const;
-
- /**
- * @return The filename used for the background image.
- */
- std::string GetBackgroundImageFilename() const;
-
- /**
- * @return The filename used for the selected background image.
- */
- std::string GetSelectedBackgroundImageFilename() const;
-
- /**
- * @return The filename used for the disabled button image.
- */
- std::string GetDisabledImageFilename() const;
-
- /**
- * @return The filename used for the disabled selected image.
- */
- std::string GetDisabledSelectedImageFilename() const;
-
- /**
- * @return The filename used for the disabled background image.
- */
- std::string GetDisabledBackgroundImageFilename() const;
-
- /**
- * @brief Sets the specified properties on the button label.
+ * @brief Produces a Property::Map of Text properties to create a Text Visual
* 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.
*/
- void ModifyLabel( const Property::Map& properties );
+ void MergeLabelProperties( const Property::Map& inMap, Property::Map& outMap );
/**
* Performs actions as requested using the action name.
void SetLabel( Actor label );
/**
- * @deprecated Sets the unselected image with an Actor.
+ * @deprecated Sets the unselected image with an url.
* @param[in] image The Actor to use.
*/
- void SetButtonImage( Actor image );
+ void SetUnselectedImage( const std::string& filename );
/**
- * @deprecated Sets the selected image with an Actor.
- * @param[in] image The Actor to use.
+ * @deprecated Sets the selected image with an url.
+ * @param[in] filename The url of the image to use to use.
*/
- void SetSelectedImage( Actor image );
+ void SetSelectedImage( const std::string& filename );
/**
- * @deprecated Sets the background image with an Actor.
- * @param[in] image The Actor to use.
+ * @deprecated Sets the selected background image with an url.
+ * @param[in] filename The url of the image to use to use.
*/
- void SetBackgroundImage( Actor image );
+ void SetSelectedBackgroundImage( const std::string& filename );
/**
- * @deprecated Sets the selected background image with an Actor.
- * @param[in] image The Actor to use.
+ * @deprecated Sets the background image with an url.
+ * @param[in] filename The url of the image to use to use.
*/
- void SetSelectedBackgroundImage( Actor image );
+ void SetBackgroundImage( const std::string& filename );
/**
- * @deprecated Sets the disabled image with an Actor.
- * @param[in] image The Actor to use.
+ * @deprecated Sets the disabled unselected background image with an url.
+ * @param[in] filename The url of the image to use to use.
*/
- void SetDisabledImage( Actor image );
+ void SetDisabledBackgroundImage( const std::string& filename );
/**
- * @deprecated Sets the disabled selected image with an Actor.
- * @param[in] image The Actor to use.
+ * @deprecated Sets the disabled unselected image with an url.
+ * @param[in] filename The url of the image to use to use.
*/
- void SetDisabledSelectedImage( Actor image );
+ void SetDisabledImage( const std::string& filename );
/**
- * @deprecated Sets the disabled background image with an Actor.
- * @param[in] image The Actor to use.
+ * @deprecated Sets the disabled selected image with an url.
+ * @param[in] filename The url of the image to use to use.
*/
- void SetDisabledBackgroundImage( Actor image );
+ void SetDisabledSelectedImage( const std::string& filename );
+
+ /**
+ * @deprecated Sets the unselected image with an Actor.
+ * @param[in] image The Image to use.
+ */
+ void SetButtonImage( Image image );
+
+ /**
+ * @deprecated Sets the selected image with an Actor.
+ * @param[in] image The Image to use.
+ */
+ void SetSelectedImage( Image image );
+
+ /**
+ * @Gets url of a image visual, used by GetProperty but for deprecated Properties
+ * @param[in] index Visual index of url required
+ * @return filename for the corresponding visual
+ */
+ std::string GetUrlForImageVisual( const Property::Index index ) const;
/**
* @copydoc Dali::Toolkit::Button::GetButtonImage
*/
Actor GetSelectedImage() const;
-protected:
+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
+ };
- enum ButtonState
+ /**
+ * Enum to distinguish the different style-able components of the button
+ */
+ enum Visuals
{
- ButtonUp, ///< The button is up.
- ButtonDown, ///< The button is down.
+ UNSELECTED_FOREGROUND = 0,
+ SELECTED_FOREGROUND,
+ DISABLED_SELECTED_FOREGROUND,
+ DISABLED_UNSELECTED_FOREGROUND,
+ UNSELECTED_BACKGROUND,
+ SELECTED_BACKGROUND,
+ DISABLED_UNSELECTED_BACKGROUND,
+ DISABLED_SELECTED_BACKGROUND,
+ VISUALS_COUNT
};
/**
- * Button paint states.
+ * Enum to list types of visual a state can have.
*/
- enum PaintState
+ enum VisualState
{
- UnselectedState, ///< The button is unselected.
- SelectedState, ///< The button is selected.
- DisabledUnselectedState, ///< The button is disabled and unselected.
- DisabledSelectedState, ///< The button is disabled and selected.
+ BACKGROUND = 0,
+ FOREGROUND,
+ VISUAL_STATE_COUNT
};
+protected:
+
/**
- * Enum to specify which decoration when getting and setting decorations.
+ * 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 DecorationState
+ enum PressState
{
- UNSELECTED_DECORATION = 0,
- SELECTED_DECORATION,
- DECORATION_STATES
+ DEPRESSED, ///< The button is up.
+ UNPRESSED, ///< The button is down.
+ TOGGLE_DEPRESSED, ///< The button has been pressed down and will stay depressed when released.
};
/**
/**
* @return A reference to the unselected button image.
*/
- Actor& GetUnselectedImage();
+ Actor GetUnselectedImage();
/**
* @return A reference to the selected image.
*/
- Actor& GetSelectedImage();
-
- /**
- * @return A reference to the background image.
- */
- Actor& GetBackgroundImage();
-
- /**
- * @return A reference to the selected background image.
- */
- Actor& GetSelectedBackgroundImage();
-
- /**
- * @return A reference to the disabled button image.
- */
- Actor& GetDisabledImage();
-
- /**
- * @return A reference to the disabled selected image.
- */
- Actor& GetDisabledSelectedImage();
-
- /**
- * @return A reference to the disabled background image.
- */
- Actor& GetDisabledBackgroundImage();
+ Actor GetSelectedImage();
private:
bool DoClickAction( const Property::Map& attributes );
/**
- * This method is called when the label is set.
- * @param[in] noPadding Used to bypass padding if the label is to be treated generically.
- */
- virtual void OnLabelSet( bool noPadding ) {}
-
- /**
- * This method is called when the unselected button image is set
- */
- virtual void OnUnselectedImageSet() {}
-
- /**
- * This method is called when the selected image is set
- */
- virtual void OnSelectedImageSet() {}
-
- /**
- * This method is called when the background image is set
- */
- virtual void OnBackgroundImageSet() {}
-
- /**
- * This method is called when the selected background image is set
- */
- virtual void OnSelectedBackgroundImageSet() {}
-
- /**
- * This method is called when the disabled button image is set
- */
- virtual void OnDisabledImageSet() {}
-
- /**
- * This method is called when the disabled selected image is set
- */
- virtual void OnDisabledSelectedImageSet() {}
-
- /**
- * This method is called when the disabled background image is set
- */
- virtual void OnDisabledBackgroundImageSet() {}
-
- /**
- * This method is called the button is down.
- * Could be reimplemented in subclasses to provide specific behaviour.
- */
- virtual void OnButtonDown();
-
- /**
- * This method is called when the button is up.
+ * 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 OnButtonUp();
+ virtual bool OnToggleReleased();
/**
* This method is called when touch leaves the boundary of the button or several touch points are received.
/**
* This method is called when the \e selected property is changed.
*/
- virtual void OnSelected() {}
+ virtual void OnStateChange( State newState ){}
/**
* This method is called when the \e disabled property is changed.
* @copydoc Toolkit::Control::OnStageDisconnection()
* @note If overridden by deriving button classes, then an up-call to Button::OnStageDisconnection MUST be made at the end.
*/
- void OnStageDisconnection();
+ virtual void OnStageDisconnection();
+ /**
+ * @copydoc Toolkit::Control::OnStageConnnection()
+ */
+ virtual void OnStageConnection( int depth );
+
+ /**
+ * @copydoc Toolkit::Control::GetNaturalSize
+ */
+ virtual Vector3 GetNaturalSize();
+
+ /**
+ * @copydoc Toolkit::Control::OnSetResizePolicy
+ */
+ virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
+
+ /**
+ * @copydoc Toolkit::Control::OnRelayout
+ */
+ virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
private:
void SetUpTimer( float delay );
/**
- * Slot called when Dali::Timer::SignalTick signal. Resets the autorepeating timer.
+ * Button has been pressed
*/
- bool AutoRepeatingSlot();
+ void Pressed();
/**
- * Sets the button as selected or unselected.
- * @param[in] selected \e selected property value.
- * @param[in] emitSignal Emit a signal if this value is \e true.
+ * This method is called the button is down.
*/
- void SetSelected( bool selected, bool emitSignal );
+ void ButtonDown();
/**
- * This method is called when the button is pressed.
+ * This method is called when the button is up.
*/
- void Pressed();
+ void ButtonUp();
/**
- * This method is called when the button is released.
+ * Slot called when Dali::Timer::SignalTick signal. Resets the autorepeating timer.
*/
- void Released();
+ bool AutoRepeatingSlot();
/**
- * Used to perform common setup applied to images within button.
- * This will replace the current image with the specifed one.
- * @param[in] actorToModify The image to replace.
- * @param[out] newActor The new image to use.
+ * 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
*/
- void SetupContent( Actor& actorToModify, Actor newActor );
+ bool ValidateState( State requestedState );
/**
- * Gets the unselected content color.
- * @return The currently used unselected color.
+ * Perform the given function on the visuals in the given state. Can be used to add and remove visuals.
+ * @param[in] functionPtr pointer to the function to perform an action on a visual
+ * @param[in] state Visuals in this state will be the target
*/
- const Vector4 GetUnselectedColor() const;
+ void PerformFunctionOnVisualsInState( void(Button::*functionPtr)( Property::Index visualIndex), State state );
/**
- * Sets the color of button in selected or unselected state, if image also supplied this color will be appplied to it.
- * If no visual exists, it is created.
- * @param[in] color The color to use.
- * @param[in] selectedState The state to apply the color to, SelectedState or DisabledUnselectedState.
+ * Changes the button state when an action occurs on it
+ * @param[in] requestedState the state to change to
*/
- void SetColor( const Vector4& color, PaintState selectedState );
+ void ChangeState( State requestedState );
/**
- * Gets the selected content color.
- * @return The currently used selected color.
+ * @brief Get unselected button color
+ * @return color as vector4
*/
- const Vector4 GetSelectedColor() const;
-
-protected:
-
- ButtonState GetState();
- PaintState GetPaintState();
- void SetDecoration( DecorationState state, Actor actor );
- Actor& GetDecoration( DecorationState state );
-
+ const Vector4 GetUnselectedColor() const;
/**
- * Returns the animation to be used for transitioning creating the animation if needed.
- * @return The initialised transition animation.
+ * @brief Get selected button color
+ * @return color as vector4
*/
- Dali::Animation GetTransitionAnimation();
+ const Vector4 GetSelectedColor() const;
/**
- * Prepares the actor to be transitioned in.
- * @param[in] actor The actor that will be transitioned in.
+ * Sets the color of button in selected or unselected state, if image also supplied this color will be appplied to it.
+ * If no visual exists, it is created.
+ * @param[in] color The color to use.
+ * @param[in] visualIndex The Visual to apply the color
*/
- virtual void PrepareForTranstionIn( Actor actor ) {}
+ void SetColor( const Vector4& color, Property::Index visualIndex );
/**
- * Prepares the actor to be transitioned in.
- * @param[in] actor The actor that will be transitioned out.
+ * This method is called when the button is released.
*/
- virtual void PrepareForTranstionOut( Actor actor ) {}
+ void Released();
- /**
- * Transitions the actor in, allowing derived classes to configure
- * the GetTransitionAnimation() animation ready.
- * Button is in charge of calling Dali::Animation::Play and so derived classes
- * only need to add the animation.
- */
- virtual void OnTransitionIn( Actor actor ) {}
+protected:
/**
- * Transitions the actor out, allowing derived classes to configure
- * the GetTransitionAnimation() animation ready.
- * Button is in charge of calling Dali::Animation::Play and so derived classes
- * only need to add the animation.
+ * Set Text Label Padding
+ * @param[in] padding BEGIN END BOTTOM TOP
*/
- virtual void OnTransitionOut( Actor actor ) {}
-
-private:
+ void SetLabelPadding( const Padding& padding );
/**
- * Starts the transition animation.
- * Button::TransitionFinished is called when the animation finishes.
+ * Get Text Label padding
+ * @return Padding
*/
- void StartTransitionAnimation();
+ Padding GetLabelPadding();
/**
- * This method stops all transition animations
+ * Set Foreground/icon Padding
+ * @param[in] padding BEGIN END BOTTOM TOP
*/
- void StopTransitionAnimation();
+ void SetForegroundPadding( const Padding& padding);
/**
- * Called when the transition animation finishes.
+ * Get Foreground padding
+ * @ return Padding
*/
- void TransitionAnimationFinished( Dali::Animation& source );
+ Padding GetForegroundPadding();
/**
- * Resets the Button to the base state for the current paint state.
- * Any additionally inserted images needed for transitions that are
- * no longer needed and the removed.
+ * @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 ResetImageLayers();
+ void CreateVisualsForComponent( Property::Index index ,const Property::Value& value, const float visualDepth );
/**
- * Transitions out the actor
+ * @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
*/
- void TransitionOut( Actor actor );
-
+ bool GetPropertyMapForVisual( Property::Index visualIndex, Property::Map& retreivedMap ) const;
/**
- * Removes the actor from the button and prepares it to be transitioned out
+ * Returns the animation to be used for transition, creating the animation if needed.
+ * @return The initialised transition animation.
*/
- void RemoveButtonImage( Actor& actor );
+ Dali::Animation GetTransitionAnimation();
/**
- * Finds the index of the actor.
- * If the actor doesn't exist, return the last index + 1.
+ * @brief Set the position of the label relative to foreground/icon, if both present
+ * @param[in] labelAlignment given alignment setting
*/
- unsigned int FindChildIndex( Actor& actor );
+ void SetLabelAlignment( Align labelAlignment);
/**
- * Adds an actor to the hierarchy and prepares it to be transitioned.
- * @param[in] actor The actor to add
+ * @brief Get set alignment of label in relation to foreground/icon
+ * @return Set alignment value
*/
- void PrepareAddButtonImage( Actor& actor );
+ Align GetLabelAlignment();
/**
- * Adds an actor to the hierarchy and marks it to be transitioned.
- * @param[in] actor The actor to add
+ * 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
*/
- void TransitionButtonImage( Actor& actor );
+ virtual void OnButtonVisualRemoval( Property::Index visualIndex );
+
+
+private:
/**
- * Adds an actor to the hierarchy.
- * @param[in] actor The actor to add
+ * Removes the visual from the button and prepares it to be transitioned out
+ * @param[in] visualIndex the visual to remove
*/
- void AddButtonImage( Actor& actor );
+ void RemoveVisual( Property::Index visualIndex );
/**
- * (Re)Adds the label (if exists) to the hierarchy (so it is always on top).
+ * Adds the required visual to the button.
+ * @param[in] visualIndex The Property index of the visual required
*/
- void ReAddLabel();
+ void SelectRequiredVisual( Property::Index visualIndex );
// Undefined
Button( const Button& );
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 used to implement the autorepeating property.
+ Timer mAutoRepeatingTimer;
- Actor mLabel; ///< Stores the button label.
+ 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 mDecoration[ DECORATION_STATES ]; ///< Stores the decorations for both selected and unselected states.
+ Align mTextLabelAlignment; ///< Position of text label in relation to foreground/icon when both are present.
- Actor mUnselectedContent; ///< Stores the unselected content.
- Actor mSelectedContent; ///< Stores the selected content.
- Actor mBackgroundContent; ///< Stores the background content.
- Actor mSelectedBackgroundContent; ///< Stores the selected background content.
- Actor mDisabledContent; ///< Stores the disabled content.
- Actor mDisabledSelectedContent; ///< Stores the disabled selected content.
- Actor mDisabledBackgroundContent; ///< Stores the disabled background content.
+ TapGestureDetector mTapDetector;
- Animation mTransitionAnimation; ///< Animation used in the state transitions.
+ Vector4 mUnselectedColor;
+ Vector4 mSelectedColor;
- 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.
- Vector4 mUnselectedColor; ///< Color to use for unselected content.
- Vector4 mSelectedColor; ///< Color to use for selected content.
+ float mInitialAutoRepeatingDelay; ///< Stores the initial autorepeating delay in seconds.
+ float mNextAutoRepeatingDelay; ///< Stores the next autorepeating delay in seconds.
- bool mDisabled; ///< Stores the disabled property.
- bool mAutoRepeating; ///< Stores the autorepeating property.
- bool mTogglableButton; ///< Stores the togglable property.
- bool mSelected; ///< Stores the selected state.
- float mInitialAutoRepeatingDelay; ///< Stores the initial autorepeating delay in seconds.
- float mNextAutoRepeatingDelay; ///< Stores the next autorepeating delay in seconds.
+ float mAnimationTime;
- float mAnimationTime; ///< The animation time.
+ 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;
-
- ButtonState mState; ///< Stores the button state.
- PaintState mPaintState; ///< Stores the paint state.
+ bool mClickActionPerforming; ///< Used to manage signal emissions during action
};
} // namespace Internal
} // namespace Dali
-#endif // __DALI_TOOLKIT_INTERNAL_BUTTON_H__
+#endif // DALI_TOOLKIT_INTERNAL_BUTTON_H