Class: TCreateAndPublishAnchorCommand

Declaration: LinkingCommands.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCommandOn

Inherited By:

None.

Purpose:

TCreateAndPublishAnchorCommand derives from TCommandOn<TModelSelection> and implements the command to create an anchor reference from a selection and publish it to the clipboard.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive from this class if an alternate way to save the anchor reference is devised or some more check has to be done before this command is executed.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TCreateAndPublishAnchorCommand::TCreateAndPublishAnchorCommand

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

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 a reference link.
const TCreateAndPublishAnchorCommand & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCreateAndPublishAnchorCommand::~TCreateAndPublishAnchorCommand

virtual ~ TCreateAndPublishAnchorCommand ()

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

virtual bool HandleCanDo (const TModelSelection &) const

Interface Category:

API.

Purpose:

Computes and returns whether or not this command can be done on the specified selection. Can override this member function if more check needs to be done.

Calling Context:

Called by TCommandOn.

Parameters:

const TModelSelection & -The selection on which to determine if this command can be done.

Return Value:

Returns true if the command can be done on the specified selection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCreateAndPublishAnchorCommand::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: TCreateAndPublishAnchorCommand::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: TCreateAndPublishAnchorCommand::HandleDoBegin

virtual void HandleDoBegin (TModelSelection &)

Interface Category:

API.

Purpose:

Creates an anchor from the selection and publishes the anchor to the clipboard. Override this member function if a new scheme is needed to publish the anchor.

Calling Context:

Called by TCommandOn.

Parameters:

TModelSelection & -The selection from which to create and publish an anchor.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCreateAndPublishAnchorCommand::HandleUndo

virtual void HandleUndo (TModelSelection &)

Interface Category:

API.

Purpose:

Undoes the create and publish command on the specified selection. This function does nothing.

Calling Context:

Called by TCommandOn.

Parameters:

TModelSelection & -The selection for which to undo the command.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCreateAndPublishAnchorCommand::HandleRedo

virtual void HandleRedo (TModelSelection &)

Interface Category:

API.

Purpose:

Redoes the create and publish command on the specified selection. This function does nothing.

Calling Context:

Called by TCommandOn.

Parameters:

TModelSelection & -The selection for which to redo the 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.