![]() |
Python Script Engine
1.0
GL Studio Editor Python Script API
|
Editor module that contains methods to run on the Editor instance itself.
void CleanAllDocuments | ( | ) |
Cleans all of the code for a given document.
CEIException |
void CleanCurrentDocument | ( | ) |
Cleans the code for a given document.
CEIException |
void CleanCurrentDocumentAndChildren | ( | ) |
Cleans the code for a given document and any referenced children.
CEIException |
void ClearDragAndDropHandlers | ( | ) |
Clear all file drag and drop handlers currently added.
void CloseAllDocuments | ( | ) |
Closes all open documents.
CEIException |
void ForceEditorRefresh | ( | ) |
Force refresh of editor user interface.
void ForceRefreshCurrentProject | ( | ) |
To be called when we know we need to refresh the project and its packages.
void GenerateAllDocuments | ( | ) |
Generates all of the code for a given document.
CEIException |
void GenerateCurrentDocument | ( | ) |
Generates the code for a given document.
CEIException |
void GenerateCurrentDocumentAndChildren | ( | ) |
Generates all of the code for a given document and any referenced children.
CEIException |
String GetActiveCodeGenerator | ( | ) |
Get a list of available code generators.
DocumentArray * GetAllDocuments | ( | ) |
Get a list of all loaded documents.
std::vector< String > GetAvailableCodeGenerators | ( | ) |
Get a list of available code generators.
CodeGenerator GetCodeGenerator | ( | String | codeGeneratorName | ) |
Gets the code generator object by name.
codeGeneratorName | The name of the code generator to return. Should be one of the strings returned by GetAvailableCodeGenerators(). |
String GetCodePathForCurrentGenerator | ( | Document * | doc = nullptr | ) |
The the code generation output path for the currently active generator.
This can be different from the document specified path based on project settings.
doc | the document to use when cacluating the path |
Document GetCurrentDocument | ( | ) |
Gets the current document.
Project * GetCurrentProject | ( | ) |
Returns the project object that is currently in use, or null if there is none.
String GetCurrentProjectFileDirectory | ( | ) |
Returns the project directory that is currently in use.
Document GetDocumentByName | ( | String | docName | ) |
Gets the document with the given name, if open.
docName | name of the document to get |
String GetResourcesPathForCurrentGenerator | ( | void | ) |
The the resources output path for the currently active generator.
void GetVersionInfo | ( | int * | major, |
int * | minor, | ||
int * | build | ||
) |
Returns a tuple of the version info in the form of (major, minor, build)
String GetVersionInfoString | ( | ) |
Returns a string containing the version info a string concatination of GetVersionInfo()
Document NewDocument | ( | String | filename = "" | ) |
Creates a new document and makes it the current document.
filename | optional filename to give the new document |
Document OpenDocument | ( | String | fileName | ) |
Opens a new document and makes it the current document.
fileName | name of file to load |
bool RegisterDragAndDropHandlers | ( | void * | dragHandler, |
void * | dropHandler | ||
) |
Register file drag and drop handlers.
dragHandler | Python callable that takes a filename to see if the drop handler will accept it. |
dropHandler | Python callable that takes a filename to handle the drop |
void SaveAllDocuments | ( | ) |
Saves all open documents.
CEIException |
bool SetActiveCodeGenerator | ( | String | codeGeneratorName | ) |
Set the current code generator.
codeGeneratorName | The name of the code generator to make active. Should be one of the strings returned by GetAvailableCodeGenerators(). |
String SetCodeGeneratorOptions | ( | String | codeGeneratorOptions | ) |
Pass some options to configure the current code generator.
codeGeneratorOptions | The options in KEY=VALUE pairs separated by spaces. |