Class: TUpdateLinkControlState

Declaration: LinkingCommands.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCommandControlState

Inherited By:

None.

Purpose:

TUpdateLinkControlState derives from TCommandControlState and implements the command to update a links. It basically pulls/or pushes data depending on the type of the link.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TUpdateLinkControlState::TUpdateLinkControlState

TUpdateLinkControlState (TGUIBundleConnection * theConnectionToAlias, const TText & name, bool notifyOfSelectionChanged =false)
TUpdateLinkControlState (TGUIBundleConnection * theConnectionToAlias, TLabel * nameLabelToAdopt, bool notifyOfSelectionChanged =false)
TUpdateLinkControlState (TGUIBundle * theBundleToAlias, const TText & name, bool notifyOfSelectionChanged =false)
TUpdateLinkControlState (TGUIBundle * theBundleToAlias, TLabel * nameLabelToAdopt, bool notifyOfSelectionChanged =false)
TUpdateLinkControlState ()

Interface Category:

API.

Purpose:

Creates a named control state for the specified bundle connection.
Creates a named control state for the specified bundle connection.
Creates a named control state for the specified bundle.
Creates a named control state for the specified bundle.
Default constructor.

Calling Context:

Called by any client object.
Called by any client object.
Called by any client object.
Called by any client object.
Called by the stream-in operators.

Parameters:

TGUIBundleConnection * theConnectionToAlias -The bundle connection for the new control state.
const TText & name -The new control state's name.
bool notifyOfSelectionChanged =false -Indicates whether or not the new control state should be notified when the selection changes.
TGUIBundleConnection * theConnectionToAlias -The bundle connection for the new control state.
TLabel * nameLabelToAdopt -The new control state's name.
bool notifyOfSelectionChanged =false -Indicates whether or not the new control state should be notified when the selection changes.
TGUIBundle * theBundleToAlias -The bundle for the new control state.
const TText & name -The new control state's name.
bool notifyOfSelectionChanged =false -Indicates whether or not the new control state should be notified when the selection changes.
TGUIBundle * theBundleToAlias -The bundle for the new control state.
TLabel * nameLabelToAdopt -The new control state's name.
bool notifyOfSelectionChanged =false -Indicates whether or not the new control state should be notified when the selection changes.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUpdateLinkControlState::~TUpdateLinkControlState

virtual ~ TUpdateLinkControlState ()

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: TUpdateLinkControlState::Select

virtual void Select ()

Interface Category:

API.

Purpose:

Selects this control state. This causes the command to be executed and the links for this object's GUI bundle to be updated.

Calling Context:

Called by any client 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: TUpdateLinkControlState::IsEnabled

virtual bool IsEnabled () const API.

Purpose:

Returns whether or not this control state is enabled.

Calling Context:

Called by any client object.

Parameters:

Takes no parameters.

Return Value:

Returns true if this control state is enabled.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUpdateLinkControlState::AddInterests

virtual void AddInterests (TSetOf < TInterest > & set)

Interface Category:

API.

Purpose:

Adds interests to the specified set. The interests added by this function indicate the notifications in which this object is interested. Derived classes who wish to provide their own set of interests should override HandleAddInterests rather than this function.

Calling Context:

Called by any client object.

Parameters:

TSetOf < TInterest > & set -The set of interests as returned by this function.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUpdateLinkControlState::HandleAddInterests

virtual void HandleAddInterests (TSetOf < TInterest > & set) const

Interface Category:

API.

Purpose:

Calling Context:

Called by AddInterests.

Parameters:

TSetOf < TInterest > & set -The set of interests as returned by this function.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUpdateLinkControlState::HandleCanDo

virtual bool HandleCanDo () const

Interface Category:

API.

Purpose:

Computes and returns whether or not this command can be done.

Calling Context:

Called by IsEnabled.

Parameters:

Takes no parameters.

Return Value:

Returns true if the command can be done.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TUpdateLinkControlState::HandleCreateCommandBinding

virtual MGUIDocumentComponentCommandBinding * HandleCreateCommandBinding ()

Interface Category:

API.

Purpose:

Creates a command binding for binding this control state to a command. This function always returns NIL. Derived classes who wish to alter the default behavior should override this function.

Calling Context:

Called by Select.

Parameters:

Takes no parameters.

Return Value:

Returns the new command binding.

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.