|
|
| Line 2: |
Line 2: |
|
| |
|
| This section describes the {{STX}} standard macros and classes. They are all linked into the library file '''stx.lib''', which is part of the standard installation, and loaded on program start. A detailed description is only given for the most useful macros and classes. For a description of all other macros and classes not described here, you must look to the source files. | | This section describes the {{STX}} standard macros and classes. They are all linked into the library file '''stx.lib''', which is part of the standard installation, and loaded on program start. A detailed description is only given for the most useful macros and classes. For a description of all other macros and classes not described here, you must look to the source files. |
| | |
|
| |
|
| ==Macros== | | ==Macros== |
| * [[Programmer_Guide/Macro_Library/BUTIL|BUtil]] → misc. utility functions | | * [[/BUTIL|BUtil]] → misc. utility functions |
| * [[Programmer_Guide/Macro_Library/UM|UM or EM]] → simple message boxes | | * [[/UM|UM or EM]] → simple message boxes |
| * [[Programmer Guide/Macro Library/CONLOG|ConLog]] → write messages to [[User_Guide/STX_Console|script console]] and/or [[User_Guide/Log_Window|Log-window]] | | * [[/CONLOG|ConLog]] → write messages to [[User_Guide/STX_Console|script console]] and/or [[User_Guide/Log_Window|Log-window]] |
| * [[Programmer_Guide/Macro_Library/LOGWINDOW|LogWindow]] → [[User_Guide/Log_Window|Log-window]] control functions | | * [[/LOGWINDOW|LogWindow]] → [[User_Guide/Log_Window|Log-window]] control functions |
| * [[Programmer Guide/Macro Library/SHOWITEM|ShowItem]] → show [[Programmer_Guide/Shell_Items|shell item]] properties and/or data | | * [[/SHOWITEM|ShowItem]] → show [[Programmer_Guide/Shell_Items|shell item]] properties and/or data |
| * [[Programmer Guide/Macro Library/BSF|BSF]] → soundfile management functions | | * [[/BSF|BSF]] → soundfile management functions |
| * [[Programmer Guide/Macro Library/BSeq|BSeq]] → create, configure and manage a signal sequence | | * [[/BSeq|BSeq]] → create, configure and manage a signal sequence |
| * [[Programmer Guide/Macro Library/DataSetCmd|DataSetCmd]] → interface to the main application (Workspace) and its GUI | | * [[/DataSetCmd|DataSetCmd]] → interface to the main application (Workspace) and its GUI |
|
| |
|
| ==Classes== | | ==Classes== |
| Line 20: |
Line 21: |
|
| |
|
| ==Outdated Documentation== | | ==Outdated Documentation== |
|
| |
|
| |
| :{|class="einrahmen"
| |
| ![[/CAppSetup|CAppSetup.stx]]
| |
| |-
| |
| | || Implements the setup dialogs, runtime control classes and the analysis methods for all Viewer-applications.<BR>Documentation included in source file.
| |
| |-
| |
| ![[/CGraphSetup|CGraphSetup.stx]]
| |
| |-
| |
| |'''class [[/CGraphSetup|CGraphSetup]]<BR>graphics profile'''
| |
| |[[/CGraphSetup#...|...]] · ...
| |
| |-
| |
| |'''class [[/SGraphColors|SGraphColors]]<BR>graph settings'''
| |
| |[[/SGraphColors#...|...]] · ...
| |
| |-
| |
| !Classes.stx<BR>basic class library
| |
| |-
| |
| |'''class [[/CObj|CObj]]<BR>the base class'''
| |
| |[[/CObj#...|...]] · ...
| |
| |-
| |
| |'''class [[/CObjEx|CObjEx]]<BR>extension class for scripts'''
| |
| |[[/CObjEx#...|...]] · ...
| |
| |-
| |
| |'''class [[/ModalDialog|ModalDialog]]<BR>a modal dialog'''
| |
| |[[/ModalDialog#...|...]] · ...
| |
| |-
| |
| |'''class [[/SetupSheet|SetupSheet]]<BR>property sheets'''
| |
| |[[/SetupSheet#...|...]] · ...
| |
| |-
| |
| |'''class [[/PlayWave|PlayWave]]<BR>general play class'''
| |
| |[[/PlayWave#...|...]] · ...
| |
| |-
| |
| |'''class SetWaveIO<BR>wave device setup'''
| |
| |Implements the wave device settings dialog and some wave device select/query functions.<BR>Documentation included in source file.
| |
| |-
| |
| |'''class [[/CalibSig|CalibSig]]<BR>signal calibration'''
| |
| |[[/CalibSig#...|...]] · ...
| |
| |-
| |
| |'''class CAppQueue<BR>batch queue'''
| |
| |This class is used to control the viewers and other applications started by the workspace application.<BR>Documentation included in source file.
| |
| |-
| |
| |'''class [[/BSignal|BSignal]]<BR>signal processing controller'''
| |
| |Implements the dialogs and execution modules for the signal modification methods (amplify, normalize, div. filters) included in the workspace application.<BR>Documentation included in source file.
| |
| |-
| |
| |'''class [[/CDlgMap|CDlgMap]]<BR>enhanced modal dialog'''
| |
| |[[/CDlgMap#...|...]] · ...
| |
| |-
| |
| |'''class [[/CMenu|CMenu]]<BR>menu handling class'''
| |
| |[[/CMenu#...|...]] · ...
| |
| |-
| |
| |'''class [[/XWave|XWave]]<BR>enhanced wave object'''
| |
| |[[/XWave#...|...]] · ...
| |
| |-
| |
| |'''class [[/XPlot|XPlot]]<BR>general function plot'''
| |
| |[[/XPlot#...|...]] · ...
| |
| |-
| |
| |'''class [[/XGraph|XGraph]]<BR>a graph in a XPlot display'''
| |
| |[[/XGraph#...|...]] · ...
| |
| |-
| |
| |'''class [[/CTemplates|CTemplates]]<BR>manage XML templates'''
| |
| |Management class for the templates used by the workspace application (e.g. ASegTemplate).<BR>Documentation included in source file.
| |
| |-
| |
| |'''class [[/NDLib|NDLib]]<BR>signal processing, audio descriptors, ...'''
| |
| |[[/NDLib#...|...]] · ...
| |
| |-
| |
| |'''class [[/TBMGR|TBMGR]]<BR>toolbox manager and base class'''
| |
| |[[/TBMGR#...|...]] · ...
| |
| |-
| |
| |'''class [[/KlattSyn|KlattSyn]]<BR>formant speech synthesis'''
| |
| |[[/KlattSyn#...|...]] · ...
| |
| |-
| |
| ![[/DataSetCmd|DataSet.stx]]
| |
| |-
| |
| |'''macro [[/DataSetCmd|DataSetCmd]]<BR>execute dataset command'''
| |
| |[[/DataSetCmd#...|...]] · ...
| |
| |-
| |
| !Parameter
| |
| |-
| |
| |'''class [[/APar|APar]]<BR>parameter data management'''
| |
| |[[/APar#...|...]] · ...
| |
| |-
| |
| ![[/StdLib|StdLib.stx]]<BR>basic macro library
| |
| |-
| |
| |'''application management'''
| |
| |[[/StdLib#AppLoad|AppLoad]] · [[/StdLib#AppMain|AppMain]] · [[/StdLib#AppCleanup|AppCleanup]] · [[/StdLib#AppHelp|AppHelp]]
| |
| |-
| |
| |'''message handling'''
| |
| |[[/StdLib#PostMessage|PostMessage]] · [[/StdLib#SetMsgHandler|SetMsgHandler]] · [[/StdLib#DispatchMsg|DispatchMsg]] · [[/StdLib#MsgQueue|MsgQueue]] · [[/StdLib#MsgFilter|MsgFilter]] · [[/StdLib#GetMessage|GetMessage]]
| |
| |-
| |
| |'''utilities for standard<BR>{{STX}} applications'''
| |
| |[[/StdLib#ExtSetup|ExtSetup]] · [[/StdLib#PlayCursor|PlayCursor]] · [[/StdLib#GenerateScaleParams|GenerateScaleParams]] · [[/StdLib#MetaSegment|MetaSegment]]
| |
| |-
| |
| |'''file functions'''
| |
| |[[/StdLib#stxFileTypeList|stxFileTypeList]] · [[/StdLib#stxFileType|stxFileType]] · [[/StdLib#SectionFile|SectionFile]] · [[/StdLib#FileToolBox|FileToolBox]]
| |
| |-
| |
| |'''display functions'''
| |
| |[[/StdLib#LogWindow|LogWindow]] · [[/StdLib#ConLog|ConLog]] · [[/StdLib#UM and EM|UM and EM]] · [[/StdLib#ShowItem|ShowItem]]
| |
| |-
| |
| |'''dialog and window functions'''
| |
| |[[/StdLib#CreateMenu|CreateMenu]] · [[/StdLib#DoModalDialog|DoModalDialog]] · [[/StdLib#SetModalWindow|SetModalWindow]] · [[/StdLib#GetWindowPos|GetWindowPos]] · [[/StdLib#SetWindowPos|SetWindowPos]] · [[/StdLib#WindowSizeDlg|WindowSizeDlg]] · [[/StdLib#GetMonitor|GetMonitor]] · [[/StdLib#GetDesktop|GetDesktop]] · [[/StdLib#ProgressBox|ProgressBox]] · [[/StdLib#InitDialogItem|InitDialogItem]] · [[/StdLib#SetControlMode|SetControlMode]]
| |
| |-
| |
| |'''[[Programmer_Guide/Shell_Items/SPU|SPU]] and [[Programmer_Guide/Shell_Items/Graph|graph]] functions'''
| |
| |[[/StdLib#SetGraphXScale|SetGraphXScale]] · [[/StdLib#GetOutputValue|GetOutputValue]]
| |
| |-
| |
| |'''[[Programmer_Guide/Shell_Items/SPU|SPUs]]'''
| |
| |[[/StdLib#XScaleLinear|XScaleLinear]] · [[/StdLib#XScaleBark|XScaleBark]] · [[/StdLib#Table2Output|Table2Output]] · [[/StdLib#Wave2output|Wave2output]]
| |
| |-
| |
| |}
| |
|
| |
|
| |
|
|
| |
|
