GuiTextListCtrl Class Reference

#include <guiTextListCtrl.h>

Inheritance diagram for GuiTextListCtrl:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 GuiTextListCtrl ()
 DECLARE_CONOBJECT (GuiTextListCtrl)
virtual void setCellSize (const Point2I &size)
virtual void getCellSize (Point2I &size)
const char * getScriptValue ()
 Returns the value of the variable bound to this object.
void setScriptValue (const char *value)
 Sets the value of the variable bound to this object.
U32 getNumEntries ()
void clear ()
virtual void addEntry (U32 id, const char *text)
virtual void insertEntry (U32 id, const char *text, S32 index)
void setEntry (U32 id, const char *text)
void setEntryActive (U32 id, bool active)
S32 findEntryById (U32 id)
S32 findEntryByText (const char *text)
bool isEntryActive (U32 id)
U32 getEntryId (U32 index)
bool onWake ()
 Called when this object is asked to wake up returns true if it's actually awake at the end.
void removeEntry (U32 id)
virtual void removeEntryByIndex (S32 id)
virtual void sort (U32 column, bool increasing=true)
virtual void sortNumerical (U32 column, bool increasing=true)
U32 getSelectedId ()
U32 getSelectedRow ()
const char * getSelectedText ()
bool onKeyDown (const GuiEvent &event)
 Happens when a key is depressed.
virtual void onRenderCell (Point2I offset, Point2I cell, bool selected, bool mouseOver)
void setSize (Point2I newSize)
void onRemove ()
 Called when this object is removed.
void addColumnOffset (S32 offset)
void clearColumnOffsets ()

Static Public Member Functions

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

Public Attributes

Vector< Entry > mList
bool mEnumerate
bool mResizeCell

Protected Types

 UP = 0
 DOWN = 1
 InvalidId = 0xFFFFFFFF
enum  ScrollConst {
  UP = 0,
  DOWN = 1
}
enum  { InvalidId = 0xFFFFFFFF }

Protected Member Functions

U32 getRowWidth (Entry *row)
void onCellSelected (Point2I cell)

Protected Attributes

Vector< S32 > mColumnOffsets
bool mFitParentWidth
bool mClipColumnText

Private Types

typedef GuiArrayCtrl Parent

Classes

struct  Entry

Member Typedef Documentation

typedef GuiArrayCtrl GuiTextListCtrl::Parent [private]

Reimplemented from GuiArrayCtrl.

Reimplemented in GuiPopupTextListCtrl, GuiPopupTextListCtrlEx, and GuiMenuTextListCtrl.

Member Enumeration Documentation

enum GuiTextListCtrl::ScrollConst [protected]

Enumerator:
UP 
DOWN 

anonymous enum [protected]

Enumerator:
InvalidId 

Constructor & Destructor Documentation

GuiTextListCtrl::GuiTextListCtrl (  ) 

Member Function Documentation

U32 GuiTextListCtrl::getRowWidth ( Entry *  row  )  [protected]

void GuiTextListCtrl::onCellSelected ( Point2I  cell  )  [protected, virtual]

Reimplemented from GuiArrayCtrl.

Reimplemented in GuiPopupTextListCtrl, and GuiPopupTextListCtrlEx.

GuiTextListCtrl::DECLARE_CONOBJECT ( GuiTextListCtrl   ) 

static void GuiTextListCtrl::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GuiControl.

virtual void GuiTextListCtrl::setCellSize ( const Point2I &  size  )  [inline, virtual]

virtual void GuiTextListCtrl::getCellSize ( Point2I &  size  )  [inline, virtual]

const char* GuiTextListCtrl::getScriptValue (  )  [virtual]

Returns the value of the variable bound to this object.

Reimplemented from GuiControl.

void GuiTextListCtrl::setScriptValue ( const char *  value  )  [virtual]

Sets the value of the variable bound to this object.

Reimplemented from GuiControl.

U32 GuiTextListCtrl::getNumEntries (  ) 

void GuiTextListCtrl::clear (  ) 

Reimplemented from SimSet.

virtual void GuiTextListCtrl::addEntry ( U32  id,
const char *  text 
) [virtual]

virtual void GuiTextListCtrl::insertEntry ( U32  id,
const char *  text,
S32  index 
) [virtual]

void GuiTextListCtrl::setEntry ( U32  id,
const char *  text 
)

void GuiTextListCtrl::setEntryActive ( U32  id,
bool  active 
)

S32 GuiTextListCtrl::findEntryById ( U32  id  ) 

S32 GuiTextListCtrl::findEntryByText ( const char *  text  ) 

bool GuiTextListCtrl::isEntryActive ( U32  id  ) 

U32 GuiTextListCtrl::getEntryId ( U32  index  ) 

bool GuiTextListCtrl::onWake (  )  [virtual]

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

Reimplemented from GuiArrayCtrl.

void GuiTextListCtrl::removeEntry ( U32  id  ) 

virtual void GuiTextListCtrl::removeEntryByIndex ( S32  id  )  [virtual]

virtual void GuiTextListCtrl::sort ( U32  column,
bool  increasing = true 
) [virtual]

virtual void GuiTextListCtrl::sortNumerical ( U32  column,
bool  increasing = true 
) [virtual]

U32 GuiTextListCtrl::getSelectedId (  ) 

U32 GuiTextListCtrl::getSelectedRow (  ) 

const char* GuiTextListCtrl::getSelectedText (  ) 

bool GuiTextListCtrl::onKeyDown ( const GuiEvent &  event  )  [virtual]

Happens when a key is depressed.

Parameters:
event Event descriptor (which contains the key)

Reimplemented from GuiArrayCtrl.

Reimplemented in GuiPopupTextListCtrl, GuiPopupTextListCtrlEx, and GuiMenuTextListCtrl.

virtual void GuiTextListCtrl::onRenderCell ( Point2I  offset,
Point2I  cell,
bool  selected,
bool  mouseOver 
) [virtual]

Reimplemented from GuiArrayCtrl.

Reimplemented in GuiPopupTextListCtrl, GuiPopupTextListCtrlEx, and GuiMenuTextListCtrl.

void GuiTextListCtrl::setSize ( Point2I  newSize  )  [virtual]

Reimplemented from GuiArrayCtrl.

void GuiTextListCtrl::onRemove (  )  [virtual]

Called when this object is removed.

Reimplemented from GuiControl.

void GuiTextListCtrl::addColumnOffset ( S32  offset  )  [inline]

void GuiTextListCtrl::clearColumnOffsets (  )  [inline]

Member Data Documentation

Vector<Entry> GuiTextListCtrl::mList

bool GuiTextListCtrl::mEnumerate

bool GuiTextListCtrl::mResizeCell

Vector<S32> GuiTextListCtrl::mColumnOffsets [protected]

bool GuiTextListCtrl::mFitParentWidth [protected]

bool GuiTextListCtrl::mClipColumnText [protected]

© GarageGames.com Home Back to Top
© GarageGames.com Home Back to Top