Programmer Guide/Macro Library: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
|||
| Line 17: | Line 17: | ||
{|class=keinrahmen | {|class=keinrahmen | ||
|[[/BUTIL|BUtil]] ||misc. utility functions | |[[/BUTIL|BUtil]] ||misc. utility functions | ||
|- | |||
|[[/UM|UM or EM]] ||simple message boxes to display user- and error-messages | |[[/UM|UM or EM]] ||simple message boxes to display user- and error-messages | ||
|- | |||
|[[/CONLOG|ConLog]] ||write messages to [[User_Guide/STX_Console|script console]] and/or [[User_Guide/Log_Window|Log-window]] | |[[/CONLOG|ConLog]] ||write messages to [[User_Guide/STX_Console|script console]] and/or [[User_Guide/Log_Window|Log-window]] | ||
|- | |||
|[[/LOGWINDOW|LogWindow]] || [[User_Guide/Log_Window|Log-window]] control functions | |[[/LOGWINDOW|LogWindow]] || [[User_Guide/Log_Window|Log-window]] control functions | ||
|- | |||
|[[/SHOWITEM|ShowItem]] ||show [[Programmer_Guide/Shell_Items|shell item]] properties and/or data | |[[/SHOWITEM|ShowItem]] ||show [[Programmer_Guide/Shell_Items|shell item]] properties and/or data | ||
|- | |||
|[[/BSF|BSF]] ||soundfile management functions | |[[/BSF|BSF]] ||soundfile management functions | ||
|- | |||
|[[/DataSetCmd|DataSetCmd]] ||interface to the main application (Workspace) and its GUI | |[[/DataSetCmd|DataSetCmd]] ||interface to the main application (Workspace) and its GUI | ||
|} | |} | ||
| Line 27: | Line 33: | ||
;Classes | ;Classes | ||
{|class="keinrahmen" | {|class="keinrahmen" | ||
|[[/COBJ|CObj]] ||the base class for all {{STX}} classes ||- | |[[/COBJ|CObj]] ||the base class for all {{STX}} classes || | ||
|- | |||
|[[/BSeq|BSeq]] ||create, configure and manage a signal sequence ||CObj | |[[/BSeq|BSeq]] ||create, configure and manage a signal sequence ||CObj | ||
|- | |||
|[[/BXMLDoc|BXMLDoc]] ||general xml document ||CObj | |[[/BXMLDoc|BXMLDoc]] ||general xml document ||CObj | ||
|- | |||
|[[/BSTXIni|BSTXIni]] ||the workspace document ||BXMLDoc | |[[/BSTXIni|BSTXIni]] ||the workspace document ||BXMLDoc | ||
|- | |||
|[[/BDataSet|BDataSet]] ||project document and project management ||BXMLDoc | |[[/BDataSet|BDataSet]] ||project document and project management ||BXMLDoc | ||
|} | |} | ||
Revision as of 17:35, 6 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
| 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
| 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 |
