Class: TTableItem

Declaration: ScrollingListControl.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

TTableItem is a class that represents a list item in a table. TTableItem defines protocol for selecting, enabling and drawing the item.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TTableItem.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TTableItem::TTableItem

TTableItem ()
TTableItem (TLabel * labelToAdopt)
TTableItem (const TTableItem &)

Interface Category:

API.

Purpose:

Default constructor.
Creates a TTableItem with the specified label.
Copy constructor.

Calling Context:

Called to create a TTableItem suitable for streaming into.
Called to create a TTableItem with a specific label.
Called to copy an object.

Parameters:

Takes no parameters.
TLabel * labelToAdopt -The label for the table item.
const TTableItem & -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: TTableItem::~TTableItem

~ TTableItem ()

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: TTableItem::operator=

TTableItem & operator =(const TTableItem &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TTableItem & -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: TTableItem::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: TTableItem::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 supported.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTableItem::AdoptLabel

virtual void AdoptLabel (TLabel * labelToAdopt)

Interface Category:

API.

Purpose:

Adopts the specified label.

Calling Context:

Call this function directly to adopt the label.

Parameters:

TLabel * label -The label to adopt.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTableItem::OrphanLabel

virtual TLabel * OrphanLabel ()

Interface Category:

API.

Purpose:

Orphans the current label.

Calling Context:

Call this function directly to orphan the current label.

Parameters:

Takes no parameters.

Return Value:

A pointer to the orphaned label.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTableItem::GetLabel

virtual TLabel * GetLabel () const

Interface Category:

API.

Purpose:

Returns a pointer to the current label.

Calling Context:

Call this function directly to obtain the current label.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to the current label.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTableItem::SetEnabled

virtual void SetEnabled (bool enabled)

Interface Category:

API.

Purpose:

Enables or disables this item, depending on the value of the parameter.

Calling Context:

Call this function directly to enable or disable this item.

Parameters:

bool enabled -If set to true, this item is enabled. If set to false, the item is disabled.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTableItem::IsEnabled

virtual bool IsEnabled () const

Interface Category:

API.

Purpose:

Returns true if this item is enabled. Returns false if this item is disabled.

Calling Context:

Call this function directly to determine if this item is enabled.

Parameters:

Takes no parameters.

Return Value:

Returns true if this item is enabled. Returns false if this item is disabled.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTableItem::SetSelected

virtual void SetSelected (bool selected)

Interface Category:

API.

Purpose:

Selects or deselects this item, depending on the value of the parameter.

Calling Context:

Call this function directly to select or deselect this item.

Parameters:

bool selected -If set to true, this item will be selected. If set to false, this item will be deselected.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTableItem::IsSelected

virtual bool IsSelected () const

Interface Category:

API.

Purpose:

Returns true if this item is selected. Returns false if this item is deselected.

Calling Context:

Call this function directly to determine the selection state of this object.

Parameters:

Takes no parameters.

Return Value:

Returns true if this item is selected. Returns false if this item is deselected.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTableItem::SetOwner

virtual void SetOwner (MTableControlState * state)

Interface Category:

API.

Purpose:

Sets the specified control state as the owner of this item.

Calling Context:

Call this function directly to set ownership of this item.

Parameters:

MTableControlState * state -The control state that will own this item.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTableItem::GetOwner

virtual MTableControlState * GetOwner () const

Interface Category:

API.

Purpose:

Returns a pointer to the control state that owns this item.

Calling Context:

Call this function directly to obtain the control state that owns this item.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to the control state that owns this item.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTableItem::Draw

virtual void Draw (TGrafPort &, const TGRect & bounds) const
virtual void Draw (TGrafPort &) const

Interface Category:

API.

Purpose:

Draws this item to the specified port with the specified bounds.
Draws this item to the specified port.

Calling Context:

Called to draw this object.
Called to draw this object.

Parameters:

TGrafPort & -The port to which this item is drawn.
const TGRect & bounds -The bounds of this item.
TGrafPort & -The port to which this item is drawn.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTableItem::SetAutoRedraw

virtual void SetAutoRedraw (bool redraw)

Interface Category:

API.

Purpose:

Enables or disables automatic redrawing of this item.

Calling Context:

Call this function directly to enable or disable automatic redrawing of this item.

Parameters:

bool redraw -If set to true, automatic redrawing is enabled. If set to false, automatic redrawing is disabled.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTableItem::DoAutoRedraw

virtual bool DoAutoRedraw () const

Interface Category:

API.

Purpose:

Returns true if automatic redraw is enabled, false if it is disabled.

Calling Context:

Call this function directly to determine if automatic redraw is enabled or disabled.

Parameters:

Takes no parameters.

Return Value:

Returns true if automatic redraw is enabled, false if it is disabled.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTableItem::RedrawItem

virtual void RedrawItem ()

Interface Category:

API.

Purpose:

Redraws this item.

Calling Context:

Call this function directly to redraw this item.

Parameters:

Takes no parameters.

Return Value:

None.

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.