I'm a doctor, not a mechanic

UE2:GUIEditBox (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT2004 Object >> GUI >> GUIComponent >> GUIButton >> GUIEditBox

Contents

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

[edit] Properties

[edit] Property group 'GUIEditBox'

[edit] AllowedCharSet

Type: string

Only Allow these characters

[edit] bAlwaysNotify

Type: bool

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

[edit] bConvertSpaces

Type: bool

Do we want to convert Spaces to "_"

[edit] bFloatOnly

Type: bool

Only Allow Float Numeric entry

[edit] bIncludeSign

Type: bool

Do we need to allow a -/+ sign

[edit] bIntOnly

Type: bool

Only Allow Interger Numeric entry

[edit] bMaskText

Type: bool

Displays the text as a *

[edit] BorderOffsets

Type: int

Array size: 4

How far in from the edit is the edit area

[edit] bReadOnly

Type: bool

Can't actually edit this box

[edit] DelayTime

Type: float


[edit] MaxWidth

Type: int

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

Default value: 768

[edit] TextCase

Type: GUI.eTextCase

Controls forcing case, etc

[edit] TextStr

Type: string

Holds the current string

[edit] Internal variables

[edit] bAllSelected

Type: bool


[edit] CaretPos

Type: int

Where is the cursor within the string

[edit] FirstVis

Type: int

Position of the first visible character;

[edit] LastCaret

Type: int


Default value: -1

[edit] LastKey

Type: byte


[edit] LastLength

Type: int

Used to make things quick

Default value: -1

[edit] LastSizeX

Type: int

Used to detect resolution changes

[edit] Default values

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

[edit] Functions

[edit] Events

[edit] InitComponent

event InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIButton.InitComponent


[edit] SetText

event SetText (string NewText)


[edit] Other instance functions

[edit] ConvertIllegal

function string ConvertIllegal (string inputstr)


[edit] DeleteChar

function DeleteChar ()


[edit] GetText

function string GetText ()


[edit] InternalActivate

function InternalActivate ()


[edit] InternalDeactivate

function InternalDeactivate ()


[edit] InternalOnKeyEvent

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

Overrides: GUIButton.InternalOnKeyEvent


[edit] InternalOnKeyType

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


[edit] TextChanged

function TextChanged ()