$Screen mod: Difference between revisions

From m204wiki
Jump to navigation Jump to search
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:
<span class="pageSubtitle">Set modified attribute in screen item</span>
<span class="pageSubtitle">Set modified attribute in screen item</span>


This function sets the modified attribute for a screen item. 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 setting a screen item from the external source, one would want to set the screen item's modified attribute so that the legacy code would know it's changed.
This function sets the modified attribute for a screen item. 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 setting a screen item from the external source, set the screen item's modified attribute so that the legacy code can tell that the item has changed.</p>


Under Model 204 7.8 and later, $Screen_mod is [[Calling Sirius Mods $functions|callable]].
Under Model 204 7.8 and later, $Screen_mod is [[Calling Sirius Mods $functions|callable]].
==Syntax==
==Syntax==
<p class="syntax">[%one =] $Screen_mod(scr_item)
<p class="syntax">[<span class="term">%one</span> =] $Screen_mod(<span class="term">scr_item</span>)
</p>
</p>


Line 14: Line 16:
<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 for which attributes are to be returned. 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 for which attributes are to be returned. <br />This can be a variable of the form <var class="term">%screen</var>:<var class="term">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>
</table>
</table>


==Examples==
==Example==
<ol>
This code fragment sets the modified attribute for screen item <code>bar</code> in screen <code>foo</code>:
<li>This code fragment sets the modified attribute for screen item <code>bar</code> in screen <code>foo</code>:
<p class="code">%rc = $Screen_mod(%foo:bar)
<p class="code">%rc = $screen_mod(%foo:bar)
</p>
</p>
</ol>
[[Category:$Functions|$Screen_mod]]
[[Category:$Functions|$Screen_mod]]

Latest revision as of 18:40, 1 June 2017

Set modified attribute in screen item

This function sets the modified attribute for a screen item. 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 setting a screen item from the external source, set the screen item's modified attribute so that the legacy code can tell that the item has changed.

Under Model 204 7.8 and later, $Screen_mod is callable.

Syntax

[%one =] $Screen_mod(scr_item)

Syntax terms

%one This function always returns 1.
scr_item The screen item for which attributes are to be returned.
This can be a variable of the form %screen:item or a screen item name variable of the form :%string.

Example

This code fragment sets the modified attribute for screen item bar in screen foo:

%rc = $Screen_mod(%foo:bar)