Programmer Guide/Macro Library: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 56: | Line 56: | ||
|[[/StdLib#XScaleLinear|XScaleLinear]] · [[/StdLib#XScaleBark|XScaleBark]] · [[/StdLib#Table2Output|Table2Output]] · [[/StdLib#Wave2output|Wave2output]] | |[[/StdLib#XScaleLinear|XScaleLinear]] · [[/StdLib#XScaleBark|XScaleBark]] · [[/StdLib#Table2Output|Table2Output]] · [[/StdLib#Wave2output|Wave2output]] | ||
|- | |- | ||
|[[/BSF|BSF.stx]] ||— | |||
|[[/BSF|BSF.stx]] | |||
|- | |- | ||
| ||'''macro BSF<BR>soundfile handling ||→ | | ||'''macro BSF<BR>soundfile handling ||→ | ||
|[[/BSF#NewDialog|NewDialog]] · [[/BSF#OpenDialog|OpenDialog]] · [[/BSF#Open|Open]] · [[/BSF#Close|Close]] · [[/BSF#CloseAll|CloseAll]] · [[/BSF#Select|Select]] · [[/BSF#Truncate|Truncate]] | |[[/BSF#NewDialog|NewDialog]] · [[/BSF#OpenDialog|OpenDialog]] · [[/BSF#Open|Open]] · [[/BSF#Close|Close]] · [[/BSF#CloseAll|CloseAll]] · [[/BSF#Select|Select]] · [[/BSF#Truncate|Truncate]] | ||
|- | |- | ||
|[[/BUTIL|BUTIL.stx]] ||— | |||
|[[/BUTIL|BUTIL.stx]] | |||
|- | |- | ||
| || '''macro BUTIL<BR>misc. utility functions ||→ | | || '''macro 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]] | |[[/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]] | ||
|- | |- | ||
|[[/Classes|Classes.stx]] ||— | |||
|[[/Classes|Classes.stx]] | |||
|- | |- | ||
| ||'''class CObj<BR>the base class''' || → | | ||'''class CObj<BR>the base class''' || → | ||
| Line 168: | Line 156: | ||
|[[/KlattSyn#...|...]] · ... | |[[/KlattSyn#...|...]] · ... | ||
|- | |- | ||
|[[/BXMLDoc|BXMLDoc.stx]] ||— | |||
|[[/BXMLDoc|BXMLDoc.stx]] | |||
|- | |- | ||
| ||'''class BXMLDoc<BR>xml document''' || → | | ||'''class BXMLDoc<BR>xml document''' || → | ||
|[[/BXMLDoc#...|...]] · ... | |[[/BXMLDoc#...|...]] · ... | ||
|- | |- | ||
|[[/BSTXIni|BSTXIni.stx]] ||— | |||
|[[/BSTXIni|BSTXIni.stx]] | |||
|- | |- | ||
| ||'''class BSTXIni<BR>workspace document''' || → | | ||'''class BSTXIni<BR>workspace document''' || → | ||
|[[/BSTXIni#...|...]] · ... | |[[/BSTXIni#...|...]] · ... | ||
|- | |- | ||
|[[/BDataSet|BDataSet.stx]] ||— | |||
|[[/BDataSet|BDataSet.stx]] | |||
|- | |- | ||
| ||'''class BDataSet<BR>project document''' || → | | ||'''class BDataSet<BR>project document''' || → | ||
|[[/BDataSet#...|...]] · ... | |[[/BDataSet#...|...]] · ... | ||
|- | |- | ||
|[[/DataSetCmd|DataSet.stx]] ||— | |||
|[[/DataSetCmd|DataSet.stx]] | |||
|- | |- | ||
| ||'''macro DataSetCmd<BR>execute dataset command''' || → | | ||'''macro DataSetCmd<BR>execute dataset command''' || → | ||
|[[/DataSetCmd#...|...]] · ... | |[[/DataSetCmd#...|...]] · ... | ||
|- | |- | ||
|[[/CGraphSetup|CGraphSetup.stx]] ||— | |||
|[[/CGraphSetup|CGraphSetup.stx]] | |||
|- | |- | ||
| ||'''class CGraphSetup<BR>graphics profile''' || → | | ||'''class CGraphSetup<BR>graphics profile''' || → | ||
| Line 218: | Line 186: | ||
|[[/SGraphColors#...|...]] · ... | |[[/SGraphColors#...|...]] · ... | ||
|- | |- | ||
|[[/CAppSetup|CAppSetup.stx]] ||— | |||
|[[/CAppSetup|CAppSetup.stx]] | |||
|- | |- | ||
| ||'''class CAppSetup<BR>viewer setup and control''' || → | | ||'''class CAppSetup<BR>viewer setup and control''' || → | ||
Revision as of 15:43, 12 May 2011
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.
alphabetical list of macros
sort=asc has no subpages to list.
StdLib.stx — application management → AppLoad — AppMain · AppCleanup · AppHelp — message handling → PostMessage · SetMsgHandler · DispatchMsg · MsgQueue · MsgFilter · GetMessage — utilities for standard
STx applications→ ExtSetup · PlayCursor · GenerateScaleParams · MetaSegment — file functions → stxFileTypeList · stxFileType · SectionFile · FileToolBox — display functions → LogWindow · ConLog · UM and EM · ShowItem — dialog and window functions → CreateMenu · DoModalDialog · SetModalWindow · GetWindowPos · SetWindowPos · WindowSizeDlg · GetMonitor · GetDesktop · ProgressBox · InitDialogItem · SetControlMode — SPU and graph functions → SetGraphXScale · GetOutputValue — SPUs → XScaleLinear · XScaleBark · Table2Output · Wave2output BSF.stx — macro BSF
soundfile handling→ NewDialog · OpenDialog · Open · Close · CloseAll · Select · Truncate BUTIL.stx — macro BUTIL
misc. utility functions→ MsgBox · EditBox · FileDialog · Copy/Move/DeleteFile · DirectoryDialog · GetDirectory · Directory · GetSwitch · GetKeyWord · GetKeyIndex · SelectTable Classes.stx — class CObj
the base class→ ... · ... — class CObjEx
extension class for scripts→ ... · ... — class ModalDialog
a modal dialog→ ... · ... — class SetupSheet
property sheets→ ... · ... — class PlayWave
general play class→ ... · ... — class SetWaveIO
wave device setup→ ... · ... — class CalibSig
signal calibration→ ... · ... — class CAppQueue
application queue for batch processing→ ... · ... — class BSignal
signal processing controller→ ... · ... — class CDlgMap
enhanced modal dialog→ ... · ... — class CMenu
menu handling class→ ... · ... — class XWave
enhanced wave object→ ... · ... — class XPlot
general function plot→ ... · ... — class XGraph
a graph in a XPlot display→ ... · ... — class CTemplates
manage XML templates→ ... · ... — class NDLib
signal processing, audio descriptors, ...→ ... · ... — class TBMGR
toolbox manager and base class→ ... · ... — class KlattSyn
formant speech synthesis→ ... · ... BXMLDoc.stx — class BXMLDoc
xml document→ ... · ... BSTXIni.stx — class BSTXIni
workspace document→ ... · ... BDataSet.stx — class BDataSet
project document→ ... · ... DataSet.stx — macro DataSetCmd
execute dataset command→ ... · ... CGraphSetup.stx — class CGraphSetup
graphics profile→ ... · ... — class SGraphColors
graph settings→ ... · ... CAppSetup.stx — class CAppSetup
viewer setup and control→ ... · ... —
