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>nw::lyt::Layout</title> 51 </head> 52 <body> 53 <h1>nw::lyt::Layout Class</h1> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class Layout</pre> 57 </div> 58 <h2>Description</h2> 59 <div class="section"> 60 <p>The class for managing the layout overall.</p> 61 </div> 62 <a name="function" id="function"> 63 <h2>Member Functions</h2> 64 <div class="section"> 65 <table class="members"> 66 <tr> 67 <th class="category" colspan="3">Memory Management</th> 68 </tr> 69 <tr> 70 <td width="100"> 71 <span class="static_style" title="static">S</span> </td> 72 <th> 73 <a href="../../../nw/lyt/Layout/GetAllocator.html"><CODE>GetAllocator</CODE></a> 74 </th> 75 <td>Gets the current memory allocator.</td> 76 </tr> 77 <tr> 78 <td width="100"> 79 <span class="static_style" title="static">S</span> </td> 80 <th> 81 <a href="../../../nw/lyt/Layout/GetDeviceMemoryAllocator.html">GetDeviceMemoryAllocator</a> 82 </th> 83 <td>Gets the current memory allocator for device memory.</td> 84 </tr> 85 <tr> 86 <td width="100"> 87 <span class="static_style" title="static">S</span> </td> 88 <th> 89 <a href="../../../nw/lyt/Layout/SetAllocator.html"><CODE>SetAllocator</CODE></a> 90 </th> 91 <td>Sets the memory allocator used to allocate memory blocks.</td> 92 </tr> 93 <tr> 94 <td width="100"> 95 <span class="static_style" title="static">S</span> </td> 96 <th> 97 <a href="../../../nw/lyt/Layout/SetDeviceMemoryAllocator.html">SetDeviceMemoryAllocator</a> 98 </th> 99 <td>Sets the memory allocator used to allocate memory blocks.</td> 100 </tr> 101 <tr> 102 <td width="100"> 103 <span class="static_style" title="static">S</span> </td> 104 <th> 105 <a href="../../../nw/lyt/Layout/AllocMemory.html">AllocMemory</a> 106 </th> 107 <td>Allocates a memory block.</td> 108 </tr> 109 <tr> 110 <td width="100"> 111 <span class="static_style" title="static">S</span> </td> 112 <th> 113 <a href="../../../nw/lyt/Layout/AllocDeviceMemory.html">AllocDeviceMemory</a> 114 </th> 115 <td>Allocates a memory block from device memory.</td> 116 </tr> 117 <tr> 118 <td width="100"> 119 <span class="static_style" title="static">S</span> </td> 120 <th> 121 <a href="../../../nw/lyt/Layout/FreeMemory.html">FreeMemory</a> 122 </th> 123 <td>Frees a memory block.</td> 124 </tr> 125 <tr> 126 <td width="100"> 127 <span class="static_style" title="static">S</span> </td> 128 <th> 129 <a href="../../../nw/lyt/Layout/FreeDeviceMemory.html">FreeDeviceMemory</a> 130 </th> 131 <td>Frees a memory block back to device memory.</td> 132 </tr> 133 <tr> 134 <th class="category" colspan="3">Initialization</th> 135 </tr> 136 <tr> 137 <td width="100"> 138 <span class="static_style" title="static">S</span> </td> 139 <th> 140 <a href="../../../nw/lyt/Layout/SetLayoutDrawEnable.html">SetLayoutDrawEnable</a> 141 </th> 142 <td>Declares whether <a href="../../../nw/lyt/Layout/Draw.html">Layout::Draw</a> is to be used (not recommended).</td> 143 </tr> 144 <tr> 145 <td width="100"> 146 <span class="static_style" title="static">S</span> </td> 147 <th> 148 <a href="../../../nw/lyt/Layout/GetLayoutDrawEnable.html">GetLayoutDrawEnable</a> 149 </th> 150 <td>Gets the setting indicating if <a href="../../../nw/lyt/Layout/Draw.html">Layout::Draw</a> is to be used (not recommended).</td> 151 </tr> 152 <tr> 153 <td width="100"> <span class="virtual_style" title="virtual">V</span> 154 </td> 155 <th> 156 <a href="../../../nw/lyt/Layout/Build.html">Build</a> 157 </th> 158 <td>Initializes the layout based on the resource.</td> 159 </tr> 160 <tr> 161 <td width="100"> 162 <span class="protected_style" title="protected">protected</span> <span class="virtual_style" title="virtual">V</span> 163 </td> 164 <th> 165 <a href="../../../nw/lyt/Layout/BuildPaneObj.html">BuildPaneObj</a> 166 </th> 167 <td>Creates a pane from a resource.</td> 168 </tr> 169 <tr> 170 <th class="category" colspan="3">Object Creation/Destruction</th> 171 </tr> 172 <tr> 173 <td width="100"> 174 <span class="static_style" title="static">S</span> </td> 175 <th> 176 <a href="../../../nw/lyt/Layout/NewObj.html">NewObj</a> 177 </th> 178 <td>Creates an object.</td> 179 </tr> 180 <tr> 181 <td width="100"> 182 <span class="static_style" title="static">S</span> </td> 183 <th> 184 <a href="../../../nw/lyt/Layout/DeleteObj.html">DeleteObj</a> 185 </th> 186 <td>Destroys an object.</td> 187 </tr> 188 <tr> 189 <th class="category" colspan="3">Constructors and Destructors</th> 190 </tr> 191 <tr> 192 <td width="100"> </td> 193 <th> 194 <a href="../../../nw/lyt/Layout/Layout.html">Layout</a> 195 </th> 196 <td>Constructor.</td> 197 </tr> 198 <tr> 199 <td width="100"> <span class="virtual_style" title="virtual">V</span> 200 </td> 201 <th> 202 <a href="../../../nw/lyt/Layout/~Layout.html">~Layout</a> 203 </th> 204 <td>Destructor.</td> 205 </tr> 206 <tr> 207 <th class="category" colspan="3">Animation</th> 208 </tr> 209 <tr> 210 <td width="100"> <span class="virtual_style" title="virtual">V</span> 211 </td> 212 <th> 213 <a href="../../../nw/lyt/Layout/CreateAnimTransform.html">CreateAnimTransform</a> 214 </th> 215 <td>Creates an animation.</td> 216 </tr> 217 <tr> 218 <td width="100"> <span class="virtual_style" title="virtual">V</span> 219 </td> 220 <th> 221 <a href="../../../nw/lyt/Layout/DeleteAnimTransform.html">DeleteAnimTransform</a> 222 </th> 223 <td>This deletes animations.</td> 224 </tr> 225 <tr> 226 <td width="100"> <span class="virtual_style" title="virtual">V</span> 227 </td> 228 <th> 229 <a href="../../../nw/lyt/Layout/BindAnimation.html">BindAnimation</a> 230 </th> 231 <td>Binds animations.</td> 232 </tr> 233 <tr> 234 <td width="100"> <span class="virtual_style" title="virtual">V</span> 235 </td> 236 <th> 237 <a href="../../../nw/lyt/Layout/UnbindAnimation.html">UnbindAnimation</a> 238 </th> 239 <td>Clears a bound animation.</td> 240 </tr> 241 <tr> 242 <td width="100"> <span class="virtual_style" title="virtual">V</span> 243 </td> 244 <th> 245 <a href="../../../nw/lyt/Layout/UnbindAllAnimation.html">UnbindAllAnimation</a> 246 </th> 247 <td>Clears all the association between animations and panes.</td> 248 </tr> 249 <tr> 250 <td width="100"> <span class="virtual_style" title="virtual">V</span> 251 </td> 252 <th> 253 <a href="../../../nw/lyt/Layout/BindAnimationAuto.html">BindAnimationAuto</a> 254 </th> 255 <td>Creates and binds animations at one time.</td> 256 </tr> 257 <tr> 258 <td width="100"> <span class="virtual_style" title="virtual">V</span> 259 </td> 260 <th> 261 <a href="../../../nw/lyt/Layout/SetAnimationEnable.html">SetAnimationEnable</a> 262 </th> 263 <td>Sets the animation's enabled/disabled status.</td> 264 </tr> 265 <tr> 266 <td width="100"> <span class="virtual_style" title="virtual">V</span> 267 </td> 268 <th> 269 <a href="../../../nw/lyt/Layout/Animate.html">Animate</a> 270 </th> 271 <td>Calculates animation results for all panes.</td> 272 </tr> 273 <tr> 274 <th class="category" colspan="3">Rendering</th> 275 </tr> 276 <tr> 277 <td width="100"> <span class="virtual_style" title="virtual">V</span> 278 </td> 279 <th> 280 <a href="../../../nw/lyt/Layout/CalculateMtx.html">CalculateMtx</a> 281 </th> 282 <td>Calculates the matrix for rendering.</td> 283 </tr> 284 <tr> 285 <td width="100"> <span class="virtual_style" title="virtual">V</span> 286 </td> 287 <th> 288 <a href="../../../nw/lyt/Layout/Draw.html">Draw</a> 289 </th> 290 <td>Performs drawing (not recommended).</td> 291 </tr> 292 <tr> 293 <th class="category" colspan="3">Set/Get</th> 294 </tr> 295 <tr> 296 <td width="100"> </td> 297 <th> 298 <a href="../../../nw/lyt/Layout/GetRootPane.html">GetRootPane</a> 299 </th> 300 <td>Gets the root pane.</td> 301 </tr> 302 <tr> 303 <td width="100"> </td> 304 <th> 305 <a href="../../../nw/lyt/Layout/GetGroupContainer.html">GetGroupContainer</a> 306 </th> 307 <td>Gets the group container.</td> 308 </tr> 309 <tr> 310 <td width="100"> </td> 311 <th> 312 <a href="../../../nw/lyt/Layout/GetLayoutSize.html">GetLayoutSize</a> 313 </th> 314 <td>Gets the display region size.</td> 315 </tr> 316 <tr> 317 <td width="100"> </td> 318 <th> 319 <a href="../../../nw/lyt/Layout/GetLayoutRect.html">GetLayoutRect</a> 320 </th> 321 <td>Gets the layout's display region.</td> 322 </tr> 323 <tr> 324 <td width="100"> <span class="virtual_style" title="virtual">V</span> 325 </td> 326 <th> 327 <a href="../../../nw/lyt/Layout/SetTagProcessor.html">SetTagProcessor</a> 328 </th> 329 <td>Sets the tag processor for all text box panes in the layout.</td> 330 </tr> 331 <tr> 332 <td width="100"> </td> 333 <th> 334 <a href="../../../nw/lyt/Layout/GetAnimTransformList.html">GetAnimTransformList</a> 335 </th> 336 <td>Gets a list of animations bound to the layout.</td> 337 </tr> 338 <tr> 339 <td width="100"> 340 <span class="protected_style" title="protected">protected</span> </td> 341 <th> 342 <a href="../../../nw/lyt/Layout/SetRootPane.html">SetRootPane</a> 343 </th> 344 <td>Sets the root pane.</td> 345 </tr> 346 <tr> 347 <td width="100"> 348 <span class="protected_style" title="protected">protected</span> </td> 349 <th> 350 <a href="../../../nw/lyt/Layout/SetGroupContainer.html">SetGroupContainer</a> 351 </th> 352 <td>Sets the group container.</td> 353 </tr> 354 <tr> 355 <td width="100"> 356 <span class="protected_style" title="protected">protected</span> </td> 357 <th> 358 <a href="../../../nw/lyt/Layout/SetLayoutSize.html">SetLayoutSize</a> 359 </th> 360 <td>Sets the display region size.</td> 361 </tr> </table> 362 </div> 363 </a> 364 <h2>See Also</h2> 365 <div class="section"> 366 <p class="reference"><a href="../../../nw/lyt/Pane/Overview.html">Pane</a><br /><a href="../../../nw/lyt/AnimTransform/Overview.html">AnimTransform</a><br /> </p> 367 </div> 368 <h2>Revision History</h2> 369 <div class="section"> 370 <dl class="history"> 371 <dt>2009/09/18</dt> 372 <dd>Initial version.<br /> 373 </dd> 374 </dl> 375 </div> 376 <hr><p>CONFIDENTIAL</p></body> 377</html>