$Screen clear - Revision history

ELowell: /* Syntax */

2017-06-01T18:59:44Z

Syntax

← Older revision		Revision as of 18:59, 1 June 2017
Line 8:		Line 8:
	Under Model 204 7.8 and later, $Screen_clear is [[Calling Sirius Mods $functions\|callable]].		Under Model 204 7.8 and later, $Screen_clear is [[Calling Sirius Mods $functions\|callable]].
	==Syntax==		==Syntax==
	<p class="syntax">[<span class="term">%one</span> =] $Screen_clear(<span class="term">scr_item</span>, [<span class="term">~~MOD~~</span>\|<span class="term">~~TAG~~</span>])		<p class="syntax">[<span class="term">%one</span> =] $Screen_clear(<span class="term">scr_item</span>, [<span class="term">mod</span>\|<span class="term">tag</span>])
	</p>		</p>
	===Syntax terms===		===Syntax terms===
Line 16:		Line 16:
	<tr><th>scr_item</th>		<tr><th>scr_item</th>
	<td>The screen item in the screen for which attributes are to be cleared. This can be a variable of the form <var class="term">%screen:item</var> or a [[Full-screen feature#Screen_item_name_variables\|screen item name variable]] of the form <var class="term">:%string</var>.</td></tr>		<td>The screen item in the screen for which attributes are to be cleared. This can be a variable of the form <var class="term">%screen:item</var> or a [[Full-screen feature#Screen_item_name_variables\|screen item name variable]] of the form <var class="term">:%string</var>.</td></tr>
	<tr><th>~~MOD~~ or ~~TAG~~</th>		<tr><th>mod or tag</th>
	<td>~~Indicates~~ the attributes to be cleared: <var class="term">~~MOD~~</var> clears only the modified attributes and <var class="term">~~TAG~~</var> clears only the tagged attributes. If any other value is specified, including no value, both modified and tagged attributes are cleared.		<td>A string indicating the attributes to be cleared. The string for <var class="term">mod</var> clears only the modified attributes, and the string for <var class="term">tag</var> clears only the tagged attributes. If any other value is specified, including no value, both modified and tagged attributes are cleared.
	</table>		</table>

ELowell: /* Syntax */

2017-06-01T18:54:39Z

Syntax

← Older revision		Revision as of 18:54, 1 June 2017
Line 8:		Line 8:
	Under Model 204 7.8 and later, $Screen_clear is [[Calling Sirius Mods $functions\|callable]].		Under Model 204 7.8 and later, $Screen_clear is [[Calling Sirius Mods $functions\|callable]].
	==Syntax==		==Syntax==
	<p class="syntax">[%one =] $Screen_clear(<I>scr_item</I>, [MOD\|TAG])		<p class="syntax">[<span class="term">%one</span> =] $Screen_clear(<span class="term">scr_item</span>, [<span class="term">MOD</span>\|<span class="term">TAG</span>])
	</p>		</p>
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr ~~class="head"~~><th>%one</th>		<tr><th>%one</th>
	<td>This function always returns 1.</td></tr>		<td>This function always returns 1.</td></tr>
	<tr><th>scr_item</th>		<tr><th>scr_item</th>
	<td>The screen item in the screen for which attributes are to be cleared. This can be a variable of the form %<i>screen~~</I>~~:~~<I>~~item</i> or a [[Full-screen feature#Screen_item_name_variables\|screen item name variable]] of the form :%~~<i>~~string</i>.</td></tr>		<td>The screen item in the screen for which attributes are to be cleared. This can be a variable of the form <var class="term">%screen:item</var> or a [[Full-screen feature#Screen_item_name_variables\|screen item name variable]] of the form <var class="term">:%string</var>.</td></tr>
	<tr ~~class="head"~~><th>MOD or TAG</th>		<tr><th>MOD or TAG</th>
	<td>Indicates the attributes to be cleared: <~~code~~>MOD</~~code~~> clears only the modified attributes and <~~code~~>TAG</~~code~~> clears only the tagged attributes. If any other value is specified, including no value, both modified and tagged attributes are cleared.		<td>Indicates the attributes to be cleared: <var class="term">MOD</var> clears only the modified attributes and <var class="term">TAG</var> clears only the tagged attributes. If any other value is specified, including no value, both modified and tagged attributes are cleared.
	</table>		</table>

ELowell at 00:45, 1 June 2017

2017-06-01T00:45:29Z

← Older revision		Revision as of 00:45, 1 June 2017
Line 2:		Line 2:
	<span class="pageSubtitle">Clear tagged and/or modified attributes in a screen</span>		<span class="pageSubtitle">Clear tagged and/or modified attributes in a screen</span>

	This function clears the tagged and/or modified attributes for all items in a screen. While it might be useful in some normal full-screen applications, it is probably most useful in applications that receive output from a non-full-screen source but populate a screen from that source, in order to be able to use legacy full-screen code. When the legacy code has produced an updated version of the screen, the code communicating with the external source ~~would~~ probably ~~want to~~ clear the tagged and/or modified bits, just as a [[Full-screen feature#READ_SCREEN_statement\|Read Screen]] statement would.		This function clears the tagged and/or modified attributes for all items in a screen. While it might be useful in some normal full-screen applications, it is probably most useful in applications that receive output from a non-full-screen source but populate a screen from that source, in order to be able to use legacy full-screen code.

			<p>When the legacy code has produced an updated version of the screen, the code communicating with the external source should probably clear the tagged and/or modified bits, just as a [[Full-screen feature#READ_SCREEN_statement\|Read Screen]] statement would.</p>

	Under Model 204 7.8 and later, $Screen_clear is [[Calling Sirius Mods $functions\|callable]].		Under Model 204 7.8 and later, $Screen_clear is [[Calling Sirius Mods $functions\|callable]].
Line 13:		Line 15:
	<td>This function always returns 1.</td></tr>		<td>This function always returns 1.</td></tr>
	<tr><th>scr_item</th>		<tr><th>scr_item</th>
	<td>The screen item in the screen for which attributes are to be cleared. This can be a variable of the form <i>%screen:item</i> or a [[Full-screen feature#Screen_item_name_variables\|screen item name variable]] of the form <i>:%string</i>.</td></tr>		<td>The screen item in the screen for which attributes are to be cleared. This can be a variable of the form %<i>screen</I>:<I>item</i> or a [[Full-screen feature#Screen_item_name_variables\|screen item name variable]] of the form :%<i>string</i>.</td></tr>
	<tr class="head"><th>MOD or TAG</th>		<tr class="head"><th>MOD or TAG</th>
	<td>Indicates the attributes to be cleared: <code>MOD</code> clears only the modified attributes and <code>TAG</code> clears only the tagged attributes. If any other value is specified, including no value, both modified and tagged attributes are cleared.		<td>Indicates the attributes to be cleared: <code>MOD</code> clears only the modified attributes and <code>TAG</code> clears only the tagged attributes. If any other value is specified, including no value, both modified and tagged attributes are cleared.

ELowell: /* Examples */

2017-06-01T00:25:40Z

Examples

← Older revision		Revision as of 00:25, 1 June 2017
Line 18:		Line 18:
	</table>		</table>

	==~~Examples~~==		==Example==
	~~<ol>~~		This code fragment clears the modified attribute for screen <code>foo</code> (which contains screen item <code>bar</code>):
	~~<li>~~This code fragment clears the modified attribute for screen <code>foo</code> (which contains screen item <code>bar</code>):
	<p class="code">%rc = $screen_clear(%foo:bar, "MOD")		<p class="code">%rc = $screen_clear(%foo:bar, "MOD")
	</p>		</p>
	~~</ol>~~
	[[Category:$Functions\|$Screen_clear]]		[[Category:$Functions\|$Screen_clear]]

ELowell: /* Syntax */

2017-06-01T00:23:18Z

Syntax

← Older revision		Revision as of 00:23, 1 June 2017
Line 6:		Line 6:
	Under Model 204 7.8 and later, $Screen_clear is [[Calling Sirius Mods $functions\|callable]].		Under Model 204 7.8 and later, $Screen_clear is [[Calling Sirius Mods $functions\|callable]].
	==Syntax==		==Syntax==
	<p class="syntax">[%one =] $Screen_clear(scr_item, [~~mod_or_tag~~])		<p class="syntax">[%one =] $Screen_clear(<I>scr_item</I>, [MOD\|TAG])
	</p>		</p>
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%one</th>		<tr class="head"><th>%one</th>
	<td>This function always returns 1.</td></tr>		<td>This function always returns 1.</td></tr>
	<tr><th>scr_item</th>		<tr><th>scr_item</th>
	<td>The screen item in the screen for which attributes are to be cleared. This can be a variable of the form <i>%screen:item</i> or a [[Full-screen feature#Screen_item_name_variables\|screen item name variable]] of the form <i>:%string</i>.</td></tr>		<td>The screen item in the screen for which attributes are to be cleared. This can be a variable of the form <i>%screen:item</i> or a [[Full-screen feature#Screen_item_name_variables\|screen item name variable]] of the form <i>:%string</i>.</td></tr>
	<tr><th>~~mod_or_tag~~</th>		<tr class="head"><th>MOD or TAG</th>
	<td>Indicates the attributes to be cleared~~. If the string~~ <i>~~'TAG'~~</i> ~~is specified,~~ only the ~~tagged~~ attributes ~~are cleared. If the string~~ <i>~~'MOD'~~</i> only the ~~modified~~ attributes ~~are cleared~~. If any other value is specified, including no value, both tagged ~~and modified~~ attributes are cleared.		<td>Indicates the attributes to be cleared: <code>MOD</code> clears only the modified attributes and <code>TAG</code> clears only the tagged attributes. If any other value is specified, including no value, both modified and tagged attributes are cleared.
	</table>		</table>

Alex: Created page with "{{DISPLAYTITLE:$Screen_clear}} Clear tagged and/or modified attributes in a screen This function clears the tagged and/or modified attribute..."

2017-05-30T18:20:22Z

Created page with "{{DISPLAYTITLE:$Screen_clear}} Clear tagged and/or modified attributes in a screen This function clears the tagged and/or modified attribute..."

New page

{{DISPLAYTITLE:$Screen_clear}}
Clear tagged and/or modified attributes in a screen

This function clears the tagged and/or modified attributes for all items in a screen. While it might be useful in some normal full-screen applications, it is probably most useful in applications that receive output from a non-full-screen source but populate a screen from that source, in order to be able to use legacy full-screen code. When the legacy code has produced an updated version of the screen, the code communicating with the external source would probably want to clear the tagged and/or modified bits, just as a [[Full-screen feature#READ_SCREEN_statement|Read Screen]] statement would.

Under Model 204 7.8 and later, $Screen_clear is [[Calling Sirius Mods $functions|callable]].
==Syntax==
[%one =] $Screen_clear(scr_item, [mod_or_tag])

===Syntax terms===
<table class="syntaxTable">
<tr><th>%one</th>
<td>This function always returns 1.</td></tr>
<tr><th>scr_item</th>
<td>The screen item in the screen for which attributes are to be cleared. This can be a variable of the form %screen:item or a [[Full-screen feature#Screen_item_name_variables|screen item name variable]] of the form :%string.</td></tr>
<tr><th>mod_or_tag</th>
<td>Indicates the attributes to be cleared. If the string 'TAG' is specified, only the tagged attributes are cleared. If the string 'MOD' only the modified attributes are cleared. If any other value is specified, including no value, both tagged and modified attributes are cleared.
</table>

==Examples==
<ol>
<li>This code fragment clears the modified attribute for screen <code>foo</code> (which contains screen item <code>bar</code>):
%rc = $screen_clear(%foo:bar, "MOD")

</ol>
[[Category:$Functions|$Screen_clear]]