Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
MCollectible
Inherited By:
None.
Purpose:
TTableCell is a class that functions as the address of a TTableItem within a list. The address of the item is represented with row and column information.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Do not derive any classes from TTableCell.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
- TTableCell ()
- TTableCell (unsigned long column, unsigned long row, bool isSelected =false, bool canSelect =true)
- TTableCell (const TGPoint & aPoint, bool isSelected =false, bool canSelect =true)
- TTableCell (const TTableCell & aCell)
Interface Category:
API.
Purpose:
- Default constructor.
- Creates a table cell with the specified parameters.
- Creates a table cell with the specified parameters.
- Copy constructor.
Calling Context:
- Called to create a TTableCell suitable for streaming into.
- Called to create a TTableCell with the specified parameters.
- Called to create a TTableCell with the specified parameters.
- Called to copy an object.
Parameters:
- Takes no parameters.
- unsigned long column -Assign a column number for this cell.
- unsigned long row -Assign a row number for this cell.
- bool isSelected -default is false -If true, this cell is set to selected.
- bool canSelect =true -If true, this cell can be selected. If false, this cell cannot be selected.
- const TGPoint & aPoint -The cell's location.
- bool isSelected =false -If true, this cell is set to selected.
- bool canSelect =true -If true, this cell can be selected. If false, this cell cannot be selected.
- const TTableCell & aCell -The object to be copied.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual ~ TTableCell ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableCell::SetRow
void SetRow (unsigned long row)
Interface Category:
API.
Purpose:
Sets this cell's row to the specified value.
Calling Context:
Call this function directly to set this cell's row.
Parameters:
- unsigned long row -The row to set.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableCell::SetColumn
void SetColumn (unsigned long column)
Interface Category:
API.
Purpose:
Sets this cell's column to the specified value.
Calling Context:
Call this function directly to set this cell's column.
Parameters:
- unsigned long column -The column to set.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableCell::GetRow
unsigned long GetRow () const
Interface Category:
API.
Purpose:
Returns this cell's row.
Calling Context:
Call this function directly to obtain this cell's row.
Parameters:
Return Value:
Returns this cell's row.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableCell::GetColumn
unsigned long GetColumn () const
Interface Category:
API.
Purpose:
Returns this cell's column.
Calling Context:
Call this function directly to obtain this cell's column.
Parameters:
Return Value:
Returns this cell's column.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableCell::Set
void Set (unsigned long column, unsigned long row)
Interface Category:
API.
Purpose:
Sets this cell's row and column to the specified values.
Calling Context:
Call this function directly to set this cell's row and column to the specified values.
Parameters:
- unsigned long column -The column.
- unsigned long row -The row.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableCell::CanSelect
virtual bool CanSelect () const
Interface Category:
API.
Purpose:
Returns true if this cell can be selected.
Calling Context:
Call this function directly to determine if this cell can be selected.
Parameters:
Return Value:
Returns true if this cell can be selected. Returns false if this cell cannot be selected.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableCell::SetCanSelect
virtual void SetCanSelect (bool canSelect =true)
Interface Category:
API.
Purpose:
Enables or disables this cell's ability to be selected.
Calling Context:
Call this function directly to enable or disable this cell's selectability.
Parameters:
- bool canSelect =true -If true, this cell will be selectable. If false, this cell will not be selectable.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableCell::IsValid
virtual bool IsValid () const
Interface Category:
API.
Purpose:
Returns true if this table cell has a valid row and column.
Calling Context:
Call this function directly to determine if this table cell has a valid row and column.
Parameters:
Return Value:
Returns true of this table cell has a valid row and column.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableCell::SetInvalid
virtual void SetInvalid ()
Interface Category:
API.
Purpose:
Sets this table cell's row and column to invalid.
Calling Context:
Call this function directly to set this table cell's row and column to invalid.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableCell::Hash
virtual long Hash () const
Interface Category:
API.
Purpose:
Returns a hash value for this object.
Calling Context:
Call this function directly to return a hash value for this object.
Parameters:
Return Value:
Returns a hash value for this object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableCell::operator<<=
virtual TStream & operator <<= (TStream & fromWhere)
Interface Category:
API.
Purpose:
Stream-in operator.
Calling Context:
Called to stream in data.
Parameters:
- TStream & fromWhere -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 original version.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableCell::operator>>=
virtual TStream & operator >>=(TStream & toWhere) const
Interface Category:
API.
Purpose:
Stream-out operator.
Calling Context:
Called to stream out data.
Parameters:
- TStream & toWhere -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: TTableCell::operator=
- virtual TTableCell & operator =(const TTableCell & aCell)
- virtual TTableCell & operator =(const TGPoint & aCell)
Interface Category:
API.
Purpose:
- Assignment operator.
- Assigns a TTableCell to a TGPoint.
Calling Context:
- Called when an object is assigned to another compatible object.
- Called when this object is assigned to a TGPoint.
Parameters:
- const TTableCell & aCell -The object to be copied.
- const TGPoint & aCell -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: TTableCell::operatorTGPoint
operator TGPoint ()
Interface Category:
API.
Purpose:
Allows a TTableCell to be reference as a TGPoint.
Calling Context:
Called automatically whenever a TTableCell is referenced as a TGPoint.
Parameters:
Return Value:
Implicitly int.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableCell::operator<
virtual bool operator < (const TTableCell & aCell)
Interface Category:
API.
Purpose:
Called to compare the position of two table cells.
Calling Context:
Called to compare two table cell position.
Parameters:
- const TTableCell & aCell -The table cell to compare to this table cell.
Return Value:
Returns true if the specified table cell position is less than this table cell.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
This member function compares row position first, then column position.
Member Function: TTableCell::operator>
virtual bool operator >(const TTableCell & aCell)
Interface Category:
API.
Purpose:
Returns true if the specified table cell position is greater than this table cell.
Calling Context:
Called to compare the position of two table cells.
Parameters:
- const TTableCell & aCell -The table cell to compare to this table cell.
Return Value:
Returns true if the specified table cell's position is greater than this table cell.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
This member function compares row position first, then column position.
Member Function: TTableCell::PrintCell
virtual void PrintCell (char aString [ 40 ]) const
Interface Category:
API.
Purpose:
Prints the table cell position.
Calling Context:
Called to print out the table cell position.
Parameters:
- char aString [ 40 ] -Text to precede the table cell's position.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
This member function should only be used by Taligent internal developer only. This member function might become unavailable to the global public.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.