Inheritance diagram for DzScriptContext:
Properties | |
DzApp | App |
DzColorDialog | ColorDialog |
DzFileDialog | FileDialog |
DzGeometry | Geometry |
DzMainWindow | MainWindow |
DzMessageBox | MessageBox |
DzOpenGL | OpenGL |
DzScene | Scene |
DzSystem | System |
Methods | |
void | acceptUndo (String caption) |
void | beginUndo () |
void | cancelUndo () |
void | clearBusyCursor () |
Boolean | ctrlPressed () |
void | finishProgress () |
Array | getArguments () |
QDesktopWidget | getDesktop () |
String | getErrorMessage (Number errCode) |
DzAuthor | getScriptAuthor () |
String | getScriptFileName () |
String | getScriptType () |
String | getScriptVersionString () |
Boolean | pointersAreEqual (Object ptr1, Object ptr2) |
void | processEvents () |
Boolean | progressIsActive () |
Boolean | progressIsCancelled () |
void | setBusyCursor () |
Boolean | shiftPressed () |
void | startProgress (String info, Number totalSteps=0, Boolean isCancellable=false, Boolean showTimeElapsed=false) |
void | stepProgress (Number numSteps=1) |
void | updateProgress (Number position) |
All DzScripts are executed in the context of a DzScriptContext instance - therefore, all the properties and methods on DzScriptContext are accessible to a script as global functions and variables. It will usually not be necessary for a script to create or use this class directly.
void DzScriptContext::acceptUndo | ( | String | caption | ) |
void DzScriptContext::beginUndo | ( | ) |
void DzScriptContext::cancelUndo | ( | ) |
void DzScriptContext::clearBusyCursor | ( | ) |
Clears the application-standard busy cursor and returns the mouse cursor to the previous cursor. Match every call to setBusyCursor() with a call to this function.
Boolean DzScriptContext::ctrlPressed | ( | ) |
This function allows a script to determine what meta keys were pressed when the script was activated.
void DzScriptContext::finishProgress | ( | ) |
Array DzScriptContext::getArguments | ( | ) |
QDesktopWidget DzScriptContext::getDesktop | ( | ) |
This function provides access to the desktop widget.
This function converts an error code into a string message.
DzAuthor DzScriptContext::getScriptAuthor | ( | ) |
String DzScriptContext::getScriptFileName | ( | ) |
String DzScriptContext::getScriptType | ( | ) |
String DzScriptContext::getScriptVersionString | ( | ) |
This function allows a script to test if two QObject-derived variables point to the same instance.
void DzScriptContext::processEvents | ( | ) |
Pauses execution of the script and allows the GUI thread time to process events.
Boolean DzScriptContext::progressIsActive | ( | ) |
Boolean DzScriptContext::progressIsCancelled | ( | ) |
void DzScriptContext::setBusyCursor | ( | ) |
Sets the application-standard busy cursor. Match every call to this function with a call to clearBusyCursor() to restore the previous cursor.
Boolean DzScriptContext::shiftPressed | ( | ) |
This function allows a script to determine what meta keys were pressed when the script was activated.
void DzScriptContext::stepProgress | ( | Number | numSteps = 1 |
) |
void DzScriptContext::updateProgress | ( | Number | position | ) |
Read Only
The DAZ Studio Application object
Read Only
The DAZ Script Color Dialog object
Read Only
The DAZ Script File Dialog object
Read Only
The DAZ Script Geometry Utility object
Read Only
The DAZ Studio Main Interface object
Read Only
The DAZ Script Message Box object
Read Only
The DAZ Studio OpenGL object
Read Only
The DAZ Studio Scene object
Read Only
The DAZ Script System Utility object