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>nn::font::CTR::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>This is the default drawing flag set by the constructor.</td> 98 </tr> </table> 99 </div> 100 </a> <a name="function" id="function"> 101<h2>Member Functions</h2> 102 <div class="section"> 103 <table class="members"> 104 <tr> 105<th class="category" colspan="3">Constructors/Destructors</th> 106 </tr> 107 <tr> 108 <td width="100"> </td> 109 <th> 110<a href="../../../../nn/font/CTR/TextWriterBase/TextWriterBase.html"><CODE>TextWriterBase</CODE></a> 111 </th> 112<td>Constructor.</td> 113 </tr> 114 <tr> 115 <td width="100"> </td> 116 <th> 117<a href="../../../../nn/font/CTR/TextWriterBase/~TextWriterBase.html"><CODE>~TextWriterBase</CODE></a> 118 </th> 119<td>Destructor.</td> 120 </tr> 121 <tr> 122<th class="category" colspan="3">Character Spacing, Leading, and Tab Width</th> 123 </tr> 124 <tr> 125 <td width="100"> </td> 126 <th> 127<a href="../../../../nn/font/CTR/TextWriterBase/SetLineSpace.html"><CODE>SetLineSpace</CODE></a> 128 </th> 129<td>Sets the line spacing.</td> 130 </tr> 131 <tr> 132 <td width="100"> </td> 133 <th> 134<a href="../../../../nn/font/CTR/TextWriterBase/GetLineSpace.html"><CODE>GetLineSpace</CODE></a> 135 </th> 136<td>Gets the line spacing.</td> 137 </tr> 138 <tr> 139 <td width="100"> </td> 140 <th> 141<a href="../../../../nn/font/CTR/TextWriterBase/SetLineHeight.html"><CODE>SetLineHeight</CODE></a> 142 </th> 143<td>Sets the height of a line.</td> 144 </tr> 145 <tr> 146 <td width="100"> </td> 147 <th> 148<a href="../../../../nn/font/CTR/TextWriterBase/GetLineHeight.html"><CODE>GetLineHeight</CODE></a> 149 </th> 150<td>Gets the height of a line.</td> 151 </tr> 152 <tr> 153 <td width="100"> </td> 154 <th> 155<a href="../../../../nn/font/CTR/TextWriterBase/SetCharSpace.html"><CODE>SetCharSpace</CODE></a> 156 </th> 157<td>Sets the space between characters.</td> 158 </tr> 159 <tr> 160 <td width="100"> </td> 161 <th> 162<a href="../../../../nn/font/CTR/TextWriterBase/GetCharSpace.html"><CODE>GetCharSpace</CODE></a> 163 </th> 164<td>Gets the space between characters.</td> 165 </tr> 166 <tr> 167 <td width="100"> </td> 168 <th> 169<a href="../../../../nn/font/CTR/TextWriterBase/SetTabWidth.html"><CODE>SetTabWidth</CODE></a> 170 </th> 171<td>Sets the tab width.</td> 172 </tr> 173 <tr> 174 <td width="100"> </td> 175 <th> 176<a href="../../../../nn/font/CTR/TextWriterBase/GetTabWidth.html"><CODE>GetTabWidth</CODE></a> 177 </th> 178<td>Gets the tab width.</td> 179 </tr> 180 <tr> 181<th class="category" colspan="3">Automatic Wrapping of Strings</th> 182 </tr> 183 <tr> 184 <td width="100"> </td> 185 <th> 186<a href="../../../../nn/font/CTR/TextWriterBase/SetWidthLimit.html"><CODE>SetWidthLimit</CODE></a> 187 </th> 188<td>Specifies the width to wrap to automatically.</td> 189 </tr> 190 <tr> 191 <td width="100"> </td> 192 <th> 193<a href="../../../../nn/font/CTR/TextWriterBase/GetWidthLimit.html"><CODE>GetWidthLimit</CODE></a> 194 </th> 195<td>Gets the set wrap width.</td> 196 </tr> 197 <tr> 198 <td width="100"> </td> 199 <th> 200<a href="../../../../nn/font/CTR/TextWriterBase/ResetWidthLimit.html"><CODE>ResetWidthLimit</CODE></a> 201 </th> 202<td>Disables the automatic wrapping feature.</td> 203 </tr> 204 <tr> 205<th class="category" colspan="3">Set/Get the Text Drawing Flag</th> 206 </tr> 207 <tr> 208 <td width="100"> </td> 209 <th> 210<a href="../../../../nn/font/CTR/TextWriterBase/SetDrawFlag.html"><CODE>SetDrawFlag</CODE></a> 211 </th> 212<td>Sets the string's drawing flag.</td> 213 </tr> 214 <tr> 215 <td width="100"> </td> 216 <th> 217<a href="../../../../nn/font/CTR/TextWriterBase/GetDrawFlag.html"><CODE>GetDrawFlag</CODE></a> 218 </th> 219<td>Gets the string's drawing flag.</td> 220 </tr> 221 <tr> 222<th class="category" colspan="3">Set/Get the Tag Processor</th> 223 </tr> 224 <tr> 225 <td width="100"> </td> 226 <th> 227<a href="../../../../nn/font/CTR/TextWriterBase/SetTagProcessor.html"><CODE>SetTagProcessor</CODE></a> 228 </th> 229<td>Sets the tag processor.</td> 230 </tr> 231 <tr> 232 <td width="100"> </td> 233 <th> 234<a href="../../../../nn/font/CTR/TextWriterBase/GetTagProcessor.html"><CODE>GetTagProcessor</CODE></a> 235 </th> 236<td>Gets the tag processor.</td> 237 </tr> 238 <tr> 239 <td width="100"> </td> 240 <th> 241<a href="../../../../nn/font/CTR/TextWriterBase/ResetTagProcessor.html"><CODE>ResetTagProcessor</CODE></a> 242 </th> 243<td>Restores the tag processor to default.</td> 244 </tr> 245 <tr> 246<th class="category" colspan="3">Calculates the drawn size of the text.</th> 247 </tr> 248 <tr> 249 <td width="100"> </td> 250 <th> 251<a href="../../../../nn/font/CTR/TextWriterBase/CalcFormatStringWidth.html"><CODE>CalcFormatStringWidth</CODE></a> 252 </th> 253<td>Calculates the width of the string.</td> 254 </tr> 255 <tr> 256 <td width="100"> </td> 257 <th> 258<a href="../../../../nn/font/CTR/TextWriterBase/CalcStringWidth.html"><CODE>CalcStringWidth</CODE></a> 259 </th> 260<td>Calculates the width of the string.</td> 261 </tr> 262 <tr> 263 <td width="100"> </td> 264 <th> 265<a href="../../../../nn/font/CTR/TextWriterBase/CalcFormatStringHeight.html"><CODE>CalcFormatStringHeight</CODE></a> 266 </th> 267<td>Calculates the height of the string.</td> 268 </tr> 269 <tr> 270 <td width="100"> </td> 271 <th> 272<a href="../../../../nn/font/CTR/TextWriterBase/CalcStringHeight.html"><CODE>CalcStringHeight</CODE></a> 273 </th> 274<td>Calculates the height of the string.</td> 275 </tr> 276 <tr> 277 <td width="100"> </td> 278 <th> 279<a href="../../../../nn/font/CTR/TextWriterBase/CalcFormatStringRect.html"><CODE>CalcFormatStringRect</CODE></a> 280 </th> 281<td>Calculates the drawing rectangle for the string.</td> 282 </tr> 283 <tr> 284 <td width="100"> </td> 285 <th> 286<a href="../../../../nn/font/CTR/TextWriterBase/CalcVStringRect.html"><CODE>CalcVStringRect</CODE></a> 287 </th> 288<td>Calculates the drawing rectangle for the string.</td> 289 </tr> 290 <tr> 291 <td width="100"> </td> 292 <th> 293<a href="../../../../nn/font/CTR/TextWriterBase/CalcStringRect.html"><CODE>CalcStringRect</CODE></a> 294 </th> 295<td>Calculates the drawing rectangle for the string.</td> 296 </tr> 297 <tr> 298<th class="category" colspan="3">Text String Drawing</th> 299 </tr> 300 <tr> 301 <td width="100"> </td> 302 <th> 303<a href="../../../../nn/font/CTR/TextWriterBase/Printf.html"><CODE>Printf</CODE></a> 304 </th> 305<td>Draws a string.</td> 306 </tr> 307 <tr> 308 <td width="100"> </td> 309 <th> 310<a href="../../../../nn/font/CTR/TextWriterBase/VPrintf.html"><CODE>VPrintf</CODE></a> 311 </th> 312<td>Draws a string.</td> 313 </tr> 314 <tr> 315 <td width="100"> </td> 316 <th> 317<a href="../../../../nn/font/CTR/TextWriterBase/Print.html"><CODE>Print</CODE></a> 318 </th> 319<td>Draws a string.</td> 320 </tr> 321 <tr> 322<th class="category" colspan="3">Format Expansion Buffer</th> 323 </tr> 324 <tr> 325 <td width="100"> 326<span class="static_style" title="static">S</span> </td> 327 <th> 328<a href="../../../../nn/font/CTR/TextWriterBase/SetBuffer.html"><CODE>SetBuffer</CODE></a> 329 </th> 330<td>Allocates a buffer for extracting formatted text.</td> 331 </tr> 332 <tr> 333 <td width="100"> 334<span class="static_style" title="static">S</span> </td> 335 <th> 336<a href="../../../../nn/font/CTR/TextWriterBase/GetBuffer.html"><CODE>GetBuffer</CODE></a> 337 </th> 338<td>Gets a pointer to the buffer used to expand the formatted string.</td> 339 </tr> 340 <tr> 341 <td width="100"> 342<span class="static_style" title="static">S</span> </td> 343 <th> 344<a href="../../../../nn/font/CTR/TextWriterBase/GetBufferSize.html"><CODE>GetBufferSize</CODE></a> 345 </th> 346<td>Gets the size of the buffer used to expand a formatted string.</td> 347 </tr> </table> 348 </div> 349 </a> 350<h2>Class Hierarchy</h2> 351 <div class="section"> 352<p class="hierarchy"><a href="../../../../nn/font/CTR/CharWriter/Overview.html">nn::font::CTR::CharWriter</a><br /> <b>nn::font::CTR::TextWriterBase</b> 353 </p> 354 </div> 355<h2>Revision History</h2> 356 <div class="section"> 357 <dl class="history"> 358 <dt>2010/11/10</dt> 359<dd>Initial version.<br /> 360 </dd> 361 </dl> 362 </div> 363 <hr><p>CONFIDENTIAL</p></body> 364</html> 365