Always snap to grid
UE3:UIToggleButton (UT3)
 |
Object >> UIRoot >> UIScreenObject >> UIObject >> UIButton >> UILabelButton >> UIToggleButton |
- Package:
- Engine
- Implemented interfaces:
- UIDataStorePublisher
- This class in other games:
- UDK
| This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
This button is identical to UIButton, with the exception that pressing this button toggles its pressed state, rather than only remaining in the pressed state while the mouse/key is depressed.
Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.
Properties[edit]
Property group 'Data'[edit]
CheckedStringRenderComponent[edit]
Type: UIComp_DrawString
Modifiers: editinline, const, noclear
Renders the caption for this button when it is checked
Default value: UIComp_DrawString'CheckedLabelStringRenderer'
ValueDataSource[edit]
Type: UIRoot.UIDataStoreBinding
Modifiers: private
the data store that this togglebutton retrieves its checked/unchecked value from
Property group 'Image'[edit]
CheckedBackgroundImageComponent[edit]
Type: UIComp_DrawImage
Modifiers: editinline, const, noclear
Component for rendering the button background image when checked
Default value: UIComp_DrawImage'CheckedBackgroundImageTemplate'
Property group 'Value'[edit]
bIsChecked[edit]
Type: bool
Modifiers: private
Controls whether this button is considered checked. When bIsChecked is TRUE, CheckedImage will be rendered over the button background image, using the current style.
Default values[edit]
| Property | Value |
|---|---|
| OnClicked | ButtonClicked |
Subobjects[edit]
BackgroundImageTemplate[edit]
Class: Engine.UIComp_DrawImage
Inherits from: UILabelButton.BackgroundImageTemplate
No new values.
CheckedBackgroundImageTemplate[edit]
Class: Engine.UIComp_DrawImage
| Property | Value | ||||
|---|---|---|---|---|---|
| ImageStyle |
|
||||
| StyleResolverTag | 'Background Image Style (Checked)' |
CheckedLabelStringRenderer[edit]
Class: Engine.UIComp_DrawString
| Property | Value | ||||
|---|---|---|---|---|---|
| StringStyle |
|
||||
| StyleResolverTag | 'Caption Style (Checked)' |
LabelStringRenderer[edit]
Class: Engine.UIComp_DrawString
Inherits from: UILabelButton.LabelStringRenderer
No new values.
WidgetEventComponent[edit]
Class: Engine.UIComp_Event
Inherits from: UILabelButton.WidgetEventComponent
No new values.
Functions[edit]
Native functions[edit]
SetCaption[edit]
Overrides: UILabelButton.SetCaption
Sets the caption for this button.
Parameters:
- NewText - the new caption for the button
SetValue[edit]
Changed the checked state of this checkbox and activates a checked event.
Parameters:
- bShouldBeChecked - TRUE to turn the checkbox on, FALSE to turn it off
- PlayerIndex - the index of the player that generated the call to SetValue; used as the PlayerIndex when activating UIEvents; if not specified, the value of GetBestPlayerIndex() is used instead.
Other instance functions[edit]
ButtonClicked[edit]
Default handler for the toggle button's OnClick
IsChecked[edit]
Returns TRUE if this button is in the checked state, FALSE if in the
