UE3:UTUIScene InputBox (UDK): Difference between revisions

From Unreal Wiki, The Unreal Engine Documentation Site
No edit summary
 
m 1 revision: class descriptions for UDK January update (part 8)
 
Line 1: Line 1:
{{infobox class
{{UE3:UTUIScene_InputBox (UT3)}}
| package = UTGame
| parent1 = UTUIScene_MessageBox
| parent2 = UTUIScene
| parent3 = UIScene
| parent4 = UIScreenObject
| parent5 = UIRoot
| parent6 = Object
}}
{{autogenerated}}
Generic Message Box Scene for UT3
 
==Properties==
====bIsPasswordKeyboard====
'''Type:''' [[bool]]
 
'''[[Variables#Modifiers|Modifiers]]:''' transient
 
Whether or not this is a password input box.
 
====InputEditbox====
'''Type:''' {{cl|UIEditBox}}
 
'''[[Variables#Modifiers|Modifiers]]:''' transient
 
<!-- enter variable description -->
 
===Subobjects===
====WidgetEventComponent====
'''Class:''' {{cl|UIComp_Event|Engine}}
 
'''Inherits from:''' {{tl|WidgetEventComponent|UTUIScene_MessageBox}}
 
''No new values.''
 
==Functions==
===Events===
====PostInitialize====
{{code|event '''PostInitialize''' ()}}
 
'''Overrides:''' {{tl|PostInitialize|UTUIScene_MessageBox}}
 
Sets delegates for the scene.
 
===Other instance functions===
====DisplayAcceptCancelBox====
{{code|function '''DisplayAcceptCancelBox''' ([[string]]&nbsp;'''Message''', optional&nbsp;[[string]]&nbsp;'''Title''', optional&nbsp;[[delegate]]<{{tl|OnSelection|UTUIScene_MessageBox}}>&nbsp;'''InSelectionDelegate''')}}
 
'''Overrides:''' {{tl|DisplayAcceptCancelBox|UTUIScene_MessageBox}}
 
Displays a message box that has an accept and cancel button.
 
'''Parameters:'''
* ''Message'' - Message for the message box. Should be datastore markup.
* ''Title'' - Title for the message box. Should be datastore markup.
* ''InSelectionDelegate'' - Delegate to call when the user dismisses the message box.
 
====GetValue====
{{code|function [[string]]&nbsp;'''GetValue''' ()}}
 
'''Returns:'''
:string Returns the value of the input box.
 
====OnKeyboardInputComplete====
{{code|function '''OnKeyboardInputComplete''' ([[bool]]&nbsp;'''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
 
====OnSubmitText====
{{code|function [[bool]]&nbsp;'''OnSubmitText''' ({{cl|UIEditBox}}&nbsp;'''Sender''', [[int]]&nbsp;'''PlayerIndex''')}}
 
Called when the user presses enter (or any other action bound to UIKey_SubmitText) while this editbox has focus.
 
'''Parameters:'''
* ''Sender'' - the editbox that is submitting text
* ''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.
 
'''Returns:'''
:if TRUE, the editbox will clear the existing value of its textbox.
 
====OptionSelected====
{{code|function '''OptionSelected''' ([[int]]&nbsp;'''OptionIdx''', [[int]]&nbsp;'''PlayerIndex''')}}
 
'''Overrides:''' {{tl|OptionSelected|UTUIScene_MessageBox}}
 
Called when a user has chosen one of the possible options available to them.
Begins hiding the dialog and calls the On
 
'''Parameters:'''
* ''OptionIdx'' - Index of the selection option.
* ''PlayerIndex'' - Index of the player that selected the option.
 
====SetPasswordMode====
{{code|function '''SetPasswordMode''' ([[bool]]&nbsp;'''bIsPasswordInput''')}}
 
Sets the flag indicating whether this input box is for a password.
 
====ShowKeyboard====
{{code|function '''ShowKeyboard''' ()}}
 
Shows the on screen keyboard.

Latest revision as of 06:02, 17 January 2010

UDK Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIScene_MessageBox >> UTUIScene_InputBox
Package:
UTGame
This class in other games:
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.

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

Generic Message Box Scene for UT3

Properties

bIsPasswordKeyboard

Type: bool

Modifiers: transient

Whether or not this is a password input box.

InputEditbox

Type: UIEditBox

Modifiers: transient

Reference to the editbox for the inputbox.

Subobjects

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIScene_MessageBox.WidgetEventComponent

No new values.

Functions

Events

PostInitialize

event PostInitialize ()

Overrides: UTUIScene_MessageBox.PostInitialize

Sets delegates for the scene.

Other instance functions

DisplayAcceptCancelBox

function DisplayAcceptCancelBox (string Message, optional string Title, optional delegate<UTUIScene_MessageBox.OnSelection> InSelectionDelegate)

Overrides: UTUIScene_MessageBox.DisplayAcceptCancelBox

Displays a message box that has an accept and cancel button.

Parameters:

  • Message - Message for the message box. Should be datastore markup.
  • Title - Title for the message box. Should be datastore markup.
  • InSelectionDelegate - Delegate to call when the user dismisses the message box.

GetValue

function string GetValue ()

Returns:

string Returns the value of the input box.

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

OnSubmitText

function bool OnSubmitText (UIEditBox Sender, int PlayerIndex)

Called when the user presses enter (or any other action bound to UIKey_SubmitText) while this editbox has focus.

Parameters:

  • Sender - the editbox that is submitting text
  • 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.

Returns:

if TRUE, the editbox will clear the existing value of its textbox.

OptionSelected

function OptionSelected (int OptionIdx, int PlayerIndex)

Overrides: UTUIScene_MessageBox.OptionSelected

Called when a user has chosen one of the possible options available to them. Begins hiding the dialog and calls the On

Parameters:

  • OptionIdx - Index of the selection option.
  • PlayerIndex - Index of the player that selected the option.

SetPasswordMode

function SetPasswordMode (bool bIsPasswordInput)

Sets the flag indicating whether this input box is for a password.

ShowKeyboard

function ShowKeyboard ()

Shows the on screen keyboard.

Retrieved from "https://wiki.beyondunreal.com/index.php?title=UE3:UTUIScene_InputBox_(UDK)&oldid=42236"