TAgkEditBox Members

The following tables list the members exposed by TAgkEditBox.

	Name	Description
	FID

Public Methods

	Name	Description
	AfterConstruction	TAgkEditBox
	Create	Create an edit box that can be positioned anywhere on screen.
	Destroy	The edit box is automatically destroyed when its owner (such as the scene that uses it) is destroyed. However, you can free it earlier if you want.
	SetBackgroundColor	This is the overview for the SetBackgroundColor method overload.
	SetBorderColor	This is the overview for the SetBorderColor method overload.
	SetCursorColor	This is the overview for the SetCursorColor method overload.
	SetPosition	This is the overview for the SetPosition method overload.
	SetScissor	This is the overview for the SetScissor method overload.
	SetSize	Sets the size of the edit box in world coordinates.
	SetTextColor	This is the overview for the SetTextColor method overload.

Public Properties

	Name	Description
	BackgroundImage	Sets an image to use for the background.
	BorderImage	Sets an image to use for the border.
	BorderSize	Sets the size of the border in world coordinates that will surround the text entry box.
	Changed	Returns True if the edit box has just become inactive, meaning the text may have changed and is not likely to change again in the short term.
	Current	Returns the edit box that currently has focus.
	CursorBlinkTime	Sets the time in seconds between the cursor appearing and disappearing in the edit box.
	CursorWidth	Sets the width in world coordinates of the text input cursor.
	Depth	Sets the depth of the edit box so it may appear behind or in front of other sprites and text objects.
	Enabled	The enabled status of this edit box.
	FixedToScreen	Whether the edit box is fixed to the screen.
	Focused	Whether the edit box has focus and is accepting input.
	FontImage	Sets the font image to use for this edit box. Use nil to return the edit box to its default font.
	Height	Returns the current height of the edit box.
	ID	The internal ID of the object.
	LineCount	Returns the number of lines of text the user has entered into the edit box.
	MaxLength	Sets the maximum number of characters that can be entered in the edit box. Use 0 (default) for unlimited.
	MaxLines	Sets the maximum number of lines that can be entered into this MultiLine edit box. Use 0 (default) for unlimited.
	MultiLine	Whether the edit box will wrap text to a new line when it reaches the edge of the edit box.
	OwnedObjectCount	The number of objects that this object owns.
	OwnedObjects	The objects that this object owns.
	Owner	The owner of this object.
	Pos	Returns the current position of the edit box.
	Text	The text which is currently being displayed in the edit box.
	TextSize	Sets the height in world coordinates of the text in this edit box.
	Visible	Whether the edit box is visible.
	Width	Returns the current width of the edit box.
	X	Returns the current X position of the edit box.
	Y	Returns the current Y position of the edit box.

Made with Doc-O-Matic® Express