Class: TCanvasGraphicID

Declaration: GrafEdit.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCollectibleGlobalID

Inherited By:

None.

Purpose:

Uniquely identifies a canvas graphic.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive to introduce extended identification schemes.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TCanvasGraphicID::TCanvasGraphicID

TCanvasGraphicID ()
TCanvasGraphicID (unsigned char)
TCanvasGraphicID (const TCanvasGraphicID &)

Interface Category:

API.

Purpose:

Default constructor.
Constructs special IDs.
Copy constructor.

Calling Context:

Called to create new IDs and by the stream-in operators and constructors of derived classes.
Called to create new special IDs.
Called to copy an object.

Parameters:

Takes no parameters.
unsigned char -An integer between the values of 0 and 255.
const TCanvasGraphicID & -Another ID.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Special IDs are used to denote special circumstances such as invalid or not found. Clients can define up to 256 such values. For example, TCanvasGraphicID::kInvalidID is defined as TCanvasGraphicID (0).

Member Function: TCanvasGraphicID::~TCanvasGraphicID

virtual ~ TCanvasGraphicID ()

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

TCanvasGraphicID & operator =(const TCanvasGraphicID &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TCanvasGraphicID & -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.

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