TextAreaWithTwoWildcards

TextArea with two wildcards. The format string (i.e. the TypedText set in setTypedText()) is expected to contain two wildcards <placeholders> from the text.

Note: the text converter tool converts the <...> to ascii value 2 which is what is being replaced by a wildcard text.

Inherits from: TextArea, Widget, Drawable

Public Functions

virtual void	draw(const Rect & invalidatedArea) const
	Draw this drawable.
virtual int16_t	getTextHeight()
	Gets the total height needed by the text, taking number of lines and line spacing into consideration.
virtual uint16_t	getTextWidth() const
	Gets the width in pixels of the current associated text in the current selected language.
const Unicode::UnicodeChar *	getWildcard1() const
	Gets the first wildcard used in the TypedText as previously set using setWildcard1().
const Unicode::UnicodeChar *	getWildcard2() const
	Gets the second wildcard used in the TypedText as previously set using setWildcard1().
void	setWildcard1(const Unicode::UnicodeChar * value)
	Sets the wildcard used in the TypedText where first <placeholder> is placed.
void	setWildcard2(const Unicode::UnicodeChar * value)
	Sets the wildcard used in the TypedText where second <placeholder> is placed.
	TextAreaWithTwoWildcards()

Protected Attributes

const Unicode::UnicodeChar *	wc1
	Pointer to the first wildcard string. Must be null-terminated.
const Unicode::UnicodeChar *	wc2
	Pointer to the second wildcard string. Must be null-terminated.

Additional inherited members

Public Functions inherited from TextArea

virtual int16_t	calculateTextHeight(const Unicode::UnicodeChar * format, ... ) const
	Gets the total height needed by the text.
uint8_t	getAlpha() const
	Gets the current alpha value of the widget.
FORCE_INLINE_FUNCTION colortype	getColor() const
	Gets the color of the text.
FORCE_INLINE_FUNCTION uint8_t	getIndentation()
	Gets the indentation of text inside the TextArea.
FORCE_INLINE_FUNCTION int16_t	getLinespacing() const
	Gets the line spacing of the TextArea.
TextRotation	getRotation() const
	Gets rotation of the text in the TextArea.
virtual Rect	getSolidRect() const
	Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
TypedText	getTypedText() const
	Gets the TypedText of the text area.
WideTextAction	getWideTextAction() const
	Gets wide text action previously set using setWideTextAction.
void	resizeHeightToCurrentText()
	Sets the height of the TextArea to match the height of the current associated text for the current selected language.
void	resizeHeightToCurrentTextWithRotation()
	Sets the height of the TextArea to match the height of the current associated text for the current selected language.
void	resizeToCurrentText()
	Sets the dimensions of the TextArea to match the width and height of the current associated text for the current selected language.
void	resizeToCurrentTextWithAlignment()
	Sets the dimensions of the TextArea to match the width and height of the current associated text for the current selected language, and for centered and right aligned text, the position of the TextArea widget is also updated to keep the text in the same position on the display.
void	setAlpha(uint8_t newAlpha)
	Sets the opacity (alpha value).
virtual void	setBaselineY(int16_t baselineY)
	Adjusts the TextArea y coordinate so the text will have its baseline at the specified value.
FORCE_INLINE_FUNCTION void	setColor(colortype color)
	Sets the color of the text.
FORCE_INLINE_FUNCTION void	setIndentation(uint8_t indent)
	Sets the indentation for the text.
FORCE_INLINE_FUNCTION void	setLinespacing(int16_t space)
	Sets the line spacing of the TextArea.
void	setRotation(const TextRotation rotation)
	Sets rotation of the text in the TextArea.
void	setTypedText(const TypedText & t)
	Sets the TypedText of the text area.
void	setWideTextAction(WideTextAction action)
	Defines what to do if a line of text is wider than the text area.
virtual void	setXBaselineY(int16_t x, int16_t baselineY)
	Adjusts the TextArea x and y coordinates so the text will have its baseline at the specified y value.
	TextArea()

Protected Attributes inherited from TextArea

uint8_t	alpha
	The alpha to use.
colortype	color
	The color to use for the text.
uint8_t	indentation
	The indentation of the text inside the text area.
int16_t	linespace
	The extra space between lines of text, measured in pixels.
TextRotation	rotation
	The text rotation to use in steps of 90 degrees.
TypedText	typedText
	The TypedText to display.
WideTextAction	wideTextAction
	What to do if the lines of text are wider than the text area.

Public Functions inherited from Widget

virtual void	getLastChild(int16_t x, int16_t y, Drawable ** last)
	Since a Widget is only one Drawable, Widget::getLastChild simply yields itself as result, but only if the Widget isVisible and isTouchable.

Public Functions inherited from Drawable

virtual void	childGeometryChanged()
	This function can be called on parent nodes to signal that the size or position of one or more of its children has changed.
	Drawable()
	Initializes a new instance of the Drawable class.
void	drawToDynamicBitmap(BitmapId id)
	Render the Drawable object into a dynamic bitmap.
Rect	getAbsoluteRect() const
	Helper function for obtaining the rectangle this Drawable covers, expressed in absolute coordinates.
virtual Drawable *	getFirstChild()
	Function for obtaining the first child of this drawable if any.
int16_t	getHeight() const
	Gets the height of this Drawable.
virtual void	getLastChild(int16_t x, int16_t y, Drawable ** last) =0
	Function for obtaining the the last child of this drawable that intersects with the specified point.
Drawable *	getNextSibling()
	Gets the next sibling node.
Drawable *	getParent() const
	Returns the parent node.
const Rect &	getRect() const
	Gets the rectangle this Drawable covers, in coordinates relative to its parent.
virtual Rect	getSolidRect() const =0
	Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual Rect	getSolidRectAbsolute()
	Helper function for obtaining the largest solid rect (as implemented by getSolidRect()) expressed in absolute coordinates.
virtual void	getVisibleRect(Rect & rect) const
	Function for finding the visible part of this drawable.
int16_t	getWidth() const
	Gets the width of this Drawable.
int16_t	getX() const
	Gets the x coordinate of this Drawable, relative to its parent.
int16_t	getY() const
	Gets the y coordinate of this Drawable, relative to its parent.
virtual void	handleClickEvent(const ClickEvent & event)
	Defines the event handler interface for ClickEvents.
virtual void	handleDragEvent(const DragEvent & event)
	Defines the event handler interface for DragEvents.
virtual void	handleGestureEvent(const GestureEvent & event)
	Defines the event handler interface for GestureEvents.
virtual void	handleTickEvent()
	Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
virtual void	invalidate() const
	Tell the framework that this entire Drawable needs to be redrawn.
virtual void	invalidateRect(Rect & invalidatedArea) const
	Request that a region of this drawable is redrawn.
bool	isTouchable() const
	Gets whether this Drawable receives touch events or not.
bool	isVisible() const
	Gets whether this Drawable is visible.
virtual void	moveRelative(int16_t x, int16_t y)
	Moves the drawable.
virtual void	moveTo(int16_t x, int16_t y)
	Moves the drawable.
virtual void	setHeight(int16_t height)
	Sets the height of this drawable.
void	setPosition(const Drawable & drawable)
	Sets the position of the Drawable to the same as the given Drawable.
void	setPosition(int16_t x, int16_t y, int16_t width, int16_t height)
	Sets the size and position of this Drawable, relative to its parent.
void	setTouchable(bool touch)
	Controls whether this Drawable receives touch events or not.
void	setVisible(bool vis)
	Controls whether this Drawable should be visible.
virtual void	setWidth(int16_t width)
	Sets the width of this drawable.
void	setWidthHeight(const Bitmap & bitmap)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
void	setWidthHeight(const Drawable & drawable)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
void	setWidthHeight(const Rect & rect)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
void	setWidthHeight(int16_t width, int16_t height)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
virtual void	setX(int16_t x)
	Sets the x coordinate of this Drawable, relative to its parent.
void	setXY(const Drawable & drawable)
	Sets the x and y coordinates of this Drawable.
void	setXY(int16_t x, int16_t y)
	Sets the x and y coordinates of this Drawable, relative to its parent.
virtual void	setY(int16_t y)
	Sets the y coordinate of this Drawable, relative to its parent.
virtual void	translateRectToAbsolute(Rect & r) const
	Helper function for converting a region of this Drawable to absolute coordinates.
virtual	~Drawable()
	Finalizes an instance of the Drawable class.

Protected Attributes inherited from Drawable

Drawable *	nextSibling
	Pointer to the next Drawable.
Drawable *	parent
	Pointer to this drawable's parent.
Rect	rect
	The coordinates of this Drawable, relative to its parent.
bool	touchable
	True if this drawable should receive touch events.
bool	visible
	True if this drawable should be drawn.

Public Functions Documentation

draw

virtual void draw	(	const Rect &	invalidatedArea	)

Draw this drawable.

It is a requirement that the draw implementation does not draw outside the region specified by invalidatedArea.

Parameters:

invalidatedArea	The sub-region of this drawable that needs to be redrawn, expressed in coordinates relative to its parent (e.g. for a complete redraw, invalidatedArea will be (0, 0, width, height).

Reimplements: touchgfx::TextArea::draw

getTextHeight

virtual int16_t getTextHeight	(			)

Gets the total height needed by the text, taking number of lines and line spacing into consideration.

Returns:

the total height needed by the text.

Reimplements: touchgfx::TextArea::getTextHeight

getTextWidth

virtual uint16_t getTextWidth	(			)	const

Gets the width in pixels of the current associated text in the current selected language.

In case of multi-lined text the width of the widest line is returned.

Returns:

The width in pixels of the current text.

Reimplements: touchgfx::TextArea::getTextWidth

getWildcard1

const Unicode::UnicodeChar * getWildcard1	(			)	const

Gets the first wildcard used in the TypedText as previously set using setWildcard1().

Returns:

The first wildcard used in the text.

getWildcard2

const Unicode::UnicodeChar * getWildcard2	(			)	const

Gets the second wildcard used in the TypedText as previously set using setWildcard1().

Returns:

The second wildcard used in the text.

setWildcard1

void setWildcard1	(	const Unicode::UnicodeChar *	value	)

Sets the wildcard used in the TypedText where first <placeholder> is placed.

Wildcard string must be a null-terminated UnicodeChar array.

Parameters:

value	A pointer to the UnicodeChar to set the wildcard to.

Note

The pointer passed is saved, and must be accessible whenever TextAreaWithTwoWildcard may need it.

setWildcard2

void setWildcard2	(	const Unicode::UnicodeChar *	value	)

Sets the wildcard used in the TypedText where second <placeholder> is placed.

Wildcard string must be a null-terminated UnicodeChar array.

Parameters:

value	A pointer to the UnicodeChar to set the wildcard to.

Note

The pointer passed is saved, and must be accessible whenever TextAreaWithTwoWildcard may need it.

TextAreaWithTwoWildcards

TextAreaWithTwoWildcards	(			)

Protected Attributes Documentation

wc1

const Unicode::UnicodeChar * wc1

Pointer to the first wildcard string. Must be null-terminated.

wc2

const Unicode::UnicodeChar * wc2

Pointer to the second wildcard string. Must be null-terminated.