Class: TGUIDocumentComponentCommandBindingTo

Declaration: GUICompoundDocumentCommand.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TDocumentComponentCommandBindingTo, MGUIDocumentComponentCommandBinding

Inherited By:

None.

Purpose:

TGUIDocumentComponentCommandBindingTo derives from TDocumentComponentCommandBindingTo and MGUIDocumentComponentCommandBinding and generates a concrete template class that should be used to bind a command and a selection for execution by the document. TGUIDocumentComponentCommandBindingTo adds a name label, and current selection update support to TDocumentComponentCommandBindingTo.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None provided.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TGUIDocumentComponentCommandBindingTo::TGUIDocumentComponentCommandBindingTo

TGUIDocumentComponentCommandBindingTo ()
TGUIDocumentComponentCommandBindingTo (TCommandOn < ATarget > * adoptCommand, ATarget * adoptTarget, const TGUIBundle & guiBundle, const TText & name)
TGUIDocumentComponentCommandBindingTo (TCommandOn < ATarget > * adoptCommand, ATarget * adoptTarget, const TGUIBundle & guiBundle, TLabel * nameLabelToAdopt)
TGUIDocumentComponentCommandBindingTo (TCommandOn < ATarget > * adoptCommand, const TModelAnchorReference &, const TGUIBundle & guiBundle, TLabel * nameLabelToAdopt, EAnchorUse =kUseSelection)
TGUIDocumentComponentCommandBindingTo (const TGUIDocumentComponentCommandBindingTo < ATarget > &)

Interface Category:

API.

Purpose:

Default constructor.
Constructs a binding with a specific command, selection target and label.
Constructs a binding with a specific command, selection target and label.
Constructs a binding with a specific command, anchor target and label.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to construct new command binding.
Called to construct new command binding.
Called to construct new command binding.
Called to copy an object.

Parameters:

Takes no parameters.
TCommandOn < ATarget > * adoptCommand -The command to execute.
ATarget * adoptTarget -The selection target.
const TGUIBundle & guiBundle -The presenter's GUI bundle.
const TText & name -The regular command label for the new command binding.
TCommandOn < ATarget > * adoptCommand -The command to execute.
ATarget * adoptTarget -The selection target.
const TGUIBundle & guiBundle -The presenter's GUI bundle.
TLabel * nameLabelToAdopt -The name label for the new command binding.
TCommandOn < ATarget > * adoptCommand -The command to execute.
const TModelAnchorReference & -The anchor target.
const TGUIBundle & guiBundle -The presenter's GUI bundle.
TLabel * nameLabelToAdopt -The name label for the new command binding.
EAnchorUse =kUseSelection -The anchor use indicator.
const TGUIDocumentComponentCommandBindingTo < ATarget > & -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDocumentComponentCommandBindingTo::~TGUIDocumentComponentCommandBindingTo

virtual ~ TGUIDocumentComponentCommandBindingTo ()

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

TGUIDocumentComponentCommandBindingTo < ATarget > & operator =(const TGUIDocumentComponentCommandBindingTo < ATarget > &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TGUIDocumentComponentCommandBindingTo < ATarget > & -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: TGUIDocumentComponentCommandBindingTo::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: TGUIDocumentComponentCommandBindingTo::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: TGUIDocumentComponentCommandBindingTo::HandleGetModelSelection

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

Interface Category:

API.

Purpose:

Handles the retrieval of the bound model selection.
Handles the retrieval of the bound model selection.

Calling Context:

Called from GetModelSelection.
Called from GetModelSelection.

Parameters:

Takes no parameters.
Takes no parameters.

Return Value:

Returns the bound model selection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function overrides MGUIDocumentComponentCommandBinding pure virtual function of the same name.

Member Function: TGUIDocumentComponentCommandBindingTo::HandleGetPresenterStateSelection

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

Interface Category:

API.

Purpose:

Handles the retrieval of the bound presenter state selection.
Handles the retrieval of the bound presenter state selection.

Calling Context:

Called from GetPresenterStateSelection.
Called from GetPresenterStateSelection.

Parameters:

Takes no parameters.
Takes no parameters.

Return Value:

Returns the bound presenter state selection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function overrides MGUIDocumentComponentCommandBinding pure virtual function of the same name.

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