GuiListBoxCtrl

Engine/source/gui/controls/guiListBoxCtrl.h

More...

Classes:

Private Types

Parent 

Public Functions

addItem(StringTableEntry text, void * itemData)
addSelection(LBItem * item, S32 index)
DECLARE_CALLBACK(bool , isObjectMirrored , (const char *indexIdString) )
DECLARE_CALLBACK(void , onClearSelection , () )
DECLARE_CALLBACK(void , onDeleteKey , () )
DECLARE_CALLBACK(void , onDoubleClick , () )
DECLARE_CALLBACK(void , onMouseUp , (S32 itemHit, S32 mouseClickCount) )
DECLARE_CALLBACK(void , onSelect , (S32 index, const char *itemText) )
DECLARE_CALLBACK(void , onUnSelect , (S32 index, const char *itemText) )
DECLARE_CATEGORY("Gui Lists" )
DECLARE_DESCRIPTION("Linear list of text items." )
drawBox(const Point2I & box, S32 size, ColorI & outlineColor, ColorI & boxColor)
findItemText(StringTableEntry text, bool caseSensitive)
bool
hitTest(const Point2I & point, S32 & outItem)
insertItem(S32 index, StringTableEntry text, void * itemData)
insertItemWithColor(S32 index, StringTableEntry text, LinearColorF color, void * itemData)
bool

Happens when a key is depressed.

onRender(Point2I offset, const RectI & updateRect)

Called when this control is to render itself.

onRenderItem(const RectI & itemRect, LBItem * item)
bool

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

parentResized(const RectI & oldParentRect, const RectI & newParentRect)

Called when this objects parent is resized.

removeSelection(LBItem * item, S32 index)
bool
renderTooltip(const Point2I & hoverPos, const Point2I & cursorPos, const char * tipText)
setCurSelRange(S32 start, S32 stop)
setMultipleSelection(bool allowMultipleSelect)

Public Static Functions

const char *
getStringElement(const char * inString, const U32 index)

Detailed Description

Private Types

typedef GuiControl Parent 

Public Attributes

bool mColorBullet 
VectorPtr< LBItem * > mFilteredItems 
bool mFitParentWidth 
VectorPtr< LBItem * > mItems 
Point2I mItemSize 
LBItem * mLastClickItem 
String mMakeNameCallback 
String mMirrorSetName 
bool mMultipleSelections 
VectorPtr< LBItem * > mSelectedItems 

Public Functions

GuiListBoxCtrl()

~GuiListBoxCtrl()

_makeMirrorItemName(SimObject * inObj)

_mirror()

addFilteredItem(String item)

addItem(StringTableEntry text, void * itemData)

addItemWithColor(StringTableEntry text, LinearColorF color, void * itemData)

addSelection(LBItem * item, S32 index)

addSelection(S32 index)

clearItemColor(S32 index)

clearItems()

clearSelection()

DECLARE_CALLBACK(bool , isObjectMirrored , (const char *indexIdString) )

DECLARE_CALLBACK(void , onClearSelection , () )

DECLARE_CALLBACK(void , onDeleteKey , () )

DECLARE_CALLBACK(void , onDoubleClick , () )

DECLARE_CALLBACK(void , onMouseDragged , () )

DECLARE_CALLBACK(void , onMouseUp , (S32 itemHit, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onSelect , (S32 index, const char *itemText) )

DECLARE_CALLBACK(void , onUnSelect , (S32 index, const char *itemText) )

DECLARE_CATEGORY("Gui Lists" )

DECLARE_CONOBJECT(GuiListBoxCtrl )

DECLARE_DESCRIPTION("Linear list of text items." )

deleteItem(S32 index)

drawBox(const Point2I & box, S32 size, ColorI & outlineColor, ColorI & boxColor)

findItemText(StringTableEntry text, bool caseSensitive)

getItemCount()

getItemIndex(LBItem * item)

getItemObject(S32 index)

getItemText(S32 index)

getSelCount()

getSelectedItem()

getSelectedItems(Vector< S32 > & Items)

hitTest(const Point2I & point, S32 & outItem)

insertItem(S32 index, StringTableEntry text, void * itemData)

insertItemWithColor(S32 index, StringTableEntry text, LinearColorF color, void * itemData)

onKeyDown(const GuiEvent & event)

Reimplemented from: GuiControl

onMouseDown(const GuiEvent & event)

Reimplemented from: GuiControl

Reimplemented by: GuiDirectoryFileListCtrl

onMouseDragged(const GuiEvent & event)

Reimplemented from: GuiControl

onMouseUp(const GuiEvent & event)

Reimplemented from: GuiControl

onRender(Point2I offset, const RectI & updateRect)

Reimplemented from: GuiControl

onRenderItem(const RectI & itemRect, LBItem * item)

onWake()

Reimplemented from: GuiControl

Reimplemented by: GuiDirectoryFileListCtrl

parentResized(const RectI & oldParentRect, const RectI & newParentRect)

Reimplemented from: GuiControl

removeFilteredItem(String item)

removeSelection(LBItem * item, S32 index)

removeSelection(S32 index)

renderTooltip(const Point2I & hoverPos, const Point2I & cursorPos, const char * tipText)

setCurSel(S32 index)

setCurSelRange(S32 start, S32 stop)

setItemColor(S32 index, const LinearColorF & color)

setItemText(S32 index, StringTableEntry text)

setMirrorObject(SimSet * inObj)

setMultipleSelection(bool allowMultipleSelect)

updateSize()

Public Static Functions

getStringElement(const char * inString, const U32 index)

getStringElementCount(const char * string)

initPersistFields()