Button Class Reference

Button widget. More...

Inheritance diagram for Button:
Widget

List of all members.

Public Member Functions

 Button ()
 Constructor.

Protected Member Functions

override void OnPressStateChanged (PressStateChangedEventArgs e)
 Called when the press status changes.
override void DisposeSelf ()
 Frees used resources.
override void OnUpdate (float elapsedTime)
 Update processing.

Properties

override float Width [get, set]
 Obtains and sets the width.
override float Height [get, set]
 Obtains and sets the height.
string Text [get, set]
 Obtains and sets the character string.
ButtonStyle Style [get, set]
 Obtains and sets the button type.
ImageAsset IconImage [get, set]
 Obtains and sets the icon image.
UIFont TextFont [get, set]
 Obtains and sets the font of the character string.
TextTrimming TextTrimming [get, set]
 Obtains and sets the cropping method of the character string.
UIColor TextColor [get, set]
 Obtains and sets the color of the character string.
TextShadowSettings TextShadow [get, set]
 Obtains and sets the shadow of the character string.
HorizontalAlignment HorizontalAlignment [get, set]
 Obtains and sets the horizontal alignment for character strings or icon images.
VerticalAlignment VerticalAlignment [get, set]
 Obtains and sets the vertical alignment for character strings or icon images.
CustomButtonImageSettings CustomImage [get, set]
 Obtains and sets custom images.
UIColor BackgroundFilterColor [get, set]
 Obtains and sets the color that multiplies in the background image.

Events

EventHandler< TouchEventArgsButtonAction
 Handler called when a button action is fired.

Detailed Description

Button widget.

An icon image and a single line of text can be set. The shape can be customized.


Member Function Documentation

override void OnPressStateChanged ( PressStateChangedEventArgs  e) [protected, virtual]

Called when the press status changes.

Parameters:
eEvent argument

Reimplemented from Widget.

override void OnUpdate ( float  elapsedTime) [protected, virtual]

Update processing.

Parameters:
elapsedTimeElapsed time from previous update (ms)

Reimplemented from Widget.


Property Documentation

ImageAsset IconImage [get, set]

Obtains and sets the icon image.

Displays the set character string when null is set.