GuiTabPageCtrl Class Reference

#include <guiTabPageCtrl.h>

Inheritance diagram for GuiTabPageCtrl:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 GuiTabPageCtrl ()
 DECLARE_CONOBJECT (GuiTabPageCtrl)
bool onWake ()
 The page awakens (becomes active)!
void onSleep ()
 The page sleeps (zzzzZZ - becomes inactive).
GuiControlfindHitControl (const Point2I &pt, S32 initialLayer=-1)
 Find which control is hit by the mouse starting at a specified layer.
void onMouseDown (const GuiEvent &event)
 Called when a mouseDown event occurs.
bool onMouseDownEditor (const GuiEvent &event, Point2I offset)
 Called when a mouseDown event occurs and the GUI editor is active.
S32 getTabIndex (void)
 Get the tab index of this control.
GuiControlfindNextTabable (GuiControl *curResponder, bool firstCall=true)
 Find next tab-accessible control with regards to the provided control.
GuiControlfindPrevTabable (GuiControl *curResponder, bool firstCall=true)
 Find previous tab-accessible control with respect to the provided one.
void selectWindow (void)
 Select this window.
virtual void setText (const char *txt=NULL)
 Override setText function to signal parent we need to update.
void onRender (Point2I offset, const RectI &updateRect)
 Called when it's time to render this page to the scene.

Static Public Member Functions

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

Private Types

typedef GuiTextCtrl Parent

Private Attributes

Point2I mMinSize
S32 mTabIndex

Member Typedef Documentation

Reimplemented from GuiTextCtrl.


Constructor & Destructor Documentation

GuiTabPageCtrl::GuiTabPageCtrl (  ) 


Member Function Documentation

GuiTabPageCtrl::DECLARE_CONOBJECT ( GuiTabPageCtrl   ) 

static void GuiTabPageCtrl::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GuiTextCtrl.

bool GuiTabPageCtrl::onWake (  )  [virtual]

The page awakens (becomes active)!

Reimplemented from GuiTextCtrl.

void GuiTabPageCtrl::onSleep (  )  [virtual]

The page sleeps (zzzzZZ - becomes inactive).

Reimplemented from GuiTextCtrl.

GuiControl* GuiTabPageCtrl::findHitControl ( const Point2I pt,
S32  initialLayer = -1 
) [virtual]

Find which control is hit by the mouse starting at a specified layer.

Reimplemented from GuiControl.

void GuiTabPageCtrl::onMouseDown ( const GuiEvent event  )  [virtual]

Called when a mouseDown event occurs.

Reimplemented from GuiControl.

bool GuiTabPageCtrl::onMouseDownEditor ( const GuiEvent event,
Point2I  offset 
) [virtual]

Called when a mouseDown event occurs and the GUI editor is active.

Reimplemented from GuiControl.

S32 GuiTabPageCtrl::getTabIndex ( void   )  [inline]

Get the tab index of this control.

GuiControl* GuiTabPageCtrl::findNextTabable ( GuiControl curResponder,
bool  firstCall = true 
) [virtual]

Find next tab-accessible control with regards to the provided control.

Parameters:
curResponder Current control
firstCall Set to true to clear the global current responder

Reimplemented from GuiControl.

GuiControl* GuiTabPageCtrl::findPrevTabable ( GuiControl curResponder,
bool  firstCall = true 
) [virtual]

Find previous tab-accessible control with respect to the provided one.

Parameters:
curResponder Current control
firstCall Set to true to clear the global previous responder

Reimplemented from GuiControl.

void GuiTabPageCtrl::selectWindow ( void   ) 

Select this window.

virtual void GuiTabPageCtrl::setText ( const char *  txt = NULL  )  [virtual]

Override setText function to signal parent we need to update.

Reimplemented from GuiTextCtrl.

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

Called when it's time to render this page to the scene.

Reimplemented from GuiTextCtrl.


Member Data Documentation