Mostly Harmless

UE2:GUIEditBox (UT2003)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2003 Object >> GUI >> GUIComponent >> GUIButton >> GUIEditBox
Package: 
XInterface
This class in other games:
UE2Runtime, UT2004

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 (c) 2002, Epic Games, Inc. All Rights Reserved

Properties[edit]

Property group 'Menu'[edit]

AllowedCharSet[edit]

Type: string

Only Allow these characters

bConvertSpaces[edit]

Type: bool

Do we want to convert Spaces to "_"

bFloatOnly[edit]

Type: bool

Only Allow Float Numeric entry

bIncludeSign[edit]

Type: bool

Do we need to allow a -/+ sign

bIntOnly[edit]

Type: bool

Only Allow Interger Numeric entry

bMaskText[edit]

Type: bool

Displays the text as a *

BorderOffsets[edit]

Type: int

Array size: 4

How far in from the edit is the edit area

bReadOnly[edit]

Type: bool

Can't actually edit this box

MaxWidth[edit]

Type: int

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

TextCase[edit]

Type: GUI.eTextCase

Controls forcing case, etc

TextStr[edit]

Type: string

Holds the current string

Internal variables[edit]

bAllSelected[edit]

Type: bool


CaretPos[edit]

Type: int

Where is the cursor within the string

DelayTime[edit]

Type: float


FirstVis[edit]

Type: int

Position of the first visible character;

LastCaret[edit]

Type: int


Default value: -1

LastKey[edit]

Type: byte


LastLength[edit]

Type: int

Used to make things quick

Default value: -1

LastSizeX[edit]

Type: int

Used to detect resolution changes

Default values[edit]

Property Value
bCaptureMouse False
OnClickSound CS_Edit
StyleName "SquareButton"
WinHeight 0.06

Functions[edit]

Events[edit]

SetText[edit]

event SetText (string NewText)


Other instance functions[edit]

ConvertIllegal[edit]

function string ConvertIllegal (string inputstr)


DeleteChar[edit]

function DeleteChar ()


GetText[edit]

function string GetText ()


InitComponent[edit]

function InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIButton.InitComponent


InternalOnKeyEvent[edit]

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

Overrides: GUIButton.InternalOnKeyEvent


InternalOnKeyType[edit]

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


LoadINI[edit]

function string LoadINI ()

Overrides: GUIComponent.LoadINI


SaveINI[edit]

function SaveINI (string Value)

Overrides: GUIComponent.SaveINI