nn::font::CTR::TextWriterBase Class

Syntax

template <typename CharType>
class TextWriterBase : public nn::font::CTR::CharWriter

Template Arguments

Name Description
CharType The character type.

Description

A class that draws strings using the nn::font::Font class.

Enumerated Types

PositionFlag Text drawing flags used by the SetDrawFlag function for string placement.

Member Constants

S DEFAULT_DRAWFLAG This is the default drawing flag set by the constructor.

Member Functions

Constructors/Destructors
TextWriterBase Constructor.
~TextWriterBase Destructor.
Character Spacing, Leading, and Tab Width
SetLineSpace Sets the line spacing.
GetLineSpace Gets the line spacing.
SetLineHeight Sets the height of a line.
GetLineHeight Gets the height of a line.
SetCharSpace Sets the space between characters.
GetCharSpace Gets the space between characters.
SetTabWidth Sets the tab width.
GetTabWidth Gets the tab width.
Automatic Wrapping of Strings
SetWidthLimit Specifies the width to wrap to automatically.
GetWidthLimit Gets the set wrap width.
ResetWidthLimit Disables the automatic wrapping feature.
Set/Get the Text Drawing Flag
SetDrawFlag Sets the string's drawing flag.
GetDrawFlag Gets the string's drawing flag.
Set/Get the Tag Processor
SetTagProcessor Sets the tag processor.
GetTagProcessor Gets the tag processor.
ResetTagProcessor Restores the tag processor to default.
Calculates the drawn size of the text.
CalcFormatStringWidth Calculates the width of the string.
CalcStringWidth Calculates the width of the string.
CalcFormatStringHeight Calculates the height of the string.
CalcStringHeight Calculates the height of the string.
CalcFormatStringRect Calculates the drawing rectangle for the string.
CalcVStringRect Calculates the drawing rectangle for the string.
CalcStringRect Calculates the drawing rectangle for the string.
Text String Drawing
Printf Draws a string.
VPrintf Draws a string.
Print Draws a string.
Format Expansion Buffer
S SetBuffer Allocates a buffer for extracting formatted text.
S GetBuffer Gets a pointer to the buffer used to expand the formatted string.
S GetBufferSize Gets the size of the buffer used to expand a formatted string.

Class Hierarchy

nn::font::CTR::CharWriter
  nn::font::CTR::TextWriterBase

Revision History

2010/11/10
Initial version.

CONFIDENTIAL