Difference between revisions of "Component: Keypad (Cursor 3x3) (Keypad)"
From Flowcode Help
Jump to navigationJump to searchLine 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
− | Please click here to download the component source project: [https://www.flowcode.co.uk/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Keypad_Cursor.fcfx FC_Comp_Source_Keypad_Cursor.fcfx] |
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Keypad_Cursor.fcfx FC_Comp_Source_Keypad_Cursor.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Keypad_Cursor.fcfx FC_Comp_Source_Keypad_Cursor.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
+ | |||
+ | |||
Line 36: | Line 38: | ||
==Examples== | ==Examples== | ||
+ | |||
+ | |||
Line 50: | Line 54: | ||
==Macro reference== | ==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;" | '''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'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| 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;" | '''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'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| 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;" | '''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 a null string. | ||
+ | |- | ||
+ | |- | ||
+ | | 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'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| 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;" | '''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'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| 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;" | '''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'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| 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;" | '''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== | ||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Dimensions | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
+ | | width="90%" | Keys | ||
+ | |- | ||
+ | | colspan="2" | Number of columns (left to right) in the array of keys. Must be a value from one to four. | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Return Values | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
+ | | width="90%" | ASCII | ||
+ | |- | ||
+ | | colspan="2" | A list of return values for the 'GetString' and 'GetASCII' macros. Enter a string with one character per key, in order of key scanning. Columns are counted first (left-to-right), then rows (direction set by the 'First Row' property) e.g. for a 2*2 grid, the order would be... [Row0, Column0], [Row0,Column1], ][Row1, Column0], [Row1, Column1] | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-11-icon.png]] | ||
+ | | width="90%" | Numbers | ||
+ | |- | ||
+ | | colspan="2" | A list of return values for the 'GetNumber' macro. Enter a comma separated list with one integer value per key, in order of key scanning. Columns are counted first (left-to-right), then rows (direction set by the 'First Row' property) e.g. for a 2*2 grid, the order would be... [Row0, Column0], [Row0,Column1], ][Row1, Column0], [Row1, Column1] | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections | ||
+ | |- | ||
+ | |- | ||
+ | | 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]] | ||
+ | | width="90%" | Port | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
+ | | width="90%" | Backplate Colour | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 1 | ||
+ | |- | ||
+ | |- | ||
+ | | 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Button 2 | ||
+ | |- | ||
+ | |- | ||
+ | | 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%" | Up arrow 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | 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%" | Left arrow 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | 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%" | Right arrow 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | 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%" | Down arrow 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | 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. | ||
+ | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" |
Revision as of 09:57, 27 January 2023
Author | Matrix Ltd |
Version | 1.0 |
Category | Keypad |
Contents
Keypad (Cursor 3x3) component
A preset keypad component with up, down, left and right cursors, and a selection of function keys, in a 3 by 3 matrix. Return values (Index or Number) are... 0 = F1, 1 = Up, 2 = F3 3 = left, 4 = OK, 5 = right 6 = F2, 7 = down, 8 = F4. 255 = No key pressed.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_Keypad_Cursor.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_Keypad_Cursor.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
![]() |
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 |
![]() |
GetAscii |
Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255. | |
![]() |
Return |
![]() |
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 a null string. | |
![]() |
Return |
![]() |
GetNumber |
Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255. | |
![]() |
Return |
![]() |
GetIndex |
Gets the index value for the current keypress. If no key pressed then the macro returns the value 255. | |
![]() |
Return |
![]() |
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
==Macro reference==
![]() |
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 |
![]() |
GetAscii |
Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255. | |
![]() |
Return |
![]() |
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 a null string. | |
![]() |
Return |
![]() |
GetNumber |
Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255. | |
![]() |
Return |
![]() |
GetIndex |
Gets the index value for the current keypress. If no key pressed then the macro returns the value 255. | |
![]() |
Return |
![]() |
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
==Macro reference==
![]() |
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 |
![]() |
GetAscii |
Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255. | |
![]() |
Return |
![]() |
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 a null string. | |
![]() |
Return |
![]() |
GetNumber |
Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255. | |
![]() |
Return |
![]() |
GetIndex |
Gets the index value for the current keypress. If no key pressed then the macro returns the value 255. | |
![]() |
Return |
![]() |
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
==Macro reference==
![]() |
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 |
![]() |
GetAscii |
Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255. | |
![]() |
Return |
![]() |
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 a null string. | |
![]() |
Return |
![]() |
GetNumber |
Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255. | |
![]() |
Return |
![]() |
GetIndex |
Gets the index value for the current keypress. If no key pressed then the macro returns the value 255. | |
![]() |
Return |
![]() |
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 |