Toggle command: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 2: | Line 2: | ||
{| | {| | ||
|width=" | |width="125px"| '''Action:''' | ||
|width=" | |width="575px"| | ||
<span class="f_Para">Reverses the state ("True" or "False") of a [[ | <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 [[ | : 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) | ||
Latest revision as of 19:07, 9 February 2023
| Action: |
Reverses the state ("True" or "False") of a 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:
Example: # toggle history toggle &historyWanted Auto History |
| Client menu: | -- |
| Introduced: | Build 37 |