Torque Game Engine Documentation
TGE Version 1.5.2

GuiArrayCtrl Class Reference

#include <guiArrayCtrl.h>

Inheritance diagram for GuiArrayCtrl:

Detailed Description

Renders a grid of cells.

Public Member Functions

GuiArrayCtrl ()

DECLARE_CONOBJECT (GuiArrayCtrl)

bool onWake ()

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

void onSleep ()

Called when this object is asked to sleep.

Array attribute methods

Point2I getSize ()

virtual void setSize (Point2I size)

void setHeaderDim (const Point2I &dim)

void getScrollDimensions (S32 &cell_size, S32 &num_cells)

Selected cell methods

void setSelectedCell (Point2I cell)

void deselectCells ()

Point2I getSelectedCell ()

void scrollSelectionVisible ()

void scrollCellVisible (Point2I cell)

Rendering methods

virtual void onRenderColumnHeaders (Point2I offset, Point2I parentOffset, Point2I headerDim)

virtual void onRenderRowHeader (Point2I offset, Point2I parentOffset, Point2I headerDim, Point2I cell)

virtual void onRenderCell (Point2I offset, Point2I cell, bool selected, bool mouseOver)

void onRender (Point2I offset, const RectI &updateRect)

Called when this control is to render itself.

Mouse input methods

void onMouseDown (const GuiEvent &event)

void onMouseMove (const GuiEvent &event)

void onMouseDragged (const GuiEvent &event)

void onMouseEnter (const GuiEvent &event)

void onMouseLeave (const GuiEvent &event)

bool onKeyDown (const GuiEvent &event)

Happens when a key is depressed.

void onRightMouseDown (const GuiEvent &event)

Protected Member Functions

bool cellSelected (Point2I cell)

virtual void onCellSelected (Point2I cell)

virtual void onCellHighlighted (Point2I cell)

Protected Attributes

Point2I mHeaderDim

Point2I mSize

Point2I mCellSize

Point2I mSelectedCell

Point2I mMouseOverCell

Resource< GFont > mFont

Private Types

typedef GuiControl Parent

Member Typedef Documentation

typedef GuiControl GuiArrayCtrl::Parent [private]

Reimplemented from GuiControl.

Reimplemented in CreatorTree, GuiConsole, GuiDirectoryTreeCtrl, GuiPopUpTextListCtrl, GuiTextListCtrl, GuiTreeViewCtrl, DbgFileView, and GuiMenuTextListCtrl.

Constructor & Destructor Documentation

GuiArrayCtrl::GuiArrayCtrl ( )

Member Function Documentation

bool GuiArrayCtrl::cellSelected ( Point2I cell ) [protected]

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

Reimplemented in GuiPopUpTextListCtrl, and GuiTextListCtrl.

virtual void GuiArrayCtrl::onCellHighlighted ( Point2I cell ) [protected, virtual]

Reimplemented in GuiMenuTextListCtrl.

GuiArrayCtrl::DECLARE_CONOBJECT ( GuiArrayCtrl )

bool GuiArrayCtrl::onWake ( ) [virtual]

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

Reimplemented from GuiControl.

Reimplemented in CreatorTree, GuiConsole, GuiDirectoryTreeCtrl, GuiTextListCtrl, GuiTreeViewCtrl, and DbgFileView.

void GuiArrayCtrl::onSleep ( ) [virtual]

Called when this object is asked to sleep.

Reimplemented from GuiControl.

Reimplemented in GuiTreeViewCtrl.

Point2I GuiArrayCtrl::getSize ( ) [inline]

virtual void GuiArrayCtrl::setSize ( Point2I size ) [virtual]

Reimplemented in GuiTextListCtrl.

void GuiArrayCtrl::setHeaderDim ( const Point2I & dim ) [inline]

void GuiArrayCtrl::getScrollDimensions	(	S32 &	cell_size,
		S32 &	num_cells
	)

void GuiArrayCtrl::setSelectedCell ( Point2I cell )

void GuiArrayCtrl::deselectCells ( ) [inline]

Point2I GuiArrayCtrl::getSelectedCell ( )

void GuiArrayCtrl::scrollSelectionVisible ( )

void GuiArrayCtrl::scrollCellVisible ( Point2I cell )

virtual void GuiArrayCtrl::onRenderColumnHeaders	(	Point2I	offset,
		Point2I	parentOffset,
		Point2I	headerDim
	)			`[virtual]`

virtual void GuiArrayCtrl::onRenderRowHeader	(	Point2I	offset,
		Point2I	parentOffset,
		Point2I	headerDim,
		Point2I	cell
	)			`[virtual]`

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

Reimplemented in CreatorTree, GuiConsole, GuiPopUpTextListCtrl, GuiTextListCtrl, GuiTreeViewCtrl, DbgFileView, and GuiMenuTextListCtrl.

void GuiArrayCtrl::onRender	(	Point2I	offset,
		const RectI &	updateRect
	)			`[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 GuiControl.

Reimplemented in GuiTreeViewCtrl.

void GuiArrayCtrl::onMouseDown ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

Reimplemented in CreatorTree, GuiPopUpTextListCtrl, GuiTreeViewCtrl, DbgFileView, and GuiMenuTextListCtrl.

void GuiArrayCtrl::onMouseMove ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

Reimplemented in GuiTreeViewCtrl.

void GuiArrayCtrl::onMouseDragged ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

Reimplemented in CreatorTree, GuiTreeViewCtrl, and DbgFileView.

void GuiArrayCtrl::onMouseEnter ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

Reimplemented in GuiTreeViewCtrl.

void GuiArrayCtrl::onMouseLeave ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

Reimplemented in GuiTreeViewCtrl.

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

Happens when a key is depressed.

Parameters:

event

Event descriptor (which contains the key)

Reimplemented from GuiControl.

Reimplemented in GuiPopUpTextListCtrl, GuiTextListCtrl, GuiTreeViewCtrl, and GuiMenuTextListCtrl.

void GuiArrayCtrl::onRightMouseDown ( const GuiEvent & event ) [virtual]

Reimplemented from GuiControl.

Reimplemented in GuiTreeViewCtrl.

Field Documentation

Point2I GuiArrayCtrl::mHeaderDim [protected]

Point2I GuiArrayCtrl::mSize [protected]

Point2I GuiArrayCtrl::mCellSize [protected]

Point2I GuiArrayCtrl::mSelectedCell [protected]

Point2I GuiArrayCtrl::mMouseOverCell [protected]

Resource<GFont> GuiArrayCtrl::mFont [protected]

Reimplemented in GuiConsole.