[ First ]  [ Previous ]  [ Next ]  [ Last ]  [ Manuals ]

 

LTableView



Overview:

LTableView is a PowerPlant class that forms the basis for the rest of the table classes. The class data members store the data you need to create and manage a table. The class member functions implement standard table-related bahavior.

Methods :

The methods in this class are:

 

LTableView()  
~LTableView()  
ActivateSelf()  
AdjustImageSize()  
CellIsSelected()  
CellToIndex()  
ClickCell()  
ClickSelect()  
ClickSelf()  
DeactivateSelf()  
DrawCell()  
DrawSelf()  
FetchIntersectingCells()  
FindCellData()  
GetCellData()  
GetCellHitBy()  
GetColWidth()  
GetCustomHilite()  
GetFirstSelectedCell()  
GetHiliteRgn()  
GetImageCellBounds()  
GetLocalCellRect()  
GetNextCell()  
GetNextSelectedCell()  
GetPreviousCell()  
GetPreviousSelectedCell()  
GetRowHeight()  
GetTableGeometry()  
GetTableSelector()  
GetTableSize()  
GetTableStorage()  
HiliteCell()  
HiliteCellActively()  
HiliteCellInactively()  
HiliteSelection()  
IndexToCell()  
InitTable()  
InsertCols()  
InsertRows()  
IsValidCell()  
IsValidCol()  
IsValidRow()  
PointsAreClose()  
RefreshCell()  
RefreshCellRange()  
RemoveAllCols()  
RemoveAllRows()  
RemoveCols()  
RemoveRows()  
ScrollCellIntoFrame()  
SelectAllCells()  
SelectCell()  
SelectionChanged()  
SetCellData()  
SetColWidth()  
SetCustomHilite()  
SetDeferAdjustment()  
SetRowHeight()  
SetTableGeometry()  
SetTableSelector()  
SetTableStorage()  
SetUseDragSelect()  
UnselectAllCells()  
UnselectCell()  

Data Members:

The data members in this class are:

 

mRows  
mCols  
mTableGeometry  
mTableSelector  
mTableStorage  
mUseDragSelect  
mCustomHilite  
mDeferAdjustment  

Operation:

LTableView inherits from LPane and LView. It is thus closely related to the operations of LView. An undertanding of how LPane and LView work is essential to getting the most from this class.

Source files:

(Table Classes)

LTableView.h

LTableView.cp

See also:

LAttachable

LView

LPane

LTableView()

Purpose:

The constructor creates an object.

Access :

Public

Prototype:

LTableView();

LTableView( const SPaneInfo	&inPaneInfo,

	const SViewInfo	&inViewInfo );

LTableView( LStream	*inStream );
Parameters:

This method has the following parameters:

 

SPaneInfo&  
inPaneInfo  
A reference to the pane info.  
SViewInfo&  
inBefore  
A reference to the superview.  
LStream*  
inStream  
A pointer to the stream object to construct from.  

~LTableView()

Purpose:

The destructor destroys the object.

Access :

Virtual, Public

Prototype:

virtual ~LTableView();

ActivateSelf()

Purpose:

Activate a Table

Access :

Virtual, Protected

Prototype:

virtual void ActivateSelf();
Parameters:

None

Return:

None

AdjustImageSize()

Purpose:

Adjust the Image size of the Table to reflect the number and size of the rows and columns.

Access :

Virtual, Public

Prototype:

virtual void AdjustImageSize( Boolean	inRefresh );
Parameters:

This method has the following parameters:

 

Boolean  
inRefresh  
A boolean indicating whether to refresh or not.  

Return:

None

CellIsSelected()

Purpose:

Return whether the specified cell is part of the current selection

Access :

Public

Prototype:

virtual Boolean CellIsSelected(

	const STableCell	&inCell ) const;
Parameters:

This method has the following parameters:

 

STableCell&  
inCell  
A reference to the cell.  

Return:

Boolean indicating true if the cell is part of the current selection

CellToIndex()

Purpose:

Pass back the index number for a specified cell

The cell does not have to be in the Table, but the index is zero if the table has no columns or inCell.row is zero.

Cells are ordered by column (across), and then by row (down)

Access :

Virtual, Public

Prototype:

virtual void CellToIndex( const STableCell	&inCell,

	TableIndexT			&outIndex ) const;
Parameters:

This method has the following parameters:

 

STableCell&  
inCell  
A reference to the cell.  
TableIndexT&  
outIndex  
The index.  

ClickCell()

Purpose:

Handle a mouse click within the specified cell.

Access :

Virtual, Protected

Prototype:

virtual void ClickCell(

	const STableCell&		 inCell,

	const SMouseDownEvent&	 inMouseDown );
Parameters:

This method has the following parameters:

 

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

ClickSelect()

Purpose:

Adjust selection in response to a click in the specified cell, and return whether or not to process the click as a normal click.

Access :

Virtual, Public

Prototype:

virtual Boolean ClickSelect(

	const STableCell		&inCell,

	const SMouseDownEvent	&inMouseDown );
Parameters:

This method has the following parameters:

 

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

Return:

Return true if a normal click, false otherwise.

ClickSelf()

Purpose:

Handle a mouse click within a TableView. This method is an override of ClickSelf().

DeactivateSelf()

Purpose:

Deactivate a Table. This method is an override of DeactivateSelf().

DrawCell()

Purpose:

Draw the contents of the specified Cell.

Access :

Virtual, Protected

Prototype:

virtual void DrawCell( const STableCell&	 inCell,

	const Rect&			 inLocalRect );
Parameters:

This method has the following parameters:

 

STableCell&  
inCell  
A reference to the cell.  
Rect&  
inLocalRect  
The rectangle coordinates of the cell.  

Return:

None

DrawSelf()

Purpose:

Draw a TableView. This is an override of DrawSelf() in LPane().

FetchIntersectingCells()

Purpose:

Pass back the rectangular range of cells, specified by the top left and bottom right cells, that intersects a given rectangle.

Access :

Virtual, Public

Prototype:

virtual void FetchIntersectingCells(

	const Rect		&inLocalRect,			

	STableCell		&outTopLeft,

	STableCell		&outBotRight) const;
Parameters:

This method has the following parameters:

 

STableCell&  
outTopLeft  
A reference to the top left cell.  
STableCell&  
outBotRight  
A reference to the bottom right cell.  
Rect&  
inLocalRect  
The rectangle coordinates of the cell.  

Return:

None

FindCellData()

Purpose:

Pass back the cell that contains the specified data.

Access :

Virtual, Public

Prototype:

virtual Boolean FindCellData(

	STableCell			&outCell,

	const void			*inDataPtr,

	UInt32				inDataSize) const;
Parameters:

This method has the following parameters:

 

STableCell&  
outCell  
A reference to the cell.  
void*  
inDataPtr  
The buffer pointer.  
UInt32  
inDataSize  
The buffer size.  

Return:

Return false if no match is found.

GetCellData()

Purpose:

Pass back the data for a particular Cell.

Access :

Virtual, Public

Prototype:

virtual void GetCellData(

	const STableCell	&inCell,

	void				*outDataPtr,

	UInt32				&ioDataSize) const;
Parameters:

This method has the following parameters:

 

STableCell&  
outCell  
A reference to the cell.  
void*  
outDataPtr  
The buffer pointer. Points to storage which must be allocated by the caller. It may be nil, in which case only the size of the data is passed back.  
UInt32&  
ioDataSize  
The size of the data buffer (

If outDataPtr is nil

  • input: <ignored>
  • output: size in bytes of cell's data

If outDataPtr is not nil,

input: maximum bytes of data to retrieve output: actual bytes of data passed back

Return:

None

GetCellHitBy()

Purpose:

Pass back the cell which contains the specified point.

If no cell contains the point, return false and

outCell.row = 0 if point is above the Table

outCell.row = mRows + 1 if point is below the Table

outCell.col = 0 if point is to the left of the Table

outCell.col = mCols + 1 if point is to the right of the Table

For example, if the horizontal coordinate is within Column 2, but the vertical coordinate is above the Table, then,

outCell.row = 0

outCell.col = 2

Access :

Virtual, Public

Prototype:

virtual Boolean GetCellHitBy(

	const SPoint32	&inImagePt,

	STableCell		&outCell ) const;
Parameters:

This method has the following parameters:

 

SPoint32&  
inImagePt  
A reference to the point.  
STableCell&  
outCell  
A reference to the cell.  

Return:

Return false if no cell contains the point.

GetColWidth()

Purpose:

Return the width of the specified column.

Access :

Virtual, Public

Prototype:

virtual UInt16 GetColWidth(

	TableIndexT	inCol ) const;
Parameters:

This method has the following parameters:

 

TableIndexT  
inCol  
The column to interrogate.  

Return:

UInt16 indicating the width.

GetCustomHilite()

Purpose:

Returns the value of the mCustomHilite member.

Access :

Public

Prototype:

Boolean GetCustomHilite();
Parameters:

None

GetFirstSelectedCell()

Purpose:

Return the first selected cell, using the LTableSelector helper object.

Access :

Public, Virtual

Prototype:

virtual STableCell GetFirstSelectedCell() const;
Parameters:

None

Return:

The first selected cell.

GetHiliteRgn()

Purpose:

Pass back a Region containing the frames of all selected cells which are within the visible rectangle of the Table.

Caller must allocate space for the region.

Access :

Virtual, Protected

Prototype:

virtual void GetHiliteRgn(

	RgnHandle	ioHiliteRgn);
Parameters:

This method has the following parameters:

 

RgnHandle  
ioHiliteRgn  
The region handle.  

Return:

None

GetImageCellBounds()

Purpose:

Pass back the location in Image coords of the specified Cell.

Access :

Virtual, Public

Prototype:

virtual void GetImageCellBounds(

	const STableCell	&inCell,

	SInt32				&outLeft,

	SInt32				&outTop,

	SInt32				&outRight,

	SInt32				&outBottom) const;
Parameters:

This method has the following parameters:

 

STableCell&  
inCell  
The cell.  
SInt32&  
outLeft  
The left side.  
SInt32&  
outTop  
The top border.  
SInt32&  
outRight  
The right side.  
SInt32&  
outBottom  
The bottom border.  

Return:

None

GetLocalCellRect()

Purpose:

Pass back the bounding rectangle of the specified Cell and return whether it intersects the Frame of the TableView.

The bounding rectangle is in Local coordinates so it will always be within QuickDraw space when its within the Frame.

Access :

Virtual, Public

Prototype:

virtual Boolean GetLocalCellRect(

	const STableCell	&inCell,

	Rect				&outCellRect) const;
Parameters:

This method has the following parameters:

 

STableCell&  
inCell  
The cell.  
Rect&  
outCellRect  
The rect of the cell.  

Return:

If the bounding rectangle is outside the Frame, return false and set the rectangle to (0,0,0,0).

GetNextCell()

Purpose:

Pass back the Cell after the specified Cell.

Cells are ordered by column (across), and then by row (down).

Row zero is before the first row. The next cell after row zero and any column is Cell (1,1).

Column zero is before column one. The next cell after row "r" and column zero is Cell (r,1).

Access :

Virtual, Public

Prototype:

virtual Boolean GetNextCell(

	STableCell	&ioCell) const;
Parameters:

This method has the following parameters:

 

STableCell&  
ioCell  
The cell.  

Return:

Return false if there is no cell after the specified one, andpass back Cell (0,0). Otherwise, return true and pass back the next Cell's indexes.

GetNextSelectedCell()

Purpose:

Pass back the selected Cell after the specified Cell.

This function uses the same ordering rules as GetNextCell(). Pass in Cell (0,0) to find the first selected Cell.

Access :

Virtual, Public

Prototype:

virtual Boolean GetNextSelectedCell(

	STableCell	&ioCell ) const;
Parameters:

This method has the following parameters:

 

STableCell&  
ioCell  
The cell.  

Return:

Return false if there is no selected Cell after the specified one.

GetPreviousCell()

Purpose:

Pass back the Cell before the specified Cell.

Cells are ordered by column (across), and then by row (down).

Cell (mRows,mCols) is the one before Cell (0,c), where c is any column. Thus, you can pass in Cell (0,0) to get the last cell.

Cell (mRows,mCols) is also the cell before any Cell that is beyond the limits of the table.

Column zero is before column one. The cell before row "r" and column zero is Cell (r-1,mCols).

Access :

Virtual, Public

Prototype:

virtual Boolean GetPreviousCell(

	STableCell	&ioCell ) const;
Parameters:

This method has the following parameters:

 

STableCell&  
ioCell  
The cell.  

Return:

Return false if there is no cell before the specified one, and pass back Cell (0,0). Otherwise, return true and pass back the previous Cell's indexes.

GetPreviousSelectedCell()

Purpose:

Pass back the selected Cell before the specified Cell.

This function uses the same ordering rules as GetPreviousCell(). Pass in Cell (0,0) to find the last selected Cell.

Access :

Virtual, Public

Prototype:

virtual Boolean GetPreviousSelectedCell(

	STableCell	&ioCell ) const;
Parameters:

This method has the following parameters:

 

STableCell&  
ioCell  
The cell.  

Return:

Return false if there is no selected cell before the cell indicated, and pass back Cell (0,0). Otherwise, return true and pass back the previous Cell's indexes.

GetRowHeight()

Purpose:

Return the height of the specified row.

Access :

Virtual, Public

Prototype:

virtual UInt16 GetRowHeight(

	TableIndexT	inRow ) const;
Parameters:

This method has the following parameters:

 

TableIndexT  
inRow  
The table index.  

Return:

A UInt16 indicating the height of the row i display coordinates.

GetTableGeometry()

Purpose:

Return the value of the mTableGeometry data member.

Access :

Public

Prototype:

LTableGeometry* GetTableGeometry();
Parameters:

None

Return:

A pointer to an LTableGeometry object.

GetTableSelector()

Purpose:

Return the value of the mTableSelector data member.

Access :

Public

Prototype:

LTableSelector* GetTableSelector();
Parameters:

None

Return:

A pointer to an LTableSelector object.

GetTableSize()

Purpose:

Pass back the number of rows and columns in a TableView.

Access :

Public

Prototype:

void GetTableSize(

	TableIndexT	&outRows,

	TableIndexT	&outCols ) const;
Parameters:

This method has the following parameters:

 

TableIndexT&  
outRows  
The number of rows.  
TableIndexT&  
outCols  
The number of columns.  

Return:

None

GetTableStorage()

Purpose:

Returns the value of the mTableStorage data member.

Access :

Public

Prototype:

LTableStorage* GetTableStorage()	;
Parameters:

None

Return:

A pointer to an LTableStorage object.

HiliteCell()

Purpose:

Draw or undraw hiliting for the specified Cell

Access :

Virtual, Public

Prototype:

virtual void HiliteCell(

	const STableCell	&inCell,

	Boolean				inHilite );
Parameters:

This method has the following parameters:

 

STableCell&  
inCell  
The cell.  
Boolean  
inHilite  
Whether to hilite or not.  

Return:

None

HiliteCellActively()

Purpose:

Draw or undraw active hiliting for a Cell.

Access :

Virtual, Protected

Prototype:

virtual void HiliteCellActively(

	const STableCell	&inCell,

	Boolean				 inHilite );
Parameters:

This method has the following parameters:

 

STableCell&  
inCell  
The cell.  
Boolean  
inHilite  
Whether to hilite or not.  

Return:

None

HiliteCellInactively()

Purpose:

Draw or undraw inactive hiliting for a Cell

Access :

Virtual, Protected

Prototype:

virtual void HiliteCellInactively(

	const STableCell	&inCell,

	Boolean				 inHilite);
Parameters:

This method has the following parameters:

 

STableCell&  
inCell  
The cell.  
Boolean  
inHilite  
Whether to hilite or not.  

Return:

None

HiliteSelection()

Purpose:

Draw or undraw hiliting for the current selection in either the active or inactive state

Access :

Virtual, Public

Prototype:

virtual void HiliteSelection(

	Boolean	inActively,

	Boolean	inHilite );
Parameters:

This method has the following parameters:

 

Boolean  
inActively  
Whether actively or not.  
Boolean  
inHilite  
Whether to hilite or not.  

Return:

None

IndexToCell()

Purpose:

Pass back the cell for a specified index number.

Index number does not have to refer to an actual Cell, but Cell is (0,0) if Table has no columns or inIndex is zero.

Access :

Virtual, Public

Prototype:

virtual void IndexToCell(

	TableIndexT	inIndex,

	STableCell	&outCell ) const;
Parameters:

This method has the following parameters:

 

TableIndexT  
inIndex  
The table index.  
STableCell&  
outCell  
The cell.  

Return:

None

InitTable()

Purpose:

Private Initializer

Access :

Private

Prototype:

void InitTable();
Parameters:

None

Return:

None

InsertCols()

Purpose:

Add columns to a TableView.

Use inAfterCol of 0 to insert columns at the beginning All cells in the newly inserted rows have the same data.

Access :

Virtual, Public

Prototype:

virtual void InsertCols(
  UInt32inHowMany,
  TableIndexT inAfterCol,
  const void* inDataPtr,
  UInt32 inDataSize,
  Boolean inRefresh);
Parameters:

This method has the following parameters:

 

UInt32  
inHowMany  
How many rows to add.  
TableIndexT  
inAfterCol  
The column to insert after.  
void*  
inDataPtr  
The buffer pointer.  
UInt32  
inDataSize  
The size of the buffer.  
Boolean  
inRefresh  
Whether to refresh or not.  

Return:

None

InsertRows()

Purpose:

Add rows to a TableView.

Use inAfterRow of 0 to insert rows at the beginning All cells in the newly inserted rows have the same data.

Access :

Virtual, Public

Prototype:

virtual void InsertRows(
  UInt32 inHowMany,
  TableIndexT inAfterRow,
  const void* inDataPtr,
  UInt32 inDataSize,
  Boolean inRefresh);
Parameters:

This method has the following parameters:

 

UInt32  
inHowMany  
How many rows to add.  
TableIndexT  
inAfterRow  
The row to insert after.  
void*  
inDataPtr  
The buffer pointer.  
UInt32  
inDataSize  
The size of the buffer.  
Boolean  
inRefresh  
Whether to refresh or not.  

Return:

None

IsValidCell()

Purpose:

Return whether a TableView includes a specified Cell.

Access :

Public

Prototype:

Boolean IsValidCell(

	const STableCell	&inCell ) const;
Parameters:

This method has the following parameters:

 

STableCell&  
inCell  
The cell index to check.  

Return:

Boolean indicating whether the cell is valid or not.

IsValidCol()

Purpose:

Return whether a TableView includes a specified column.

Access :

Public

Prototype:

Boolean IsValidCol(

	TableIndexT	inCol ) const;
Parameters:

This method has the following parameters:

 

STableCell&  
inCol  
The cell column to check.  

Return:

Boolean indicating whether the cell includes the column or not.

IsValidRow()

Purpose:

Return whether a TableView includes a specified row

Access :

Public

Prototype:

Boolean IsValidRow(

	TableIndexT	inRow ) const;
Parameters:

This method has the following parameters:

 

TableIndexT  
inRow  
The cell row to check.  

Return:

Boolean indicating whether the cell includes the row or not.

PointsAreClose()

Purpose:

Indicate whether the two points are close enough to be part of a multi-click. Points are in Local coordinates.

Points must meet the standard test (inherited function) as well as be inside the same cell.

Access :

Virtual, Public

Prototype:

virtual Boolean PointsAreClose(

	Point	inFirstPt,

	Point	inSecondPt ) const;
Parameters:

This method has the following parameters:

 

Point  
inFirstPt  
The first point.  
Point  
inSecondPt  
The second point.  

Return:

Return true if the two points are close enough, else return false.

RefreshCell()

Purpose:

Invalidate the area occupied by the specified cell so that its contents will be redrawn during the next update event

Access :

Virtual, Public

Prototype:

virtual void RefreshCell(

	const STableCell	&inCell );
Parameters:

This method has the following parameters:

 

STableCell&  
inCell  
The cell.  

Return:

None

RefreshCellRange()

Purpose:

Invalidate a rectangular block of cells so that their contents will be redrawn during the next update event.

Access :

Virtual, Public

Prototype:

virtual void RefreshCellRange(

	const STableCell	&inTopLeft,

	const STableCell	&inBotRight );
Parameters:

This method has the following parameters:

 

STableCell&  
inTopLeft  
The top left cell.  
STableCell&  
inBotRight  
The bottom right cell.  

Return:

None

RemoveAllCols()

Purpose:

Remove all columns in a table.

Access :

Virtual, Public

Prototype:

virtual void RemoveAllCols(

	Boolean		inRefresh );
Parameters:

This method has the following parameters:

 

Boolean  
inRefresh  
Whether to refresh or not.  

Return:

None

RemoveAllRows()

Purpose:

Remove all rows from a table.

Access :

Virtual, Public

Prototype:

virtual void RemoveAllRows(

	Boolean		inRefresh );
Parameters:

This method has the following parameters:

 

Boolean  
inRefresh  
Whether to refresh or not.  

Return:

None

RemoveCols()

Purpose:

Delete columns from a TableView

Access :

Virtual, Public

Prototype:

virtual void RemoveCols(

	UInt32		inHowMany,

	TableIndexT	inFromCol,

	Boolean		inRefresh );
Parameters:

This method has the following parameters:

 

UInt32  
inHowMany  
How many columns to delete.  
TableIndexT  
inFromCol  
The column to start from.  
Boolean  
inRefresh  
Whether or not to refresh.  

Return:

None

RemoveRows()

Purpose:

Delete rows from a TableView

Access :

Virtual, Public

Prototype:

virtual void RemoveRows(

	UInt32		inHowMany,

	TableIndexT	inFromRow,

	Boolean		inRefresh );
Parameters:

This method has the following parameters:

 

UInt32  
inHowMany  
How many rows to delete.  
TableIndexT  
inFromRow  
The row to start from.  
Boolean  
inRefresh  
Whether or not to refresh.  

Return:

None

ScrollCellIntoFrame()

Purpose:

Scroll the TableView as little as possible to move the specified Cell so that it's entirely within the Frame of the TableView.

If Cell is wider and/or taller than Frame, align Cell to left/top of Frame.

Access :

Virtual, Public

Prototype:

virtual void ScrollCellIntoFrame(

	const STableCell	&inCell );
Parameters:

This method has the following parameters:

 

STableCell&  
inCell  
The cell.  

Return:

None

SelectAllCells()

Purpose:

Select all Cells in a Table

Access :

VIrtual, Public

Prototype:

virtual void SelectAllCells();
Parameters:

None

Return:

None

SelectCell()

Purpose:

Add the specified cell to the current selection.

Access :

Virtual, Public

Prototype:

virtual void SelectCell(

	const STableCell	&inCell );
Parameters:

This method has the following parameters:

 

STableCell&  
inCell  
The cell.  

Return:

None

SelectionChanged()

Purpose:

Notification that the cells which are selected has changed

Access :

Virtual, Public

Prototype:

virtual void SelectionChanged();
Parameters:

None

Return:

None

SetCellData()

Purpose:

Specify the data associated with a particular Cell

Access :

Virtual, Public

Prototype:

virtual void SetCellData(

	const STableCell	&inCell,

	const void			*inDataPtr,

	UInt32				inDataSize );
Parameters:

This method has the following parameters:

 

STableCell&  
inCell  
The cell.  
void*  
inDataPtr  
The buffer pointer.  
UInt32  
inDataSize  
The buffer size.  

Return:

None

SetColWidth()

Purpose:

Set the width of the specified columns.

Access :

Virtual, Public

Prototype:

virtual void SetColWidth(

	UInt16		inWidth,

	TableIndexT	inFromCol,

	TableIndexT	inToCol);
Parameters:

This method has the following parameters:

 

UInt16  
inWidth  
The cell width.  
TableIndexT  
inFromCol  
The starting column.  
TableIndexT  
inToCol  
The ending column.  

Return:

None

SetCustomHilite()

Purpose:

Set tha value of the mCustomHilite data member.

Access :

Public

Prototype:

void SetCustomHilite( Boolean inCustom );
Parameters:

This method has the following parameters:

 

Boolean  
inCustom  
The value to set.  

Return:

None

SetDeferAdjustment()

Purpose:

Specify whether to defer adjustment of Table to account for a change in the size of the Table (number or size of rows or columns).

Calling AdjustImageSize() can take a lot of time, especially for large Tables and those with variable row or column sizes. If you are going to make a series of changes to a Table, there's no need to adjust the Image size until after all those changes are made.

Therefore, call SetDeferAdjustment(true) before making your changes, then call SetDeferAdjustment(false) afterwards. Or use the StDeferTableAdjustment stack-based class.

Access :

Public

Prototype:

void SetDeferAdjustment( Boolean		inDefer );
Parameters:

This method has the following parameters:

 

Boolean  
inDefer  
Whether to defer or not.  

Return:

None

SetRowHeight()

Purpose:

Set the height of the specified rows.

Access :

Virtual, Public

Prototype:

virtual void SetRowHeight( UInt16		inHeight,

	TableIndexT	inFromRow,

	TableIndexT	inToRow );
Parameters:

This method has the following parameters:

 

UInt16  
inHeight  
The height to use.  
TableIndexT  
inFromRow  
The starting row.  
TableIndexT  
inToRow  
The ending row.  

Return:

None

SetTableGeometry()

Purpose:

Specify the Geometry for a TableView.

The Geometry determines the dimensions of the Cells in the Table

Access :

Virtual, Public

Prototype:

virtual void SetTableGeometry(

	LTableGeometry	*inTableGeometry );
Parameters:

This method has the following parameters:

 

LTableGeometry*  
inTableGeometry  
The table geometry object.  

Return:

None

SetTableSelector()

Purpose:

Specify the Selector for a TableView. The Selector stores and controls which Cells in a Table are selected. This sets the value of mTableSelector.

Access :

Virtual, Public

Prototype:

virtual void SetTableSelector(

	LTableSelector	*inTableSelector );
Parameters:

This method has the following parameters:

 

LTableSelector*  
inTableSelector  
The table selector pointer.  

Return:

None

SetTableStorage()

Purpose:

Specify the Storage for a TableView. The Storage holds the data for each Cell in a Table. This sets the value of mTableStorage.

Access :

Virtual, Public

Prototype:

virtual void SetTableStorage(

	LTableStorage	*inTableStorage );
Parameters:

This method has the following parameters:

 

LTableStorage*  
inTableStorage  
The table storage pointer.  

Return:

None

SetUseDragSelect()

Purpose:

Indicate whether to use drag select or not. This sets the value of the mUseDragSelect data member.

Access :

Public

Prototype:

void SetUseDragSelect( Boolean inUseIt);
Parameters:

This method has the following parameters:

 

Boolean  
inUseIt  
The value to set.  

Return:

None

UnselectAllCells()

Purpose:

Unselect all currently selected cells so there is no selection

Access :

Virtual, Public

Prototype:

virtual void UnselectAllCells();
Parameters:

None

Return:

None

UnselectCell()

Purpose:

Remove the specified cell from the current selection

Access :

Virtual, Public

Prototype:

virtual void UnselectCell(const STableCell	
&inCell);
Parameters:

This method has the following parameters:

 

STableCell&  
inCell  
The cell.  

Return:

None

mRows

Purpose:

Data member that contains number of rows.

Access :

Protected

Prototype:

TableIndexT mRows;

mCols

Purpose:

Data member that contains number of columns.

Access :

Protected

Prototype:

TableIndexT mCols;

mTableGeometry

Purpose:

Storage for the table geometry.

Access :

Protected

Prototype:

LTableGeometry *mTableGeometry;

mTableSelector

Purpose:

Storage for the table selector

Access :

Protected

Prototype:

LTableSelector *mTableSelector;

mTableStorage

Purpose:

Table storage.

Access :

Protected

Prototype:

LTableStorage *mTableStorage;

mUseDragSelect

Purpose:

Storage for whether or not to use drag select.

Access :

Protected

Prototype:

Boolean mUseDragSelect;

mCustomHilite

Purpose:

Whether to use custom hilite or not.

Access :

Protected

Prototype:

Boolean mCustomHilite;

mDeferAdjustment

Purpose:

Whether to defer adjustments to the table or not.

Access :

Protected

Prototype:

Boolean mDeferAdjustment;

 


[ First ]  [ Previous ]  [ Next ]  [ Last ]  [ Manuals ]

Visit the Metrowerks website at: http://www.metrowerks.com
For assistance contact Metrowerks Technical Support at: cw_support@metrowerks.com
Copyright © 2000, Metrowerks Corp. All rights reserved.

Last updated: July 21, 2000