Jw: Created page with "File:dialog_control_edit.png SET `dialog` `index` EDIT `row` `col` `caption` `var₁` [ `width` <..."

2018-05-15T09:56:54Z

Created page with "File:dialog_control_edit.png SET <var>dialog</var> <var>index</var> EDIT <var>row</var> <var>col</var> <var>caption</var> <var>var1</var> [ <var>width</var> <..."

New page

[[File:dialog_control_edit.png]]

SET <var>dialog</var> <var>index</var> EDIT <var>row</var> <var>col</var> <var>caption</var> <var>var1</var> [ <var>width</var> <var>height</var> <var>var2</var>|* <var>fg</var> <var>bg</var> <var>font</var> ] [ /A|L|R ] [ /F[=PCAFS] ]

{|class="keinrahmen"
| <var>var1</var>
| The name of the variable or table (for multiline edit; <code>/Multiline</code>) to store the edit string in.
|-
| <var>var2</var>
| This is an optional table setting advanced properties of the edit control (see below). If you don't need to set advanced properties, you may indicate so by supplying the asterisk, "<code>*</code>", instead of a table.
|}

==== Advanced properties of the EDIT control ====

A large number of advanced properties (i.e., settings) for an edit control may be set using a parameter table supplied as the <var>var2</var> argument (see above). If you don't need these advanced features, you may indicate so by supplying an asterisk, "<code>*</code>", instead of a table.

The parameter table used for setting the advanced properties of an edit control must be an extended table containing exactly two string columns that, in turn, must be named "parameter" and "string". You may create such a table using the following {{STX}} statement:

#tab := new table * * /E string:parameter string:string

For each advanced property to set, you need to store a respective entry (i.e., row) in the table, ''and'' tag the entry (see [[Programmer_Guide/Shell_Items/Table/SET_TABLE#Tagging_table_entries|Tagging table entries]]). Each such entry has to contain the name of the respective property in the <code>name</code> column, and its desired value in the <code>string</code> column.

The following advanced parameters are supported:

{|class="keinrahmen"
! align="left" | Parameter
! align="left" | Value(s)
|-
! align="left" | <var>name</var> field
! align="left" | <var>string</var> field
|-
| <code>append</code>
| <code>on</code> or <code>off</code>
|-
| <code>breakpoints</code>
| <code>on</code> or <code>off</code>
|-
| <code>caret</code>
| <code>on</code> or <code>off</code>
|-
| <code>clear</code>
| If specified, clears the contents of the edit control. There is no argument to this parameter.
Example: <code>$#tSettings parameter clear /T</code>
|-
| <code>colorOutput</code>
| sets the color for the shell output (only for edit controls with a <code>type</code> property set to <code>cli</code>)
|-
| <code>colorInput</code>
| sets the color for the input (only for edit controls with a <code>type</code> property set to <code>cli</code>)
|-
| <code>colorPrompt</code>
| sets the color for the prompt (only for edit controls with a <code>type</code> property set to <code>cli</code>)
|-
| <code>colorBackground</code>
| Sets the color for the background (only for edit controls with a <code>type</code> property set to <code>cli</code>)
|-
| <code>colorCaret</code>
| Sets the color (only for edit controls with a <code>type</code> property set to <code>cli</code>)

Example: <code>$#tSettings * parameter colorBackground string hlgray /t</code>Example: <code>$#tSettings * parameter colorPrompt string 0:250:128 /t</code>
|-
| <code>currentLine</code>
| <code>lineNumber</code>
|-
| <code>lineNumbers</code>
| <code>on</code> or <code>off</code>
|-
| <code>outputMode</code>
| The following values are supported:
* <code>overwrite</code> - overwrites old content with new content
* <code>append</code> - appends new content to old content
* <code>overwriteLastLine</code> - overwrites the last line
* <code>newLine</code> - which appends new data on a new line

Example: <code>$#tSettings * parameter outputMode string overwriteLastLine /T</code>
|-
| <code>outputLineLimit</code>
| If set to a number higher than zero, the control will limit the number of lines displayed. This is particularly useful when using a "<code>log</code>" type edit box.
|-
| <code>prompt</code>
| the CLI prompt, e.g. <code>"> "</code> or <code>"# "</code>
|-
| <code>readonly</code>
| <code>on</code> or <code>off</code>
|-
| <code>showLine</code>
| <code>lineNumber</code>
|-
| <code>type</code>
| The following values are supported:
* <code>edit</code> - a normal edit box
* <code>log</code> - read-only, append mode, caret off
* <code>code</code> - read-only, breakpoints on, linenumbers on, caret off and uses {{STX}} syntax highlighting
* <code>cli</code> - the command line interface
|-
| <code>waitforinput</code>
| If set to "<code>on</code>", key messages will be passed on to the shell without the CLI processing them in any other way. This can, e.g., be used by the console getc command to wait for the user to input a character. When the key processing should continue, this parameter should be set to "<code>off</code>".
|}

Note again that parameters you supply in the control table are ''ignored'' ''unless'' tagged.

Important: Once a setting has been applied, the tag will be ''removed''. So, if you want to change the setting at a later time, you need to tag it again.

==== Additional options for the EDIT control ====

{|class="keinrahmen"
! Option
! Meaning
|-
| <code>/Integer</code> or <code>/Number</code>
| Input field must contain a valid floating-point number (<code>/Number</code>) or an integer (<code>/Integer</code>), or a numeric expression of the respective type; expressions are evaluated before assigned to <var>var1</var> (not applicable/available if <var>var1</var> is a table).
|-
| <code>/Password</code>
| Input is hidden; an asterisk, "<code>*</code>" is displayed for each entered character
|-
| <code>/Multiline</code>
| Allow multiline input.
|-
|<code>/Keystroke</code>
| Send <code>[[Programmer Guide/Shell Items/Dialog/DISPLAY and DIALOG Messages|UPDATE]]</code> message to shell for each entered character; otherwise the update message is only sent if the input is completed (another control is selected).The enter key is a special case; for /Multiline edit boxes, the enter key is used for line breaks, whilst for single line edit boxes, the enter key sends a <code>[[Programmer Guide/Shell Items/Dialog/DISPLAY and DIALOG Messages|COMMAND]]</code> message (since {{STX}} version 3.6.0). Note that the enter key for a single line edit box also sends the same command as the default button (if one is defined - see <code>BUTTON</code>).
|-
| <code>/F[=PCAFS]</code>
| If ''no'' modifier is specified, all keys are forwarded. Otherwise, the listed modifiers will come into effect. Any combination of the modifiers is allowed. The modifiers have the following meaning:
* <code>P</code> - printable keys
* <code>C</code> - control keys (ctrl, shift, alt, alt-gr)
* <code>A</code> - action keys (left, right, esc, return etc.
* <code>F</code> - function keys (F1-F24)
* <code>S</code> - sticky keys (caps lock, num lock, scroll lock)
|}

See [[Programmer_Guide/Shell_Items/Dialog/Dialog_Controls#Common_arguments|Common arguments]] for a description of the parameters not described here.

Programmer Guide/Shell Items/Dialog/Dialog Controls/Edit - Revision history

Jw: Created page with "File:dialog_control_edit.png SET dialog index EDIT row col caption var1 [ width <..."

Jw: Created page with "File:dialog_control_edit.png SET `dialog` `index` EDIT `row` `col` `caption` `var₁` [ `width` <..."