Component: Keypad (Cursor 3x3) (Keypad): Difference between revisions

Revision as of 09:57, 27 January 2023

Author	Matrix Ltd
Version	1.0
Category	Keypad

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.
- BYTE	Return

	GetAscii
Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255.
- BYTE	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.
- STRING	Return

	GetNumber
Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255.
- BYTE	Return

	GetIndex
Gets the index value for the current keypress. If no key pressed then the macro returns the value 255.
- BYTE	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.
- VOID	Return

Property reference

	Properties
	Dimensions
	Keys
Number of columns (left to right) in the array of keys. Must be a value from one to four.
	Return Values
	ASCII
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]
	Numbers
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]
	Connections
	Output Mode

	Port

	Appearance
	Backplate Colour

	Button 1
	Key colour
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.
	Label colour
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.
	Button 2
	Key colour
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.
	Up arrow colour
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.
	Button 3
	Key colour
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.
	Label colour
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.
	Button 4
	Key colour
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.
	Left arrow colour
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.
	Button 5
	Key colour
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.
	Label colour
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.
	Button 6
	Key colour
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.
	Right arrow colour
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.
	Button 7
	Key colour
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.
	Label colour
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.
	Button 8
	Key colour
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.
	Down arrow colour
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.
	Button 9
	Key colour
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.
	Label colour
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==

	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.
- BYTE	Return

	GetAscii
Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255.
- BYTE	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.
- STRING	Return

	GetNumber
Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255.
- BYTE	Return

	GetIndex
Gets the index value for the current keypress. If no key pressed then the macro returns the value 255.
- BYTE	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.
- VOID	Return

Property reference

	Properties
	Dimensions
	Keys
Number of columns (left to right) in the array of keys. Must be a value from one to four.
	Return Values
	ASCII
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]
	Numbers
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]
	Connections
	Output Mode

	Port

	Appearance
	Backplate Colour

	Button 1
	Key colour
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.
	Label colour
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.
	Button 2
	Key colour
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.
	Up arrow colour
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.
	Button 3
	Key colour
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.
	Label colour
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.
	Button 4
	Key colour
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.
	Left arrow colour
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.
	Button 5
	Key colour
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.
	Label colour
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.
	Button 6
	Key colour
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.
	Right arrow colour
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.
	Button 7
	Key colour
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.
	Label colour
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.
	Button 8
	Key colour
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.
	Down arrow colour
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.
	Button 9
	Key colour
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.
	Label colour
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==

	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.
- BYTE	Return

	GetAscii
Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255.
- BYTE	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.
- STRING	Return

	GetNumber
Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255.
- BYTE	Return

	GetIndex
Gets the index value for the current keypress. If no key pressed then the macro returns the value 255.
- BYTE	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.
- VOID	Return

Property reference

	Properties
	Dimensions
	Keys
Number of columns (left to right) in the array of keys. Must be a value from one to four.
	Return Values
	ASCII
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]
	Numbers
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]
	Connections
	Output Mode

	Port

	Appearance
	Backplate Colour

	Button 1
	Key colour
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.
	Label colour
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.
	Button 2
	Key colour
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.
	Up arrow colour
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.
	Button 3
	Key colour
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.
	Label colour
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.
	Button 4
	Key colour
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.
	Left arrow colour
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.
	Button 5
	Key colour
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.
	Label colour
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.
	Button 6
	Key colour
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.
	Right arrow colour
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.
	Button 7
	Key colour
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.
	Label colour
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.
	Button 8
	Key colour
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.
	Down arrow colour
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.
	Button 9
	Key colour
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.
	Label colour
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==

	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.
- BYTE	Return

	GetAscii
Gets the ASCII value for the current keypress. If no key is pressed then the macro returns the value 255.
- BYTE	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.
- STRING	Return

	GetNumber
Gets the numeric value for the current keypress. If no key pressed then the macro returns the value 255.
- BYTE	Return

	GetIndex
Gets the index value for the current keypress. If no key pressed then the macro returns the value 255.
- BYTE	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.
- VOID	Return

Property reference

	Properties
	Dimensions
	Keys
Number of columns (left to right) in the array of keys. Must be a value from one to four.
	Return Values
	ASCII
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]
	Numbers
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]
	Connections
	Output Mode

	Port

	Appearance
	Backplate Colour

	Button 1
	Key colour
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.
	Label colour
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.
	Button 2
	Key colour
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.
	Up arrow colour
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.
	Button 3
	Key colour
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.
	Label colour
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.
	Button 4
	Key colour
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.
	Left arrow colour
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.
	Button 5
	Key colour
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.
	Label colour
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.
	Button 6
	Key colour
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.
	Right arrow colour
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.
	Button 7
	Key colour
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.
	Label colour
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.
	Button 8
	Key colour
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.
	Down arrow colour
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.
	Button 9
	Key colour
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.
	Label colour
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.

Wiki bot (talk | contribs)

Revision as of 09:57, 27 January 2023

Keypad (Cursor 3x3) component

Component Source Code

Detailed description

Examples

Macro reference

Property reference

Property reference

Property reference

Property reference