![](../../Home/Icons/Home.gif)
![](../icons/UpCNM.gif)
![](../icons/CNMContext.gif)
![](../../Home/Icons/Search.gif)
Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
None.
Inherited By:
TGUIDialogController
TClipboardCopyControlState
TClipboardCutControlState
TClipboardPasteControlState
TCommandControlState
TDocumentComponentView
TDocumentTextView
TGUIPresenter
Purpose:
This class is mixed into GUI presentation classes. It holds an alias to a GUIBundle, and reports the bundle's protocol. There aren't many clients which use the MGUIBundle protocol polymorphically -it's mostly an implementation convenience.
Instantiation:
Always mix into another class.
Deriving Classes:
Just use the protocol as-is.
Concurrency:
Multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
- MGUIBundle (TGUIBundleConnection * theConnectionToAlias)
- MGUIBundle (TGUIBundle * theBundleToAlias)
- MGUIBundle (const MGUIBundle &)
- MGUIBundle ()
Interface Category:
API.
Purpose:
- Constructor that alias a redirectable TGUIBundleConnection. is commonly used for shared controls such as menus.
- Usual constructor. Aliases the TGUIBundle.
- Copy constructor.
- Default constructor.
Calling Context:
- Called from constructors of derived classes.
- Called from constructors of derived classes.
- Called to copy an object.
- Called from empty constructors of derived classes.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
virtual ~ MGUIBundle ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetGUIBundle
TGUIBundle * GetGUIBundle () const
Interface Category:
API.
Purpose:
Gets the GUI bundle associated with this class.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the GUI bundle associated with this class.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::SetGUIBundle
void SetGUIBundle (TGUIBundle * theBundleToAlias)
Interface Category:
API.
Purpose:
Sets the GUI bundle associated with this object.
Calling Context:
Call this function directly.
Parameters:
- TGUIBundle * theBundleToAlias -The GUI bundle to alias.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::IsInActivePresenter
bool IsInActivePresenter () const
Interface Category:
API.
Purpose:
Allows clients to determine if they are in the active presenter.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if the bundle is in the active presenter.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::SetActive
void SetActive (bool isActive)
Interface Category:
API.
Purpose:
Sets the active state.
Calling Context:
Called by the Presentation framework.
Parameters:
- bool isActive -The new active state.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::IsInRootPresenter
bool IsInRootPresenter () const
Interface Category:
API.
Purpose:
Lets a client know if the bundle is associated with a root presenter. Some presentations act different when they are the root. For example, scroll bars are typically used for root presentations, but not for embedded presentations.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if the bundle is associated with a root presenter.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::SetIsInRootPresenter
void SetIsInRootPresenter (bool isInRootPresenter)
Interface Category:
API.
Purpose:
Sets the in root presenter property.
Calling Context:
Called by the Presentation framework when creating bundle.
Parameters:
- bool isInRootPresenter -The new value of in root presenter property.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetPlaceReference
TPlaceReference GetPlaceReference () const
Interface Category:
API.
Purpose:
Returns the place reference associated with a presenter.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the place reference associated with a presenter.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetDocumentReference
TDocumentReference GetDocumentReference () const
Interface Category:
API.
Purpose:
Returns the document reference associated with a presenter.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the document reference associated with a presenter.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetDocumentPresenterReference
TDocumentPresenterReference GetDocumentPresenterReference () const
Interface Category:
API.
Purpose:
Returns the document presenter reference associated with a presenter.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the document presenter reference associated with a presenter.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetPresenterReference
TPresenterReference GetPresenterReference () const
Interface Category:
API.
Purpose:
Returns the presenter reference of the presenter associated with the bundle.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the presenter reference of the presenter associated with the bundle.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::SetPresenterReference
void SetPresenterReference (const TPresenterReference &)
Interface Category:
API.
Purpose:
Sets the presenter reference of the bundle.
Calling Context:
Called by the Presentation framework.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetWindowGroup
- TWindowGroup * GetWindowGroup ()
- const TWindowGroup * GetWindowGroup () const
Interface Category:
API.
Purpose:
- Gets a non-const pointer to the window group associated with the bundle.
- Gets a const pointer to the window group associated with the bundle.
Calling Context:
- Any client with a non-const pointer to a TGUIBundle.
- Any client with a const pointer to a TGUIBundle.
Parameters:
- Takes no parameters.
- Takes no parameters.
Return Value:
Returns a pointer to the window group associated with the bundle.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
Both const and non-const versions are provided. This means that if you have a const pointer or reference to a GUIBundle, then you will get a const pointer to the window group. This preserves the const semantics.
Member Function: MGUIBundle::GetPresenterSessionStore
- TPresenterSessionStore * GetPresenterSessionStore ()
- const TPresenterSessionStore * GetPresenterSessionStore () const
Interface Category:
API.
Purpose:
- Gets a non-const pointer to the presenter session store associated with the bundle.
- Gets a const pointer to the presenter session store associated with the bundle.
Calling Context:
- Any client with a non-const pointer to a TGUIBundle.
- Any client with a const pointer to a TGUIBundle.
Parameters:
- Takes no parameters.
- Takes no parameters.
Return Value:
Returns a pointer to the presenter session store associated with the GUIBundle.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
Both const and non-const versions are provided. This means that if you have a const pointer or reference to a GUIBundle, then you will get a const pointer to the presenter session store. This preserves the const semantics.
Member Function: MGUIBundle::GetGUIMessageLog
- TGUIMessageLog * GetGUIMessageLog ()
- const TGUIMessageLog * GetGUIMessageLog () const
Interface Category:
API.
Purpose:
- Gets a non-const pointer to the message log associated with the bundle.
- Gets a const pointer to the message log associated with the bundle.
Calling Context:
- Any client with a non-const pointer to a TGUIBundle.
- Any client with a const pointer to a TGUIBundle.
Parameters:
- Takes no parameters.
- Takes no parameters.
Return Value:
Returns a pointer to the message log associated with the GUIBundle.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
Both const and non-const versions are provided. This means that if you have a const pointer or reference to a GUIBundle, then you will get a const pointer to the message log. This preserves the const semantics.
Member Function: MGUIBundle::GetGUIWindowArranger
- TGUIWindowArranger * GetGUIWindowArranger ()
- const TGUIWindowArranger * GetGUIWindowArranger () const
Interface Category:
API.
Purpose:
- Gets a non-const pointer to the window arranger associated with the bundle.
- Gets a const pointer to the window arranger associated with the bundle.
Calling Context:
- Any client with a non-const pointer to a TGUIBundle.
- Any client with a const pointer to a TGUIBundle.
Parameters:
- Takes no parameters.
- Takes no parameters.
Return Value:
Returns a pointer to the window arranger associated with the bundle.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
Both const and non-const versions are provided. This means that if you have a const pointer or reference to a GUIBundle, then you will get a const pointer to the window arranger. This preserves the const semantics.
Member Function: MGUIBundle::AdoptUndoRedoLabels
TPseudoTimeStamp AdoptUndoRedoLabels (TLabel * theUndoLabelToAdopt, TLabel * theRedoLabelToAdopt)
Interface Category:
API.
Purpose:
Adopts the arguments as the new undo and redo labels for the whole task. Generates notification.
Calling Context:
Called by the Presentation framework.
Parameters:
- TLabel * theUndoLabelToAdopt -The label of the next command to be undone.
- TLabel * theRedoLabelToAdopt -The label of the next command to be redone.
Return Value:
Returns the pseudo-time-stamp of the undo/redo label state.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetUndoLabel
- TLabel * GetUndoLabel ()
- const TLabel * GetUndoLabel () const
Interface Category:
API.
Purpose:
- Get a non-const pointer to the current undo label.
- Get a const pointer to the current undo label.
Calling Context:
- Called by the Presentation framework.
- Called by the Presentation framework.
Parameters:
- Takes no parameters.
- Takes no parameters.
Return Value:
Returns the label of the next command to be undone.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetRedoLabel
- TLabel * GetRedoLabel ()
- const TLabel * GetRedoLabel () const
Interface Category:
API.
Purpose:
- Gets a non-const pointer to the current redo label
- Gets a const pointer to the current redo label
Calling Context:
- Called by the Presentation framework.
- Called by the Presentation framework.
Parameters:
- Takes no parameters.
- Takes no parameters.
Return Value:
Returns the label of the next command to be redone.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetLabelTimeStamp
TPseudoTimeStamp GetLabelTimeStamp () const
Interface Category:
API.
Purpose:
Returns the time stamp of the undo/redo labels. If the time-stamp hasn't changed, then neither have the undo/redo labels. This is the same value returned from AdoptUndoRedoLabels.
Calling Context:
Called by the Presentation framework..
Parameters:
Return Value:
Returns the timestamp of the current undo/redo labels.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetLabelChangeInterest
TGUIBundleInterest GetLabelChangeInterest () const
Interface Category:
API.
Purpose:
Returns the interest associated with the undo/redo labels. Notification will be sent to this interest whenever the undo/redo labels change.
Calling Context:
Called by the Presentation framework.
Parameters:
Return Value:
Returns the label change interest.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetModelReference
TModelReference GetModelReference () const
Interface Category:
API.
Purpose:
Returns a reference to the model associated with this bundle.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns a reference to the model associated with this bundle.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::SetModelReference
void SetModelReference (const TModelReference &)
Interface Category:
API.
Purpose:
Sets the model associated with this bundle.
Calling Context:
Called by the Presentation framework.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
Usually called only once in a bundle's lifetime, during its initialization.
Member Function: MGUIBundle::GetPresenterStateReference
TPresenterStateReference GetPresenterStateReference () const
Interface Category:
API.
Purpose:
Returns a reference to the presenter state associated with a bundle.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns a reference to the presenter state associated with a bundle.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::SetPresenterStateReference
void SetPresenterStateReference (const TPresenterStateReference &)
Interface Category:
API.
Purpose:
Sets the presenter state associated with the bundle.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
Usually called only once in a bundle's lifetime, during its initialization.
Member Function: MGUIBundle::GetRawCurrentSelection
- const TDocumentComponentSelection * GetRawCurrentSelection () const
- TDocumentComponentSelection * GetRawCurrentSelection ()
Interface Category:
API.
Purpose:
- Returns the const current selection.
- Returns the current selection.
Calling Context:
- Called by clients interested in the unfiltered current selection.
- Called by clients interested in the unfiltered current selection.
Parameters:
- Takes no parameters.
- Takes no parameters.
Return Value:
The current selection.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
The current selection may or may not apply to the document component that's associated with a particular MGUIBundle mix-in. Clients would usually call GetCurrentSelection, GetCurrentPresenterStateSelection, or GetCurrentModelSelection instead.
Member Function: MGUIBundle::GetCurrentSelection
- const TDocumentComponentSelection * GetCurrentSelection () const
- TDocumentComponentSelection * GetCurrentSelection ()
Interface Category:
API.
Purpose:
- Returns the filtered const current selection. If the real current selection applies to a different component, then NIL is returned.
- Returns the filtered const current selection. If the real current selection applies to a different component, then NIL is returned.
Calling Context:
- Call this function directly.
- Call this function directly.
Parameters:
- Takes no parameters.
- Takes no parameters.
Return Value:
The filtered current selection. (i.e. either the return value applies to this class' document component or it is NIL.)
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetCurrentModelSelection
const TModelSelection * GetCurrentModelSelection () const
Interface Category:
API.
Purpose:
Returns the model selection part of the filtered current selection. If the real current selection applies to a different component, then NIL is returned.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the filtered current model selection.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetCurrentPresenterStateSelection
const TPresenterStateSelection * GetCurrentPresenterStateSelection () const
Interface Category:
API.
Purpose:
Returns the presenter state selection part of the filtered current selection. If the real current selection applies to a different component, then NIL is returned.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the filtered current presenter state selection.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetCurrentSelectionTimeStamp
TPseudoTimeStamp GetCurrentSelectionTimeStamp () const
Interface Category:
API.
Purpose:
Returns the time-stamp for the current selection.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the time-stamp for the current selection.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetCurrentSelectionChangeInterest
TGUIBundleInterest GetCurrentSelectionChangeInterest () const
Interface Category:
API.
Purpose:
Return an interest that can be used to connect for notification of when the current selection changes.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns an interest that can be used to connect for notification of when the current selection changes.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::NotifyOfCurrentSelectionChange
void NotifyOfCurrentSelectionChange () const
Interface Category:
API.
Purpose:
Sends out notification that the current selection changed.
Calling Context:
Called by the Presentation framework.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::AdoptCurrentSelection
TPseudoTimeStamp AdoptCurrentSelection (TDocumentComponentSelection * adoptedSelection)
Interface Category:
API.
Purpose:
Changes the current selection.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the time stamp of the new current selection.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::AdoptCurrentModelSelection
TPseudoTimeStamp AdoptCurrentModelSelection (TModelSelection * theModelSelection)
Interface Category:
API.
Purpose:
Changes the current selection. This is a convenience function which wraps the model selection up in a TDocumentComponentSelection with an appropriate TPresenterStateSelection.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the time stamp of the new current selection.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::AdoptCurrentPresenterStateSelection
TPseudoTimeStamp AdoptCurrentPresenterStateSelection (TPresenterStateSelection * thePresenterStateSelection)
Interface Category:
API.
Purpose:
Changes the current selection. This is a convenience function which wraps the presenter state selection up in a TDocumentComponentSelection with an appropriate TModelSelection.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the time stamp of the new current selection.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::AdoptAndDo
void AdoptAndDo (TAbstractDocumentComponentCommandBinding *)
Interface Category:
API.
Purpose:
Utility function which forwards the command binding to the document. Saves you from having to create a TDocumentSurrogate.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::DoBegin
void DoBegin (TAbstractDocumentComponentCommandBinding &)
Interface Category:
API.
Purpose:
Utility function which forwards the command binding to the document. Saves you from having to create a TDocumentSurrogate.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::DoIncrement
void DoIncrement (TAbstractDocumentComponentCommandBinding &)
Interface Category:
API.
Purpose:
Utility function which forwards the command binding to the document. Saves you from having to create a TDocumentSurrogate.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::AdoptAndDoEnd
void AdoptAndDoEnd (TAbstractDocumentComponentCommandBinding *)
Interface Category:
API.
Purpose:
Utility function which forwards the command binding to the document. Saves you from having to create a TDocumentSurrogate.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetMenu
TMenu * GetMenu () const
Interface Category:
API.
Purpose:
Returns the menu associated with this bundle.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns a pointer to the menu associated with this bundle.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetLocale
TLocale GetLocale () const
Interface Category:
API.
Purpose:
Returns the locale associated with this bundle.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the locale associated with this bundle.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::SetGUIBundleConnection
void SetGUIBundleConnection (TGUIBundleConnection * theConnectionToAlias)
Interface Category:
API.
Purpose:
Sets the bundle connection for this GUI bundle.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::GetGUIBundleConnection
TGUIBundleConnection * GetGUIBundleConnection () const
Interface Category:
API.
Purpose:
Returns this GUI bundle's bundle connection.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns this GUI bundle's bundle connection.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::operator<<=
virtual TStream & operator <<= (TStream & fromWhere)
Interface Category:
API.
Purpose:
Stream-in operator.
Calling Context:
Called to stream in data.
Parameters:
- TStream & fromWhere -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:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::operator>>=
virtual TStream & operator >>=(TStream & toWhere) const
Interface Category:
API.
Purpose:
Stream-out operator.
Calling Context:
Called to stream out data.
Parameters:
- TStream & toWhere -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:
Multithread safe.
Other Considerations:
None.
Member Function: MGUIBundle::AdoptCurrentSelectionMaster
TPseudoTimeStamp AdoptCurrentSelectionMaster (TDocumentComponentSelection * adoptedSelection)
Interface Category:
API.
Purpose:
Adopts a current selection as a new selection master. TGUIBundle maintains a shared reference counted master selection. When a new TGUIBUndle is created from another, it adds a reference to the source bundles selection and shares it. This member function allows a new, independent master selection to be set for this gui bundle.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None
Member Function: MGUIBundle::GetSelectionChangedForPresenterInterest
TPresenterInterest GetSelectionChangedForPresenterInterest () const
Interface Category:
API.
Purpose:
Gets an interest in selection changes for the presenter that owns this GUIBundle. Only notifications caused by selections set on this bundle's presenter will be received.
Calling Context:
Call this function directly.
Parameters:
Return Value:
TPresenterInterest -The interest used to connect.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.