Programmer Guide/Command Reference/MESSAGE - Revision history

Jw at 12:39, 6 August 2019

2019-08-06T12:39:03Z

← Older revision		Revision as of 14:39, 6 August 2019
Line 5:		Line 5:
	and <code>[[Programmer_Guide/Macro_Library#DispatchMsg\|DISPATCHMSG]]</code>, the <code>[[Programmer_Guide/Macro_Library#GetMessage\|GETMESSAGE]]</code> macro implements the standard {{STX}} message handling system.		and <code>[[Programmer_Guide/Macro_Library#DispatchMsg\|DISPATCHMSG]]</code>, the <code>[[Programmer_Guide/Macro_Library#GetMessage\|GETMESSAGE]]</code> macro implements the standard {{STX}} message handling system.

	'''Note:''' For message handling in ''classes'', you may use the member functions <code>[[Programmer_Guide/Macro_Library/~~CObj~~#~~AttachItem~~\|AttachItem]]</code>, <code>[[Programmer_Guide/Macro_Library/~~CObj~~#~~DetachItem~~\|DetachItem]]</code> and <code>[[Programmer_Guide/Macro_Library/~~CObj~~#MsgHandler\|MsgHandler]]</code> as an alternative better suited to the object-oriented use-case.		'''Note:''' For message handling in ''classes'', you may use the member functions <code>[[Programmer_Guide/Macro_Library/COBJ#AttachItem_.2F_AttachShell\|AttachItem]]</code>, <code>[[Programmer_Guide/Macro_Library/COBJ#DetachItem_.2F_DetachShell\|DetachItem]]</code> and <code>[[Programmer_Guide/Macro_Library/COBJ#MsgHandler\|MsgHandler]]</code> as an alternative better suited to the object-oriented use-case.

	;Sub-commands: [[#MESSAGE BEEP\|BEEP]], [[#MESSAGE DEBUG\|DEBUG]], [[#MESSAGE DESKTOP\|DESKTOP]], [[#MESSAGE EXIT\|EXIT]], [[#MESSAGE LOGFILE\|LOGFILE]], [[#MESSAGE LOOP\|LOOP]], [[#MESSAGE MAIN\|MAIN]], [[#MESSAGE MENU\|MENU]], [[#MESSAGE NOMAIN\|NOMAIN]], [[#MESSAGE RUN\|RUN]], [[#MESSAGE QUEUE\|QUEUE]]		;Sub-commands: [[#MESSAGE BEEP\|BEEP]], [[#MESSAGE DEBUG\|DEBUG]], [[#MESSAGE DESKTOP\|DESKTOP]], [[#MESSAGE EXIT\|EXIT]], [[#MESSAGE LOGFILE\|LOGFILE]], [[#MESSAGE LOOP\|LOOP]], [[#MESSAGE MAIN\|MAIN]], [[#MESSAGE MENU\|MENU]], [[#MESSAGE NOMAIN\|NOMAIN]], [[#MESSAGE RUN\|RUN]], [[#MESSAGE QUEUE\|QUEUE]]

Jw: /* MESSAGE DESKTOP */

2014-06-03T11:37:37Z

MESSAGE DESKTOP

← Older revision		Revision as of 13:37, 3 June 2014
Line 66:		Line 66:
	Code example:		Code example:
	msg desktop		msg desktop
	readvar #msg #width #height #x0 #y0 #screencount		readvar #msg #width #height #x0 #y0 #screencount #

	=== <code>MESSAGE EXIT</code> ===		=== <code>MESSAGE EXIT</code> ===

Christian: /* MESSAGE RUN */

2014-04-25T15:05:19Z

MESSAGE RUN

← Older revision		Revision as of 17:05, 25 April 2014
Line 124:		Line 124:
	The <code>MESSAGE RUN</code> command will send a message to the shell <var>shellid</var>. ''Do not'' use this command directly! Instead, always call the macro <code>POSTMESSAGE</code>.		The <code>MESSAGE RUN</code> command will send a message to the shell <var>shellid</var>. ''Do not'' use this command directly! Instead, always call the macro <code>POSTMESSAGE</code>.

	If you supply an asterisk, <code>*</code> for the <var>shellid</var> argument, the message will be sent to ''all'' except the sending shell. If you supply the character "<code>=</code>", the message will be sent to the sending shell itself.		If you supply an asterisk, <code>*</code> for the <var>shellid</var> argument (which you won't because you never call this command directly), the message will be sent to ''all'' shells except the sending shell. If you supply the character "<code>=</code>" (which you won't either, because you never call this command directly), the message will be sent to the sending shell itself.

	Messages sent using the <code>MESSAGE RUN</code> command are pre-processed by the macro <code>GETMESSAGE</code>.		Messages sent using the <code>MESSAGE RUN</code> command are pre-processed by the macro <code>GETMESSAGE</code>.

Christian: /* MESSAGE RUN */

2014-04-25T15:04:00Z

MESSAGE RUN

← Older revision		Revision as of 17:04, 25 April 2014
Line 120:		Line 120:
	=== <code>MESSAGE RUN</code> ===		=== <code>MESSAGE RUN</code> ===

	MESSAGE RUN <var>shellid messageid messegaparameters</var>		MESSAGE RUN <var>shellid</var> <var>messageid</var> <var>messegaparameters</var>

	The <code>MESSAGE RUN</code> command will send a message to the shell <var>shellid</var>. ''Do not'' use this command directly! Instead, always call the macro <code>POSTMESSAGE</code>.		The <code>MESSAGE RUN</code> command will send a message to the shell <var>shellid</var>. ''Do not'' use this command directly! Instead, always call the macro <code>POSTMESSAGE</code>.

Christian: /* MESSAGE MENU */

2014-04-25T15:03:33Z

MESSAGE MENU

← Older revision		Revision as of 17:03, 25 April 2014
Line 105:		Line 105:
	=== <code>MESSAGE MENU</code> ===		=== <code>MESSAGE MENU</code> ===

	MESSAGE MENU /Addpopup <var>name item<sub>1</sub> item<sub>2</sub></var>…		MESSAGE MENU /Addpopup <var>name</var> <var>item<sub>1</sub></var> <var>item<sub>2</sub></var>…
	MESSAGE MENU /Addpopup <var>name table</var> /Table		MESSAGE MENU /Addpopup <var>name</var> <var>table</var> /Table
	MESSAGE MENU /Show		MESSAGE MENU /Show
	MESSAGE MENU /Delete		MESSAGE MENU /Delete

Christian: /* MESSAGE MAIN */

2014-04-25T15:03:05Z

MESSAGE MAIN

← Older revision		Revision as of 17:03, 25 April 2014
Line 97:		Line 97:
	=== <code>MESSAGE MAIN</code> ===		=== <code>MESSAGE MAIN</code> ===

	MESSAGE MAIN <var>mode</var> [<var>style xpos ypos width height title</var>]		MESSAGE MAIN <var>mode</var> [<var>style</var> <var>xpos</var> <var>ypos</var> <var>width</var> <var>height </var> <var>title</var>]

	Set and/or get the mode of the log window (one out of <code>HIDDEN</code>, <code>VISIBLE</code>, <code>ENABLED</code>, <code></code>), its style (one out of <code>MINIMIZED</code>, <code>RESTORED</code>, <code>MAXIMIZED</code>, <code></code>), and its position, size and/or caption. The current settings are stored in the message variable <code>#MSG</code> in the following format:		Set and/or get the mode of the log window (one out of <code>HIDDEN</code>, <code>VISIBLE</code>, <code>ENABLED</code>, <code></code>), its style (one out of <code>MINIMIZED</code>, <code>RESTORED</code>, <code>MAXIMIZED</code>, <code></code>), and its position, size and/or caption. The current settings are stored in the message variable <code>#MSG</code> in the following format:

Christian: /* MESSAGE BEEP */

2014-04-25T15:01:40Z

MESSAGE BEEP

← Older revision		Revision as of 17:01, 25 April 2014
Line 16:		Line 16:

	MESSAGE BEEP /Speaker\|Asterisk\|Exclamation\|Hand\|Question\|Okay		MESSAGE BEEP /Speaker\|Asterisk\|Exclamation\|Hand\|Question\|Okay
	MESSAGE BEEP <var>frequency duration</var>		MESSAGE BEEP <var>frequency</var> <var>duration</var>

	Play a tone via the PC loudspeaker. A standard windows sound (selected with an option) or a <var>frequency</var> ([http://en.wikipedia.org/wiki/Hertz Hz]) and <var>duration</var> ([http://en.wikipedia.org/wiki/Millisecond ms]) may be specified. No commands are processed while the sound is being played.		Play a tone via the PC loudspeaker. A standard windows sound (selected with an option) or a <var>frequency</var> ([http://en.wikipedia.org/wiki/Hertz Hz]) and <var>duration</var> ([http://en.wikipedia.org/wiki/Millisecond ms]) may be specified. No commands are processed while the sound is being played.

Christian at 15:01, 25 April 2014

2014-04-25T15:01:00Z

← Older revision		Revision as of 17:01, 25 April 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}__NOTOC__		{{DISPLAYTITLE:{{SUBPAGENAME}}}}__NOTOC__
	The <code>MESSAGE</code> command is a low-level means for processing shell messages in {{STX}}. There are a number of different sub-commands you may pass to the command (see below). Many of the sub-commands use the variable <~~code~~>#msg</~~code~~> to return values. The <code>MESSAGE</code> command may be abbreviated to <code>MSG</code>.		The <code>MESSAGE</code> command is a low-level means for processing shell messages in {{STX}}. There are a number of different sub-commands you may pass to the command (see below). Many of the sub-commands use the variable <var>#msg</var> to return values. The <code>MESSAGE</code> command may be abbreviated to <code>MSG</code>.

	If you want to use macro message handlers in an application, you need to call the macro <code>[[Programmer_Guide/Macro_Library#GetMessage\|GETMESSAGE]]</code> to retrieve messages, instead of directly using the <code>MESSAGE</code> command. In conjunction with the macros <code>[[Programmer_Guide/Macro_Library#SetMsgHandler\|SETMSGHANDLER]]</code>		If you want to use macro message handlers in an application, you need to call the macro <code>[[Programmer_Guide/Macro_Library#GetMessage\|GETMESSAGE]]</code> to retrieve messages, instead of directly using the <code>MESSAGE</code> command. In conjunction with the macros <code>[[Programmer_Guide/Macro_Library#SetMsgHandler\|SETMSGHANDLER]]</code>

193.171.195.53: /* MESSAGE DESKTOP */

2014-02-27T19:39:29Z

MESSAGE DESKTOP

← Older revision		Revision as of 21:39, 27 February 2014
Line 59:		Line 59:
	The <code>MESSAGE DESKTOP</code> command retrieves the origin, the height and the width of the whole desktop (all monitors), as well as the number of monitors connected to the computer. Furthermore, for each monitor, it will return its virtual coordinates (left, top, right, and bottom, in this order). It returns this information in the <var>#MSG</var> variable in the following format:		The <code>MESSAGE DESKTOP</code> command retrieves the origin, the height and the width of the whole desktop (all monitors), as well as the number of monitors connected to the computer. Furthermore, for each monitor, it will return its virtual coordinates (left, top, right, and bottom, in this order). It returns this information in the <var>#MSG</var> variable in the following format:

	<var>desktopWidth</var> <var>desktopHeight</var> <var>desktopXOrigin</var> <var>desktopYOrigin</var> <var>numberOfMonitors</var> <var>left<sub>1</sub></var> <var>top<sub>1</sub></var> <var>right<sub>1</sub></var> <var>bottom<sub>1</sub></var>… <var>left<sub>N</sub></var> <var>top<sub>N</sub></var> <var>right<sub>N</sub></var> <var>bottom<sub>N</sub></var>		<var>desktopWidth</var> <var>desktopHeight</var> <var>desktopXOrigin</var> <var>desktopYOrigin</var> <var>numberOfMonitors</var>
			<var>left<sub>1</sub></var> <var>top<sub>1</sub></var> <var>right<sub>1</sub></var> <var>bottom<sub>1</sub></var>… <var>left<sub>N</sub></var> <var>top<sub>N</sub></var> <var>right<sub>N</sub></var> <var>bottom<sub>N</sub></var>

	Note that the primary monitor always has an origin of 0/0 (x/y). Therefore, if you have three monitors, and the middle one is the primary monitor, the value <var>desktopXOrigin</var> will be negative.		Note that the primary monitor always has an origin of 0/0 (x/y). Therefore, if you have three monitors, and the middle one is the primary monitor, the value <var>desktopXOrigin</var> will be negative.

193.171.195.53: /* MESSAGE DESKTOP */

2014-02-27T19:39:04Z

MESSAGE DESKTOP

← Older revision		Revision as of 21:39, 27 February 2014
Line 57:		Line 57:
	MESSAGE DESKTOP		MESSAGE DESKTOP

	The <code>MESSAGE DESKTOP</code> command retrieves the origin, the height and the width of the whole desktop (all monitors), as well as the number of monitors connected to the computer. It returns this information in the <var>#MSG</var> variable in the following format:		The <code>MESSAGE DESKTOP</code> command retrieves the origin, the height and the width of the whole desktop (all monitors), as well as the number of monitors connected to the computer. Furthermore, for each monitor, it will return its virtual coordinates (left, top, right, and bottom, in this order). It returns this information in the <var>#MSG</var> variable in the following format:

	<var>desktopWidth</var> <var>desktopHeight</var> <var>desktopXOrigin</var> <var>desktopYOrigin</var> <var>numberOfMonitors</var>		<var>desktopWidth</var> <var>desktopHeight</var> <var>desktopXOrigin</var> <var>desktopYOrigin</var> <var>numberOfMonitors</var> <var>left<sub>1</sub></var> <var>top<sub>1</sub></var> <var>right<sub>1</sub></var> <var>bottom<sub>1</sub></var>… <var>left<sub>N</sub></var> <var>top<sub>N</sub></var> <var>right<sub>N</sub></var> <var>bottom<sub>N</sub></var>

	Note that the primary monitor always has an origin of 0/0 (x/y). Therefore, if you have three monitors, and the middle one is the primary monitor, the value <var>desktopXOrigin</var> will be negative.		Note that the primary monitor always has an origin of 0/0 (x/y). Therefore, if you have three monitors, and the middle one is the primary monitor, the value <var>desktopXOrigin</var> will be negative.

← Older revision		Revision as of 14:39, 6 August 2019
Line 5:		Line 5:
	and <code>[[Programmer_Guide/Macro_Library#DispatchMsg\|DISPATCHMSG]]</code>, the <code>[[Programmer_Guide/Macro_Library#GetMessage\|GETMESSAGE]]</code> macro implements the standard {{STX}} message handling system.		and <code>[[Programmer_Guide/Macro_Library#DispatchMsg\|DISPATCHMSG]]</code>, the <code>[[Programmer_Guide/Macro_Library#GetMessage\|GETMESSAGE]]</code> macro implements the standard {{STX}} message handling system.

	'''Note:''' For message handling in ''classes'', you may use the member functions <code>[[Programmer_Guide/Macro_Library/~~CObj~~#~~AttachItem~~\|AttachItem]]</code>, <code>[[Programmer_Guide/Macro_Library/~~CObj~~#~~DetachItem~~\|DetachItem]]</code> and <code>[[Programmer_Guide/Macro_Library/~~CObj~~#MsgHandler\|MsgHandler]]</code> as an alternative better suited to the object-oriented use-case.		'''Note:''' For message handling in ''classes'', you may use the member functions <code>[[Programmer_Guide/Macro_Library/COBJ#AttachItem_.2F_AttachShell\|AttachItem]]</code>, <code>[[Programmer_Guide/Macro_Library/COBJ#DetachItem_.2F_DetachShell\|DetachItem]]</code> and <code>[[Programmer_Guide/Macro_Library/COBJ#MsgHandler\|MsgHandler]]</code> as an alternative better suited to the object-oriented use-case.

	;Sub-commands: [[#MESSAGE BEEP\|BEEP]], [[#MESSAGE DEBUG\|DEBUG]], [[#MESSAGE DESKTOP\|DESKTOP]], [[#MESSAGE EXIT\|EXIT]], [[#MESSAGE LOGFILE\|LOGFILE]], [[#MESSAGE LOOP\|LOOP]], [[#MESSAGE MAIN\|MAIN]], [[#MESSAGE MENU\|MENU]], [[#MESSAGE NOMAIN\|NOMAIN]], [[#MESSAGE RUN\|RUN]], [[#MESSAGE QUEUE\|QUEUE]]		;Sub-commands: [[#MESSAGE BEEP\|BEEP]], [[#MESSAGE DEBUG\|DEBUG]], [[#MESSAGE DESKTOP\|DESKTOP]], [[#MESSAGE EXIT\|EXIT]], [[#MESSAGE LOGFILE\|LOGFILE]], [[#MESSAGE LOOP\|LOOP]], [[#MESSAGE MAIN\|MAIN]], [[#MESSAGE MENU\|MENU]], [[#MESSAGE NOMAIN\|NOMAIN]], [[#MESSAGE RUN\|RUN]], [[#MESSAGE QUEUE\|QUEUE]]