Programmer Guide/Macro Library: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
No edit summary
 
(16 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]] &rarr; simple message boxes
parent=Programmer_Guide/Macro_Library
* [[Programmer Guide/Macro Library/CONLOG|ConLog]] &rarr; write messages to [[User_Guide|STX_Console]] Console and/or [[User_Guide/Log_Window|Log-window]]
sort=asc
* [[Programmer_Guide/Macro_Library/LOGWINDOW|LogWindow]] &rarr; [[User_Guide/Log_Window|Log-window]] control functions
sortby=title
* [[Programmer Guide/Macro Library/SHOWITEM|ShowItem]] &rarr; show [[Programmer_Guide/Shell_Items|shell item]] properties and/or data
showpath=no
* [[Programmer Guide/Macro Library/BSF|BSF]] &rarr; soundfile management functions
liststyle=bar
* [[Programmer Guide/Macro Library/BSeq|BSeq]] &rarr; create, configure and manage a signal sequence
kidsonly=yes
* [[Programmer Guide/Macro Library/DataSetCmd|DataSetCmd]] &rarr; interface to the main application (Workspace) and its GUI
/>
 
==Classes==
* [[/COBJ|CObj - the base class for all {{STX}} classes]]
* [[/BXMLDoc|BXMLDoc - general xml document]] &larr; CObj
* [[/BSTXIni|BSTXIni - workspace document]] &larr; BXMLDoc
* [[/BDataSet|BDataSet - project document and project management]] &larr; BXMLDoc
 
==Outdated Documentation==


 
==Quick Overview==
:{|class="einrahmen"
;Macros
![[/CAppSetup|CAppSetup.stx]]
{|class=keinrahmen
|'''Name''' ||'''Description'''
|-
|-
| || Implements the setup dialogs, runtime control classes and the analysis methods for all Viewer-applications.<BR>Documentation included in source file.
|[[/BUTIL|BUtil]] ||misc. utility functions
|-
|-
![[/CGraphSetup|CGraphSetup.stx]]
|[[/UM|UM or EM]] ||simple message boxes to display user- and error-messages
|-
|-
|'''class [[/CGraphSetup|CGraphSetup]]<BR>graphics profile'''
|[[/CONLOG|ConLog]] ||write messages to [[User_Guide/STX_Console|script console]] and/or [[User_Guide/Log_Window|Log-window]]
|[[/CGraphSetup#...|...]] &middot; ...
|-
|-
|'''class [[/SGraphColors|SGraphColors]]<BR>graph settings'''
|[[/LOGWINDOW|LogWindow]] || [[User_Guide/Log_Window|Log-window]] control functions
|[[/SGraphColors#...|...]] &middot; ...
|-
|-
!Classes.stx<BR>basic class library
|[[/SHOWITEM|ShowItem]] ||show [[Programmer_Guide/Shell_Items|shell item]] properties and/or data
|-
|-
|'''class [[/CObj|CObj]]<BR>the base class'''
|[[/BSF|BSF]] ||soundfile management functions
|[[/CObj#...|...]] &middot; ...
|-
|-
|'''class [[/CObjEx|CObjEx]]<BR>extension class for scripts'''
|[[/DataSetCmd|DataSetCmd]] ||interface to the main application (Workspace) and its GUI
|[[/CObjEx#...|...]] &middot; ...
|}
|-
 
|'''class [[/ModalDialog|ModalDialog]]<BR>a modal dialog'''
;Classes
|[[/ModalDialog#...|...]] &middot; ...
{|class="keinrahmen"
|-
|'''Name''' ||'''Description''' ||'''Parent-Class'''  
|'''class [[/SetupSheet|SetupSheet]]<BR>property sheets'''
|[[/SetupSheet#...|...]] &middot; ...
|-
|'''class [[/PlayWave|PlayWave]]<BR>general play class'''
|[[/PlayWave#...|...]] &middot; ...
|-
|'''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#...|...]] &middot; ...
|-
|'''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#...|...]] &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'''
|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#...|...]] &middot; ...
|-
|-
|'''class [[/TBMGR|TBMGR]]<BR>toolbox manager and base class'''
|[[/COBJ|CObj]] ||the base class for all {{STX}} classes ||
|[[/TBMGR#...|...]] &middot; ...
|-
|-
|'''class [[/KlattSyn|KlattSyn]]<BR>formant speech synthesis'''
|[[/BSeq|BSeq]] ||create, configure and manage a signal sequence ||CObj
|[[/KlattSyn#...|...]] &middot; ...
|-
|-
![[/DataSetCmd|DataSet.stx]]
|[[/BXMLDoc|BXMLDoc]] ||general xml document ||CObj
|-
|-
|'''macro [[/DataSetCmd|DataSetCmd]]<BR>execute dataset command'''
|[[/BSTXIni|BSTXIni]] ||the workspace document ||BXMLDoc
|[[/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=Programmer_Guide/Macro_Library
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