Python Script Engine  8.3
GL Studio Editor Python Script API
EditorLog Class Reference

Module Methods

Methods that can be called on the module.

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

Detailed Description

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

Member Function Documentation

◆ ClearLog()

None ClearLog ( )

Clear the editor log.

◆ PrintCodeError()

None PrintCodeError ( str  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

◆ PrintCodeInfo()

None PrintCodeInfo ( str  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

◆ PrintCodeWarning()

None PrintCodeWarning ( str  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

◆ PrintError()

None PrintError ( str  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)

◆ PrintInfo()

None PrintInfo ( str  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)

◆ PrintWarning()

None PrintWarning ( str  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)

◆ SaveLog()

None SaveLog ( str  fileName,
str  lastLine = str () 
)

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: