Gah - a solution with more questions. – EntropicLqd

UE3:UTUITabPage_Options (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> UIRoot >> UIScreenObject >> UIObject >> UIContainer >> UITabPage >> UTTabPage >> UTUITabPage_Options
Package: 
UTGame
Implemented interfaces
UIDataStoreSubscriber
Direct subclasses:
UTUITabPage_HUDSettings, UTUITabPage_NetworkSettings, UTUITabPage_AudioSettings, UTUITabPage_GameSettings, UTUITabPage_InputSettings, UTUITabPage_ServerFilter, UTUITabPage_VideoSettings, UTUITabPage_WeaponSettings, UTUITabPage_DynamicOptions
This class in other games:
UDK

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

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

Properties[edit]

bAllowResetToDefaults[edit]

Type: bool

Modifiers: transient

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

bIsPasswordKeyboard[edit]

Type: bool

Modifiers: transient

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

DescriptionLabel[edit]

Type: UILabel

Modifiers: transient


KeyboardTargetEditBox[edit]

Type: UIEditBox

Modifiers: transient

Target editbox for the onscreen keyboard, if any.

OptionList[edit]

Type: UTUIOptionList

Modifiers: transient

Option list present on this tab page.

SafeRegionPanel[edit]

Type: UIScreenObject

Modifiers: transient


StringListDataStore[edit]

Type: UTUIDataStore_StringList

Modifiers: transient


Subobjects[edit]

WidgetEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTTabPage.WidgetEventComponent

No new values.

Delegates[edit]

OnAcceptOptions[edit]

delegate OnAcceptOptions (UIScreenObject InObject, int PlayerIndex)


OnOptionChanged[edit]

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

Called when one of our options changes.

OnOptionFocused[edit]

delegate OnOptionFocused (UIScreenObject InObject, UIDataProvider OptionProvider)

Called when one of our options is focused

Functions[edit]

Events[edit]

PostInitialize[edit]

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Post initialization event - Setup widget delegates.

Other instance functions[edit]

ConditionallyAppendDefaultsButton[edit]

function ConditionallyAppendDefaultsButton (UTUIButtonBar ButtonBar)

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

ConditionallyAppendKeyboardButton[edit]

function ConditionallyAppendKeyboardButton (UTUIButtonBar ButtonBar)

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

OnButtonBar_ResetToDefaults[edit]

function bool OnButtonBar_ResetToDefaults (UIScreenObject InButton, int InPlayerIndex)

Buttonbar callback for resetting to defaults.

OnButtonBar_ShowKeyboard[edit]

function bool OnButtonBar_ShowKeyboard (UIScreenObject InButton, int InPlayerIndex)

Buttonbar callback for showing the keyboard.

OnKeyboardInputComplete[edit]

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[edit]

function OnOptionList_AcceptOptions (UIScreenObject InObject, int PlayerIndex)

Pass through the accept callback.

OnOptionList_OptionChanged[edit]

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

Pass through the option callback.

OnOptionList_OptionFocused[edit]

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[edit]

function OnResetToDefaults ()

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

OnResetToDefaults_Confirm[edit]

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[edit]

function OnShowKeyboard ()

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

SetupButtonBar[edit]

function SetupButtonBar (UTUIButtonBar ButtonBar)

Overrides: UTTabPage.SetupButtonBar

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

ShowKeyboard[edit]

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.