Component: Keypad (4x4) (Keypad): Difference between revisions
Appearance
XML import |
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder"" |
||
| (18 intermediate revisions by 2 users not shown) | |||
| 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 | ||
| Keypad | | Keypad | ||
|} | |} | ||
==Keypad component== | |||
== | |||
Preset keypad based around the 4 * 4 unit. | Preset keypad based around the 4 * 4 unit. | ||
== | ==Detailed description== | ||
''No detailed description exists yet for this component'' | |||
==Examples== | |||
'' | ''<span style="color:red;">No additional examples</span>'' | ||
==Macro reference== | |||
===GetAscii=== | |||
{| class="mtx-class-macrotable wikitable" | |||
|- | |||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" class="mtx-class-macrohead" | '''GetAscii''' | |||
|- | |||
| colspan="2" | Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255. | |||
|- | |||
|- | |||
| 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'' | |||
|} | |||
'' | ===GetIndex=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" class="mtx-class-macrohead" | '''GetIndex''' | |||
|- | |||
| colspan="2" | Gets the index value for the current keypress. If no key pressed then the macro returns the value 255. | |||
|- | |||
|- | |||
| 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'' | |||
|} | |||
== | ===GetNumber=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" class="mtx-class-macrohead" | '''GetNumber''' | |||
|- | |||
| colspan="2" | Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255. | |||
|- | |||
|- | |||
| 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'' | |||
|} | |||
===GetString=== | |||
{| class="mtx-class-macrotable wikitable" | |||
|- | |||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" class="mtx-class-macrohead" | '''GetString''' | |||
|- | |||
| colspan="2" | Gets the ASCII value for the current keypress and returns in the form of a string. If no key pressed then the macro returns the value 255. | |||
|- | |||
|- | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | |||
|} | |||
===WaitPressed=== | |||
{| class="mtx-class-macrotable wikitable" | |||
|- | |||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" class="mtx-class-macrohead" | '''WaitPressed''' | |||
|- | |||
| colspan="2" | Blocking call that waits for one of the keys on the keypad to be pressed. The index of the key that was pressed is passed back to the user. | |||
|- | |||
|- | |||
| 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'' | |||
|} | |||
===WaitReleased=== | |||
{| class="mtx-class-macrotable wikitable" | |||
|- | |||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" class="mtx-class-macrohead" | '''WaitReleased''' | |||
|- | |||
| colspan="2" | Blocking call that waits for the keys on the keypad to be released. If no key is pressed then the function will return immediatley. | |||
|- | |||
|- | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | |||
|} | |||
==Property reference== | |||
This | {| class="mtx-class-macrotable wikitable" | ||
|- | |||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | |||
| width="90%" class="mtx-class-macrohead" | '''Properties''' | |||
|- | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Connections | |||
This | |- | ||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |||
| width="90%" | Output Mode | |||
|- | |||
| colspan="2" | | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-19-icon.png]] | |||
This | | width="90%" | Port | ||
|- | |||
| colspan="2" | | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Appearance | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Backplate Colour | |||
This | |- | ||
| colspan="2" | | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Button 1 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Key colour | |||
|- | |||
This | | colspan="2" | Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | ||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Label colour | |||
|- | |||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Button 2 | |||
|- | |||
This | |- | ||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Key colour | |||
|- | |||
| colspan="2" | Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Label colour | |||
|- | |||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Button 3 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Key colour | |||
|- | |||
| colspan="2" | Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Label colour | |||
|- | |||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Button 4 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Key colour | |||
|- | |||
| colspan="2" | Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Label colour | |||
|- | |||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Button 5 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Key colour | |||
|- | |||
| colspan="2" | Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Label colour | |||
|- | |||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Button 6 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Key colour | |||
|- | |||
| colspan="2" | Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | |||
| width="90%" | Label colour | |||
|- | |||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Button 7 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Key colour | |||
|- | |||
| colspan="2" | Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Label colour | |||
|- | |||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Button 8 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Key colour | |||
|- | |||
| colspan="2" | Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | |||
| width="90%" | Label colour | |||
|- | |||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Button 9 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Key colour | |||
|- | |||
| colspan="2" | Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Label colour | |||
|- | |||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Button 10 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Key colour | |||
|- | |||
| colspan="2" | Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Label colour | |||
|- | |||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Button 11 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Key colour | |||
|- | |||
| colspan="2" | Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Label colour | |||
|- | |||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Button 12 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Key colour | |||
|- | |||
| colspan="2" | Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Label colour | |||
|- | |||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Button 13 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Key colour | |||
|- | |||
| colspan="2" | Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Label colour | |||
|- | |||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Button 14 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Key colour | |||
|- | |||
| colspan="2" | Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Label colour | |||
|- | |||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Button 15 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Key colour | |||
|- | |||
| colspan="2" | Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Label colour | |||
|- | |||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |||
|- | |||
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" class="mtx-class-propfolder" | Button 16 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Key colour | |||
|- | |||
| colspan="2" | Set the colour of the key body here. This is applied to all objects making up a key, including the background colour of any text labels. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Label colour | |||
|- | |||
| colspan="2" | Set the colour for the default 'ASCII' text label on the key-cap. This setting will be ignored if a bitmap is set for the key label. | |||
|} | |||
==Component Source Code== | |||
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Keypad_4x4.fcfx FC_Comp_Source_Keypad_4x4.fcfx] | |||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Keypad_4x4.fcfx FC_Comp_Source_Keypad_4x4.fcfx] | |||
Latest revision as of 14:36, 13 July 2026
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Keypad |
Keypad component
Preset keypad based around the 4 * 4 unit.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
GetAscii
| GetAscii | |
| Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255. | |
| Return | |
GetIndex
| GetIndex | |
| Gets the index value for the current keypress. If no key pressed then the macro returns the value 255. | |
| Return | |
GetNumber
| GetNumber | |
| Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255. | |
| Return | |
GetString
| GetString | |
| Gets the ASCII value for the current keypress and returns in the form of a string. If no key pressed then the macro returns the value 255. | |
| Return | |
WaitPressed
| WaitPressed | |
| Blocking call that waits for one of the keys on the keypad to be pressed. The index of the key that was pressed is passed back to the user. | |
| Return | |
WaitReleased
| WaitReleased | |
| Blocking call that waits for the keys on the keypad to be released. If no key is pressed then the function will return immediatley. | |
| Return | |
Property reference
Component Source Code
Please click here to download the component source project: FC_Comp_Source_Keypad_4x4.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_Keypad_4x4.fcfx