LTableSelector

LTableSelector is an abstract PowerPlant class that specifies the interface for the selector helper objects. These methods provide behaviors to maintain the selection range in a table.

Methods :

The methods in this class are:

LTableSelector()	~LTableSelector()
CellIsSelected()	ClickSelect()
DragSelect()	GetFirstSelectedCell()
GetFirstSelectedRow()	InsertCols()
InsertRows()	RemoveCols()
RemoveRows()	SelectAllCells()
SelectCell()	UnselectAllCells()
UnselectCell()

Data Members:

The data members in this class are:

mTableView

Operation:

All of the methods in this class are pure virtual or empty.

Source files:

(Table Classes)

UTableHelpers.h

LTableSelector()

Purpose:

The constructor creates the object.

Access :

Public

Prototype:

LTableSelector();

None

~LTableSelector()

Purpose:

The destructor destroys the object.

Access :

Virtual, Public

Prototype:

virtual		 ~LTableSelector();

CellIsSelected()

Purpose:

Indicates whether a given cell is selected.

Access :

Pure Virtual, Public

Prototype:

virtual Boolean		CellIsSelected(

	const STableCell		&inCell ) const = 0;

This method has the following parameters:

STableCell&

inCell

A reference to the cell.

Return:

Returns true if selected, else returns false.

ClickSelect()

Purpose:

Handle a mouse click within the specified cell.

Access :

Pure Virtual, Public

Prototype:

virtual void		ClickSelect(

	const STableCell		&inCell,

	const SMouseDownEvent	&inMouseDown ) = 0;

This method has the following parameters:

STableCell&	inCell	A reference to the cell.
SMouseDownEvent&	inMouseDown	The mouse down event info.

Return:

None

DragSelect()

Purpose:

Handle a drag operation (the user is pressing the mouse) on a cell.

Access :

Pure Virtual, Public

Prototype:

virtual Boolean		DragSelect(

	const STableCell		&inCell,

	const SMouseDownEvent	&inMouseDown ) = 0;

This method has the following parameters:

STableCell&	inCell	A reference to the cell.
SMouseDownEvent&	inMouseDown	The mouse down event info.

Return:

Return true if the mouse never leaves inCell.

GetFirstSelectedCell()

Purpose:

Get the value of the first selected cell.

Access :

Pure Virtual, Public

Prototype:

virtual	STableCell	GetFirstSelectedCell() const = 0;

None

Return:

The cell.

GetFirstSelectedRow()

Purpose:

Get the first selected row.

Access :

Pure Virtual, Public

Prototype:

virtual	TableIndexT	GetFirstSelectedRow() const = 0;

None

Return:

The cell.

InsertCols()

Purpose:

This method handles insertion of columns to the table.

Access :

Virtual, Public

Prototype:

virtual void	InsertCols(

	UInt32			inHowMany,

	TableIndexT		inAfterCol );

This method has the following parameters:

UInt32	inHowMany	How many columns to insert.
TableIndexT	inAfterCol	The column index to insert after.

Return:

None

InsertRows()

Purpose:

This method handles insertion of rows to the table.

Access :

Virtual, Public

Prototype:

virtual void		InsertRows(

	UInt32			inHowMany,

	TableIndexT		inAfterRow );

This method has the following parameters:

UInt32	inHowMany	How many rows to insert.
TableIndexT	inAfterRow	The row index to insert after.

Return:

None

RemoveCols()

Purpose:

This method handles removal of columns to the table.

Access :

Virtual, Public

Prototype:

virtual void		RemoveCols(

	UInt32			inHowMany,

	TableIndexT		inFromCol );

This method has the following parameters:

UInt32	inHowMany	How many columns to insert.
TableIndexT	inFromCol	The column index to start removal at.

Return:

None

RemoveRows()

Purpose:

Remove rows from the table.

Access :

Virtual, Public

Prototype:

virtual void		RemoveRows(

	UInt32				inHowMany,

	TableIndexT			inFromRow) = 0;

This method has the following parameters:

UInt32	inHowMany	How many rows to remove.
TableIndexT	inAfterRow	The row index to start removal at.

Return:

None

SelectAllCells()

Purpose:

Selects all cells in the table.

Access :

Pure Virtual, Public

Prototype:

virtual void		SelectAllCells() = 0;

None

Return:

None

SelectCell()

Purpose:

Select a cell.

Access :

Pure Virtual, Public

Prototype:

virtual void		SelectCell(

	const STableCell	&inCell ) = 0;

This method has the following parameters:

STableCell&

inCell

The cell.

Return:

None

UnselectAllCells()

Purpose:

Unselect all cells in the table.

Access :

Pure Virtual, Public

Prototype:

virtual void		UnselectAllCells() = 0;

None

Return:

None

UnselectCell()

Purpose:

Unselect a cell.

Access :

Pure Virtual, Public

Prototype:

virtual void		UnselectCell(

	const STableCell	&inCell ) = 0;

This method has the following parameters:

STableCell&

inCell

The cell.

Return:

None

mTableView

Purpose:

The table view storage.

Access :

Protected

Prototype:

LTableView *mTableView;