Programmer Guide/Macro Library: Difference between revisions
From STX Wiki
Jump to navigationJump to search
(initial import) |
No edit summary |
||
| (100 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{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. | |||
==Alphabetical List of Macros and Classes== | |||
<splist | <splist | ||
parent= | parent=Programmer_Guide/Macro_Library | ||
sort=asc | sort=asc | ||
sortby=title | sortby=title | ||
showpath=no | showpath=no | ||
liststyle= | liststyle=bar | ||
kidsonly=yes | kidsonly=yes | ||
> | /> | ||
==Quick Overview== | |||
;Macros | |||
{|class=keinrahmen | |||
|'''Name''' ||'''Description''' | |||
|- | |||
|[[/BUTIL|BUtil]] ||misc. utility functions | |||
|- | |||
|[[/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]] | |||
|- | |||
|[[/LOGWINDOW|LogWindow]] || [[User_Guide/Log_Window|Log-window]] control functions | |||
|- | |||
|[[/SHOWITEM|ShowItem]] ||show [[Programmer_Guide/Shell_Items|shell item]] properties and/or data | |||
|- | |||
|[[/BSF|BSF]] ||soundfile management functions | |||
|- | |||
|[[/DataSetCmd|DataSetCmd]] ||interface to the main application (Workspace) and its GUI | |||
|} | |||
;Classes | |||
{|class="keinrahmen" | |||
|'''Name''' ||'''Description''' ||'''Parent-Class''' | |||
|- | |||
|[[/COBJ|CObj]] ||the base class for all {{STX}} classes || | |||
|- | |||
|[[/BSeq|BSeq]] ||create, configure and manage a signal sequence ||CObj | |||
|- | |||
|[[/BXMLDoc|BXMLDoc]] ||general xml document ||CObj | |||
|- | |||
|[[/BSTXIni|BSTXIni]] ||the workspace document ||BXMLDoc | |||
|- | |||
|[[/BDataSet|BDataSet]] ||project document and project management ||BXMLDoc | |||
|} | |||
==See also== | |||
[[/Kernal|Macros and Classes of the STx Kernal]] | |||
Latest revision as of 11: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 |
