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

UTGame.UTUITabPage_Options

Extends
UTTabPage
Modifiers
placeable

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Options tab page, autocreates a set of options widgets using the datasource provided.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- Engine.UIContainer
            |   
            +-- Engine.UITabPage
               |   
               +-- UTGame.UTTabPage
                  |   
                  +-- UTGame.UTUITabPage_Options

Direct Known Subclasses:

UTUITabPage_AudioSettings, UTUITabPage_DynamicOptions, UTUITabPage_GameSettings, UTUITabPage_HUDSettings, UTUITabPage_InputSettings, UTUITabPage_NetworkSettings, UTUITabPage_ServerFilter, UTUITabPage_VideoSettings, UTUITabPage_WeaponSettings

Constants Summary
Inherited Contants from Engine.UITabPage
CAPTION_DATABINDING_INDEX, DESCRIPTION_DATABINDING_INDEX, TOOLTIP_DATABINDING_INDEX

Variables Summary
boolbAllowResetToDefaults
boolbIsPasswordKeyboard
UILabelDescriptionLabel
UIEditBoxKeyboardTargetEditBox
UTUIOptionListOptionList
UIScreenObjectSafeRegionPanel
UTUIDataStore_StringListStringListDataStore
Inherited Variables from UTGame.UTTabPage
bRequiresTick
Inherited Variables from Engine.UITabPage
ButtonCaption, ButtonClass, ButtonToolTip, PageDescription, TabButton

Delegates Summary
delegate OnAcceptOptions (UIScreenObject InObject, int PlayerIndex)
delegate OnOptionChanged (UIScreenObject InObject, name OptionName, int PlayerIndex)
delegate OnOptionFocused (UIScreenObject InObject, UIDataProvider OptionProvider)
Inherited Delegates from UTGame.UTTabPage
OnTick

Functions Summary
function ConditionallyAppendDefaultsButton (UTUIButtonBar ButtonBar))
function ConditionallyAppendKeyboardButton (UTUIButtonBar ButtonBar))
functionbool OnButtonBar_ResetToDefaults (UIScreenObject InButton, int InPlayerIndex))
functionbool OnButtonBar_ShowKeyboard (UIScreenObject InButton, int InPlayerIndex))
function OnKeyboardInputComplete (bool bWasSuccessful))
function OnOptionList_AcceptOptions (UIScreenObject InObject, int PlayerIndex))
function OnOptionList_OptionChanged (UIScreenObject InObject, name OptionName, int PlayerIndex))
function OnOptionList_OptionFocused (UIScreenObject InObject, UIDataProvider OptionProvider))
function OnResetToDefaults ()))
function OnResetToDefaults_Confirm (UTUIScene_MessageBox MessageBox, int SelectionIdx, int PlayerIndex))
function OnShowKeyboard ()))
event PostInitialize ()))
function SetupButtonBar (UTUIButtonBar ButtonBar))
function ShowKeyboard (UIEditBox InTargetEditBox, string Title, optional string Message, optional bool bPassword, optional bool bShouldValidate, optional string DefaultText="", optional int MaxLength))
Inherited Functions from UTGame.UTTabPage
CloseParentScene, GetButtonBar, HandleInputKey, OnChildRepositioned, SetupButtonBar
Inherited Functions from Engine.UITabPage
ActivatePage, AddedToTabControl, CanActivatePage, ClearBoundDataStores, CreateTabButton, GetBoundDataStores, GetDataStoreBinding, GetOwnerTabControl, GetTabButton, IsActivePage, LinkToTabButton, NotifyDataStoreValueUpdated, OnActiveStateChanged, RefreshSubscriberValue, RemovedFromParent, SetDataStoreBinding, SetTabCaption


Variables Detail

bAllowResetToDefaults Source code

var transient bool bAllowResetToDefaults;
Whether or not this option page supports resetting settings to defaults.

bIsPasswordKeyboard Source code

var transient bool bIsPasswordKeyboard;
Whether or not the keyboard being displayed is a password keyboard.

DescriptionLabel Source code

var transient UILabel DescriptionLabel;

KeyboardTargetEditBox Source code

var transient UIEditBox KeyboardTargetEditBox;
Target editbox for the onscreen keyboard, if any.

OptionList Source code

var transient UTUIOptionList OptionList;
Option list present on this tab page.

SafeRegionPanel Source code

var transient UIScreenObject SafeRegionPanel;

StringListDataStore Source code

var transient UTUIDataStore_StringList StringListDataStore;


Delegates Detail

OnAcceptOptions Source code

delegate OnAcceptOptions ( UIScreenObject InObject, int PlayerIndex )

OnOptionChanged Source code

delegate OnOptionChanged ( UIScreenObject InObject, name OptionName, int PlayerIndex )
Called when one of our options changes.

OnOptionFocused Source code

delegate OnOptionFocused ( UIScreenObject InObject, UIDataProvider OptionProvider )
Called when one of our options is focused


Functions Detail

ConditionallyAppendDefaultsButton Source code

function ConditionallyAppendDefaultsButton ( UTUIButtonBar ButtonBar) )
Condtionally appends reset to defaults button if the tab page supports it.

ConditionallyAppendKeyboardButton Source code

function ConditionallyAppendKeyboardButton ( UTUIButtonBar ButtonBar) )
Appends a keyboard button to the buttonbar if we are on PS3 and a editbox option is selected.

OnButtonBar_ResetToDefaults Source code

function bool OnButtonBar_ResetToDefaults ( UIScreenObject InButton, int InPlayerIndex) )
Buttonbar callback for resetting to defaults.

OnButtonBar_ShowKeyboard Source code

function bool OnButtonBar_ShowKeyboard ( UIScreenObject InButton, int InPlayerIndex) )
Buttonbar callback for showing the keyboard.

OnKeyboardInputComplete Source code

function OnKeyboardInputComplete ( bool bWasSuccessful) )
Delegate used when the keyboard input request has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnOptionList_AcceptOptions Source code

function OnOptionList_AcceptOptions ( UIScreenObject InObject, int PlayerIndex) )
Pass through the accept callback.

OnOptionList_OptionChanged Source code

function OnOptionList_OptionChanged ( UIScreenObject InObject, name OptionName, int PlayerIndex) )
Pass through the option callback.

OnOptionList_OptionFocused Source code

function OnOptionList_OptionFocused ( UIScreenObject InObject, UIDataProvider OptionProvider) )
Callback for when an option is focused, by default tries to set the description label for this tab page.

OnResetToDefaults Source code

function OnResetToDefaults ( ) )
Reset to defaults callback, resets all of the profile options in this widget to their default values.

OnResetToDefaults_Confirm Source code

function OnResetToDefaults_Confirm ( UTUIScene_MessageBox MessageBox, int SelectionIdx, int PlayerIndex) )
Callback for the reset to defaults confirmation dialog box.
@param SelectionIdx Selected item
@param PlayerIndex Index of player that performed the action.

OnShowKeyboard Source code

function OnShowKeyboard ( ) )
Shows the onscreen keyboard using the currently selected option as a target.

PostInitialize Source code

event PostInitialize ( ) )
Post initialization event - Setup widget delegates.

SetupButtonBar Source code

function SetupButtonBar ( UTUIButtonBar ButtonBar) )
Callback allowing the tabpage to setup the button bar for the current scene.

ShowKeyboard Source code

function ShowKeyboard ( UIEditBox InTargetEditBox, string Title, optional string Message, optional bool bPassword, optional bool bShouldValidate, optional string DefaultText="", optional int MaxLength) )
Shows the on screen keyboard.


Defaultproperties

defaultproperties
{
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTTabPage:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTTabPage:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UTUITabPage_Options"
   ObjectArchetype=UTTabPage'UTGame.Default__UTTabPage'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:59.784 - Created with UnCodeX