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