Class: TPrintMedia

Declaration: PageDescription.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TPrinterAttribute

Inherited By:

None.

Purpose:

Print Media is a printing attribute. It is used to characterize the media for a printer (for example paper, film, transparencies, cardboard, and so on). This class is used to generically classify the physical or tangible properties of the media by name or as an enclosure rather than trying to characterize all possible manifestations of media. Media is thus differentiated primarily by name.

Instantiation:

Abstract class; do not instantiate.

Deriving Classes:

Clients derive from this class to create various types of named printer media. In deriving from this class, clients should override GetName (inherited from TPrinterAttribute) to provide a name for the media being represented.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TPrintMedia::~TPrintMedia

virtual ~ TPrintMedia ()

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

TPrintMedia & operator =(const TPrintMedia &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TPrintMedia & -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: TPrintMedia::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns a hash value for this object. Derived classes need to override this.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A value of type long is returned.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintMedia::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream the object is streamed in from.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintMedia::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 stream the object is streamed out to.

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: TPrintMedia::TPrintMedia

TPrintMedia ()
TPrintMedia (const TPrintMedia &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators .
Called to copy an object.

Parameters:

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

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

These constructors are protected.

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