Skip to main content

TextAreaWithWildcardBase

touchgfx/widgets/TextAreaWithWildcard.hpp

Base class for TextArea with one or two wildcards.

See: TextAreaWithOneWildcard, TextAreaWithTwoWildcards

Inherits from: TextArea, Widget, Drawable

Inherited by: TextAreaWithOneWildcard, TextAreaWithTwoWildcards

Public Functions

virtual voiddraw(const Rect & invalidatedArea) const
Draw this drawable.
virtual voidinvalidateContent() const
Tell the framework that the contents of the Drawable needs to be redrawn.
TextAreaWithWildcardBase()

Protected Functions

virtual TextArea::BoundingAreacalculateBoundingArea() const
Calculates the minimum bounding rectangle of this text area and correlates it with the containing text, to get the bounding area.

Additional inherited members

Protected Classes inherited from TextArea

classBoundingArea
Structure for the relationship between a bounding rectangle and the contained text.

Public Functions inherited from TextArea

virtual int16_tcalculateTextHeight(const Unicode::UnicodeChar * format, ... ) const
Gets the total height needed by the text.
virtual AlignmentgetAlignment() const
Gets the alignment of text inside the TextArea.
uint8_tgetAlpha() const
Gets the current alpha value of the widget.
FORCE_INLINE_FUNCTION colortypegetColor() const
Gets the color of the text.
FORCE_INLINE_FUNCTION uint8_tgetIndentation()
Gets the indentation of text inside the TextArea.
FORCE_INLINE_FUNCTION int16_tgetLinespacing() const
Gets the line spacing of the TextArea.
TextRotationgetRotation() const
Gets rotation of the text in the TextArea.
virtual RectgetSolidRect() const
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual int16_tgetTextHeight() const
Gets the total height needed by the text, taking number of lines and line spacing into consideration.
virtual uint16_tgetTextWidth() const
Gets the width in pixels of the current associated text in the current selected language.
const TypedText &getTypedText() const
Gets the TypedText of the text area.
WideTextActiongetWideTextAction() const
Gets wide text action previously set using setWideTextAction.
virtual const Unicode::UnicodeChar *getWildcard1() const
Gets the first wildcard used in the TypedText.
virtual const Unicode::UnicodeChar *getWildcard2() const
Gets the second wildcard used in the TypedText.
voidresizeHeightToCurrentText()
Sets the height of the TextArea to match the height of the current associated text for the current selected language.
voidresizeHeightToCurrentTextWithRotation()
Sets the height of the TextArea to match the height of the current associated text for the current selected language.
voidresizeToCurrentText()
Sets the dimensions of the TextArea to match the width and height of the current associated text for the current selected language.
voidresizeToCurrentTextWithAlignment()
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.
virtual voidsetAlpha(uint8_t newAlpha)
Sets the opacity (alpha value).
virtual voidsetBaselineY(int16_t baselineY)
Adjusts the TextArea y coordinate so the text will have its baseline at the specified value.
FORCE_INLINE_FUNCTION voidsetColor(colortype newColor)
Sets the color of the text.
virtual voidsetHeight(int16_t height)
Sets the height of this drawable.
FORCE_INLINE_FUNCTION voidsetIndentation(uint8_t indent)
Sets the indentation for the text.
FORCE_INLINE_FUNCTION voidsetLinespacing(int16_t space)
Sets the line spacing of the TextArea.
FORCE_INLINE_FUNCTION voidsetRotation(const TextRotation textRotation)
Sets rotation of the text in the TextArea.
voidsetTypedText(const TypedText & t)
Sets the TypedText of the text area.
FORCE_INLINE_FUNCTION voidsetWideTextAction(WideTextAction action)
Defines what to do if a line of text is wider than the text area.
virtual voidsetWidth(int16_t width)
Sets the width of this drawable.
virtual voidsetXBaselineY(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_talpha
The alpha to use.
BoundingAreaboundingArea
Bounding area of this text area.
colortypecolor
The color to use for the text.
uint8_tindentation
The indentation of the text inside the text area.
int16_tlinespace
The extra space between lines of text, measured in pixels.
TextRotationrotation
The text rotation to use in steps of 90 degrees.
TypedTexttypedText
The TypedText to display.
WideTextActionwideTextAction
What to do if the lines of text are wider than the text area.
const uint16_tnewLine
NewLine value.

Public Functions inherited from Widget

virtual voidgetLastChild(int16_t , int16_t , 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

voidcenter()
Centers the Drawable inside its parent.
voidcenterX()
Center the Drawable horizontally inside its parent.
voidcenterY()
Center the Drawable vertically inside its parent.
virtual voidchildGeometryChanged()
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.
voiddrawToDynamicBitmap(BitmapId id)
Render the Drawable object into a dynamic bitmap.
voidexpand(int margin =0)
Expands the Drawable to have the same size as its parent with a given margin around the edge.
RectgetAbsoluteRect() 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_tgetHeight() const
Gets the height of this Drawable.
virtual voidgetLastChild(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 RectgetSolidRect() const =0
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual RectgetSolidRectAbsolute()
Helper function for obtaining the largest solid rect (as implemented by getSolidRect()) expressed in absolute coordinates.
virtual voidgetVisibleRect(Rect & rect) const
Function for finding the visible part of this drawable.
int16_tgetWidth() const
Gets the width of this Drawable.
int16_tgetX() const
Gets the x coordinate of this Drawable, relative to its parent.
int16_tgetY() const
Gets the y coordinate of this Drawable, relative to its parent.
virtual voidhandleClickEvent(const ClickEvent & event)
Defines the event handler interface for ClickEvents.
virtual voidhandleDragEvent(const DragEvent & event)
Defines the event handler interface for DragEvents.
virtual voidhandleGestureEvent(const GestureEvent & event)
Defines the event handler interface for GestureEvents.
virtual voidhandleTickEvent()
Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
virtual voidinvalidate() const
Tell the framework that this entire Drawable needs to be redrawn.
virtual voidinvalidateRect(Rect & invalidatedArea) const
Request that a region of this drawable is redrawn.
boolisTouchable() const
Gets whether this Drawable receives touch events or not.
boolisVisible() const
Gets whether this Drawable is visible.
virtual voidmoveRelative(int16_t x, int16_t y)
Moves the drawable.
virtual voidmoveTo(int16_t x, int16_t y)
Moves the drawable.
virtual voidsetHeight(int16_t height)
Sets the height of this drawable.
voidsetPosition(const Drawable & drawable)
Sets the position of the Drawable to the same as the given Drawable.
voidsetPosition(int16_t x, int16_t y, int16_t width, int16_t height)
Sets the size and position of this Drawable, relative to its parent.
voidsetTouchable(bool touch)
Controls whether this Drawable receives touch events or not.
voidsetVisible(bool vis)
Controls whether this Drawable should be visible.
virtual voidsetWidth(int16_t width)
Sets the width of this drawable.
voidsetWidthHeight(const Bitmap & bitmap)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(const Drawable & drawable)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(const Rect & other)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(int16_t width, int16_t height)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
virtual voidsetX(int16_t x)
Sets the x coordinate of this Drawable, relative to its parent.
voidsetXY(const Drawable & drawable)
Sets the x and y coordinates of this Drawable.
voidsetXY(int16_t x, int16_t y)
Sets the x and y coordinates of this Drawable, relative to its parent.
virtual voidsetY(int16_t y)
Sets the y coordinate of this Drawable, relative to its parent.
virtual voidtranslateRectToAbsolute(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.
Rectrect
The coordinates of this Drawable, relative to its parent.
booltouchable
True if this drawable should receive touch events.
boolvisible
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:
invalidatedAreaThe 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

invalidateContent

virtual void invalidateContent()const

Tell the framework that the contents of the Drawable needs to be redrawn.

If the Drawable is invisible, nothing happens. Subclasses of Drawable are encouraged to implement this function and invalidate as little as possible, i.e. the smallest rectangle covering the visual element(s) drawn by the widget.

Reimplements: touchgfx::TextArea::invalidateContent

TextAreaWithWildcardBase

Protected Functions Documentation

calculateBoundingArea

virtual TextArea::BoundingArea calculateBoundingArea()const

Calculates the minimum bounding rectangle of this text area and correlates it with the containing text, to get the bounding area.

Note: The bounding rectangle is adjusted according to alignment and rotation.

Returns:

The bounding area.

Reimplements: touchgfx::TextArea::calculateBoundingArea