|
|
| (20 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| {{DISPLAYTITLE:Macros and Classes of the Standard Library}} | | {{DISPLAYTITLE:Macros and Classes of the Standard Library}} |
|
| |
| 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== | | ==Alphabetical List of Macros and Classes== |
| * [[Programmer_Guide/Macro_Library/BUTIL|BUtil]] → misc. utility functions
| | <splist |
| * [[Programmer_Guide/Macro_Library/UM|UM or EM]] → simple message boxes
| | parent=Programmer_Guide/Macro_Library |
| * [[Programmer Guide/Macro Library/CONLOG|ConLog]] → write messages to [[User_Guide|STX_Console]] Console and/or [[User_Guide/Log_Window|Log-window]]
| | sort=asc |
| * [[Programmer_Guide/Macro_Library/LOGWINDOW|LogWindow]] → [[User_Guide/Log_Window|Log-window]] control functions
| | sortby=title |
| * [[Programmer Guide/Macro Library/SHOWITEM|ShowItem]] → show [[Programmer_Guide/Shell_Items|shell item]] properties and/or data
| | showpath=no |
| * [[Programmer Guide/Macro Library/BSF|BSF]] → soundfile management functions
| | liststyle=bar |
| * [[Programmer Guide/Macro Library/DataSetCmd|DataSetCmd]] → interface to the main application (Workspace) and its GUI
| | kidsonly=yes |
| | | /> |
| ==Classes==
| |
| * [[/COBJ|CObj - the base class for all {{STX}} classes]]
| |
| * [[/BXMLDoc|BXMLDoc - general xml document]] ← CObj
| |
| * [[/BSTXIni|BSTXIni - workspace document]] ← BXMLDoc
| |
| * [[/BDataSet|BDataSet - project document and project management]] ← BXMLDoc
| |
| | |
| ==Outdated Documentation==
| |
| | |
|
| |
|
| :{|class="einrahmen"
| | ==Quick Overview== |
| ![[/ADesc|ADesc.stx]]
| | ;Macros |
| | {|class=keinrahmen |
| | |'''Name''' ||'''Description''' |
| |- | | |- |
| | ||Implements a set of classes to store and retrieve audio descriptor data in a combined XML/binary format.<BR>Documentation included in source file. | | |[[/BUTIL|BUtil]] ||misc. utility functions |
| |- | | |- |
| ![[/BDataSet|BDataSet.stx]]
| | |[[/UM|UM or EM]] ||simple message boxes to display user- and error-messages |
| |- | | |- |
| |'''class [[/BDataSet|BDataSet]]<BR>project document''' | | |[[/CONLOG|ConLog]] ||write messages to [[User_Guide/STX_Console|script console]] and/or [[User_Guide/Log_Window|Log-window]] |
| |[[/BDataSet#...|...]] · ... | |
| |- | | |- |
| ![[/BSeq|BSeq.stx]]
| | |[[/LOGWINDOW|LogWindow]] || [[User_Guide/Log_Window|Log-window]] control functions |
| |- | | |- |
| |'''class [[/BSeq|BSeq]]<BR>signal sequence''' | | |[[/SHOWITEM|ShowItem]] ||show [[Programmer_Guide/Shell_Items|shell item]] properties and/or data |
| |[[/CAppSetup#...|...]] · ... | |
| |- | | |- |
| ![[/BSF|BSF.stx]]
| | |[[/BSF|BSF]] ||soundfile management functions |
| |- | | |- |
| |'''macro [[/BSF|BSF]]<BR>soundfile handling | | |[[/DataSetCmd|DataSetCmd]] ||interface to the main application (Workspace) and its GUI |
| |[[/BSF#NewDialog|NewDialog]] · [[/BSF#OpenDialog|OpenDialog]] · [[/BSF#Open|Open]] · [[/BSF#Close|Close]] · [[/BSF#CloseAll|CloseAll]] · [[/BSF#Select|Select]] · [[/BSF#Truncate|Truncate]]
| | |} |
| |-
| | |
| ![[/BSTXIni|BSTXIni.stx]]
| | ;Classes |
| |-
| | {|class="keinrahmen" |
| |'''class [[/BSTXIni|BSTXIni]]<BR>workspace document'''
| | |'''Name''' ||'''Description''' ||'''Parent-Class''' |
| |[[/BSTXIni#...|...]] · ...
| |
| |-
| |
| ![[/BUTIL|BUTIL.stx]]
| |
| |-
| |
| | '''macro [[/BUTIL|BUTIL]]<BR>misc. utility functions'''
| |
| |[[/BUTIL#MsgBox|MsgBox]] · [[/BUTIL#EditBox|EditBox]] · [[/BUTIL#FileDialog|FileDialog]] · [[/BUTIL#FileCommands|Copy/Move/DeleteFile]] · [[/BUTIL#DirectoryDialog|DirectoryDialog]] · [[/BUTIL#GetDirectory|GetDirectory]] · [[/BUTIL#Directory|Directory]] · [[/BUTIL#GetSwitch|GetSwitch]] · [[/BUTIL#GetKeyWord|GetKeyWord]] · [[/BUTIL#GetKeyIndex|GetKeyIndex]] · [[/BUTIL#SelectTable|SelectTable]]
| |
| |-
| |
| ![[/BXMLDoc|BXMLDoc.stx]]
| |
| |-
| |
| |'''class [[/BXMLDoc|BXMLDoc]]<BR>xml document'''
| |
| |[[/BXMLDoc#...|...]] · ...
| |
| |-
| |
| ![[/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''' | | |[[/COBJ|CObj]] ||the base class for all {{STX}} classes || |
| |[[/APar#...|...]] · ... | |
| |- | | |- |
| ![[/StdLib|StdLib.stx]]<BR>basic macro library
| | |[[/BSeq|BSeq]] ||create, configure and manage a signal sequence ||CObj |
| |- | | |- |
| |'''application management'''
| | |[[/BXMLDoc|BXMLDoc]] ||general xml document ||CObj |
| |[[/StdLib#AppLoad|AppLoad]] · [[/StdLib#AppMain|AppMain]] · [[/StdLib#AppCleanup|AppCleanup]] · [[/StdLib#AppHelp|AppHelp]] | |
| |- | | |- |
| |'''message handling''' | | |[[/BSTXIni|BSTXIni]] ||the workspace document ||BXMLDoc |
| |[[/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]]
| |
| |- | | |- |
| | |[[/BDataSet|BDataSet]] ||project document and project management ||BXMLDoc |
| |} | | |} |
|
| |
|
| | | ==See also== |
| | | [[/Kernal|Macros and Classes of the STx Kernal]] |
| ===alphabetical list of macros===
| |
| | |
| <splist
| |
| parent=
| |
| sort=asc
| |
| sortby=title
| |
| showpath=no
| |
| liststyle=bar
| |
| kidsonly=yes
| |
| /> | |
