GuiMLTextEditCtrl Class Reference

#include <guiMLTextEditCtrl.h>

Inheritance diagram for GuiMLTextEditCtrl:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 GuiMLTextEditCtrl ()
 ~GuiMLTextEditCtrl ()
bool onWake ()
 Called when this object is asked to wake up returns true if it's actually awake at the end.
bool resize (const Point2I &newPosition, const Point2I &newExtent)
 Changes the size and/or position of this control.
 DECLARE_CONOBJECT (GuiMLTextEditCtrl)

Static Public Member Functions

static void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.

Protected Member Functions

bool onKeyDown (const GuiEvent &event)
 Happens when a key is depressed.
void handleMoveKeys (const GuiEvent &)
void handleDeleteKeys (const GuiEvent &)
void onRender (Point2I offset, const RectI &updateRect)
 Called when this control is to render itself.

Protected Attributes

StringTableEntry mEscapeCommand

Private Types

typedef GuiMLTextCtrl Parent

Member Typedef Documentation

Reimplemented from GuiMLTextCtrl.


Constructor & Destructor Documentation

GuiMLTextEditCtrl::GuiMLTextEditCtrl (  ) 

GuiMLTextEditCtrl::~GuiMLTextEditCtrl (  ) 


Member Function Documentation

bool GuiMLTextEditCtrl::onKeyDown ( const GuiEvent event  )  [protected, virtual]

Happens when a key is depressed.

Parameters:
event Event descriptor (which contains the key)

Reimplemented from GuiMLTextCtrl.

void GuiMLTextEditCtrl::handleMoveKeys ( const GuiEvent  )  [protected]

void GuiMLTextEditCtrl::handleDeleteKeys ( const GuiEvent  )  [protected]

void GuiMLTextEditCtrl::onRender ( Point2I  offset,
const RectI updateRect 
) [protected, virtual]

Called when this control is to render itself.

Parameters:
offset The location this control is to begin rendering
updateRect The screen area this control has drawing access to

Reimplemented from GuiMLTextCtrl.

bool GuiMLTextEditCtrl::onWake (  )  [virtual]

Called when this object is asked to wake up returns true if it's actually awake at the end.

Reimplemented from GuiMLTextCtrl.

bool GuiMLTextEditCtrl::resize ( const Point2I newPosition,
const Point2I newExtent 
) [virtual]

Changes the size and/or position of this control.

Parameters:
newPosition New position of this control
newExtent New size of this control

Reimplemented from GuiControl.

GuiMLTextEditCtrl::DECLARE_CONOBJECT ( GuiMLTextEditCtrl   ) 

static void GuiMLTextEditCtrl::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

See also:
addField(), addFieldV(), addDeprecatedField(), addGroup(), endGroup()

Reimplemented from GuiMLTextCtrl.


Member Data Documentation