Difference between revisions of "Component: Keyboard (Controls )"
From Flowcode Help
Jump to navigationJump to search| Line 1: | Line 1: | ||
| − | + | {| style="width:50%" | |
| − | |||
| − | {| | ||
|- | |- | ||
| − | | width="20%" style="color: gray;" | Author | + | | width="20%" style="color:gray;" | Author |
| Matrix TSL | | Matrix TSL | ||
|- | |- | ||
| − | | width="20%" style="color: gray;" | Version | + | | width="20%" style="color:gray;" | Version |
| − | | 1.0 | + | | 1.0 |
|- | |- | ||
| − | | width="20%" style="color: gray;" | Category | + | | width="20%" style="color:gray;" | Category |
| Controls | | Controls | ||
|} | |} | ||
| + | ==Keyboard component== | ||
| + | Component to allow you to get direct input from the keyboard. Specific keys can be polled to test if they are pressed and provide interaction with the runtime panel. A full list of virtual key codes can be found here: https://docs.microsoft.com/en-gb/windows/win32/inputdev/virtual-key-codes?redirectedfrom=MSDN | ||
| − | == | + | ==Detailed description== |
| − | |||
| − | + | ''No detailed description exists yet for this component'' | |
| + | ==Examples== | ||
| − | |||
| − | |||
Here is an example of how to use the keyboard component to map key pressed to various functions on the panel. | Here is an example of how to use the keyboard component to map key pressed to various functions on the panel. | ||
| Line 45: | Line 43: | ||
==Downloadable macro reference== | ==Downloadable macro reference== | ||
| − | '' | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" |
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetKeyPress''' | ||
| + | |- | ||
| + | | colspan="2" | Checks a single virtual key code to test if the button is pressed or not. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | KeyCode | ||
| + | |- | ||
| + | | colspan="2" | Virtual Key Code Number | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| − | |||
| − | = | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" |
| − | + | |- | |
| − | + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |
| − | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CheckMultipleKeys''' | |
| − | + | |- | |
| − | :[[ | + | | colspan="2" | Checks all of the keys enabled in the component properties. If any keys are pressed then their scan index number is returned. If no keys are pressed then 0 is returned. |
| − | :: | + | |- |
| − | + | |- | |
| − | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | |
| − | ''' | + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' |
| − | + | |} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | Checks all of the keys enabled in the component properties. | ||
| − | |||
| − | If any keys are pressed then their scan index number is returned. | ||
| − | |||
| − | If no keys are pressed then 0 is returned. | ||
| − | |||
| − | |||
| − | |||
| − | : | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| Line 83: | Line 77: | ||
==Property reference== | ==Property reference== | ||
| − | |||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | + | |- | |
| − | Sets the number of keys to scan through when calling the CheckMultipleKeys function. | + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] |
| − | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | |
| − | + | |- | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |
| − | + | | width="90%" | Number of Scan Keys | |
| − | Virtual Keycode assigned to the scan index | + | |- |
| − | + | | colspan="2" | Sets the number of keys to scan through when calling the CheckMultipleKeys function. | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |
| − | + | | width="90%" | Scan Key 1 | |
| − | + | |- | |
| − | Virtual Keycode assigned to the scan index | + | | colspan="2" | Virtual Keycode assigned to the scan index |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |
| − | + | | width="90%" | Scan Key 2 | |
| − | + | |- | |
| − | + | | colspan="2" | Virtual Keycode assigned to the scan index | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |
| − | + | | width="90%" | Scan Key 3 | |
| − | + | |- | |
| − | + | | colspan="2" | Virtual Keycode assigned to the scan index | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |
| + | | width="90%" | Scan Key 4 | ||
| + | |- | ||
| + | | colspan="2" | Virtual Keycode assigned to the scan index | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections''' | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations''' | ||
| + | |- | ||
| + | |} | ||
Revision as of 09:19, 21 September 2021
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Controls |
Contents
Keyboard component
Component to allow you to get direct input from the keyboard. Specific keys can be polled to test if they are pressed and provide interaction with the runtime panel. A full list of virtual key codes can be found here: https://docs.microsoft.com/en-gb/windows/win32/inputdev/virtual-key-codes?redirectedfrom=MSDN
Detailed description
No detailed description exists yet for this component
Examples
Here is an example of how to use the keyboard component to map key pressed to various functions on the panel.
You can define keys that can be changed by the user by right clicking the keys in the keyboard component property and exposing them to the top level.
Once the properties have been exposed you can double click the top level property and rename to give a meaningful name in your application.
The user can then easily select which key they would like to assign to each function.
Downloadable macro reference
|
GetKeyPress |
| Checks a single virtual key code to test if the button is pressed or not. | |
 - BYTE
|
KeyCode |
| Virtual Key Code Number | |
| - BYTE
|
Return |
|
|
CheckMultipleKeys |
| Checks all of the keys enabled in the component properties. If any keys are pressed then their scan index number is returned. If no keys are pressed then 0 is returned. | |
| - BYTE
|
Return |
Property reference
|
Properties |
|
Number of Scan Keys |
| Sets the number of keys to scan through when calling the CheckMultipleKeys function. | |
|
|
Scan Key 1 |
| Virtual Keycode assigned to the scan index | |
|
|
Scan Key 2 |
| Virtual Keycode assigned to the scan index | |
|
|
Scan Key 3 |
| Virtual Keycode assigned to the scan index | |
|
|
Scan Key 4 |
| Virtual Keycode assigned to the scan index | |
|
Connections |
|
|
Simulations |
