Programmer Guide/Macro Library: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
No edit summary
 
(57 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
{{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.
==Alphabetical List of Macros and Classes==
<splist
parent=Programmer_Guide/Macro_Library
sort=asc
sortby=title
showpath=no
liststyle=bar
kidsonly=yes
/>


:{|class="einrahmen"
==Quick Overview==
![[/ADesc|ADesc.stx]]
;Macros
{|class=keinrahmen
|'''Name''' ||'''Description'''
|-
|-
|'''class [[/ADesc|ADesc]]<BR>general audio descriptor management'''
|[[/BUTIL|BUtil]] ||misc. utility functions
|[[/ADesc#...|...]] &middot; ...
|-
|-
![[/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#...|...]] &middot; ...
|-
|-
![[/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#...|...]] &middot; ...
|-
|-
![[/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]] &middot; [[/BSF#OpenDialog|OpenDialog]] &middot; [[/BSF#Open|Open]] &middot; [[/BSF#Close|Close]] &middot; [[/BSF#CloseAll|CloseAll]] &middot; [[/BSF#Select|Select]] &middot; [[/BSF#Truncate|Truncate]]
|}
|-
 
![[/BSTXIni|BSTXIni.stx]]
;Classes
|-
{|class="keinrahmen"
|'''class [[/BSTXIni|BSTXIni]]<BR>workspace document'''
|'''Name''' ||'''Description''' ||'''Parent-Class'''  
|[[/BSTXIni#...|...]] &middot; ...
|-
![[/BUTIL|BUTIL.stx]]
|-
| '''macro [[/BUTIL|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]]
|-
![[/BXMLDoc|BXMLDoc.stx]]
|-
|'''class [[/BXMLDoc|BXMLDoc]]<BR>xml document'''
|[[/BXMLDoc#...|...]] &middot; ...
|-
![[/CAppSetup|CAppSetup.stx]]
|-
|'''class [[/CAppSetup|CAppSetup]]<BR>viewer setup and control'''
|[[/CAppSetup#...|...]] &middot; ...
|-
![[/CGraphSetup|CGraphSetup.stx]]
|-
|'''class [[/CGraphSetup|CGraphSetup]]<BR>graphics profile'''
|[[/CGraphSetup#...|...]] &middot; ...
|-
|'''class [[/SGraphColors|SGraphColors]]<BR>graph settings'''
|[[/SGraphColors#...|...]] &middot; ...
|-
!Classes.stx<BR>basic class library
|-
|'''class [[/CObj|CObj]]<BR>the base class'''
|[[/CObj#...|...]] &middot; ...
|-
|'''class [[/CObjEx|CObjEx]]<BR>extension class for scripts'''
|[[/CObjEx#...|...]] &middot; ...
|-
|'''class [[/ModalDialog|ModalDialog]]<BR>a modal dialog'''
|[[/ModalDialog#...|...]] &middot; ...
|-
|'''class [[/SetupSheet|SetupSheet]]<BR>property sheets'''
|[[/SetupSheet#...|...]] &middot; ...
|-
|'''class [[/PlayWave|PlayWave]]<BR>general play class'''
|[[/PlayWave#...|...]] &middot; ...
|-
|'''class [[/SetWaveIO|SetWaveIO]]<BR>wave device setup'''
|[[/SetWaveIO#...|...]] &middot; ...
|-
|'''class [[/CalibSig|CalibSig]]<BR>signal calibration'''
|[[/CalibSig#...|...]] &middot; ...
|-
|'''class [[/CAppQueue|CAppQueue]]<BR>application queue for batch processing'''
|[[/CAppQueue#...|...]] &middot; ...
|-
|'''class [[/BSignal|BSignal]]<BR>signal processing controller'''
|[[/BSignal#...|...]] &middot; ...
|-
|'''class [[/CDlgMap|CDlgMap]]<BR>enhanced modal dialog'''
|[[/CDlgMap#...|...]] &middot; ...
|-
|'''class [[/CMenu|CMenu]]<BR>menu handling class'''
|[[/CMenu#...|...]] &middot; ...
|-
|'''class [[/XWave|XWave]]<BR>enhanced wave object'''
|[[/XWave#...|...]] &middot; ...
|-
|'''class [[/XPlot|XPlot]]<BR>general function plot'''
|[[/XPlot#...|...]] &middot; ...
|-
|'''class [[/XGraph|XGraph]]<BR>a graph in a XPlot display'''
|[[/XGraph#...|...]] &middot; ...
|-
|'''class [[/CTemplates|CTemplates]]<BR>manage XML templates'''
|[[/CTemplates#...|...]] &middot; ...
|-
|-
|'''class [[/NDLib|NDLib]]<BR>signal processing, audio descriptors, ...'''
|[[/COBJ|CObj]] ||the base class for all {{STX}} classes ||
|[[/NDLib#...|...]] &middot; ...
|-
|-
|'''class [[/TBMGR|TBMGR]]<BR>toolbox manager and base class'''
|[[/BSeq|BSeq]] ||create, configure and manage a signal sequence ||CObj
|[[/TBMGR#...|...]] &middot; ...
|-
|-
|'''class [[/KlattSyn|KlattSyn]]<BR>formant speech synthesis'''
|[[/BXMLDoc|BXMLDoc]] ||general xml document ||CObj
|[[/KlattSyn#...|...]] &middot; ...
|-
|-
![[/DataSetCmd|DataSet.stx]]
|[[/BSTXIni|BSTXIni]] ||the workspace document ||BXMLDoc
|-
|'''macro [[/DataSetCmd|DataSetCmd]]<BR>execute dataset command'''
|[[/DataSetCmd#...|...]] &middot; ...
|-
!Parameter
|-
|'''class [[/APar|APar]]<BR>parameter data management'''
|[[/APar#...|...]] &middot; ...
|-
![[/StdLib|StdLib.stx]]<BR>basic macro library
|-
|'''application management'''
|[[/StdLib#AppLoad|AppLoad]] &middot; [[/StdLib#AppMain|AppMain]] &middot; [[/StdLib#AppCleanup|AppCleanup]] &middot; [[/StdLib#AppHelp|AppHelp]]
|-
|'''message handling'''
|[[/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'''
|[[/StdLib#ExtSetup|ExtSetup]] &middot; [[/StdLib#PlayCursor|PlayCursor]] &middot; [[/StdLib#GenerateScaleParams|GenerateScaleParams]] &middot; [[/StdLib#MetaSegment|MetaSegment]]
|-
|'''file functions'''
|[[/StdLib#stxFileTypeList|stxFileTypeList]] &middot; [[/StdLib#stxFileType|stxFileType]] &middot; [[/StdLib#SectionFile|SectionFile]] &middot; [[/StdLib#FileToolBox|FileToolBox]]
|-
|'''display functions'''
|[[/StdLib#LogWindow|LogWindow]] &middot; [[/StdLib#ConLog|ConLog]] &middot; [[/StdLib#UM and EM|UM and EM]] &middot; [[/StdLib#ShowItem|ShowItem]]
|-
|'''dialog and window functions'''
|[[/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'''
|[[/StdLib#SetGraphXScale|SetGraphXScale]] &middot; [[/StdLib#GetOutputValue|GetOutputValue]]
|-
|'''[[Programmer_Guide/Shell_Items/SPU|SPUs]]'''
|[[/StdLib#XScaleLinear|XScaleLinear]] &middot; [[/StdLib#XScaleBark|XScaleBark]] &middot; [[/StdLib#Table2Output|Table2Output]] &middot; [[/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
/>

Latest revision as of 10:41, 7 March 2018

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.

Alphabetical List of Macros and Classes

ADesc · APar · BDataSet · BSF · BSTXIni · BSeq · BUTIL · BXMLDoc · CDlgMap · CMenu · COBJ · CONLOG · CObjEx · CREATEMENU · CTemplates · DISPATCHMSG · DOMODALDIALOG · DataSetCmd · EM · EXTSETUP · GENERATESCALEPARAMS · GETDESKTOP · GETMESSAGE · GETMONITOR · GETOUTPUTVALUE · GETWINDOWPOS · INITDIALOGITEM · Kernal · KlattSyn · LOGMSG · LOGWINDOW · METASEGMENT · MSGQUEUE · ModalDialog · PLAYCURSOR · POSTMESSAGE · PROGRESSBOX · Playwave · SECTIONFILE · SETCONTROLMODE · SETGRAPHXSCALE · SETMSGHANDLER · SETWAVEIO · SETWINDOWPOS · SHOWITEM · SOURCEFILE · SetupSheet · TBMGR · UM · WINDOWSIZEDLG · XGraph · XPlot · XWave

Quick Overview

Macros
Name Description
BUtil misc. utility functions
UM or EM simple message boxes to display user- and error-messages
ConLog write messages to script console and/or Log-window
LogWindow Log-window control functions
ShowItem show shell item properties and/or data
BSF soundfile management functions
DataSetCmd interface to the main application (Workspace) and its GUI
Classes
Name Description Parent-Class
CObj the base class for all STx classes
BSeq create, configure and manage a signal sequence CObj
BXMLDoc general xml document CObj
BSTXIni the workspace document BXMLDoc
BDataSet project document and project management BXMLDoc

See also

Macros and Classes of the STx Kernal

Retrieved from "https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=Programmer_Guide/Macro_Library&oldid=9885"

Navigation menu

Personal tools