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