Harmony
Scripting Interface Documentation
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 debug mode to on/off More...
 
bool isDebug ()
 returns whether debug mode is set 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

◆ debug

void MessageLog::debug ( String &  messageIfDebug)
slot

writes the message 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().

◆ isDebug

bool MessageLog::isDebug ( )
slot

returns whether debug mode is set

◆ setDebug

void MessageLog::setDebug ( bool  b)
slot

sets debug mode to on/off

◆ trace

void MessageLog::trace ( String &  message)
slot

writes the message to the message log