Class: TGUIMessageLog

Declaration: GUICompoundDocument.h

Taxonomy Categories:

Member Functions:

TGUIMessageLog
~TGUIMessageLog
PostMessage
ReportException
GetWindowGroup
FormatMessage
HandleWindowClosed

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

TGUIMessageLog is used to send messages to the user. This is the standard way to report warnings, errors, and information to the user. The default implementation displays dialog boxes containing the messages.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Developers are not expected to derive from this class.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TGUIMessageLog::TGUIMessageLog

TGUIMessageLog (TWindowGroup * theWindowGroupToAlias)
TGUIMessageLog (TWindowGroup * theWindowGroupToAlias, TLocale theCurrentLocale)

Interface Category:

API.

Purpose:

Constructor. Not normally called by clients.
Constructor. Not normally called by clients.

Calling Context:

Called by Presentation framework to create the message log.
Called by Presentation framework to create the message log.

Parameters:

TWindowGroup * theWindowGroupToAlias -The window group to alias.
TWindowGroup * theWindowGroupToAlias -The window group to alias.
TLocale theCurrentLocale -The presentation's locale.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGUIMessageLog::~TGUIMessageLog

virtual ~ TGUIMessageLog ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object. Not normally called by clients.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGUIMessageLog::PostMessage

virtual void PostMessage (EMessage, const TText & theMessage) const

Interface Category:

API.

Purpose:

Posts the message to the user. The exact way the message is posted is a private implementation detail. The current implementation puts up an alert window. In addition, if the message type is kError, the message is echoed to the console.

Calling Context:

Call this function directly.

Parameters:

EMessage -The type of message.
const TText & theMessage -The text of the message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGUIMessageLog::ReportException

virtual void ReportException (const TStandardException & e) const
virtual void ReportException (const TStandardException & e, const TText & additionalInfo) const

Interface Category:

API.

Purpose:

Reports an exception to the user.
Reports an exception to the user. Allows client to specify additional information.

Calling Context:

Usually called from a catch block.
Usually called from a catch block.

Parameters:

const TStandardException & e -The exception to report.
const TStandardException & e -The exception to report.
const TText & additionalInfo -Additional text information about the exception.

Return Value:

None.

Exceptions:

Throws no exceptions.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGUIMessageLog::GetWindowGroup

TWindowGroup * GetWindowGroup () const

Interface Category:

API.

Purpose:

Used internally to get the window group. New message dialog boxes will be placed into this window group.

Calling Context:

Called internally and by derived classes wishing to put up custom windows.

Parameters:

Takes no parameters.

Return Value:

The window group associated with this message log.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

This function is protected.

Member Function: TGUIMessageLog::FormatMessage

virtual void FormatMessage (TText & result, const TStandardException & e, const TText * additionalInfo) const

Interface Category:

API.

Purpose:

Used internally to compose a human-readable message reporting an exception.

Calling Context:

Called internally and by derived classes wishing to report exceptions.

Parameters:

TText & result -The human-readable message as returned by this function.
const TStandardException & e -The exception to report.
const TText * additionalInfo -Additional information which is appended to the report.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

This function is protected.

Member Function: TGUIMessageLog::HandleWindowClosed

virtual void HandleWindowClosed (const TNotification & notification)

Interface Category:

API.

Purpose:

Deletes a message window after it has been closed.

Calling Context:

Used internally. Not to be called by clients.

Parameters:

const TNotification & notification -The notification of the window that has been closed.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

This function is protected.

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