Toggle command - Revision history

Ekern at 19:07, 9 February 2023

2023-02-09T19:07:58Z

← Older revision		Revision as of 19:07, 9 February 2023
Line 2:		Line 2:

	{\|		{\|
	\|width="~~50%~~"\| '''Action:'''		\|width="125px"\| '''Action:'''
	\|width="~~50%~~"\|		\|width="575px"\|
	<span class="f_Para">Reverses the state ("True" or "False") of a [[Working with macro variables\|macro variable]]. If the variable value is </span><span class="f_Monospace">0</span><span class="f_Para"> or a zero length (null) string, or if it is undefined, its state is considered to be </span><span class="f_Monospace">False.</span><span class="f_Para"> For all other values, its state is considered to be </span><span class="f_Monospace">True.</span><span class="f_Para"> </span>		<span class="f_Para">Reverses the state ("True" or "False") of a [[Working with macro variables\|macro variable]]. If the variable value is </span><span class="f_Monospace">0</span><span class="f_Para"> or a zero length (null) string, or if it is undefined, its state is considered to be </span><span class="f_Monospace">False.</span><span class="f_Para"> For all other values, its state is considered to be </span><span class="f_Monospace">True.</span><span class="f_Para"> </span>

Ekern at 03:34, 14 December 2022

2022-12-14T03:34:26Z

← Older revision		Revision as of 03:34, 14 December 2022
Line 4:		Line 4:
	\|width="50%"\| '''Action:'''		\|width="50%"\| '''Action:'''
	\|width="50%"\|		\|width="50%"\|
	<span class="f_Para">Reverses the state ("True" or "False") of a [[~~working_with_macro_variables.html~~\|macro variable]]. If the variable value is </span><span class="f_Monospace">0</span><span class="f_Para"> or a zero length (null) string, or if it is undefined, its state is considered to be </span><span class="f_Monospace">False.</span><span class="f_Para"> For all other values, its state is considered to be </span><span class="f_Monospace">True.</span><span class="f_Para"> </span>		<span class="f_Para">Reverses the state ("True" or "False") of a [[Working with macro variables\|macro variable]]. If the variable value is </span><span class="f_Monospace">0</span><span class="f_Para"> or a zero length (null) string, or if it is undefined, its state is considered to be </span><span class="f_Monospace">False.</span><span class="f_Para"> For all other values, its state is considered to be </span><span class="f_Monospace">True.</span><span class="f_Para"> </span>

	<span class="f_Para">The </span><span class="f_Monospace">toggle</span><span class="f_Para"> command sets to 0</span><span class="f_DefListDDTable"> </span><span class="f_Para">("toggles to False")</span><span class="f_DefListDDTable"> </span><span class="f_Para">a variable whose state is True</span><span class="f_DefListDDTable">. </span><span class="f_Para">And it sets to 1 ("toggles to True") a variable whose state is False. </span>		<span class="f_Para">The </span><span class="f_Monospace">toggle</span><span class="f_Para"> command sets to 0</span><span class="f_DefListDDTable"> </span><span class="f_Para">("toggles to False")</span><span class="f_DefListDDTable"> </span><span class="f_Para">a variable whose state is True</span><span class="f_DefListDDTable">. </span><span class="f_Para">And it sets to 1 ("toggles to True") a variable whose state is False. </span>
Line 16:		Line 16:
	*''&var'' is a macro variable that may or may not already exist.		*''&var'' is a macro variable that may or may not already exist.
	*''msg_string'' is an optional message string, useful for constructing a message to report what was toggled.		*''msg_string'' is an optional message string, useful for constructing a message to report what was toggled.
	: If ''msg_string'' is specified, either of the following is displayed in the [[~~glance_at_status_area.html~~\|Status bar]] after the toggle:		: If ''msg_string'' is specified, either of the following is displayed in the [[Status bar\|Status bar]] after the toggle:
	: "''msg_string'' is on " (if toggled on)		: "''msg_string'' is on " (if toggled on)
	: "''msg_string'' is off " (if toggled off)		: "''msg_string'' is off " (if toggled off)

Ekern at 22:48, 11 July 2022

2022-07-11T22:48:19Z

← Older revision		Revision as of 22:48, 11 July 2022
Line 16:		Line 16:
	*''&var'' is a macro variable that may or may not already exist.		*''&var'' is a macro variable that may or may not already exist.
	*''msg_string'' is an optional message string, useful for constructing a message to report what was toggled.		*''msg_string'' is an optional message string, useful for constructing a message to report what was toggled.
			: If ''msg_string'' is specified, either of the following is displayed in the [[glance_at_status_area.html\|Status bar]] after the toggle:
	If ''msg_string'' is specified, either of the following is displayed in the [[glance_at_status_area.html\|Status bar]] after the toggle:		: "''msg_string'' is on " (if toggled on)
			: "''msg_string'' is off " (if toggled off)
	"''msg_string'' is on " (if toggled on)

	"''msg_string'' is off " (if toggled off)

	Example:		Example:

	<p class="syntax"># toggle history</p>		<p class="syntax"># toggle history</p>
	<p class="syntax">toggle &historyWanted Auto History </p>		<p class="syntax">toggle &historyWanted Auto History </p>

Ekern: Created page with "TOC {| |width="50%"| '''Action:''' |width="50%"| Reverses the state ("True" or "False") of a working_with_macro_variables.html|..."

2022-07-11T22:47:30Z

Created page with "__TOC__ {| |width="50%"| '''Action:''' |width="50%"| Reverses the state ("True" or "False") of a working_with_macro_variables.html|..."

New page

__TOC__

{|
|width="50%"| '''Action:'''
|width="50%"|
Reverses the state ("True" or "False") of a [[working_with_macro_variables.html|macro variable]]. If the variable value is 0 or a zero length (null) string, or if it is undefined, its state is considered to be False. For all other values, its state is considered to be True. 

The toggle command sets to 0 ("toggles to False") a variable whose state is True. And it sets to 1 ("toggles to True") a variable whose state is False. 

'''Syntax:'''

toggle ''&var''[msg_string] 

where: 

*''&var'' is a macro variable that may or may not already exist.
*''msg_string'' is an optional message string, useful for constructing a message to report what was toggled.

If ''msg_string'' is specified, either of the following is displayed in the [[glance_at_status_area.html|Status bar]] after the toggle:

"''msg_string'' is on " (if toggled on)

"''msg_string'' is off " (if toggled off)

Example:

# toggle history
toggle &historyWanted Auto History 
|-
| '''Client menu:'''
| --
|-
| '''Introduced:'''
| Build 37 
|}

[[Category:Debugger Commands]]

Toggle command - Revision history

Ekern at 19:07, 9 February 2023

Ekern at 03:34, 14 December 2022

Ekern at 22:48, 11 July 2022

Ekern: Created page with "__TOC__ {| |width="50%"| '''Action:''' |width="50%"| Reverses the state ("True" or "False") of a working_with_macro_variables.html|..."

Ekern: Created page with "TOC {| |width="50%"| '''Action:''' |width="50%"| Reverses the state ("True" or "False") of a working_with_macro_variables.html|..."