Python Script Engine  7.2
GL Studio Editor Python Script API
List of all members
EditorLog Class Reference

Module Methods

Methods that can be called on the module.

void PrintInfo (String str)
 
void PrintWarning (String str)
 
void PrintError (String str)
 
void PrintCodeInfo (String str)
 
void PrintCodeWarning (String str)
 
void PrintCodeError (String str)
 
void ClearLog (void)
 
void SaveLog (String fileName, String lastLine=String())
 

Detailed Description

Editor Logging module that contains methods to send messages to the GL Studio Log.

Member Function Documentation

void ClearLog ( void  )

Clear the editor log.

void PrintCodeError ( String  str)

Output an error string to the editor log with no formatting.

Useful to display code.

Parameters
strerror string to output (NOTE: the string can contain any number of newline characters if multiple line output is desired)
Since
GL Studio 6.0.1
void PrintCodeInfo ( String  str)

Output an info string to the editor log with no formatting.

Useful to display code.

Parameters
strinfo string to output (NOTE: the string can contain any number of newline characters if multiple line output is desired)
Since
GL Studio 6.0.1
void PrintCodeWarning ( String  str)

Output an error string to the editor log with no formatting.

Useful to display code.

Parameters
strerror string to output (NOTE: the string can contain any number of newline characters if multiple line output is desired)
Since
GL Studio 6.0.1
void PrintError ( String  str)

Output an error string to the editor log.

Parameters
strerror string to output (NOTE: the string can contain any number of newline characters if multiple line output is desired)
void PrintInfo ( String  str)

Output an info string to the editor log.

Parameters
strInfo string to output (NOTE: the string can contain any number of newline characters if multiple line output is desired)
void PrintWarning ( String  str)

Output a warning string to the editor log.

Parameters
strwarning string to output (NOTE: the string can contain any number of newline characters if multiple line output is desired)
void SaveLog ( String  fileName,
String  lastLine = String () 
)

Save the current log to the specified file.

Parameters
fileNameFully qualified path name of the file to write
lastLineAn addition non-formatted line to add to the end of the log. Normally used by errors written by exception handlers
The documentation for this class was generated from the following file: