BAPP_SpecialFolders | |
specialFolders | By using the SpecialFolders functions, you can retrieve information about the different folders (directories) used by the application. All of the functions are read-only. They return strings that represent folders in use by the various applications. Depending on the application (e.g. Toon Boom Harmony versus Toon Boom AnimatePro), the same content is stored in a different location |
Labeled | |
ComboBox | Simplified ComboBox widget |
DateEdit | Simplified DateEdit widget |
LineEdit | Simplified LineEdit widget. Note that this widget is derived from Label, so also has a label property |
NumberEdit | Simplified NumberEdit widget |
Slider | Simplified slider widget |
SpinBox | Simplified SpinBox widget |
TimeEdit | Simplified TimeEdit widget |
QObject | |
about | Returns information about the current application running the script and its environment. You can use it in both Script Editor and scriptModule |
CaptionManager | This interface is used to access caption properties. Note that the text in captions is in html format |
ColorRGBA | |
DateEditEnum | Enum class for simplified DateEdit class - specifies display order of day, month, year |
Dir | Interface to operating system Dir operations, ie, mkdir, rmdir, rename, etc |
DirSpec | Enum for directory operations |
DrawingToolParams | DrawingTool params class - used as parameters in drawingTools calls |
ExportManager | This interface is used to export the storyboard project |
File | Interface to operating system File operations, ie open, close, read, write.. |
FileAccess | Enum to define file operation |
FunctionManager | With the Function Manager, you can manipulate the camera functions and the layer functions. Note that for all methods you must give the unique id. For the camera, this is the sceneId. For a layer functions, this is the panelId |
LayerManager | This interface is used to access the layers within a given panel |
MotionManager | This interface is used to access the shot cameras or the panel layers, and add or remove motion to them |
PrjMgtManager | This interface is used to merge/extract another storyboard into the main storyboard |
Process | Used to launch an external process. Processes can be instantiated in the scripting environment |
PropertiesManager | This interface is used to access the properties of the storyboard project |
SCR_FileIOTypeWrapper | |
SCR_FileWrapper | Base class to TemporaryFile and PermanentFile |
PermanentFile | Used to represent an actual image file on disk which will not be deleted after script execution. Permanent files can be instantiated in the scripting environment or retrieved in an SM_InputPortWrapper object |
TemporaryFile | Used to represent an actual image file on disk which will be deleted after script execution. Temporary files can be instantiated in the scripting environment or retrieved in an SM_InputPortWrapper object |
SelectionManager | This interface is used to access the GUI storyboard selection. In batch mode, this interface is a no-op |
soundColumnInterface | |
soundSequenceInterface | |
SoundTrackManager | This interface is used to access the audio tracks of a storyboard project |
StoryboardManager | This interface is used to access the main storyboard project. It can be used to query the sequences, scenes, panels and transitions of the project. As well, it can be used to create, delete or rename project objects |
QScriptable | |
soundColumnInterface | |
soundSequenceInterface | |
SCR_BaseInterface | |
about | Returns information about the current application running the script and its environment. You can use it in both Script Editor and scriptModule |
Action | Action interface is used to perform menu or tool bar functions |
DrawingTools | |
FileDialog | Simplified FileDialog interface |
fileMapper | The FileMapper function, toNativePath( String&) will return the complete path of the passed path resolving shortcuts in windows. Will also convert the path separator to |
Input | Access to Simplified Input Dialogs |
KeyModifiers | |
MessageBox | Simplified MessageBox widget |
MessageLog | Allows the user to print messages to the message log window |
PenstyleManager | This set of functions is used to query/modify the current penstyle and list of penstyles. The list of penstyles includes the brush, pencil and texture styles |
preferences | With the Preferences functions, you can retrieve information about the whole preference system. The user can set and retrieve the value of any preferences in the software |
scene | With the Scene functions, you can retrieve and set global scene attributes, like the aspect ratio of the cells in the scene grid |
SCR_SystemInterfaceImpl | |
Uiloader | The UILoader interface allows the user to load pre-defined Qt forms that define Qt widgets (generally built within Qt Designer). This allows users to build complex dialogs, using all of the pre-defined widgets that Qt4.8 supports. See Qt documentation for further details: http://qt-project.org/doc/qt-4.8 |
view | The View functions provide information about the contents of selected View windows |
SCRIPT_QSWidget | |
CheckBox | Simplified CheckBox widget |
Dialog | Simplified Dialog widget. This class and the associated widget classes are used to build simple dialogs |
GroupBox | Simplified GroupBox widget |
Label | Simplified Label widget |
RadioButton | Simplified RadioButton widget |
TextEdit | Simplified TextEdit widget |