Programmer Guide/Macro Library: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
No edit summary
Line 4: Line 4:


:{|class="einrahmen"
:{|class="einrahmen"
![[/StdLib|StdLib.stx]]
![[/ADesc|ADesc.stx]]
|-
|-
|'''application management'''
|'''class ADesc<BR>general audio descriptor management'''
|[[/StdLib#AppLoad|AppLoad]] &middot; [[/StdLib#AppMain|AppMain]] &middot; [[/StdLib#AppCleanup|AppCleanup]] &middot; [[/StdLib#AppHelp|AppHelp]]
|[[/ADesc#...|...]] &middot; ...
|-
|-
|'''message handling'''
![[/BDataSet|BDataSet.stx]]
|[[/StdLib#PostMessage|PostMessage]] &middot; [[/StdLib#SetMsgHandler|SetMsgHandler]] &middot; [[/StdLib#DispatchMsg|DispatchMsg]] &middot; [[/StdLib#MsgQueue|MsgQueue]] &middot; [[/StdLib#MsgFilter|MsgFilter]] &middot; [[/StdLib#GetMessage|GetMessage]]
|-
|-
|'''utilities for standard<BR>{{STX}} applications'''
|'''class BDataSet<BR>project document'''
|[[/StdLib#ExtSetup|ExtSetup]] &middot; [[/StdLib#PlayCursor|PlayCursor]] &middot; [[/StdLib#GenerateScaleParams|GenerateScaleParams]] &middot; [[/StdLib#MetaSegment|MetaSegment]]
|[[/BDataSet#...|...]] &middot; ...
|-
|-
|'''file functions'''
![[/BSeq|BSeq.stx]]
|[[/StdLib#stxFileTypeList|stxFileTypeList]] &middot; [[/StdLib#stxFileType|stxFileType]] &middot; [[/StdLib#SectionFile|SectionFile]] &middot; [[/StdLib#FileToolBox|FileToolBox]]
|-
|-
|'''display functions'''
|'''class BSeq<BR>signal sequence'''
|[[/StdLib#LogWindow|LogWindow]] &middot; [[/StdLib#ConLog|ConLog]] &middot; [[/StdLib#UM and EM|UM and EM]] &middot; [[/StdLib#ShowItem|ShowItem]]
|[[/CAppSetup#...|...]] &middot; ...
|-
|-
|'''dialog and window functions'''
![[/BSF|BSF.stx]]
|[[/StdLib#CreateMenu|CreateMenu]] &middot; [[/StdLib#DoModalDialog|DoModalDialog]] &middot; [[/StdLib#SetModalWindow|SetModalWindow]] &middot; [[/StdLib#GetWindowPos|GetWindowPos]] &middot; [[/StdLib#SetWindowPos|SetWindowPos]] &middot; [[/StdLib#WindowSizeDlg|WindowSizeDlg]] &middot; [[/StdLib#GetMonitor|GetMonitor]] &middot; [[/StdLib#GetDesktop|GetDesktop]] &middot; [[/StdLib#ProgressBox|ProgressBox]] &middot; [[/StdLib#InitDialogItem|InitDialogItem]] &middot; [[/StdLib#SetControlMode|SetControlMode]]
|-
|-
|'''[[Programmer_Guide/Shell_Items/SPU|SPU]] and [[Programmer_Guide/Shell_Items/Graph|graph]] functions'''
|'''macro BSF<BR>soundfile handling
|[[/StdLib#SetGraphXScale|SetGraphXScale]] &middot; [[/StdLib#GetOutputValue|GetOutputValue]]
|[[/BSF#NewDialog|NewDialog]] &middot; [[/BSF#OpenDialog|OpenDialog]] &middot; [[/BSF#Open|Open]] &middot; [[/BSF#Close|Close]] &middot; [[/BSF#CloseAll|CloseAll]] &middot; [[/BSF#Select|Select]] &middot; [[/BSF#Truncate|Truncate]]
|-
|-
|'''[[Programmer_Guide/Shell_Items/SPU|SPUs]]'''
![[/BSTXIni|BSTXIni.stx]]
|[[/StdLib#XScaleLinear|XScaleLinear]] &middot; [[/StdLib#XScaleBark|XScaleBark]] &middot; [[/StdLib#Table2Output|Table2Output]] &middot; [[/StdLib#Wave2output|Wave2output]]
|-
|-
![[/BSF|BSF.stx]]
|'''class BSTXIni<BR>workspace document'''
|-
|[[/BSTXIni#...|...]] &middot; ...
| ||'''macro BSF<BR>soundfile handling
|[[/BSF#NewDialog|NewDialog]] &middot; [[/BSF#OpenDialog|OpenDialog]] &middot; [[/BSF#Open|Open]] &middot; [[/BSF#Close|Close]] &middot; [[/BSF#CloseAll|CloseAll]] &middot; [[/BSF#Select|Select]] &middot; [[/BSF#Truncate|Truncate]]
|-
|-
![[/BUTIL|BUTIL.stx]]
![[/BUTIL|BUTIL.stx]]
Line 39: Line 33:
| '''macro BUTIL<BR>misc. utility functions'''
| '''macro BUTIL<BR>misc. utility functions'''
|[[/BUTIL#MsgBox|MsgBox]] &middot; [[/BUTIL#EditBox|EditBox]] &middot; [[/BUTIL#FileDialog|FileDialog]] &middot; [[/BUTIL#FileCommands|Copy/Move/DeleteFile]] &middot; [[/BUTIL#DirectoryDialog|DirectoryDialog]] &middot; [[/BUTIL#GetDirectory|GetDirectory]] &middot; [[/BUTIL#Directory|Directory]] &middot; [[/BUTIL#GetSwitch|GetSwitch]] &middot; [[/BUTIL#GetKeyWord|GetKeyWord]] &middot; [[/BUTIL#GetKeyIndex|GetKeyIndex]] &middot; [[/BUTIL#SelectTable|SelectTable]]
|[[/BUTIL#MsgBox|MsgBox]] &middot; [[/BUTIL#EditBox|EditBox]] &middot; [[/BUTIL#FileDialog|FileDialog]] &middot; [[/BUTIL#FileCommands|Copy/Move/DeleteFile]] &middot; [[/BUTIL#DirectoryDialog|DirectoryDialog]] &middot; [[/BUTIL#GetDirectory|GetDirectory]] &middot; [[/BUTIL#Directory|Directory]] &middot; [[/BUTIL#GetSwitch|GetSwitch]] &middot; [[/BUTIL#GetKeyWord|GetKeyWord]] &middot; [[/BUTIL#GetKeyIndex|GetKeyIndex]] &middot; [[/BUTIL#SelectTable|SelectTable]]
|-
![[/BXMLDoc|BXMLDoc.stx]]
|-
|'''class BXMLDoc<BR>xml document'''
|[[/BXMLDoc#...|...]] &middot; ...
|-
![[/CAppSetup|CAppSetup.stx]]
|-
|'''class CAppSetup<BR>viewer setup and control'''
|[[/CAppSetup#...|...]] &middot; ...
|-
![[/CGraphSetup|CGraphSetup.stx]]
|-
|'''class CGraphSetup<BR>graphics profile'''
|[[/CGraphSetup#...|...]] &middot; ...
|-
|'''class SGraphColors<BR>graph settings'''
|[[/SGraphColors#...|...]] &middot; ...
|-
|-
![[/Classes|Classes.stx]]
![[/Classes|Classes.stx]]
Line 95: Line 107:
|'''class KlattSyn<BR>formant speech synthesis'''
|'''class KlattSyn<BR>formant speech synthesis'''
|[[/KlattSyn#...|...]] &middot; ...
|[[/KlattSyn#...|...]] &middot; ...
|-
![[/BXMLDoc|BXMLDoc.stx]]
|-
|'''class BXMLDoc<BR>xml document'''
|[[/BXMLDoc#...|...]] &middot; ...
|-
![[/BSTXIni|BSTXIni.stx]]
|-
|'''class BSTXIni<BR>workspace document'''
|[[/BSTXIni#...|...]] &middot; ...
|-
![[/BDataSet|BDataSet.stx]]
|-
|'''class BDataSet<BR>project document'''
|[[/BDataSet#...|...]] &middot; ...
|-
|-
![[/DataSetCmd|DataSet.stx]]
![[/DataSetCmd|DataSet.stx]]
Line 116: Line 113:
|[[/DataSetCmd#...|...]] &middot; ...
|[[/DataSetCmd#...|...]] &middot; ...
|-
|-
![[/CGraphSetup|CGraphSetup.stx]]
![[/Parameter|Parameter.stx]]
|-
|-
|'''class CGraphSetup<BR>graphics profile'''
|'''class APar<BR>parameter data management'''
|[[/CGraphSetup#...|...]] &middot; ...
|[[/APar#...|...]] &middot; ...
|-
|-
|'''class SGraphColors<BR>graph settings'''
![[/StdLib|StdLib.stx]]
|[[/SGraphColors#...|...]] &middot; ...
|-
|-
![[/CAppSetup|CAppSetup.stx]]
|'''application management'''
|[[/StdLib#AppLoad|AppLoad]] &middot; [[/StdLib#AppMain|AppMain]] &middot; [[/StdLib#AppCleanup|AppCleanup]] &middot; [[/StdLib#AppHelp|AppHelp]]
|-
|-
|'''class CAppSetup<BR>viewer setup and control'''
|'''message handling'''
|[[/CAppSetup#...|...]] &middot; ...
|[[/StdLib#PostMessage|PostMessage]] &middot; [[/StdLib#SetMsgHandler|SetMsgHandler]] &middot; [[/StdLib#DispatchMsg|DispatchMsg]] &middot; [[/StdLib#MsgQueue|MsgQueue]] &middot; [[/StdLib#MsgFilter|MsgFilter]] &middot; [[/StdLib#GetMessage|GetMessage]]
|-
|-
![[/BSeq|BSeq.stx]]
|'''utilities for standard<BR>{{STX}} applications'''
|[[/StdLib#ExtSetup|ExtSetup]] &middot; [[/StdLib#PlayCursor|PlayCursor]] &middot; [[/StdLib#GenerateScaleParams|GenerateScaleParams]] &middot; [[/StdLib#MetaSegment|MetaSegment]]
|-
|-
|'''class BSeq<BR>signal sequence'''
|'''file functions'''
|[[/CAppSetup#...|...]] &middot; ...
|[[/StdLib#stxFileTypeList|stxFileTypeList]] &middot; [[/StdLib#stxFileType|stxFileType]] &middot; [[/StdLib#SectionFile|SectionFile]] &middot; [[/StdLib#FileToolBox|FileToolBox]]
|-
|-
![[/Parameter|Parameter.stx]]
|'''display functions'''
|[[/StdLib#LogWindow|LogWindow]] &middot; [[/StdLib#ConLog|ConLog]] &middot; [[/StdLib#UM and EM|UM and EM]] &middot; [[/StdLib#ShowItem|ShowItem]]
|-
|-
|'''class APar<BR>parameter data management'''
|'''dialog and window functions'''
|[[/APar#...|...]] &middot; ...
|[[/StdLib#CreateMenu|CreateMenu]] &middot; [[/StdLib#DoModalDialog|DoModalDialog]] &middot; [[/StdLib#SetModalWindow|SetModalWindow]] &middot; [[/StdLib#GetWindowPos|GetWindowPos]] &middot; [[/StdLib#SetWindowPos|SetWindowPos]] &middot; [[/StdLib#WindowSizeDlg|WindowSizeDlg]] &middot; [[/StdLib#GetMonitor|GetMonitor]] &middot; [[/StdLib#GetDesktop|GetDesktop]] &middot; [[/StdLib#ProgressBox|ProgressBox]] &middot; [[/StdLib#InitDialogItem|InitDialogItem]] &middot; [[/StdLib#SetControlMode|SetControlMode]]
|-
|-
![[/ADesc|ADesc.stx]]
|'''[[Programmer_Guide/Shell_Items/SPU|SPU]] and [[Programmer_Guide/Shell_Items/Graph|graph]] functions'''
|[[/StdLib#SetGraphXScale|SetGraphXScale]] &middot; [[/StdLib#GetOutputValue|GetOutputValue]]
|-
|-
|'''class ADesc<BR>general audio descriptor management'''
|'''[[Programmer_Guide/Shell_Items/SPU|SPUs]]'''
|[[/ADesc#...|...]] &middot; ...
|[[/StdLib#XScaleLinear|XScaleLinear]] &middot; [[/StdLib#XScaleBark|XScaleBark]] &middot; [[/StdLib#Table2Output|Table2Output]] &middot; [[/StdLib#Wave2output|Wave2output]]
|-
|-
|}
|}

Revision as of 17:22, 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.

ADesc.stx
class ADesc
general audio descriptor management
... · ...
BDataSet.stx
class BDataSet
project document
... · ...
BSeq.stx
class BSeq
signal sequence
... · ...
BSF.stx
macro BSF
soundfile handling
NewDialog · OpenDialog · Open · Close · CloseAll · Select · Truncate
BSTXIni.stx
class BSTXIni
workspace document
... · ...
BUTIL.stx
macro BUTIL
misc. utility functions
MsgBox · EditBox · FileDialog · Copy/Move/DeleteFile · DirectoryDialog · GetDirectory · Directory · GetSwitch · GetKeyWord · GetKeyIndex · SelectTable
BXMLDoc.stx
class BXMLDoc
xml document
... · ...
CAppSetup.stx
class CAppSetup
viewer setup and control
... · ...
CGraphSetup.stx
class CGraphSetup
graphics profile
... · ...
class SGraphColors
graph settings
... · ...
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
... · ...
DataSet.stx
macro DataSetCmd
execute dataset command
... · ...
Parameter.stx
class APar
parameter data management
... · ...
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


alphabetical list of macros

sort=asc has no subpages to list.

Navigation menu

Personal tools