Engine.UIAction_ShowKeyboardUI

/**
 * This action tells the online subsystem to show the keyboard input ui
 *
 * Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.
 */
class UIAction_ShowKeyboardUI extends UIAction
	native(inherit);

// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)

/** The text to display at the top of the screen */
var() string TitleText;

/** The text to put in the edit control by default */
var() string DefaultText;

/** The text describing what is being input */
var() string DescriptionText;

/** Whether to validate the text or not */
var() bool bShouldValidate;

/** Whether to use password entry or not */
var() bool bIsPassword;

/** Will hold the resultant value the user input */
var string StringReturnValue;

/** Whether the async call is done or not */
var bool bIsDone;

/**
 * Uses the online subsystem to show the virtual keyboard for input
 */
event ReadKeyboardInput()
{
	local OnlineSubsystem OnlineSub;
	local OnlinePlayerInterface PlayerInt;

	OnlineSub = class'GameEngine'.static.GetOnlineSubsystem();
	if (OnlineSub != None)
	{
		PlayerInt = OnlineSub.PlayerInterface;
		if (PlayerInt != None)
		{
			// Register our callback
			PlayerInt.AddKeyboardInputDoneDelegate(OnKeyboardInputDone);
			// Show the UI
			if (PlayerInt.ShowKeyboardUI(class'UIInteraction'.static.GetPlayerControllerId(PlayerIndex),
				TitleText,DescriptionText,bIsPassword,bShouldValidate,DefaultText) == false)
			{
				// Don't wait if there was an error
				bIsDone = true;
			}
		}
	}
}

/**
 * Reads the results of the user's keyboard input
 *
 * @param bWasSuccessful whether the call succeeded or not
 */
function OnKeyboardInputDone(bool bWasSuccessful)
{
	local OnlineSubsystem OnlineSub;
	local OnlinePlayerInterface PlayerInt;
	local byte bWasCancelled;

	OnlineSub = class'GameEngine'.static.GetOnlineSubsystem();
	if (OnlineSub != None)
	{
		PlayerInt = OnlineSub.PlayerInterface;
		if (PlayerInt != None)
		{
			if (bWasSuccessful == true)
			{
				StringReturnValue = PlayerInt.GetKeyboardInputResults(bWasCancelled);
			}
			else
			{
				LogInternal("Failed to read keyboard input");
			}
		}
	}
	bIsDone = true;
}

defaultproperties
{
   bShouldValidate=True
   bLatentExecution=True
   VariableLinks(0)=(ExpectedType=Class'Engine.SeqVar_String',LinkDesc="Title Text",PropertyName="TitleText")
   VariableLinks(1)=(ExpectedType=Class'Engine.SeqVar_String',LinkDesc="Description Text",PropertyName="DescriptionText")
   VariableLinks(2)=(ExpectedType=Class'Engine.SeqVar_String',LinkDesc="Default Text",PropertyName="DefaultText")
   VariableLinks(3)=(ExpectedType=Class'Engine.SeqVar_Bool',LinkDesc="Needs Validation",PropertyName="bShouldValidate",MinVars=1,MaxVars=255)
   VariableLinks(4)=(ExpectedType=Class'Engine.SeqVar_String',LinkDesc="String Return Value",PropertyName="StringReturnValue",MinVars=1,MaxVars=255)
   ObjName="Get Keyboard Input"
   ObjCategory="Online"
   Name="Default__UIAction_ShowKeyboardUI"
   ObjectArchetype=UIAction'Engine.Default__UIAction'
}