MessageLog Class Reference

The MessageLog JavaScript global object. Allows the user to print messages to the message log window. More...

Public Slots
void	trace (String &message)
	Writes the message to the message log. More...
void	debug (String &messageIfDebug)
	Writes the message to the message log if debug mode is on. More...
void	error (String &message)
	Prints message to message log as an error. More...
void	setDebug (bool b)
	Sets the debug mode to on/off. More...
bool	isDebug ()
	Returns whether the debug mode is set. More...
String	getLog ()
	Returns the content of the message log. More...
void	clearLog ()
	Clears the message log. More...

Detailed Description

The MessageLog JavaScript global object. Allows the user to print messages to the message log window.

MessageLog.trace("Export template failed. Nothing selected.");

Member Function Documentation

clearLog

void MessageLog::clearLog ( )

slot

Clears the message log.

The same as clearing the message log through the ui. Cleared content can still be retrieved with getLog().

debug

void MessageLog::debug ( String &  messageIfDebug )

slot

Writes the message to the message log if debug mode is on.

Parameters

messageIfDebug

: The message to be written to the message log if debug mode is on.

error

void MessageLog::error ( String &  message )

slot

Prints message to message log as an error.

When running as an interactive application, this will report the error in a modal dialog box (at the end of the script only). In batch mode, the error is logged to the log file, like trace().

Parameters

message

: The message to the written to the message log as an error.

getLog

String MessageLog::getLog ( )

slot

Returns the content of the message log.

Returns

the content of the message log.

isDebug

bool MessageLog::isDebug ( )

slot

Returns whether the debug mode is set.

Returns

Returns true if the debug mode is set.

setDebug

void MessageLog::setDebug ( bool  b )

slot

Sets the debug mode to on/off.

Parameters

b	: If true sets the debug mode to on.

trace

void MessageLog::trace ( String &  message )

slot

Writes the message to the message log.

Parameters

message

: The message to be written to the message log.