UE3:UTUITabPage_Options (UDK)

Object >> UIRoot >> UIScreenObject >> UIObject >> UIContainer >> UITabPage >> UTTabPage >> UTUITabPage_Options

Package: 

UTGame

Implemented interfaces: 

UIDataStoreSubscriber

Direct subclasses:

UTUITabPage_GameSettings, UTUITabPage_ServerFilter

This class in other games:

UT3

Options tab page, autocreates a set of options widgets using the datasource provided.

Properties

bAllowResetToDefaults

Type: bool

Modifiers: transient

Whether or not this option page supports resetting settings to defaults.

bIsPasswordKeyboard

Type: bool

Modifiers: transient

Whether or not the keyboard being displayed is a password keyboard.

DescriptionLabel

Type: UILabel

Modifiers: transient

KeyboardTargetEditBox

Type: UIEditBox

Modifiers: transient

Target editbox for the onscreen keyboard, if any.

OptionList

Type: UTUIOptionList

Modifiers: transient

Option list present on this tab page.

StringListDataStore

Type: UTUIDataStore_StringList

Modifiers: transient

Subobjects

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UTTabPage.WidgetEventComponent

No new values.

Delegates

OnAcceptOptions

delegate OnAcceptOptions (UIScreenObject InObject, int PlayerIndex)

OnOptionChanged

delegate OnOptionChanged (UIScreenObject InObject, name OptionName, int PlayerIndex)

Called when one of our options changes.

OnOptionFocused

delegate OnOptionFocused (UIScreenObject InObject, UIDataProvider OptionProvider)

Called when one of our options is focused

Functions

Events

PostInitialize

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Post initialization event - Setup widget delegates.

Other instance functions

ConditionallyAppendDefaultsButton

function ConditionallyAppendDefaultsButton (UTUIButtonBar ButtonBar)

Condtionally appends reset to defaults button if the tab page supports it.

ConditionallyAppendKeyboardButton

function ConditionallyAppendKeyboardButton (UTUIButtonBar ButtonBar)

Appends a keyboard button to the buttonbar if we are on PS3 and a editbox option is selected.

OnButtonBar_ResetToDefaults

function bool OnButtonBar_ResetToDefaults (UIScreenObject InButton, int InPlayerIndex)

Buttonbar callback for resetting to defaults.

OnButtonBar_ShowKeyboard

function bool OnButtonBar_ShowKeyboard (UIScreenObject InButton, int InPlayerIndex)

Buttonbar callback for showing the keyboard.

OnKeyboardInputComplete

function OnKeyboardInputComplete (bool bWasSuccessful)

Delegate used when the keyboard input request has completed

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

OnOptionList_AcceptOptions

function OnOptionList_AcceptOptions (UIScreenObject InObject, int PlayerIndex)

Pass through the accept callback.

OnOptionList_OptionChanged

function OnOptionList_OptionChanged (UIScreenObject InObject, name OptionName, int PlayerIndex)

Pass through the option callback.

OnOptionList_OptionFocused

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

function OnResetToDefaults ()

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

OnResetToDefaults_Confirm

function OnResetToDefaults_Confirm (UTUIScene_MessageBox MessageBox, int SelectionIdx, int PlayerIndex)

Callback for the reset to defaults confirmation dialog box.

Parameters:

• SelectionIdx - Selected item
• PlayerIndex - Index of player that performed the action.

OnShowKeyboard

function OnShowKeyboard ()

Shows the onscreen keyboard using the currently selected option as a target.

SetupButtonBar

function SetupButtonBar (UTUIButtonBar ButtonBar)

Overrides: UTTabPage.SetupButtonBar

Callback allowing the tabpage to setup the button bar for the current scene.

ShowKeyboard

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.