Class: TGUIBundleConnection

Declaration: GUICompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

TGUIBundleConnection provides a connection to a bundle. This class is used by MGUIBundle.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Should not derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TGUIBundleConnection::TGUIBundleConnection

TGUIBundleConnection ()
TGUIBundleConnection (TGUIBundle * theBundleToAlias)

Interface Category:

API.

Purpose:

Default constructor.
Creates a new bundle connection to the specified bundle.

Calling Context:

Called by the stream-in operators.
Called by the Presentation framework.

Parameters:

Takes no parameters.
TGUIBundle * theBundleToAlias -The GUI bundle to which the new object is a connection.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGUIBundleConnection::~TGUIBundleConnection

virtual ~ TGUIBundleConnection ()

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:

Multithread safe.

Other Considerations:

None.

Member Function: TGUIBundleConnection::SetGUIBundle

void SetGUIBundle (TGUIBundle *)

Interface Category:

API.

Purpose:

Sets this object's GUI bundle.

Calling Context:

Called by the Presentation framework.

Parameters:

TGUIBundle * -The new GUI bundle for this object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGUIBundleConnection::GetGUIBundle

const TGUIBundle * GetGUIBundle () const

Interface Category:

API.

Purpose:

Returns this object's current GUI bundle.

Calling Context:

Called by the Presentation framework.

Parameters:

Takes no parameters.

Return Value:

Returns a const pointer to this object's current GUI bundle.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGUIBundleConnection::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: TGUIBundleConnection::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.

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