Class: TCutToClipboardCommand

Declaration: ClipboardCommands.h

Taxonomy Categories:

Member Functions:

TCutToClipboardCommand
operator=
~TCutToClipboardCommand
operator>>=
operator<<=

Interface Category:

API.

Inherits From:

TOrphanDataCommand

Inherited By:

None.

Purpose:

The TCutToClipboardCommand class is the command used to copy the selected data to the clipboard. It does this by creating a ModelScrapItem that contains the copied model and putting a simple provider on the clipboard.

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

TCutToClipboardCommand (const TDocumentComponentSelection & theSource)
TCutToClipboardCommand (const TCutToClipboardCommand &)
TCutToClipboardCommand ()

Interface Category:

API.

Purpose:

Creates a cut to clipboard command whose source of data is the specified selection object.
Copy constructor.
Default constructor.

Calling Context:

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

Parameters:

const TDocumentComponentSelection & theSource -The selection to be cut.
const TCutToClipboardCommand & -The object to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws TCompoundDocumentException:: kNILSelection if the input parameter is NIL.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCutToClipboardCommand::operator=

TCutToClipboardCommand & operator =(const TCutToClipboardCommand &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TCutToClipboardCommand & -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: TCutToClipboardCommand::~TCutToClipboardCommand

virtual ~ TCutToClipboardCommand ()

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: TCutToClipboardCommand::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: TCutToClipboardCommand::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.