Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
oCaboutReturns information about the current application running the script and its environment. You can use it in both Script Editor and scriptModule
oCActionAction interface is used to perform menu or tool bar functions
oCCaptionManagerThis interface is used to access caption properties. Note that the text in captions is in html format
oCCheckBoxSimplified CheckBox widget
oCComboBoxSimplified ComboBox widget
oCDateEditSimplified DateEdit widget
oCDateEditEnumEnum class for simplified DateEdit class - specifies display order of day, month, year
oCDialogSimplified Dialog widget. This class and the associated widget classes are used to build simple dialogs
oCDirInterface to operating system Dir operations, ie, mkdir, rmdir, rename, etc
oCDirSpecEnum for directory operations
oCDrawingToolParamsDrawingTool params class - used as parameters in drawingTools calls
oCExportManagerThis interface is used to export the storyboard project
oCFileInterface to operating system File operations, ie open, close, read, write..
oCFileAccessEnum to define file operation
oCFileDialogSimplified FileDialog interface
oCfileMapperThe FileMapper function, toNativePath( String&) will return the complete path of the passed path resolving shortcuts in windows. Will also convert the path separator to
oCFunctionManagerWith 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
oCGroupBoxSimplified GroupBox widget
oCInputAccess to Simplified Input Dialogs
oCLabelSimplified Label widget
oCLayerManagerThis interface is used to access the layers within a given panel
oCLineEditSimplified LineEdit widget. Note that this widget is derived from Label, so also has a label property
oCMessageBoxSimplified MessageBox widget
oCMessageLogAllows the user to print messages to the message log window
oCMotionManagerThis interface is used to access the shot cameras or the panel layers, and add or remove motion to them
oCNumberEditSimplified NumberEdit widget
oCPenstyleManagerThis 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
oCPermanentFileUsed 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
oCpreferencesWith 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
oCPrjMgtManagerThis interface is used to merge/extract another storyboard into the main storyboard
oCProcessUsed to launch an external process. Processes can be instantiated in the scripting environment
oCPropertiesManagerThis interface is used to access the properties of the storyboard project
oCRadioButtonSimplified RadioButton widget
oCsceneWith the Scene functions, you can retrieve and set global scene attributes, like the aspect ratio of the cells in the scene grid
oCSCR_FileWrapperBase class to TemporaryFile and PermanentFile
oCSelectionManagerThis interface is used to access the GUI storyboard selection. In batch mode, this interface is a no-op
oCSliderSimplified slider widget
oCSoundTrackManagerThis interface is used to access the audio tracks of a storyboard project
oCspecialFoldersBy 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
oCSpinBoxSimplified SpinBox widget
oCStoryboardManagerThis 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
oCTemporaryFileUsed 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
oCTextEditSimplified TextEdit widget
oCTimeEditSimplified TimeEdit widget
oCUiloaderThe 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:
\CviewThe View functions provide information about the contents of selected View windows