I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX
UE3:UIToggleButton (UT3)
From Unreal Wiki, The Unreal Engine Documentation Site
 |
Object >> UIRoot >> UIScreenObject >> UIObject >> UIButton >> UILabelButton >> UIToggleButton |
Contents |
- Package:
- Engine
- Implemented interfaces:
- UIDataStorePublisher
- This class in other games:
- UDK
| This is an auto-generated page and may need human attention. Please remove this 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.
[edit] Properties
[edit] Property group 'Data'
[edit] CheckedStringRenderComponent
Type: UIComp_DrawString
Modifiers: editinline, const, noclear
Renders the caption for this button when it is checked
Default value: UIComp_DrawString'CheckedLabelStringRenderer'
[edit] ValueDataSource
Type: UIRoot.UIDataStoreBinding
Modifiers: private
the data store that this togglebutton retrieves its checked/unchecked value from
[edit] Property group 'Image'
[edit] CheckedBackgroundImageComponent
Type: UIComp_DrawImage
Modifiers: editinline, const, noclear
Component for rendering the button background image when checked
Default value: UIComp_DrawImage'CheckedBackgroundImageTemplate'
[edit] Property group 'Value'
[edit] bIsChecked
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.
[edit] Default values
| Property | Value |
|---|---|
| OnClicked | ButtonClicked |
[edit] Subobjects
[edit] BackgroundImageTemplate
Class: Engine.UIComp_DrawImage
Inherits from: UILabelButton.BackgroundImageTemplate
No new values.
[edit] CheckedBackgroundImageTemplate
Class: Engine.UIComp_DrawImage
| Property | Value | ||||
|---|---|---|---|---|---|
| ImageStyle |
|
||||
| StyleResolverTag | 'Background Image Style (Checked)' |
[edit] CheckedLabelStringRenderer
Class: Engine.UIComp_DrawString
| Property | Value | ||||
|---|---|---|---|---|---|
| StringStyle |
|
||||
| StyleResolverTag | 'Caption Style (Checked)' |
[edit] LabelStringRenderer
Class: Engine.UIComp_DrawString
Inherits from: UILabelButton.LabelStringRenderer
No new values.
[edit] WidgetEventComponent
Class: Engine.UIComp_Event
Inherits from: UILabelButton.WidgetEventComponent
No new values.
[edit] Functions
[edit] Native functions
[edit] SetCaption
Overrides: UILabelButton.SetCaption
Sets the caption for this button.
Parameters:
- NewText - the new caption for the button
[edit] SetValue
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.
[edit] Other instance functions
[edit] ButtonClicked
Default handler for the toggle button's OnClick
[edit] IsChecked
Returns TRUE if this button is in the checked state, FALSE if in the
