Class: TListSelection

Declaration: ScrollingListAdvanced.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

TListSelection is a class that represents an arbitrary selection of TTableCells.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

You should not derive any classes from TListSelection.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TListSelection::TListSelection

TListSelection ()
TListSelection (const TListSelection & copy)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called to create a TListSelection suitable for streaming into.
Called to copy an object.

Parameters:

Takes no parameters.
const TListSelection & copy -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TListSelection::~TListSelection

virtual ~ TListSelection ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TListSelection::operator=

TListSelection & operator =(const TListSelection & copy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TListSelection & copy -The object to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TListSelection::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The destination stream.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TListSelection::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The source stream.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws TInvalidVersionError if the version of the flattened object is not the same as the original version.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TListSelection::AddCell

virtual void AddCell (const TTableCell & aCell)

Interface Category:

API.

Purpose:

Add the specified cell to this list.

Calling Context:

Call this function directly to add a cell to the list.

Parameters:

const TTableCell & aCell -The cell to add.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TListSelection::RemoveCell

virtual void RemoveCell (const TTableCell & aCell)

Interface Category:

API.

Purpose:

Removes the specified cell from the list. The cell is not destroyed, only the pointer to the cell is destroyed.

Calling Context:

Call this function directly to remove a cell from the list.

Parameters:

const TTableCell & aCell -The cell to remove.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TListSelection::GetCells

virtual const TDequeOf < TTableCell > * GetCells () const

Interface Category:

API.

Purpose:

Returns a pointer to the list of cells.

Calling Context:

Call this function directly to obtain a pointer to the list of cells.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to the list of cells.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TListSelection::GetFixedCell

virtual void GetFixedCell (TTableCell & cell) const

Interface Category:

API.

Purpose:

Fills in the supplied parameter with the cell that has the lowest position in the list.

Calling Context:

Call this function directly to obtain the cell with the lowest position in the list.

Parameters:

TTableCell & cell -Filled in with the cell with the lowest position in the list.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TListSelection::GetMaximumCell

virtual void GetMaximumCell (TTableCell & cell) const

Interface Category:

API.

Purpose:

Fills in the supplied parameter with the cell that has the highest position in the list.

Calling Context:

Call this function directly to obtain the cell with the highest position in the list.

Parameters:

TTableCell & cell -Filled in with the cell with the highest position in the list.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TListSelection::GetMinimumCell

virtual void GetMinimumCell (TTableCell & cell) const

Interface Category:

API.

Purpose:

Fills in the supplied parameter with the cell that has the lowest position in the list.

Calling Context:

Called by GetFixedCell.

Parameters:

TTableCell & cell -Filled in with the cell with the lowest position in the list.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TListSelection::Clear

virtual void Clear ()

Interface Category:

API.

Purpose:

Removes all cells from the list. The original cells are not destroyed, only the pointer to the cell.

Calling Context:

Call this function directly to remove all cell from the list.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TListSelection::IsCellSelected

virtual bool IsCellSelected (const TTableCell & aCell) const

Interface Category:

API.

Purpose:

Returns true if the specified cell is selected, otherwise false is returned.

Calling Context:

Call this function directly to determine if a cell is selected.

Parameters:

const TTableCell & aCell -The cell to check.

Return Value:

Returns true if the specified cell is selected.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.