Class: TGUIBundleInterest

Declaration: GUICompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TInterest

Inherited By:

None.

Purpose:

Specifies interest in a notification on a TGUIBundle.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

No special instructions.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TGUIBundleInterest::TGUIBundleInterest

TGUIBundleInterest (const TGUIBundle & theBundle, const TToken & theName)
TGUIBundleInterest (const TDocumentPresenterReference & theDocumentPresenterReference, const TToken & theName)
TGUIBundleInterest (const TGUIBundleInterest &)
TGUIBundleInterest ()

Interface Category:

API.

Purpose:

Creates an interest on a specific bundle with a specific name.
Creates an interest on the bundle associated with a particular document presenter reference and with a specific name.
Copy constructor.
Default constructor.

Calling Context:

Call this function directly.
Call this function directly.
Called to copy an object.
Only for internal use by Resurrect. Developers should treat as protected.

Parameters:

const TGUIBundle & theBundle -The bundle that will generate the notification.
const TToken & theName -The name of the notification.
const TDocumentPresenterReference & theDocumentPresenterReference -A reference to the document presenter associated with the GUI Bundle.
const TToken & theName -The name of the notification.
const TGUIBundleInterest & -The interest to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

The default constructor is protected.

Member Function: TGUIBundleInterest::~TGUIBundleInterest

virtual ~ TGUIBundleInterest ()

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: TGUIBundleInterest::GetDocumentPresenterReference

TDocumentPresenterReference GetDocumentPresenterReference () const

Interface Category:

API.

Purpose:

Returns the document presenter reference associated with the GUIBundle that the interest applies to.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the document presenter reference associated with the GUIBundle that the interest applies to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Not a terribly useful function. May be removed in the future.

Member Function: TGUIBundleInterest::operator=

TGUIBundleInterest & operator =(const TGUIBundleInterest &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TGUIBundleInterest & -the interest to copy.

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: TGUIBundleInterest::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: TGUIBundleInterest::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: TGUIBundleInterest::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns the hash value for this object. The hash value used to speed comparison.

Calling Context:

Called by collections when comparing objects.

Parameters:

Takes no parameters.

Return Value:

Returns the hash value for this object.

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.