Tizen Native API  4.0
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
 Enumeration for the instance of properties belonging to the PushButton class. More...

Public Types

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

Public Member Functions

 PushButton ()
 Creates 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) DALI_DEPRECATED_API
 Sets the unselected image with an Actor.
void SetBackgroundImage (Actor image) DALI_DEPRECATED_API
 Sets the background image with an Actor.
void SetSelectedImage (Actor image) DALI_DEPRECATED_API
 Sets the selected image with an Actor.
void SetSelectedBackgroundImage (Actor image) DALI_DEPRECATED_API
 Sets the selected background image with an Actor.
void SetDisabledBackgroundImage (Actor image) DALI_DEPRECATED_API
 Sets the disabled background image with an Actor.
void SetDisabledImage (Actor image) DALI_DEPRECATED_API
 Sets the disabled image with an Actor.
void SetDisabledSelectedImage (Actor image) DALI_DEPRECATED_API
 Sets the disabled selected image with an Actor.

Static Public Member Functions

static PushButton New ()
 Creates an initialized PushButton.
static PushButton DownCast (BaseHandle handle)
 Downcasts 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.

Usage example: -

 // in Creating a DALi Application
 void HelloWorldExample::Create( Application& application )
 {
   PushButton button = PushButton::New();
   button.SetParentOrigin( ParentOrigin::CENTER );
   button.SetProperty( Button::Property::LABEL, "Press" );
   Stage::GetCurrent().Add( button );

   // Connect to button signals emitted by the button
   button.ClickedSignal().Connect( this, &HelloWorldExample::OnButtonClicked );
   button.PressedSignal().Connect( this, &HelloWorldExample::OnButtonPressed );
   button.ReleasedSignal().Connect( this, &HelloWorldExample::OnButtonReleased );
 }

 bool HelloWorldExample::OnButtonClicked( Button button )
 {
   // Do something when the button is clicked
   return true;
 }

 bool HelloWorldExample::OnButtonPressed( Button button )
 {
   // Do something when the button is pressed
   return true;
 }

 bool HelloWorldExample::OnButtonReleased( Button button )
 {
   // Do something when the button is released
   return true;
 }

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

Since:
3.0, DALi version 1.0.0

Member Enumeration Documentation

enum Dali::Toolkit::PushButton::PropertyRange

Enumeration for the start and end property ranges for this control.

Since:
3.0, DALi version 1.0.0
Enumerator:
PROPERTY_START_INDEX 
Since:
3.0, DALi version 1.0.0
PROPERTY_END_INDEX 

Reserving 1000 property indices.

Since:
3.0, DALi version 1.0.0

Reimplemented from Dali::Toolkit::Button.

Constructor & Destructor Documentation

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

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

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

Since:
3.0, DALi version 1.0.0
Dali::Toolkit::PushButton::PushButton ( const PushButton &  pushButton)

Copy constructor.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]pushButtonHandle to an object
Dali::Toolkit::PushButton::~PushButton ( )

Destructor.

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

Since:
3.0, DALi version 1.0.0

Member Function Documentation

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

Downcasts 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:
3.0, DALi version 1.0.0
Parameters:
[in]handleHandle to an object
Returns:
handle to a PushButton or an uninitialized handle

Reimplemented from Dali::Toolkit::Button.

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

Creates an initialized PushButton.

Since:
3.0, DALi version 1.0.0
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:
3.0, DALi version 1.0.0
Parameters:
[in]pushButtonHandle to an object
Returns:
A reference to this
void Dali::Toolkit::PushButton::SetBackgroundImage ( Actor  image)

Sets the background image with an Actor.

Deprecated:
Deprecated since 3.0, DALi version 1.0.50. Instead, use Button::SetBackgroundImage.
Since:
3.0, DALi version 1.0.0
Parameters:
[in]imageThe Actor to use
void Dali::Toolkit::PushButton::SetButtonImage ( Actor  image)

Sets the unselected image with an Actor.

Deprecated:
Deprecated since 3.0, DALi version 1.0.50. Instead, use Button::SetUnselectedImage.
Since:
3.0, DALi version 1.0.0
Parameters:
[in]imageThe Actor to use
void Dali::Toolkit::PushButton::SetDisabledBackgroundImage ( Actor  image)

Sets the disabled background image with an Actor.

Deprecated:
Deprecated since 3.0, DALi version 1.0.50. Instead, use Button::SetDisabledBackgroundImage.
Since:
3.0, DALi version 1.0.0
Parameters:
[in]imageThe Actor to use
void Dali::Toolkit::PushButton::SetDisabledImage ( Actor  image)

Sets the disabled image with an Actor.

Deprecated:
Deprecated since 3.0, DALi version 1.0.50. Instead, use Button::SetDisabledImage.
Since:
3.0, DALi version 1.0.0
Parameters:
[in]imageThe Actor to use
void Dali::Toolkit::PushButton::SetDisabledSelectedImage ( Actor  image)

Sets the disabled selected image with an Actor.

Deprecated:
Deprecated since 3.0, DALi version 1.0.50. Instead, use Button::SetDisabledSelectedImage.
Since:
3.0, DALi version 1.0.0
Parameters:
[in]imageThe Actor to use
void Dali::Toolkit::PushButton::SetSelectedBackgroundImage ( Actor  image)

Sets the selected background image with an Actor.

Deprecated:
Deprecated since 3.0, DALi version 1.0.50. Instead, use Button::SetSelectedBackgroundImage.
Since:
3.0, DALi version 1.0.0
Parameters:
[in]imageThe Actor to use
void Dali::Toolkit::PushButton::SetSelectedImage ( Actor  image)

Sets the selected image with an Actor.

Deprecated:
Deprecated since 3.0, DALi version 1.0.50. Instead, use Button::SetSelectedImage( const std::string& filename ).
Since:
3.0, DALi version 1.0.0
Parameters:
[in]imageThe Actor to use