UTGame.UTUIScene_InputBox

Extends

UTUIScene_MessageBox

Modifiers

native ( UI )

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Generic Message Box Scene for UT3

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIScene
         |   
         +-- UTGame.UTUIScene
            |   
            +-- UTGame.UTUIScene_MessageBox
               |   
               +-- UTGame.UTUIScene_InputBox

Functions Summary
		DisplayAcceptCancelBox (string Message, optional string Title="", optional delegate<OnSelection> InSelectionDelegate))
	string	GetValue ()))
		OnKeyboardInputComplete (bool bWasSuccessful))
	bool	OnSubmitText (UIEditBox Sender, int PlayerIndex ))
		OptionSelected (int OptionIdx, int PlayerIndex))
		PostInitialize ()))
		SetPasswordMode (bool bIsPasswordInput ))
		ShowKeyboard ()))

bIsPasswordKeyboard Source code

Whether or not this is a password input box.

InputEditbox Source code

Reference to the editbox for the inputbox.

DisplayAcceptCancelBox Source code

Displays a message box that has an accept and cancel button.
@param Message Message for the message box. Should be datastore markup.
@param Title Title for the message box. Should be datastore markup.
@param InSelectionDelegate Delegate to call when the user dismisses the message box.

GetValue Source code

@return string Returns the value of the input box.

OnKeyboardInputComplete Source code

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

OnSubmitText Source code

Called when the user presses enter (or any other action bound to UIKey_SubmitText) while this editbox has focus.
@param Sender the editbox that is submitting text
@param 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.
@return if TRUE, the editbox will clear the existing value of its textbox.

OptionSelected Source code

Called when a user has chosen one of the possible options available to them. Begins hiding the dialog and calls the On
@param OptionIdx Index of the selection option.
@param PlayerIndex Index of the player that selected the option.

PostInitialize Source code

Sets delegates for the scene.

SetPasswordMode Source code

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

ShowKeyboard Source code

Shows the on screen keyboard.

defaultproperties
{
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIScene_MessageBox:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUIScene_MessageBox:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UTUIScene_InputBox"
   ObjectArchetype=UTUIScene_MessageBox'UTGame.Default__UTUIScene_MessageBox'
}