GfxTextBox2 Class Reference

Inheritance diagram for GfxTextBox2:

Public Member Functions
	GfxTextBox2 (String initialText, GfxFont &font=GfxDefaultFont, bool border=true, uint8_t padding=1, char justify='C', uint16_t width=0, uint16_t height=0)
void	draw (uint16_t xOffset=0, uint16_t yOffset=0)
uint16_t	width ()
uint16_t	height ()
const String &	text ()
void	setText (const String &newText)

Protected Attributes
String	_text
GfxFont &	_font
bool	_border
uint8_t	_padding
bool	_justify
uint16_t	_width
uint16_t	_height

Detailed Description

Definition at line 8 of file GfxTextBox2.h.

Constructor & Destructor Documentation

GfxTextBox2()

GfxTextBox2::GfxTextBox2	(	String	initialText,
		GfxFont &	font = GfxDefaultFont,
		bool	border = true,
		uint8_t	padding = 1,
		char	justify = 'C',
		uint16_t	width = 0,
		uint16_t	height = 0
	)

Constructor.

Parameters

initialText	the initial text in the box
font	the font to be used. If NULL, the default font will be used
border	whether or not to draw the border around the text box
padding	how many pixels padding between the border and the font
justify	'L', 'C', or 'R' (left, center, right)
width	the width in pixels. If 0, determine width from font/text
height	the height in pixels. If 0, determine width from font/text

Definition at line 5 of file GfxTextBox2.cpp.

Here is the call graph for this function:

Member Function Documentation

draw()

void GfxTextBox2::draw ( uint16_t  xOffset = 0, uint16_t  yOffset = 0  )

virtual

Draw it.

Draws the bext box, starting at the top left corner specified by (xOffset,yOffset)

Implements GfxItem.

Definition at line 28 of file GfxTextBox2.cpp.

Here is the call graph for this function:

height()

uint16_t GfxTextBox2::height ( )

virtual

Get the height of the text box.

Implements GfxItem.

Definition at line 56 of file GfxTextBox2.cpp.

setText()

void GfxTextBox2::setText

(

const String &

newText

)

Update the text in the text box.

Definition at line 65 of file GfxTextBox2.cpp.

text()

const String & GfxTextBox2::text

(

)

Get the text in the text box.

Definition at line 60 of file GfxTextBox2.cpp.

width()

uint16_t GfxTextBox2::width ( )

virtual

Get the width of the text box.

Implements GfxItem.

Definition at line 51 of file GfxTextBox2.cpp.

---

The documentation for this class was generated from the following files:

• src/GfxTextBox2.h
• src/GfxTextBox2.cpp