1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 span.virtual_style 22 { 23 font-size : 8pt; 24 color : white; 25 font-weight : bold; 26 background : #0a0; 27 border-left : solid 1px #0f0; 28 border-top : solid 1px #0f0; 29 border-right : solid 1px #060; 30 border-bottom : solid 1px #060; 31 padding-left : 2px; 32 padding-right : 2px; 33 } 34 span.protected_style 35 { 36 font-size : 8pt; 37 color : white; 38 font-weight : bold; 39 background : #444; 40 border-left : solid 1px #ccc; 41 border-top : solid 1px #ccc; 42 border-right : solid 1px #222; 43 border-bottom : solid 1px #222; 44 padding-left : 2px; 45 padding-right : 2px; 46 } 47 --></style> 48<title>nn::font::CTR::TextWriterBase</title> 49 </head> 50 <body> 51<h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/font/Overview.html">font</a>::<a href="../../../../nn/font/CTR/Overview.html">CTR</a>::TextWriterBase</CODE> Class</h1> 52<h2>Syntax</h2> 53 <div class="section"> 54<pre class="definition">template <typename CharType> 55class TextWriterBase : public <a href="../../../../nn/font/CTR/CharWriter/Overview.html">nn::font::CTR::CharWriter</a></pre> 56 </div> 57<h2>Template Arguments</h2> 58 <div class="section"> 59 <table class="arguments"> 60 <thead> 61 <tr> 62<th>Name</th> 63<td>Description</td> 64 </tr> 65 </thead> 66 <tr> 67<th>CharType</th> 68<td>The character type.</td> 69 </tr> </table> 70 </div> 71<h2>Description</h2> 72 <div class="section"> 73<p>A class that draws strings using the <a href="../../../../nn/font/Font/Overview.html"><CODE>nn::font::Font</CODE></a> class.</p><!-- write here --></div> 74 <a name="enum" id="enum"> 75<h2>Enumerated Types</h2> 76 <div class="section"> 77 <table class="members"> 78 <tr> 79 <td width="100"> </td> 80 <th> 81<a href="../../../../nn/font/CTR/TextWriterBase/PositionFlag.html"><CODE>PositionFlag</CODE></a> 82 </th> 83<td>Text drawing flags used by the <a href="../../../../nn/font/CTR/TextWriterBase/SetDrawFlag.html"><CODE>SetDrawFlag</CODE></a> function for string placement.</td> 84 </tr> </table> 85 </div> 86 </a> <a name="constant" id="constant"> 87<h2>Member Constants</h2> 88 <div class="section"> 89 <table class="members"> 90 <tr> 91 <td width="100"> 92<span class="static_style" title="static">S</span> 93 </td> 94 <th> 95<span class="argument"><a href="../../../../nn/font/CTR/TextWriterBase/DEFAULT_DRAWFLAG.html"><CODE>DEFAULT_DRAWFLAG</CODE></a></span> 96 </th> 97<td width="100"><CODE>const u32</CODE></td> 98<td>This is the default drawing flag set by the constructor.</td> 99 </tr> </table> 100 </div> 101 </a> <a name="function" id="function"> 102<h2>Member Functions</h2> 103 <div class="section"> 104 <table class="members"> 105 <tr> 106<th class="category" colspan="3">Constructors/Destructors</th> 107 </tr> 108 <tr> 109 <td width="100"> </td> 110 <th> 111<a href="../../../../nn/font/CTR/TextWriterBase/TextWriterBase.html"><CODE>TextWriterBase</CODE></a> 112 </th> 113<td>Constructor.</td> 114 </tr> 115 <tr> 116 <td width="100"> </td> 117 <th> 118<a href="../../../../nn/font/CTR/TextWriterBase/~TextWriterBase.html"><CODE>~TextWriterBase</CODE></a> 119 </th> 120<td>Destructor.</td> 121 </tr> 122 <tr> 123<th class="category" colspan="3">Character Spacing, Leading, and Tab Width</th> 124 </tr> 125 <tr> 126 <td width="100"> </td> 127 <th> 128<a href="../../../../nn/font/CTR/TextWriterBase/SetLineSpace.html"><CODE>SetLineSpace</CODE></a> 129 </th> 130<td>Sets the line spacing.</td> 131 </tr> 132 <tr> 133 <td width="100"> </td> 134 <th> 135<a href="../../../../nn/font/CTR/TextWriterBase/GetLineSpace.html"><CODE>GetLineSpace</CODE></a> 136 </th> 137<td>Gets the line spacing.</td> 138 </tr> 139 <tr> 140 <td width="100"> </td> 141 <th> 142<a href="../../../../nn/font/CTR/TextWriterBase/SetLineHeight.html"><CODE>SetLineHeight</CODE></a> 143 </th> 144<td>Sets the height of a line.</td> 145 </tr> 146 <tr> 147 <td width="100"> </td> 148 <th> 149<a href="../../../../nn/font/CTR/TextWriterBase/GetLineHeight.html"><CODE>GetLineHeight</CODE></a> 150 </th> 151<td>Gets the height of a line.</td> 152 </tr> 153 <tr> 154 <td width="100"> </td> 155 <th> 156<a href="../../../../nn/font/CTR/TextWriterBase/SetCharSpace.html"><CODE>SetCharSpace</CODE></a> 157 </th> 158<td>Sets the space between characters.</td> 159 </tr> 160 <tr> 161 <td width="100"> </td> 162 <th> 163<a href="../../../../nn/font/CTR/TextWriterBase/GetCharSpace.html"><CODE>GetCharSpace</CODE></a> 164 </th> 165<td>Gets the space between characters.</td> 166 </tr> 167 <tr> 168 <td width="100"> </td> 169 <th> 170<a href="../../../../nn/font/CTR/TextWriterBase/SetTabWidth.html"><CODE>SetTabWidth</CODE></a> 171 </th> 172<td>Sets the tab width.</td> 173 </tr> 174 <tr> 175 <td width="100"> </td> 176 <th> 177<a href="../../../../nn/font/CTR/TextWriterBase/GetTabWidth.html"><CODE>GetTabWidth</CODE></a> 178 </th> 179<td>Gets the tab width.</td> 180 </tr> 181 <tr> 182<th class="category" colspan="3">Automatic Wrapping of Strings</th> 183 </tr> 184 <tr> 185 <td width="100"> </td> 186 <th> 187<a href="../../../../nn/font/CTR/TextWriterBase/SetWidthLimit.html"><CODE>SetWidthLimit</CODE></a> 188 </th> 189<td>Specifies the width to wrap to automatically.</td> 190 </tr> 191 <tr> 192 <td width="100"> </td> 193 <th> 194<a href="../../../../nn/font/CTR/TextWriterBase/GetWidthLimit.html"><CODE>GetWidthLimit</CODE></a> 195 </th> 196<td>Gets the set wrap width.</td> 197 </tr> 198 <tr> 199 <td width="100"> </td> 200 <th> 201<a href="../../../../nn/font/CTR/TextWriterBase/ResetWidthLimit.html"><CODE>ResetWidthLimit</CODE></a> 202 </th> 203<td>Disables the automatic wrapping feature.</td> 204 </tr> 205 <tr> 206<th class="category" colspan="3">Set/Get the Text Drawing Flag</th> 207 </tr> 208 <tr> 209 <td width="100"> </td> 210 <th> 211<a href="../../../../nn/font/CTR/TextWriterBase/SetDrawFlag.html"><CODE>SetDrawFlag</CODE></a> 212 </th> 213<td>Sets the string's drawing flag.</td> 214 </tr> 215 <tr> 216 <td width="100"> </td> 217 <th> 218<a href="../../../../nn/font/CTR/TextWriterBase/GetDrawFlag.html"><CODE>GetDrawFlag</CODE></a> 219 </th> 220<td>Gets the string's drawing flag.</td> 221 </tr> 222 <tr> 223<th class="category" colspan="3">Set/Get the Tag Processor</th> 224 </tr> 225 <tr> 226 <td width="100"> </td> 227 <th> 228<a href="../../../../nn/font/CTR/TextWriterBase/SetTagProcessor.html"><CODE>SetTagProcessor</CODE></a> 229 </th> 230<td>Sets the tag processor.</td> 231 </tr> 232 <tr> 233 <td width="100"> </td> 234 <th> 235<a href="../../../../nn/font/CTR/TextWriterBase/GetTagProcessor.html"><CODE>GetTagProcessor</CODE></a> 236 </th> 237<td>Gets the tag processor.</td> 238 </tr> 239 <tr> 240 <td width="100"> </td> 241 <th> 242<a href="../../../../nn/font/CTR/TextWriterBase/ResetTagProcessor.html"><CODE>ResetTagProcessor</CODE></a> 243 </th> 244<td>Restores the tag processor to default.</td> 245 </tr> 246 <tr> 247<th class="category" colspan="3">Calculates the drawn size of the text.</th> 248 </tr> 249 <tr> 250 <td width="100"> </td> 251 <th> 252<a href="../../../../nn/font/CTR/TextWriterBase/CalcFormatStringWidth.html"><CODE>CalcFormatStringWidth</CODE></a> 253 </th> 254<td>Calculates the width of the string.</td> 255 </tr> 256 <tr> 257 <td width="100"> </td> 258 <th> 259<a href="../../../../nn/font/CTR/TextWriterBase/CalcStringWidth.html"><CODE>CalcStringWidth</CODE></a> 260 </th> 261<td>Calculates the width of the string.</td> 262 </tr> 263 <tr> 264 <td width="100"> </td> 265 <th> 266<a href="../../../../nn/font/CTR/TextWriterBase/CalcFormatStringHeight.html"><CODE>CalcFormatStringHeight</CODE></a> 267 </th> 268<td>Calculates the height of the string.</td> 269 </tr> 270 <tr> 271 <td width="100"> </td> 272 <th> 273<a href="../../../../nn/font/CTR/TextWriterBase/CalcStringHeight.html"><CODE>CalcStringHeight</CODE></a> 274 </th> 275<td>Calculates the height of the string.</td> 276 </tr> 277 <tr> 278 <td width="100"> </td> 279 <th> 280<a href="../../../../nn/font/CTR/TextWriterBase/CalcFormatStringRect.html"><CODE>CalcFormatStringRect</CODE></a> 281 </th> 282<td>Calculates the drawing rectangle for the string.</td> 283 </tr> 284 <tr> 285 <td width="100"> </td> 286 <th> 287<a href="../../../../nn/font/CTR/TextWriterBase/CalcVStringRect.html"><CODE>CalcVStringRect</CODE></a> 288 </th> 289<td>Calculates the drawing rectangle for the string.</td> 290 </tr> 291 <tr> 292 <td width="100"> </td> 293 <th> 294<a href="../../../../nn/font/CTR/TextWriterBase/CalcStringRect.html"><CODE>CalcStringRect</CODE></a> 295 </th> 296<td>Calculates the drawing rectangle for the string.</td> 297 </tr> 298 <tr> 299<th class="category" colspan="3">Text String Drawing</th> 300 </tr> 301 <tr> 302 <td width="100"> </td> 303 <th> 304<a href="../../../../nn/font/CTR/TextWriterBase/Printf.html"><CODE>Printf</CODE></a> 305 </th> 306<td>Draws a string.</td> 307 </tr> 308 <tr> 309 <td width="100"> </td> 310 <th> 311<a href="../../../../nn/font/CTR/TextWriterBase/VPrintf.html"><CODE>VPrintf</CODE></a> 312 </th> 313<td>Draws a string.</td> 314 </tr> 315 <tr> 316 <td width="100"> </td> 317 <th> 318<a href="../../../../nn/font/CTR/TextWriterBase/Print.html"><CODE>Print</CODE></a> 319 </th> 320<td>Draws a string.</td> 321 </tr> 322 <tr> 323<th class="category" colspan="3">Format Expansion Buffer</th> 324 </tr> 325 <tr> 326 <td width="100"> 327<span class="static_style" title="static">S</span> </td> 328 <th> 329<a href="../../../../nn/font/CTR/TextWriterBase/SetBuffer.html"><CODE>SetBuffer</CODE></a> 330 </th> 331<td>Allocates a buffer for extracting formatted text.</td> 332 </tr> 333 <tr> 334 <td width="100"> 335<span class="static_style" title="static">S</span> </td> 336 <th> 337<a href="../../../../nn/font/CTR/TextWriterBase/GetBuffer.html"><CODE>GetBuffer</CODE></a> 338 </th> 339<td>Gets a pointer to the buffer used to expand the formatted string.</td> 340 </tr> 341 <tr> 342 <td width="100"> 343<span class="static_style" title="static">S</span> </td> 344 <th> 345<a href="../../../../nn/font/CTR/TextWriterBase/GetBufferSize.html"><CODE>GetBufferSize</CODE></a> 346 </th> 347<td>Gets the size of the buffer used to expand a formatted string.</td> 348 </tr> </table> 349 </div> 350 </a> 351<h2>Class Hierarchy</h2> 352 <div class="section"> 353<p class="hierarchy"><a href="../../../../nn/font/CTR/CharWriter/Overview.html">nn::font::CTR::CharWriter</a><br /> <b>nn::font::CTR::TextWriterBase</b> 354 </p> 355 </div> 356<h2>Revision History</h2> 357 <div class="section"> 358 <dl class="history"> 359 <dt>2010/11/10</dt> 360<dd>Initial version.<br /> 361 </dd> 362 </dl> 363 </div> 364 <hr><p>CONFIDENTIAL</p></body> 365</html> 366