Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.UIToggleButton

Extends
UILabelButton
Modifiers
native ( inherit )

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. 

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- Engine.UIButton
            |   
            +-- Engine.UILabelButton
               |   
               +-- Engine.UIToggleButton
Variables Summary
Data
UIComp_DrawStringCheckedStringRenderComponent
UIDataStoreBindingValueDataSource
Image
UIComp_DrawImageCheckedBackgroundImageComponent
Value
boolbIsChecked
Inherited Variables from Engine.UILabelButton
CaptionDataSource, StringRenderComponent
Inherited Variables from Engine.UIButton
BackgroundImageComponent, ClickedCue

Functions Summary
functionbool ButtonClicked (UIScreenObject Sender, int PlayerIndex ))
functionbool IsChecked ()))
function OnSetBoolValue (UIAction_SetBoolValue Action ))
function SetCaption (string NewText)
function SetValue (bool bShouldBeChecked, optional int PlayerIndex=INDEX_NONE)
Inherited Functions from Engine.UILabelButton
ClearBoundDataStores, GetBoundDataStores, GetCaption, GetDataStoreBinding, NotifyDataStoreValueUpdated, OnGetTextValue, OnSetLabelText, RefreshSubscriberValue, SaveSubscriberValue, SetCaption, SetDataStoreBinding, SetTextAlignment
Inherited Functions from Engine.UIButton
SetImage

Variables Detail

Data

CheckedStringRenderComponent Source code

var(Data) editinline const noclear UIComp_DrawString CheckedStringRenderComponent;
Renders the caption for this button when it is checked

ValueDataSource Source code

var(Data) private UIDataStoreBinding ValueDataSource;
the data store that this togglebutton retrieves its checked/unchecked value from

Image

CheckedBackgroundImageComponent Source code

var(Image) editinline const noclear UIComp_DrawImage CheckedBackgroundImageComponent;
Component for rendering the button background image when checked

Value

bIsChecked Source code

var(Value) private bool bIsChecked;
Controls whether this button is considered checked. When bIsChecked is TRUE, CheckedImage will be rendered over the button background image, using the current style.

Functions Detail

ButtonClicked Source code

function bool ButtonClicked ( UIScreenObject Sender, int PlayerIndex ) )
Default handler for the toggle button's OnClick

IsChecked Source code

final function bool IsChecked ( ) )
Returns TRUE if this button is in the checked state, FALSE if in the

OnSetBoolValue Source code

final function OnSetBoolValue ( UIAction_SetBoolValue Action ) )

SetCaption Source code

native function SetCaption ( string NewText )
Sets the caption for this button.
@param NewText the new caption for the button

SetValue Source code

native final function SetValue ( bool bShouldBeChecked, optional int PlayerIndex=INDEX_NONE )
Changed the checked state of this checkbox and activates a checked event.
@param bShouldBeChecked TRUE to turn the checkbox on, FALSE to turn it off
@param 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.

Defaultproperties 

defaultproperties
{
   ValueDataSource=
   Begin Object Class=UIComp_DrawString Name=CheckedLabelStringRenderer ObjName=CheckedLabelStringRenderer Archetype=UIComp_DrawString'Engine.Default__UIComp_DrawString'
      StyleResolverTag="Caption Style (Checked)"
      StringStyle=(DefaultStyleTag="DefaultToggleButtonStyle")
      Name="CheckedLabelStringRenderer"
      ObjectArchetype=UIComp_DrawString'Engine.Default__UIComp_DrawString'
   End Object
   CheckedStringRenderComponent=CheckedLabelStringRenderer
   Begin Object Class=UIComp_DrawImage Name=CheckedBackgroundImageTemplate ObjName=CheckedBackgroundImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Background Image Style (Checked)"
      ImageStyle=(DefaultStyleTag="DefaultToggleButtonBackgroundStyle")
      Name="CheckedBackgroundImageTemplate"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   CheckedBackgroundImageComponent=CheckedBackgroundImageTemplate
   Begin Object Class=UIComp_DrawString Name=LabelStringRenderer ObjName=LabelStringRenderer Archetype=UIComp_DrawString'Engine.Default__UILabelButton:LabelStringRenderer'
      ObjectArchetype=UIComp_DrawString'Engine.Default__UILabelButton:LabelStringRenderer'
   End Object
   StringRenderComponent=LabelStringRenderer
   Begin Object Class=UIComp_DrawImage Name=BackgroundImageTemplate ObjName=BackgroundImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UILabelButton:BackgroundImageTemplate'
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UILabelButton:BackgroundImageTemplate'
   End Object
   BackgroundImageComponent=BackgroundImageTemplate
   __OnClicked__Delegate=Default__UIToggleButton.ButtonClicked
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UILabelButton:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'Engine.Default__UILabelButton:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UIToggleButton"
   ObjectArchetype=UILabelButton'Engine.Default__UILabelButton'
}
Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:48.218 - Created with UnCodeX