Class: TGUIToolCommandBinding

Declaration: GUICompoundDocumentToolSupport.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TDocumentComponentCommandBinding, MGUIDocumentComponentCommandBinding

Inherited By:

None.

Purpose:

TGUIToolCommandBinding implements a concrete that wraps a TToolCommandBinding and can be used as an MGUIDocumentComponentCommandBinding.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

No special rule. A derived class can specialize any of the HandleXXX member functions.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TGUIToolCommandBinding::TGUIToolCommandBinding

TGUIToolCommandBinding (TToolCommandBinding *, const TGUIBundle &)
TGUIToolCommandBinding (const TGUIToolCommandBinding &)
TGUIToolCommandBinding ()

Interface Category:

API.

Purpose:

Creates a new TGUIToolCommandBinding that wraps the specified TToolCommandBinding and has the specified GUI bundle.
Copy constructor.
Default constructor.

Calling Context:

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

Parameters:

TToolCommandBinding * -The tool command binding to be wrapped by the new object.
const TGUIBundle & -The GUI bundle for the new object.
const TGUIToolCommandBinding & -The object copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIToolCommandBinding::~TGUIToolCommandBinding

virtual ~ TGUIToolCommandBinding ()

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: TGUIToolCommandBinding::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: TGUIToolCommandBinding::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: TGUIToolCommandBinding::IsThisIncrementRequired

virtual bool IsThisIncrementRequired () const

Interface Category:

API.

Purpose:

Indicates if the value of this increment of the command is necessary for reconstructing the command's execution.

Calling Context:

Called to determine if the command increment needs to be streamed to the command log.

Parameters:

Takes no parameters.

Return Value:

Always returns true.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIToolCommandBinding::StreamOutIncrementDelta

virtual void StreamOutIncrementDelta (TStream &) const

Interface Category:

API.

Purpose:

Streams the change from a DoIncrement.

Calling Context:

Called to log the effects of an incremental command

Parameters:

TStream & -The destination stream.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIToolCommandBinding::StreamInIncrementDelta

virtual void StreamInIncrementDelta (TStream &)

Interface Category:

API.

Purpose:

Restores the effect of a DoIncrement from a stream.

Calling Context:

Called to stream in an incremental delta from a command log.

Parameters:

TStream & -The source stream.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIToolCommandBinding::AdoptToolCommandBinding

void AdoptToolCommandBinding (TToolCommandBinding *)

Interface Category:

API.

Purpose:

Adopts the specified TToolCommandBinding. This function changes the tool command binding wrapped by this object.

Calling Context:

You can call this function directly.

Parameters:

TToolCommandBinding * -The new tool command binding.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIToolCommandBinding::OrphanToolCommandBinding

TToolCommandBinding * OrphanToolCommandBinding ()

Interface Category:

API.

Purpose:

Orphans this object's wrapped TToolCommandBinding. The caller is responsible for the returned object's destruction.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the orphaned object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIToolCommandBinding::operator=

TGUIToolCommandBinding & operator =(const TGUIToolCommandBinding &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TGUIToolCommandBinding & -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: TGUIToolCommandBinding::HandleDo

virtual void HandleDo ()

Interface Category:

API.

Purpose:

Performs the command. This function delegates to the wrapped TToolCommandBinding.

Calling Context:

Called only from Do.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TGUIToolCommandBinding::HandleDoBegin

virtual void HandleDoBegin ()

Interface Category:

API.

Purpose:

Starts command execution. This function delegates to the wrapped TToolCommandBinding.

Calling Context:

Called by DoBegin after command state has been verified.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TGUIToolCommandBinding::HandleDoIncrement

virtual void HandleDoIncrement ()

Interface Category:

API.

Purpose:

Performs incremental command functionality. This function delegates to the wrapped TToolCommandBinding.

Calling Context:

Called by DoIncrement after command state has been verified.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TGUIToolCommandBinding::HandleDoEnd

virtual void HandleDoEnd ()

Interface Category:

API.

Purpose:

Cleans up after command execution. This function delegates to the wrapped TToolCommandBinding.

Calling Context:

Called by DoEnd after command state has been verified.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TGUIToolCommandBinding::HandleUndo

virtual void HandleUndo ()

Interface Category:

API.

Purpose:

Undoes the effect of a reversible command. This function delegates to the wrapped TToolCommandBinding.

Calling Context:

Called by Undo after command state has been verified.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TGUIToolCommandBinding::HandleRedo

virtual void HandleRedo ()

Interface Category:

API.

Purpose:

Restores the effect of an undone command. This function delegates to the wrapped TToolCommandBinding.

Calling Context:

Called by Redo after command state has been verified.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TGUIToolCommandBinding::HandleCommit

virtual void HandleCommit ()

Interface Category:

API.

Purpose:

Commits a command that is in the done state. This function delegates to the wrapped TToolCommandBinding.

Calling Context:

Called by Commit after the command state is determined to be Done.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TGUIToolCommandBinding::HandleCanDo

virtual bool HandleCanDo () const

Interface Category:

API.

Purpose:

Returns whether or not the command is currently able to be executed. This function delegates to the wrapped TToolCommandBinding.

Calling Context:

Called by CanDo after the state of the command has been verified.

Parameters:

Takes no parameters.

Return Value:

Returns true if the command can be executed; false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TGUIToolCommandBinding::HandleCanUndo

virtual bool HandleCanUndo () const

Interface Category:

API.

Purpose:

Returns whether or not the effects of the command is currently able to be reversed. This function delegates to the wrapped TToolCommandBinding.

Calling Context:

Called by CanUndo after the state of the command has been verified.

Parameters:

Takes no parameters.

Return Value:

Returns true if the command can be reversed; false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TGUIToolCommandBinding::HandleCanRedo

virtual bool HandleCanRedo () const

Interface Category:

API.

Purpose:

Returns whether or not the effects of an undone command can currently be restored. This function delegates to the wrapped TToolCommandBinding.

Calling Context:

Called by CanRedo after the state of the command has been verified.

Parameters:

Takes no parameters.

Return Value:

Returns true if the command can be restored; false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TGUIToolCommandBinding::HandleFixupDataBeforeDo

virtual void HandleFixupDataBeforeDo ()

Interface Category:

API.

Purpose:

Fixes up the data before executing the command. This is used by commands that use model data that must be fixed up prior to passing the data to a target selection. This function does nothing.

Calling Context:

Called only by FixupDataBeforeDo.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TGUIToolCommandBinding::HandleGetModelSelection

virtual TModelSelection * HandleGetModelSelection ()
virtual const TModelSelection * HandleGetModelSelection () const

Interface Category:

API.

Purpose:

Returns the model selection if one is bound to this object's wrapped TToolCommandBinding. If the wrapped object is bound to an anchor, the anchor's selection is returned.
Returns a const pointer to the model selection if one is bound to this object's wrapped TToolCommandBinding. If the wrapped object is bound to an anchor, the anchor's selection is returned.

Calling Context:

Called only from derived classes.
Called only from derived classes.

Parameters:

Takes no parameters.
Takes no parameters.

Return Value:

Returns the model selection bound to this object's wrapped TToolCommandBinding. This function returns NIL if no model selection or model anchor is bound.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIToolCommandBinding::HandleGetPresenterStateSelection

virtual TPresenterStateSelection * HandleGetPresenterStateSelection ()
virtual const TPresenterStateSelection * HandleGetPresenterStateSelection () const

Interface Category:

API.

Purpose:

Returns the presenter state selection, if one is bound to this command's wrapped TToolCommandBinding object.
Returns a const pointer to the presenter state selection, if one is bound to this command's wrapped TToolCommandBinding object.

Calling Context:

Called only from derived classes.
Called only from derived classes.

Parameters:

Takes no parameters.
Takes no parameters.

Return Value:

Returns the presenter state selection, if one is bound to this command's wrapped TToolCommandBinding object. Returns NIL if no presenter state selection is bound.
Returns a const pointer to the presenter state selection, if one is bound to this command's wrapped TToolCommandBinding object. Returns NIL if no presenter state selection is bound.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIToolCommandBinding::InternalGetPresenterStateSelection

TPresenterStateSelection * InternalGetPresenterStateSelection ()
const TPresenterStateSelection * InternalGetPresenterStateSelection () const

Interface Category:

API.

Purpose:

Return the bound presenter state selection.
Return the count bound presenter state selection.

Calling Context:

Called by TGUIToolCommandBinding.
Called by TGUIToolCommandBinding.

Parameters:

Takes no parameters.
Takes no parameters.

Return Value:

TPresenterStateSelection * -The bound presenter state selection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIToolCommandBinding::InternalGetModelSelection

TModelSelection * InternalGetModelSelection ()
const TModelSelection * InternalGetModelSelection () const

Purpose:

Return the bound model selection.
Return the count bound model selection.

Calling Context:

Called by TGUIToolCommandBinding.
Called by TGUIToolCommandBinding.

Parameters:

Takes no parameters.
Takes no parameters.

Return Value:

TModelSelection * -The bound model selection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIToolCommandBinding::HandleGetUndoType

virtual TCommonCommand :: UndoType HandleGetUndoType () const

Interface Category:

API.

Purpose:

Returns the undo type for the bound command.

Calling Context:

Called by TAbstractDocumentComponentCommandBinding.

Parameters:

Takes no parameters.

Return Value:

TCommonCommand :: UndoType -The undo type.

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.