Programmer Guide/Programming a Toolbox

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 are stored for convenience's sake in the folder Toolbox in the install directory in files with the extension sts.

The Toolbox functionality requires STx version 3.6.0 and newer.

Toolbox Functions

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:

• Toolbox Function Definition
• Toolbox Function Implementation

The Toolbox function ExportSegmentsToSoundfiles 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 Toolbox 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.

Default Toolbox Functions Included in STx

<splist parent= sort=asc sortby=title showpath=no liststyle=unordered kidsonly=yes >