SetCursor (ScreenField subroutine): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
|||
| (12 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:ScreenField:SetCursor subtitle}} | |||
The <var>SetCursor</var> method positions the cursor at the beginning of the referenced <var>ScreenField</var> object. An optional numeric argument positions the cursor within the field. | |||
==Syntax== | |||
{{Template:ScreenField:SetCursor syntax}} | |||
===Syntax terms=== | |||
<table class="syntaxTable"> | |||
<tr><th>sfield</th> | |||
<td>A reference to an instance of a <var>ScreenField</var> object. | |||
<tr><th>position</th> | |||
<td>A positive integral value that specifies the relative position within the <var class="term">sfield</var> object, where position 1 is the first position in the field, and the maximum width was set by the <var>[[AddField_(Screen_function)|AddField]]</var> method.</td></tr> | |||
</table> | |||
==Usage notes== | |||
<ul> | |||
<li>If the <var class="term">position</var> value exceeds the maximum width of the field, the request is canceled. | |||
</ul> | |||
==Examples== | |||
The following sequence sets the cursor on an unprotected screenfield immediately to the right of a field with a protected <code>===></code> command prompt: | |||
<p class="code"> ... | |||
%scr is object screen | |||
%prompt is object screenField | |||
%cmd is object screenField | |||
%prompt = %scr:<var>addField</var>(row=2, color=white, value='===>') | |||
%cmd = %scr:<var>addField</var>(protected=false, - | |||
width=%scr:columns - 15, color=green) | |||
%cmd:setcursor | |||
... | |||
</p> | |||
==See also== | |||
{{Template:ScreenField:SetCursor footer}} | |||
Latest revision as of 20:07, 20 November 2012
Set or return the value of a screenfield (ScreenField class)
The SetCursor method positions the cursor at the beginning of the referenced ScreenField object. An optional numeric argument positions the cursor within the field.
Syntax
sfield:SetCursor[( [position])]
Syntax terms
| sfield | A reference to an instance of a ScreenField object. |
|---|---|
| position | A positive integral value that specifies the relative position within the sfield object, where position 1 is the first position in the field, and the maximum width was set by the AddField method. |
Usage notes
- If the position value exceeds the maximum width of the field, the request is canceled.
Examples
The following sequence sets the cursor on an unprotected screenfield immediately to the right of a field with a protected ===> command prompt:
... %scr is object screen %prompt is object screenField %cmd is object screenField %prompt = %scr:addField(row=2, color=white, value='===>') %cmd = %scr:addField(protected=false, - width=%scr:columns - 15, color=green) %cmd:setcursor ...