Class: TPasteClipboardDataCommand

Declaration: ClipboardCommands.h

Taxonomy Categories:

Member Functions:

TPasteClipboardDataCommand
operator=
~TPasteClipboardDataCommand
operator>>=
operator<<=

Interface Category:

API.

Inherits From:

TAbsorbDataCommand

Inherited By:

None.

Purpose:

The TPasteClipboardDataCommand class is the command used to paste the clipboard's current data into a document.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TPasteClipboardDataCommand::TPasteClipboardDataCommand

TPasteClipboardDataCommand (MDataExchanger & theDestination)
TPasteClipboardDataCommand (const TPasteClipboardDataCommand &)
TPasteClipboardDataCommand ()

Interface Category:

API.

Purpose:

Creates a paste command to paste the clipboard data into the specified destination.
Copy constructor.
Default constructor.

Calling Context:

You can call this function directly.
Called to copy an object.
Called by the stream-in operators.

Parameters:

MDataExchanger & theDestination -The destination for the paste operation.
const TPasteClipboardDataCommand & -The object to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

1.Throws TCompoundDocumentException::kTypeNegotiationFailed if the destination accepts non of the data types on the clipboard.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPasteClipboardDataCommand::operator=

TPasteClipboardDataCommand & operator =(const TPasteClipboardDataCommand &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TPasteClipboardDataCommand & -The object to be copied.

Return Value:

Returns a 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: TPasteClipboardDataCommand::~TPasteClipboardDataCommand

virtual ~ TPasteClipboardDataCommand ()

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The stream to which the object streams itself out.

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

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream from which the object streams itself in.

Return Value:

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

Exceptions:

Throws a TInvalidVersionError if the version of the object on the stream is unknown to the version of the shared library installed.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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