Class: TPasteAsLinkCommand

Declaration: LinkingCommands.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCommandOn

Inherited By:

None.

Purpose:

TPasteAsLinkCommand derives from TCommandOn<MDataExchanger> and implements a command to paste the contents of the clipboard as a link. Links can be pasted as data or reference link.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TPasteAsLinkCommand::TPasteAsLinkCommand

TPasteAsLinkCommand (bool isReferenceLink =false)
TPasteAsLinkCommand (const TPasteAsLinkCommand &)

Interface Category:

API.

Purpose:

Creates a new command.
Copy constructor.

Calling Context:

Called by any client object.
Called to copy an object.

Parameters:

bool isReferenceLink =false -Indicates whether or not the new command is to create a reference link.
const TPasteAsLinkCommand & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPasteAsLinkCommand::~TPasteAsLinkCommand

virtual ~ TPasteAsLinkCommand ()

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: TPasteAsLinkCommand::HandleCanDo

virtual bool HandleCanDo (const MDataExchanger &) const

Interface Category:

API.

Purpose:

Computes and returns whether or not this command can be done on the specified data exchanger's current selection.

Calling Context:

Called by any client object.

Parameters:

const MDataExchanger & -The data exchanger on which to determine if this command can be done.

Return Value:

Returns true if the command can be done on the specified data exchanger's current selection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPasteAsLinkCommand::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: TPasteAsLinkCommand::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.

Member Function: TPasteAsLinkCommand::HandleDoBegin

virtual void HandleDoBegin (MDataExchanger &)

Interface Category:

API.

Purpose:

Does the command on the specified data exchanger. This function pastes the contents of the clipboard as a link into the specified data exchanger.

Calling Context:

Called by TCommandOn.

Parameters:

MDataExchanger & -The data exchanger on which to perform the command.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPasteAsLinkCommand::HandleUndo

virtual void HandleUndo (MDataExchanger &)

Interface Category:

API.

Purpose:

Undoes the command on the specified data exchanger.

Calling Context:

Called by TCommandOn.

Parameters:

MDataExchanger & -The data exchanger for which to undo the paste as link command.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPasteAsLinkCommand::HandleRedo

virtual void HandleRedo (MDataExchanger &)

Interface Category:

API.

Purpose:

Redoes the paste as link command for the specified data exchanger.

Calling Context:

Called by TCommandOn.

Parameters:

MDataExchanger & -The data exchanger for which to redo the paste as link command.

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.