Macros
#define	gTextfmt_col(col)
	DrawString() format option to align text to a text column

#define	gTextfmt_row(row)
	DrawString() format option to align text to a text row/line

Enumerations
enum	eraseLine_t { eraseTO_EOL, eraseFROM_BOL, eraseFULL_LINE, eraseNONE }
	Erase line options. More...

enum	gTextfmt_t { gTextfmt_left, gTextfmt_right, gTextfmt_top, gTextfmt_bottom, gTextfmt_center, gTextfmt_current }
	DrawString Format Options. More...

enum	gTextMode { gTextMode_SCROLLDOWN, gTextMode_VARasFIXED, gTextMode_OVERSTRIKE }
	Text area modes. More...

enum	gTextProp_t { gTextProp_x1, gTextProp_y1, gTextProp_x2, gTextProp_y2, gTextProp_cols, gTextProp_rows, gTextProp_FontWidth, gTextProp_FontHeight, gTextProp_minC, gTextProp_maxC }
	Get text area properties. More...

enum	predefinedArea { textAreaFULL, textAreaTOP, textAreaBOTTOM, textAreaLEFT, textAreaRIGHT, textAreaTOPLEFT, textAreaTOPRIGHT, textAreaBOTTOMLEFT, textAreaBOTTOMRIGHT }
	Pre Defined Text areas. More...

Detailed Description

Enumeration Type Documentation

enum eraseLine_t

Erase line options.

These enumerations are used with the function calls:
EraseTextLine() DrawString() They provide similar functionality to the ANSI EraseInLine terminal primitive: CSI n K

Enumerator
eraseTO_EOL	Erase From cursor to end of Line.
eraseFROM_BOL	Erase From Begining of Line to Cursor.
eraseFULL_LINE	Erase Entire line.
eraseNONE	Erase Nothing - not part of ANSI.

enum gTextfmt_t

DrawString Format Options.

These enumerations are used with the function calls:
DrawString() to align the output string.

Note: In addtion to these enumeration types, gTextfmt_col(col) and gTextfmt_row(row) can be use to specify a text column or text row/line.

Enumerator
gTextfmt_left	horizontal left adjust
gTextfmt_right	horizontal right adjust
gTextfmt_top	vertical top
gTextfmt_bottom	vertical bottom
gTextfmt_center	horizonal/vertical center
gTextfmt_current	current horizontal/vertical location

enum gTextMode

Text area modes.

These constants are used to define operation modes of text areas They are used with:

Enumerator
gTextMode_SCROLLDOWN	Reverse/Downward scrolling.
gTextMode_VARasFIXED	Render Variable font as fixed width.
gTextMode_OVERSTRIKE	Character Overstrike mode.

enum gTextProp_t

Get text area properties.

These enumerations are used with the function call:
GetAreaProp() to retrieve text area properties

Enumerator
gTextProp_x1	x1 - Upper left x coordinate
gTextProp_y1	y1 - Upper left y coordinate
gTextProp_x2	x2 - Lower right x coordinate
gTextProp_y2	y2 - Lower right y coordinate
gTextProp_cols	Text colums in text area.
gTextProp_rows	Text Rows in text area.
gTextProp_FontWidth	Current Font rendered max fixed width.
gTextProp_FontHeight	Current Font rendered height.
gTextProp_minC	Minimum character code for current font.
gTextProp_maxC	Maximum character code for current font.

enum predefinedArea

Pre Defined Text areas.

These enumerations are used to easily define text areas using predefined display areas.
They are used with the DefineArea() function call.

Enumerator
textAreaFULL	Entire GLCD display.
textAreaTOP	Top half of GLCD display.
textAreaBOTTOM	Bottom half of GLCD display.
textAreaLEFT	Left side of GLCD display.
textAreaRIGHT	Right side of GLCD display.
textAreaTOPLEFT	Upper left quarter of GLCD display.
textAreaTOPRIGHT	Upper right quarter of GLCD display.
textAreaBOTTOMLEFT	Buttom left quarter of GLCD display.
textAreaBOTTOMRIGHT	Bottom right quarter of GLCD display.

Macros

Enumerations

Detailed Description

Enumeration Type Documentation