Component: GLCD Textfield (Graphical Library): Difference between revisions

Latest revision as of 14:22, 13 July 2026

Author	Matrix TSL
Version	1.2
Category	Graphical Library

GLCD Textfield component

A component to simplify the process of drawing text to a graphical display. Allows the graphical LCD to be used more like a standard alphanumeric display. Compatible with the Graphical LCDs.

Detailed description

No detailed description exists yet for this component

Examples

Example program showing how to use the component with a graphical display.

GLCD TextField Example

Macro reference

Clear

	Clear
Clears all text from the display
- VOID	Return

ClearLine

	ClearLine
Clears a single line of text from the display
- BYTE	Line
Line to clear. Range 0 to CharacterHeight - 1
- VOID	Return

ClearLineRemainder

	ClearLineRemainder

- VOID	Return

Cursor

	Cursor
Moves the current pixel position of the cursor within the coordinate space
- UINT	X
Sets the pixel position on the X plane, 0 is the left most pixel
- UINT	Y
Sets the pixel position on the Y plane, 0 is the top most pixel
- VOID	Return

GetCursorPosition

	GetCursorPosition
Gets the current pixel position of the cursor within the coordinate space
- BYTE	Axis
0=X, 1=Y
- UINT	Return

PrintASCII

	PrintASCII
Prints a single ASCII character to the display
- BYTE	Character
Holds an ASCII value e.g. 'A'
- VOID	Return

PrintFormattedNumber

	PrintFormattedNumber
Will allow you to print a number up to 32-bits with signed or unsigned formatting. Signed = -2147483648 to 2147483647 Unsigned = 0 to 4294967295
- ULONG	Number
Enter the number or variable to print to the display
- BOOL	Format
0 = Signed, 1 = Unsigned
- VOID	Return

PrintNumber

	PrintNumber
Prints a number to the display as an ASCII string
- INT	Number
Enter the number or variable to print to the display
- VOID	Return

PrintString

	PrintString
Prints a string of ASCII characters to the display
- STRING	Text
Enter the text or variable to print to the display
- VOID	Return

Property reference

	Properties
	LinkTo

	Font
Chooses one of the fonts define dby the display component.
	Auto Clear
Automatically clears the remainder of a line when printing data.
	Entire Display
Specifies if we are using the entire display or a portion of the display
	Orientation 1/3
Swaps the pixel width and height for orientations 1 and 3.
	X Coordinate
X coordinate for top left of the text field
	Y Coordinate
Y coordinate for top left of the text field
	Pixel Width
Pixel width of selected display
	Pixel Height
Pixel height of selected display
	ColourDisplay
Automatically detects if the graphical LCD object is colour or monochrome

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Lib_GLCD_Textfield.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Lib_GLCD_Textfield.fcfx

@@ Line 85: / Line 85: @@
 ===Clear===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Clear'''
+| width="90%" class="mtx-class-macrohead" | '''Clear'''
 |-
 | colspan="2" | Clears all text from the display&nbsp;
@@ Line 99: / Line 99: @@
 ===ClearLine===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ClearLine'''
+| width="90%" class="mtx-class-macrohead" | '''ClearLine'''
 |-
 | colspan="2" | Clears a single line of text from the display&nbsp;
@@ Line 118: / Line 118: @@
 ===ClearLineRemainder===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ClearLineRemainder'''
+| width="90%" class="mtx-class-macrohead" | '''ClearLineRemainder'''
 |-
 | colspan="2" | &nbsp;
@@ Line 132: / Line 132: @@
 ===Cursor===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Cursor'''
+| width="90%" class="mtx-class-macrohead" | '''Cursor'''
 |-
 | colspan="2" | Moves the current pixel position of the cursor within the coordinate space&nbsp;
@@ Line 156: / Line 156: @@
 ===GetCursorPosition===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetCursorPosition'''
+| width="90%" class="mtx-class-macrohead" | '''GetCursorPosition'''
 |-
 | colspan="2" | Gets the current pixel position of the cursor within the coordinate space&nbsp;
@@ Line 175: / Line 175: @@
 ===PrintASCII===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintASCII'''
+| width="90%" class="mtx-class-macrohead" | '''PrintASCII'''
 |-
 | colspan="2" | Prints a single ASCII character to the display&nbsp;
@@ Line 194: / Line 194: @@
 ===PrintFormattedNumber===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintFormattedNumber'''
+| width="90%" class="mtx-class-macrohead" | '''PrintFormattedNumber'''
 |-
 | colspan="2" | Will allow you to print a number up to 32-bits with signed or unsigned formatting. Signed = -2147483648 to 2147483647 Unsigned = 0 to 4294967295&nbsp;
@@ Line 218: / Line 218: @@
 ===PrintNumber===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintNumber'''
+| width="90%" class="mtx-class-macrohead" | '''PrintNumber'''
 |-
 | colspan="2" | Prints a number to the display as an ASCII string&nbsp;
@@ Line 237: / Line 237: @@
 ===PrintString===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintString'''
+| width="90%" class="mtx-class-macrohead" | '''PrintString'''
 |-
 | colspan="2" | Prints a string of ASCII characters to the display&nbsp;
@@ Line 257: / Line 257: @@
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-

SteveT (talk | contribs)