UE2:GUIEditBox (UT2004)

Object >> GUI >> GUIComponent >> GUIButton >> GUIEditBox

Package: 

XInterface

This class in other games:

UE2Runtime, UT2003

Class: XInterface.GUIEditBox

GUIEditBox - The basic text edit control. I've merged Normal edit, restricted edit, numeric edit and password edit in to 1 control.

Written by Joe Wilcox Updated by Ron Prestenback (c) 2002, 2003, Epic Games, Inc. All Rights Reserved

Properties

Property group 'GUIEditBox'

AllowedCharSet

Type: string

Only Allow these characters

bAlwaysNotify

Type: bool

If true, send OnChange event when receive SetText(), even if text is identical

bConvertSpaces

Type: bool

Do we want to convert Spaces to "_"

bFloatOnly

Type: bool

Only Allow Float Numeric entry

bIncludeSign

Type: bool

Do we need to allow a -/+ sign

bIntOnly

Type: bool

Only Allow Interger Numeric entry

bMaskText

Type: bool

Displays the text as a *

BorderOffsets

Type: int

Array size: 4

How far in from the edit is the edit area

bReadOnly

Type: bool

Can't actually edit this box

DelayTime

Type: float

MaxWidth

Type: int

Holds the maximum width (in chars) of the string - 0 = No Max

Default value: 768

TextCase

Type: GUI.eTextCase

Controls forcing case, etc

TextStr

Type: string

Holds the current string

Internal variables

bAllSelected

Type: bool

CaretPos

Type: int

Where is the cursor within the string

FirstVis

Type: int

Position of the first visible character;

LastCaret

Type: int

Default value: -1

LastKey

Type: byte

LastLength

Type: int

Used to make things quick

Default value: -1

LastSizeX

Type: int

Used to detect resolution changes

Default values

Property	Value
bCaptureMouse	False
bRequiresStyle	True
OnActivate	InternalActivate
OnClickSound	CS_Edit
OnDeActivate	InternalDeactivate
OnKeyEvent	InternalOnKeyEvent
OnKeyType	InternalOnKeyType
StyleName	"EditBox"
WinHeight	0.06

Functions

Events

InitComponent

event InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIButton.InitComponent

SetText

event SetText (string NewText)

Other instance functions

ConvertIllegal

function string ConvertIllegal (string inputstr)

DeleteChar

function DeleteChar ()

GetText

function string GetText ()

InternalActivate

function InternalActivate ()

InternalDeactivate

function InternalDeactivate ()

InternalOnKeyEvent

function bool InternalOnKeyEvent (out byte Key, out byte State, float delta)

Overrides: GUIButton.InternalOnKeyEvent

InternalOnKeyType

function bool InternalOnKeyType (out byte Key, optional string Unicode)

TextChanged

function TextChanged ()