Selection Functions
- Last UpdatedJan 07, 2026
- 2 minute read
|
choice_select(Title, Header, Actions) |
||
|
The function presents a box with a list of actions and lets the user select one of these. |
||
|
Input parameters: |
||
|
Title |
string |
The title of the box (max 132 characters) |
|
Header |
string |
The header of the list (max 512 characters) |
|
Actions |
Stringlist |
List of actions (max 132 characters for each action and max 20 actions) |
|
Returned value: |
||
|
[0] |
integer |
User response |
|
[1] |
integer |
The chosen action |
|
Exceptions: |
||
|
kcs_ValueError |
Invalid parameter value |
|
Figure 3:2. Box created with choice_select.
|
string_select(Title, Header, Prompt, Alternatives) |
||
|
The function presents a box with a list of strings and lets the user select one of these. |
||
|
Input parameters: |
||
|
Title |
string |
The title of the box (max 132 characters) |
|
Header |
string |
The header of the list (max 512 characters) |
|
Prompt |
string |
The prompt (max 512 characters) |
|
Alternatives |
Stringlist |
List of alternatives (max 132 characters for each alternative) |
|
Returned value: |
||
|
[0] |
integer |
User response |
|
[1] |
integer |
The selected alternative |
|
Exceptions: |
||
|
kcs_ValueError |
Invalid parameter value |
|
Figure 3:3. Example on a box created with string_select.
|
colour_select(Title, Colour) |
||
|
The function presents a colour box and lets the user select a colour. |
||
|
Input parameters: |
||
|
Title |
string |
The title of the box (max 132 characters) |
|
Output parameters: |
||
|
Colour |
Colour |
The selected colour |
|
Returned value: |
||
|
[0] |
integer |
User response |
|
[1] |
integer |
The selected colour |
|
Exceptions: |
||
|
kcs_ValueError |
Invalid parameter value |
|
|
symbol_select(Prompt, Font) |
||
|
The function lets the user select a symbol from a menu of all symbols in a given font. |
||
|
Input parameters: |
||
|
Prompt |
string |
The prompt (max 512 characters) |
|
Font |
integer |
The symbol font |
|
Returned value |
||
|
[0] |
integer |
User response |
|
:[1] |
integer |
The selected symbol within given font |
|
Exceptions: |
||
|
kcs_ValueError |
Invalid parameter value |
|
|
kcs_FontInvalid |
The symbol font was not found |
|
|
kcs_FontEmpty |
There are no symbols in the symbol font |
|
|
symbol_select(Prompt, SymbList) |
||
|
The function lets the user select a symbol from a menu of all symbols in a given list. This list may contain symbols from any existing symbol font. Non-existing symbols in the list will appear as blanks entries in the menu, thus alerting the user of incorrect input values. |
||
|
Input parameters: |
||
|
Prompt |
string |
The prompt (max 512 characters) |
|
SymbList |
Symbollist |
The symbol font |
|
Returned value: |
||
|
[0] |
integer |
User response |
|
[1] |
integer |
The font containing the selected symbol |
|
[2] |
integer |
The selected symbol within that font |
|
Exceptions: |
||
|
kcs_ValueError |
Invalid parameter value |
|
|
Example: |
||
|
# Example: kcs_ex_ui3.py |
||
|
# Example: kcs_ex_ui4.py |
||