Always snap to grid

UE3:UTUITabPage_Options (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UDK Object >> UIRoot >> UIScreenObject >> UIObject >> UIContainer >> UITabPage >> UTTabPage >> UTUITabPage_Options

Contents
Package: 
UTGame
Implemented interfaces: 
UIDataStoreSubscriber
Direct subclasses:
UTUITabPage_GameSettings, UTUITabPage_ServerFilter
This class in other games:
UT3
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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

[edit] Properties

[edit] bAllowResetToDefaults

Type: bool

Modifiers: transient

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

[edit] bIsPasswordKeyboard

Type: bool

Modifiers: transient

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

[edit] DescriptionLabel

Type: UILabel

Modifiers: transient


[edit] KeyboardTargetEditBox

Type: UIEditBox

Modifiers: transient

Target editbox for the onscreen keyboard, if any.

[edit] OptionList

Type: UTUIOptionList

Modifiers: transient

Option list present on this tab page.

[edit] StringListDataStore

Type: UTUIDataStore_StringList

Modifiers: transient


[edit] Subobjects

[edit] WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UTTabPage.WidgetEventComponent

No new values.

[edit] Delegates

[edit] OnAcceptOptions

delegate OnAcceptOptions (UIScreenObject InObject, int PlayerIndex)


[edit] OnOptionChanged

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

Called when one of our options changes.

[edit] OnOptionFocused

delegate OnOptionFocused (UIScreenObject InObject, UIDataProvider OptionProvider)

Called when one of our options is focused

[edit] Functions

[edit] Events

[edit] PostInitialize

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Post initialization event - Setup widget delegates.

[edit] Other instance functions

[edit] ConditionallyAppendDefaultsButton

function ConditionallyAppendDefaultsButton (UTUIButtonBar ButtonBar)

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

[edit] ConditionallyAppendKeyboardButton

function ConditionallyAppendKeyboardButton (UTUIButtonBar ButtonBar)

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

[edit] OnButtonBar_ResetToDefaults

function bool OnButtonBar_ResetToDefaults (UIScreenObject InButton, int InPlayerIndex)

Buttonbar callback for resetting to defaults.

[edit] OnButtonBar_ShowKeyboard

function bool OnButtonBar_ShowKeyboard (UIScreenObject InButton, int InPlayerIndex)

Buttonbar callback for showing the keyboard.

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

[edit] OnOptionList_AcceptOptions

function OnOptionList_AcceptOptions (UIScreenObject InObject, int PlayerIndex)

Pass through the accept callback.

[edit] OnOptionList_OptionChanged

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

Pass through the option callback.

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

[edit] OnResetToDefaults

function OnResetToDefaults ()

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

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

[edit] OnShowKeyboard

function OnShowKeyboard ()

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

[edit] SetupButtonBar

function SetupButtonBar (UTUIButtonBar ButtonBar)

Overrides: UTTabPage.SetupButtonBar

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

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

Retrieved from "http://wiki.beyondunreal.com/UE3:UTUITabPage_Options_(UDK)"
Personal tools