Class: TDocumentWindow

Declaration: DocumentWindow.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardWindow

Inherited By:

None.

Purpose:

TDocumentWindow is a concrete class implementing the document window for the Taligent Human Interface. TDocumentWindow derives from TStandardWindow.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Rarely derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TDocumentWindow::TDocumentWindow

TDocumentWindow (const TDocumentReference &)
TDocumentWindow ()

Interface Category:

API.

Purpose:

Creates a new TDocumentWindow and constructs a document surrogate from the specified TDocumentReference. The TDocumentWindow hangs onto the document surrogate for the lifetime of the window.
Default constructor.

Calling Context:

Call this function directly.
Called by the stream-in operators.

Parameters:

const TDocumentReference & -The document reference from which to create the document surrogate. The document surrogate is retained for the lifetime of the window.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Views (and consequently windows) do not draw until they are connected into a rooted view hierarchy.

Member Function: TDocumentWindow::~TDocumentWindow

virtual ~ TDocumentWindow ()

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: TDocumentWindow::GetDocument

TDocumentSurrogate GetDocument () const

Interface Category:

API.

Purpose:

Returns a copy of the document surrogate associated with this window.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a copy of the document surrogate associated with this window.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentWindow::SetTitleForDocument

virtual void SetTitleForDocument (const TText &)

Interface Category:

API.

Purpose:

Changes the name of the document as well as the window title.

Calling Context:

Call this function directly.

Parameters:

const TText & -The new document name.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentWindow::operator=

TDocumentWindow & operator =(const TDocumentWindow &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TDocumentWindow & -The object to be copied.

Return Value:

A non-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: TDocumentWindow::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 the object streams itself out to.

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: TDocumentWindow::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 the object streams itself in from.

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: TDocumentWindow::GetDocumentIcon

TDocumentIcon * GetDocumentIcon () const

Interface Category:

API.

Purpose:

Returns the document icon proxy for the document.

Calling Context:

Called directly by derived classes.

Parameters:

Takes no parameters.

Return Value:

Returns the document icon for the document.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TDocumentWindow::HandleBeforeDisconnectionFromViewRoot

virtual void HandleBeforeDisconnectionFromViewRoot ()

Purpose:

Called by the View system before the window is removed from a view root. The window disconnects from any notifications at this time.

Calling Context:

Called by the View system just before the window is removed from a view root.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TDocumentWindow::HandleAfterConnectionToViewRoot

virtual void HandleAfterConnectionToViewRoot ()

Interface Category:

API.

Purpose:

Called by the View system after the window is added to a view root. The view root's request processor is available to the window at this time, and it performs any notification connections here.

Calling Context:

Called by the View system after the window is connected to from a view root.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TDocumentWindow::AddWindowTabControls

virtual void AddWindowTabControls ()

Interface Category:

API.

Purpose:

Adds controls to the window tab. Override to add additional controls or to alter the ordering of exiting ones.

Calling Context:

Classes overriding this function should call the parent function to add the default resizers, close box, zoom box, and minimizer.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

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