|
|
| (8 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| {{DISPLAYTITLE:{{SUBPAGENAME}}}} | | {{DISPLAYTITLE:{{SUBPAGENAME}}}} |
| {{Toolbox}} | | {{PGToolbox}} |
| The Toolbox is a way to add extra functionality to {{STX}}. Toolbox functions are programmed for specific contexts in {{STX}} (e.g. for the Workspace or for the Sectioner in Spectrogram & Parameters Viewer). See the Toolbox Functions entry in the Programmer Guide if you want to know how to programme Toolbox functions.
| | Toolbox functions can be used to provide extra context-dependent functionality in {{STX}}. See the [[User Guide/Toolbox|User Guide]] for details about calling Toolbox functions from the {{STX}} GUI. If you want to program a Toolbox function, please read the following two articles: |
|
| |
|
| Toolbox functions are stored for convenience's sake in the folder <code>Toolbox</code> in the install directory in files with the extension <code>sts</code>. | | *[[Programmer_Guide/Programming a Toolbox/Toolbox_function_definition|Toolbox Function Definition]] |
| | *[[Programmer_Guide/Programming a Toolbox/Toolbox_function_implementation|Toolbox Function Implementation]] |
|
| |
|
| The Toolbox functionality requires {{STX}} version 3.6.0 and newer.
| | ==Example Toolbox Function== |
|
| |
|
| ==Toolbox Functions==
| | The Toolbox function <code>[[Programmer_Guide/Programming a Toolbox/Example_Toolbox_function|ExportSegmentsToSoundfiles]]</code> has been included as an example of a Toolbox function. |
|
| |
|
| Toolbox functions can be used to provide extra context-dependent functionality in {{STX}}. See the User Guide for details about calling Toolbox functions from the {{STX}} GUI. If you want to program a Toolbox function, please read the following two articles:
| | ==Pre-installed Toolboxes== |
| | |
| *[[Programmer_Guide/Toolbox/Toolbox_function_definition|Toolbox Function Definition]]
| |
| *[[Programmer_Guide/Toolbox/Toolbox_function_implementation|Toolbox Function Implementation]]
| |
| | |
| The Toolbox function <code>[[Programmer_Guide/Toolbox/Example_Toolbox_function|ExportSegmentsToSoundfiles]]</code> has been included as an example of a Toolbox function.
| |
| | |
| ==Loading, Reloading and Unloading Toolbox Functions== | |
| | |
| Toolbox functions are stored in {{STX}} script files (*.sts) in the <code>Toolbox</code> folder. General toolbar commands are found in the Workspace Special > Toolbox functions menu. E.g. you can load new toolbox files, unload them, and reload any that have been changed on disk (useful if you are developing a toolbox function). Once a Toolbox function is loaded, it is available in all contexts for which is was designed. All loaded toolbox functions can be displayed with the Show command.
| |
| | |
| ==Calling Toolbox Functions==
| |
| | |
| Exactly how you call a Toolbox function depends on the context and whether or not a hotkey has been defined for it. For example, in the Spectrogram & Parameters Viewer Sectioner, the available toolbox functions (e.g. those that are loaded and available in the spectum context) are available via the context menu entry Toolbox.
| |
|
| |
|
| A list of toolboxes installed by default in {{STX}} can be found in the [[User Guide/Toolbox|User Guide]]. | | A list of toolboxes installed by default in {{STX}} can be found in the [[User Guide/Toolbox|User Guide]]. |
|
| |
|
| '''Default Toolbox Functions Included in {{STX}}'''
| | The Toolbox functionality requires {{STX}} version 3.6.0 and newer. |
| | |
| <splist
| |
| parent=
| |
| sort=asc
| |
| sortby=title
| |
| showpath=no
| |
| liststyle=unordered
| |
| kidsonly=yes
| |
| >
| |
Toolbox functions can be used to provide extra context-dependent functionality in STx. See the User Guide for details about calling Toolbox functions from the STx GUI. If you want to program a Toolbox function, please read the following two articles:
Example Toolbox Function
The Toolbox function ExportSegmentsToSoundfiles has been included as an example of a Toolbox function.
Pre-installed Toolboxes
A list of toolboxes installed by default in STx can be found in the User Guide.
The Toolbox functionality requires STx version 3.6.0 and newer.
