Tizen Native API
Classes | Public Types | Public Member Functions | Static Public Member Functions
Dali::Toolkit::PushButton Class Reference
Buttons

A PushButton changes its appearance when is pressed and returns to its original when is released. More...

Inheritance diagram for Dali::Toolkit::PushButton:
Dali::Toolkit::Button Dali::Toolkit::Control Dali::CustomActor Dali::Actor Dali::Handle Dali::BaseHandle

Classes

struct  Property
 An enumeration of properties belonging to the PushButton class. More...

Public Types

enum  PropertyRange
 The start and end property ranges for this control. More...

Public Member Functions

 PushButton ()
 Create an uninitialized PushButton; this can be initialized with PushButton::New().
 PushButton (const PushButton &pushButton)
 Copy constructor.
PushButton & operator= (const PushButton &pushButton)
 Assignment operator.
 ~PushButton ()
 Destructor.
void SetButtonImage (Actor image)
 Sets the unselected image with an Actor.
void SetBackgroundImage (Actor image)
 Sets the background image with an Actor.
void SetSelectedImage (Actor image)
 Sets the selected image with an Actor.
void SetSelectedBackgroundImage (Actor image)
 Sets the selected background image with an Actor.
void SetDisabledBackgroundImage (Actor image)
 Sets the disabled background image with an Actor.
void SetDisabledImage (Actor image)
 Sets the disabled image with an Actor.
void SetDisabledSelectedImage (Actor image)
 Sets the disabled selected image with an Actor.

Static Public Member Functions

static PushButton New ()
 Create an initialized PushButton.
static PushButton DownCast (BaseHandle handle)
 Downcast a handle to PushButton handle.

Detailed Description

A PushButton changes its appearance when is pressed and returns to its original when is released.

By default a PushButton emits a Button::PressedSignal() signal when the button is pressed, a Button::ClickedSignal() signal when it's clicked and a Button::ReleasedSignal() signal when it's released or having pressed it, the touch point leaves the boundary of the button.

See Button for more detail on signals and modifying appearance via properties.

Since :
2.4

Member Enumeration Documentation

enum Dali::Toolkit::PushButton::PropertyRange

The start and end property ranges for this control.

Since :
2.4
Enumerator:
PROPERTY_END_INDEX 

Reserving 1000 property indices.

Since :
2.4

Reimplemented from Dali::Toolkit::Button.

Constructor & Destructor Documentation

Dali::Toolkit::PushButton::PushButton ( )

Create an uninitialized PushButton; this can be initialized with PushButton::New().

Calling member functions with an uninitialized Dali::Object is not allowed.

Since :
2.4
Dali::Toolkit::PushButton::PushButton ( const PushButton &  pushButton)

Copy constructor.

Since :
2.4
Dali::Toolkit::PushButton::~PushButton ( )

Destructor.

This is non-virtual since derived Handle types must not contain data or virtual methods.

Since :
2.4

Member Function Documentation

static PushButton Dali::Toolkit::PushButton::DownCast ( BaseHandle  handle) [static]

Downcast a handle to PushButton handle.

If handle points to a PushButton the downcast produces valid handle. If not the returned handle is left uninitialized.

Since :
2.4
Parameters:
[in]handleHandle to an object
Returns:
A handle to a PushButton or an uninitialized handle

Reimplemented from Dali::Toolkit::Button.

static PushButton Dali::Toolkit::PushButton::New ( ) [static]

Create an initialized PushButton.

Since :
2.4
Returns:
A handle to a newly allocated Dali resource.

Reimplemented from Dali::Toolkit::Control.

PushButton& Dali::Toolkit::PushButton::operator= ( const PushButton &  pushButton)

Assignment operator.

Since :
2.4
void Dali::Toolkit::PushButton::SetBackgroundImage ( Actor  image)

Sets the background image with an Actor.

Since :
2.4
Remarks:
Avoid using this method as it's a legacy code. Instead, use Button::SetBackgroundImage.
Parameters:
[in]imageThe Actor to use
void Dali::Toolkit::PushButton::SetButtonImage ( Actor  image)

Sets the unselected image with an Actor.

Since :
2.4
Remarks:
Avoid using this method as it's a legacy code. Instead, use Button::SetUnselectedImage.
Parameters:
[in]imageThe Actor to use
void Dali::Toolkit::PushButton::SetDisabledBackgroundImage ( Actor  image)

Sets the disabled background image with an Actor.

Since :
2.4
Remarks:
Avoid using this method as it's a legacy code. Instead, use Button::SetDisabledBackgroundImage.
Parameters:
[in]imageThe Actor to use
void Dali::Toolkit::PushButton::SetDisabledImage ( Actor  image)

Sets the disabled image with an Actor.

Since :
2.4
Remarks:
Avoid using this method as it's a legacy code. Instead, use Button::SetDisabledImage.
Parameters:
[in]imageThe Actor to use
void Dali::Toolkit::PushButton::SetDisabledSelectedImage ( Actor  image)

Sets the disabled selected image with an Actor.

Since :
2.4
Remarks:
Avoid using this method as it's a legacy code. Instead, use Button::SetDisabledSelectedImage.
Parameters:
[in]imageThe Actor to use
void Dali::Toolkit::PushButton::SetSelectedBackgroundImage ( Actor  image)

Sets the selected background image with an Actor.

Since :
2.4
Remarks:
Avoid using this method as it's a legacy code. Instead, use Button::SetSelectedBackgroundImage.
Parameters:
[in]imageThe Actor to use
void Dali::Toolkit::PushButton::SetSelectedImage ( Actor  image)

Sets the selected image with an Actor.

Since :
2.4
Remarks:
Avoid using this method as it's a legacy code. Instead, use Button::SetSelectedImage( const std::string& filename ).
Parameters:
[in]imageThe Actor to use