projects
/
platform
/
core
/
uifw
/
dali-toolkit.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Updated Model3dView control to use SetTexture
[platform/core/uifw/dali-toolkit.git]
/
dali-toolkit
/
internal
/
controls
/
buttons
/
button-impl.h
diff --git
a/dali-toolkit/internal/controls/buttons/button-impl.h
b/dali-toolkit/internal/controls/buttons/button-impl.h
index
a8e9c6b
..
71a42fe
100644
(file)
--- a/
dali-toolkit/internal/controls/buttons/button-impl.h
+++ b/
dali-toolkit/internal/controls/buttons/button-impl.h
@@
-58,72
+58,72
@@
protected:
public:
/**
public:
/**
- * @copydoc Dali::Toolkit::Button::SetDisabled
( bool disabled )
+ * @copydoc Dali::Toolkit::Button::SetDisabled
*/
void SetDisabled( bool disabled );
/**
*/
void SetDisabled( bool disabled );
/**
- * @copydoc Dali::Toolkit::Button::IsDisabled
() const
+ * @copydoc Dali::Toolkit::Button::IsDisabled
*/
bool IsDisabled() const;
/**
*/
bool IsDisabled() const;
/**
- * @copydoc Dali::Toolkit::Button::SetAutoRepeating
( bool autoRepeating )
+ * @copydoc Dali::Toolkit::Button::SetAutoRepeating
*/
void SetAutoRepeating( bool autoRepeating );
/**
*/
void SetAutoRepeating( bool autoRepeating );
/**
- * @copydoc Dali::Toolkit::Button::IsAutoRepeating
() const
+ * @copydoc Dali::Toolkit::Button::IsAutoRepeating
*/
bool IsAutoRepeating() const;
/**
*/
bool IsAutoRepeating() const;
/**
- * @copydoc Dali::Toolkit::Button::SetInitialAutoRepeatingDelay
( float initialAutoRepeatingDelay )
+ * @copydoc Dali::Toolkit::Button::SetInitialAutoRepeatingDelay
*/
void SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay );
/**
*/
void SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay );
/**
- * @copydoc Dali::Toolkit::Button::GetInitialAutoRepeatingDelay
() const
+ * @copydoc Dali::Toolkit::Button::GetInitialAutoRepeatingDelay
*/
float GetInitialAutoRepeatingDelay() const;
/**
*/
float GetInitialAutoRepeatingDelay() const;
/**
- * @copydoc Dali::Toolkit::Button::SetNextAutoRepeatingDelay
( float nextAutoRepeatingDelay )
+ * @copydoc Dali::Toolkit::Button::SetNextAutoRepeatingDelay
*/
void SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay );
/**
*/
void SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay );
/**
- * @copydoc Dali::Toolkit::Button::GetNextAutoRepeatingDelay
() const
+ * @copydoc Dali::Toolkit::Button::GetNextAutoRepeatingDelay
*/
float GetNextAutoRepeatingDelay() const;
/**
*/
float GetNextAutoRepeatingDelay() const;
/**
- * @copydoc Dali::Toolkit::Button::SetTogglableButton
( bool togglable )
+ * @copydoc Dali::Toolkit::Button::SetTogglableButton
*/
void SetTogglableButton( bool togglable );
/**
*/
void SetTogglableButton( bool togglable );
/**
- * @copydoc Dali::Toolkit::Button::IsTogglableButton
() const
+ * @copydoc Dali::Toolkit::Button::IsTogglableButton
*/
bool IsTogglableButton() const;
/**
*/
bool IsTogglableButton() const;
/**
- * @copydoc Dali::Toolkit::Button::SetSelected
( bool selected )
+ * @copydoc Dali::Toolkit::Button::SetSelected
*/
void SetSelected( bool selected );
/**
*/
void SetSelected( bool selected );
/**
- * @copydoc Dali::Toolkit::Button::IsSelected
() const
+ * @copydoc Dali::Toolkit::Button::IsSelected
*/
bool IsSelected() const;
/**
*/
bool IsSelected() const;
/**
- * @copydoc Dali::Toolkit::Button::SetAnimationTime
()
+ * @copydoc Dali::Toolkit::Button::SetAnimationTime
*/
void SetAnimationTime( float animationTime );
/**
*/
void SetAnimationTime( float animationTime );
/**
- * @copydoc Dali::Toolkit::Button::GetAnimationTime
()
+ * @copydoc Dali::Toolkit::Button::GetAnimationTime
*/
float GetAnimationTime() const;
*/
float GetAnimationTime() const;
@@
-208,6
+208,14
@@
public:
std::string GetDisabledBackgroundImageFilename() const;
/**
std::string GetDisabledBackgroundImageFilename() const;
/**
+ * @brief Sets the specified properties on the button label.
+ * 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.
+ */
+ void ModifyLabel( const Property::Map& properties );
+
+ /**
* 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.
* 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.
@@
-266,12
+274,12
@@
public: // Deprecated API
void SetDisabledBackgroundImage( Actor image );
/**
void SetDisabledBackgroundImage( Actor image );
/**
- * @copydoc Dali::Toolkit::Button::GetButtonImage
()
+ * @copydoc Dali::Toolkit::Button::GetButtonImage
*/
Actor GetButtonImage() const;
/**
*/
Actor GetButtonImage() const;
/**
- * @copydoc Dali::Toolkit::Button::GetSelectedImage
()
+ * @copydoc Dali::Toolkit::Button::GetSelectedImage
*/
Actor GetSelectedImage() const;
*/
Actor GetSelectedImage() const;
@@
-327,15
+335,10
@@
private:
bool DoClickAction( const Property::Map& attributes );
/**
bool DoClickAction( const Property::Map& attributes );
/**
- * This method is called after the button initialization.
- * Could be reimplemented in subclasses to provide specific behaviour.
- */
- virtual void OnButtonInitialize() { }
-
- /**
* This method is called when the label is set.
* 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() {}
+ virtual void OnLabelSet(
bool noPadding
) {}
/**
* This method is called when the unselected button image is set
/**
* This method is called when the unselected button image is set
@@
-373,37
+376,30
@@
private:
virtual void OnDisabledBackgroundImageSet() {}
/**
virtual void OnDisabledBackgroundImageSet() {}
/**
- * This method is called
from the OnTouchEvent method when
the button is down.
+ * This method is called the button is down.
* Could be reimplemented in subclasses to provide specific behaviour.
*/
virtual void OnButtonDown();
/**
* Could be reimplemented in subclasses to provide specific behaviour.
*/
virtual void OnButtonDown();
/**
- * This method is called
from the OnTouchEvent method
when the button is up.
+ * This method is called when the button is up.
* Could be reimplemented in subclasses to provide specific behaviour.
*/
virtual void OnButtonUp();
/**
* Could be reimplemented in subclasses to provide specific behaviour.
*/
virtual void OnButtonUp();
/**
- * 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 touch leaves the boundary of the button or several touch points are received.
* Could be reimplemented in subclasses to provide specific behaviour.
*/
virtual void OnTouchPointLeave();
/**
* Could be reimplemented in subclasses to provide specific behaviour.
*/
virtual void OnTouchPointLeave();
/**
- * This method is called
from the OnTouchEvent method when the touch point
is interrupted.
+ * This method is called
when the touch
is interrupted.
* Could be reimplemented in subclasses to provide specific behaviour.
*/
virtual void OnTouchPointInterrupted();
/**
* Could be reimplemented in subclasses to provide specific behaviour.
*/
virtual void OnTouchPointInterrupted();
/**
- * This method is called when the button is removed from the stage.
- * Could be reimplemented in subclasses to provide specific behaviour.
- */
- virtual void OnButtonStageDisconnection();
-
- /**
* This method is called when the \e selected property is changed.
*/
virtual void OnSelected() {}
* This method is called when the \e selected property is changed.
*/
virtual void OnSelected() {}
@@
-474,17
+470,11
@@
public:
*/
static Property::Value GetProperty( BaseObject* object, Property::Index propertyIndex );
*/
static Property::Value GetProperty( BaseObject* object, Property::Index propertyIndex );
-protected: // From CustomActorImpl
-
- /**
- * @copydoc Dali::CustomActorImpl::OnTouchEvent( const TouchEvent& event )
- */
- virtual bool OnTouchEvent( const TouchEvent& event );
-
-private: // From Control
+protected: // From Control
/**
* @copydoc Toolkit::Control::OnInitialize()
/**
* @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();
*/
virtual void OnInitialize();
@@
-499,14
+489,22
@@
private: // From Control
virtual bool OnKeyboardEnter();
/**
virtual bool OnKeyboardEnter();
/**
- *
Callback received when the button is disconnected from the stage.
- *
It resets the button status
.
+ *
@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 On
Control
StageDisconnection();
+ void OnStageDisconnection();
private:
/**
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 );
+
+ /**
* 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).
* 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).