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