Programmer Guide/Programming a Toolbox: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
No edit summary
 
(5 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 are stored for convenience's sake in the folder <code>Toolbox</code> in the install directory in files with the extension <code>sts</code>.
 
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/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 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:


*[[Programmer_Guide/Toolbox/Toolbox_function_definition|Toolbox Function Definition]]
*[[Programmer_Guide/Programming a Toolbox/Toolbox_function_definition|Toolbox Function Definition]]
*[[Programmer_Guide/Toolbox/Toolbox_function_implementation|Toolbox Function Implementation]]
*[[Programmer_Guide/Programming a Toolbox/Toolbox_function_implementation|Toolbox Function Implementation]]


==Example Toolbox Function==
==Example Toolbox Function==


The Toolbox function <code>[[Programmer_Guide/Toolbox/Example_Toolbox_function|ExportSegmentsToSoundfiles]]</code> has been included as an example of a Toolbox function.
The Toolbox function <code>[[Programmer_Guide/Programming a Toolbox/Example_Toolbox_function|ExportSegmentsToSoundfiles]]</code> has been included as an example of a Toolbox function.


==Pre-installed Toolboxes==
==Pre-installed Toolboxes==
Line 22: Line 14:
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]].


<splist
The Toolbox functionality requires {{STX}} version 3.6.0 and newer.
parent=
sort=asc
sortby=title
showpath=no
liststyle=unordered
kidsonly=yes
>

Latest revision as of 15:42, 31 August 2015

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.

Navigation menu

Personal tools