Programmer Guide/Macro Library: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
No edit summary
 
(65 intermediate revisions by 5 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===


==Alphabetical List of Macros and Classes==
<splist
<splist
parent=
parent=Programmer_Guide/Macro_Library
sort=asc
sort=asc
sortby=title
sortby=title
Line 14: Line 12:
/>
/>


 
==Quick Overview==
:{|class="keinrahmen"
;Macros
|[[/StdLib|StdLib.stx]] ||&mdash;
{|class=keinrahmen
|'''Name''' ||'''Description'''
|-
|-
| ||'''application management''' || &rarr;
|[[/BUTIL|BUtil]] ||misc. utility functions
|[[/StdLib#AppLoad|AppLoad]] &mdash; [[/StdLib#AppMain|AppMain]] &middot; [[/StdLib#AppCleanup|AppCleanup]] &middot; [[/StdLib#AppHelp|AppHelp]]
|-
|-
| ||&mdash;
|[[/UM|UM or EM]] ||simple message boxes to display user- and error-messages
|-
|-
| ||'''message handling''' ||&rarr;
|[[/CONLOG|ConLog]] ||write messages to [[User_Guide/STX_Console|script console]] and/or [[User_Guide/Log_Window|Log-window]]
|[[/StdLib#PostMessage|PostMessage]] &middot; [[/StdLib#SetMsgHandler|SetMsgHandler]] &middot; [[/StdLib#DispatchMsg|DispatchMsg]] &middot; [[/StdLib#MsgQueue|MsgQueue]] &middot; [[/StdLib#MsgFilter|MsgFilter]] &middot; [[/StdLib#GetMessage|GetMessage]]
|-
|-
| ||&mdash;
|[[/LOGWINDOW|LogWindow]] || [[User_Guide/Log_Window|Log-window]] control functions
|-
|-
| ||'''utilities for standard<BR>{{STX}} applications''' ||&rarr;
|[[/SHOWITEM|ShowItem]] ||show [[Programmer_Guide/Shell_Items|shell item]] properties and/or data
|[[/StdLib#ExtSetup|ExtSetup]] &middot; [[/StdLib#PlayCursor|PlayCursor]] &middot; [[/StdLib#GenerateScaleParams|GenerateScaleParams]] &middot; [[/StdLib#MetaSegment|MetaSegment]]
|-
|-
| ||&mdash;
|[[/BSF|BSF]] ||soundfile management functions
|-
|-
| ||'''file functions''' ||&rarr;
|[[/DataSetCmd|DataSetCmd]] ||interface to the main application (Workspace) and its GUI
|[[/StdLib#stxFileTypeList|stxFileTypeList]] &middot; [[/StdLib#stxFileType|stxFileType]] &middot; [[/StdLib#SectionFile|SectionFile]] &middot; [[/StdLib#FileToolBox|FileToolBox]]
|}
|-
 
| ||&mdash;
;Classes
|-
{|class="keinrahmen"
| ||'''display functions''' ||&rarr;
|'''Name''' ||'''Description''' ||'''Parent-Class'''  
|[[/StdLib#LogWindow|LogWindow]] &middot; [[/StdLib#ConLog|ConLog]] &middot; [[/StdLib#UM and EM|UM and EM]] &middot; [[/StdLib#ShowItem|ShowItem]]
|-
| ||&mdash;
|-
| ||'''dialog and window functions''' ||&rarr;
|[[/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]]
|-
| ||&mdash;
|-
| ||'''[[Programmer_Guide/Shell_Items/SPU|SPU]] and [[Programmer_Guide/Shell_Items/Graph|graph]] functions''' ||&rarr;
|[[/StdLib#SetGraphXScale|SetGraphXScale]] &middot; [[/StdLib#GetOutputValue|GetOutputValue]]
|-
| ||&mdash;
|-
| ||'''[[Programmer_Guide/Shell_Items/SPU|SPUs]]''' ||&rarr;
|[[/StdLib#XScaleLinear|XScaleLinear]] &middot; [[/StdLib#XScaleBark|XScaleBark]] &middot; [[/StdLib#Table2Output|Table2Output]] &middot; [[/StdLib#Wave2output|Wave2output]]
|-
|[[/BSF|BSF.stx]] ||&mdash;
|-
| ||'''macro BSF<BR>soundfile handling ||&rarr;
|[[/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]] ||&mdash;
|-
| || '''macro BUTIL<BR>misc. utility functions ||&rarr;
|[[/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]]
|-
|[[/Classes|Classes.stx]] ||&mdash;
|-
| ||'''class CObj<BR>the base class''' || &rarr;
|[[/CObj#...|...]] &middot; ...
|-
| ||&mdash;
|-
| ||'''class CObjEx<BR>extension class for scripts''' ||&rarr;
|[[/CObjEx#...|...]] &middot; ...
|-
| ||&mdash;
|-
| ||'''class ModalDialog<BR>a modal dialog''' ||&rarr;
|[[/ModalDialog#...|...]] &middot; ...
|-
| ||&mdash;
|-
| ||'''class SetupSheet<BR>property sheets''' ||&rarr;
|[[/SetupSheet#...|...]] &middot; ...
|-
| ||&mdash;
|-
| ||'''class PlayWave<BR>general play class''' ||&rarr;
|[[/PlayWave#...|...]] &middot; ...
|-
| ||&mdash;
|-
| ||'''class SetWaveIO<BR>wave device setup''' ||&rarr;
|[[/SetWaveIO#...|...]] &middot; ...
|-
| ||&mdash;
|-
| ||'''class CalibSig<BR>signal calibration''' ||&rarr;
|[[/CalibSig#...|...]] &middot; ...
|-
| ||&mdash;
|-
| ||'''class CAppQueue<BR>application queue for batch processing''' ||&rarr;
|[[/CAppQueue#...|...]] &middot; ...
|-
| ||&mdash;
|-
| ||'''class BSignal<BR>signal processing controller''' ||&rarr;
|[[/BSignal#...|...]] &middot; ...
|-
| ||&mdash;
|-
| ||'''class CDlgMap<BR>enhanced modal dialog''' ||&rarr;
|[[/CDlgMap#...|...]] &middot; ...
|-
| ||&mdash;
|-
| ||'''class CMenu<BR>menu handling class''' ||&rarr;
|[[/CMenu#...|...]] &middot; ...
|-
| ||&mdash;
|-
| ||'''class XWave<BR>enhanced wave object''' ||&rarr;
|[[/XWave#...|...]] &middot; ...
|-
| ||&mdash;
|-
| ||'''class XPlot<BR>general function plot''' ||&rarr;
|[[/XPlot#...|...]] &middot; ...
|-
| ||&mdash;
|-
| ||'''class XGraph<BR>a graph in a XPlot display''' ||&rarr;
|[[/XGraph#...|...]] &middot; ...
|-
|-
| ||&mdash;
|[[/COBJ|CObj]] ||the base class for all {{STX}} classes ||
|-
|-
| ||'''class CTemplates<BR>manage XML templates''' ||&rarr;
|[[/BSeq|BSeq]] ||create, configure and manage a signal sequence ||CObj
|[[/XGraph#...|...]] &middot; ...
|-
|-
| ||&mdash;
|[[/BXMLDoc|BXMLDoc]] ||general xml document ||CObj
|-
|-
| ||'''class NDLib<BR>signal processing, audio descriptors, ...''' ||&rarr;
|[[/BSTXIni|BSTXIni]] ||the workspace document ||BXMLDoc
|[[/NDLib#...|...]] &middot; ...
|-
| ||&mdash;
|-
| ||'''class TBMGR<BR>toolbox manager and base class''' ||&rarr;
|[[/TBMGR#...|...]] &middot; ...
|-
| ||&mdash;
|-
| ||'''class KlattSyn<BR>formant speech synthesis''' ||&rarr;
|[[/KlattSyn#...|...]] &middot; ...
|-
|[[/BXMLDoc|BXMLDoc.stx]] ||&mdash;
|-
| ||'''class BXMLDoc<BR>xml document''' || &rarr;
|[[/BXMLDoc#...|...]] &middot; ...
|-
|[[/BSTXIni|BSTXIni.stx]] ||&mdash;
|-
| ||'''class BSTXIni<BR>workspace document''' || &rarr;
|[[/BSTXIni#...|...]] &middot; ...
|-
|[[/BDataSet|BDataSet.stx]] ||&mdash;
|-
| ||'''class BDataSet<BR>project document''' || &rarr;
|[[/BDataSet#...|...]] &middot; ...
|-
|[[/DataSetCmd|DataSet.stx]] ||&mdash;
|-
| ||'''macro DataSetCmd<BR>execute dataset command''' || &rarr;
|[[/DataSetCmd#...|...]] &middot; ...
|-
|[[/CGraphSetup|CGraphSetup.stx]] ||&mdash;
|-
| ||'''class CGraphSetup<BR>graphics profile''' || &rarr;
|[[/CGraphSetup#...|...]] &middot; ...
|-
| ||&mdash;
|-
| ||'''class SGraphColors<BR>graph settings''' || &rarr;
|[[/SGraphColors#...|...]] &middot; ...
|-
|[[/CAppSetup|CAppSetup.stx]] ||&mdash;
|-
| ||'''class CAppSetup<BR>viewer setup and control''' || &rarr;
|[[/CAppSetup#...|...]] &middot; ...
|-
|[[/BSeq|BSeq.stx]] ||&mdash;
|-
| ||'''class BSeq<BR>signal sequence''' || &rarr;
|[[/CAppSetup#...|...]] &middot; ...
|-
|[[/Parameter|Parameter.stx]] ||&mdash;
|-
| ||'''class APar<BR>parameter data management''' || &rarr;
|[[/APar#...|...]] &middot; ...
|-
|[[/ADesc|ADesc.stx]] ||&mdash;
|-
| ||'''class ADesc<BR>general audio descriptor management''' || &rarr;
|[[/ADesc#...|...]] &middot; ...
|-
|-
|[[/BDataSet|BDataSet]] ||project document and project management ||BXMLDoc
|}
|}
==See also==
[[/Kernal|Macros and Classes of the STx Kernal]]

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