UE3:UIButton (UDK)

Object >> UIRoot >> UIScreenObject >> UIObject >> UIButton

Package: 

Engine

Direct subclasses:

UICheckbox, UILabelButton, UINumericEditBoxButton, UIOptionListButton, UIScrollbarButton, UTUIPressButton

This class in other games:

UT3

Base class for all widget types which act as buttons. Buttons trigger events when they are clicked on or activated using the keyboard. This basic button contains only a background image.

Properties

Property group 'Components'

BackgroundImageComponent

Type: UIComp_DrawImage

Modifiers: editinline, const, noclear

Component for rendering the button background image

Default value: UIComp_DrawImage'BackgroundImageTemplate'

Property group 'Sound'

ClickedCue

Type: name

this sound is played when this widget is clicked

Default value: 'Clicked'

Default values

Property	Value
bSupportsPrimaryStyle	False
DefaultStates[2]	Class'Engine.UIState_Focused'
DefaultStates[3]	Class'Engine.UIState_Active'
DefaultStates[4]	Class'Engine.UIState_Pressed'
PrimaryStyle	Member Value DefaultStyleTag 'ButtonBackground' RequiredStyleClass Class'Engine.UIStyle_Image'

Subobjects

BackgroundImageTemplate

Class: Engine.UIComp_DrawImage

Property	Value
ImageStyle	Member Value DefaultStyleTag 'ButtonBackground'
StyleResolverTag	'Background Image Style'

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UIObject.WidgetEventComponent

Property	Value
DefaultEvents[1]	Member Value EventState Class'Engine.UIState_Focused' EventTemplate UIEvent_OnClick'Engine.Default__UIButton:ButtonClickHandler'

Instance functions

SetImage

final function SetImage (Surface NewImage)

Changes the background image for this button, creating the wrapper UITexture if necessary.

Parameters:

• NewImage - the new surface to use for this UIImage