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
oCActionAction interface is used to perform menu or tool bar functions
oCCheckBoxSimplified CheckBox widget
oCcolumnWith the Column function, you can retrieve values from columns in your scene and you can add and remove them
oCComboBoxSimplified ComboBox widget
oCCompositionItemA class that represent a single entry in the composition order. The composition order is an array of this composition item
oCcopyPasteImplement the copy paste interface, which is available to the scripting environment
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
oCDrawingProvide an interface for iterating and manipulating the collection of drawings of an element
oCDrawingToolParamsDrawingTool params class - used as parameters in drawingTools calls
oCDrawingToolsWith the drawing functions, you can call some functions on the current drawing to modify it in some ways
oCelementWith the Element functions, you can retrieve information about the elements in your scene and you can add and remove them. Each element has an index (0..nbElements), an integer id (key of the element in the database), which is unique and a name ( which is not guaranteed to be unique )
oCexporterThis set of functions provides access to the project's export directory
oCFileInterface to operating system File operations, ie open, close, read, write..
oCFileAccessEnum to define file operation
oCFileDialogSimplified FileDialog interface
oCfileMapperThe FileMapper function, toNativePath(const QString&) will return the complete path of the passed path resolving shortcuts in windows. Will also convert the path separator to
oCframeWith the Frame functions, you can retrieve values from frames and you can add and remove frames in your scene
oCfuncWith the Function Curve functions, you can retrieve and modify values in the function curves
oCGroupBoxSimplified GroupBox widget
oCInputAccess to Simplified Input Dialogs
oCKeyModifiersScripting interface class to query key modifiers
oCLabelSimplified Label widget
oClibraryInterface to select templates, and generate thumbnails and movies for them
oCLineEditSimplified LineEdit widget. Note that this widget is derived from Label, so also has a label property
oCMatrix4x4Defines a four by four matrix container. Matrix4x4 objects can be instantiated in the scripting environment
oCMessageBoxSimplified MessageBox widget
oCMessageLogAllows the user to print messages to the message log window
oCMovieImportThis object is used to import a QuickTime movie in the scene. First the user needs to set up the importing parameters using the functions: setMovieFilename, setImageFolder, setImagePrefix and setAudioFile. Then call doImport and after that, the user can iterate over the number of images, the current image filename and whether an audio file was created or not
oCnodeNodes are synonymous with Filter, IO, Move and Group Modules in the Network View
oCNumberEditSimplified NumberEdit widget
oCPaletteManagerQuery information from the Colour view
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
oCPoint2dDefines a bi-dimensional point container. Point2d objects can be instantiated in the scripting environment
oCPoint3dDefines a three-dimensional point container. Point3d objects can be instantiated in the scripting environment
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
oCRadioButtonSimplified RadioButton widget
oCrenderThe Render class is used to render the scene or a part of the scene. The scripting environment can receive notifications when scene frame is ready. See the TB_ExportFLV script for an example
oCsceneWith the Scene functions, you can retrieve and set global scene attributes, like the aspect ratio of the cells in the scene grid
oCselectionWith the Selection functions, you can retrieve information about the modules or columns you have selected within a view. These functions work best if run from an icon in the Views Toolbar
oCSliderSimplified slider widget
oCsoundThe Sound class is used to access the scene's soundtrack in part or in whole. The scripting environment can receive notifications when scene frame is ready. See the TB_ExportFLV script for an example
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
oCSystemProvided for backward compatibility with QSA scripts - provides println and getenv
oCTextEditSimplified TextEdit widget
oCTimeEditSimplified TimeEdit widget
oCTimelineWith the Timeline functions, you can return values for layers and frames in the Timeline window
oCToolPropertiesThis object controls most of the tool properties that can be found on the Tool Properties Panel. The Tool Presets view must have been loaded for these function to be available
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:
oCVector2dDefines a bi-dimensional vector container. Vector2d objects can be instantiated in the scripting environment
oCVector3dDefines a three-dimensional vector container. Vector3d objects can be instantiated in the scripting environment
\CviewThe View functions provide information about the contents of selected View windows