← Back to branch summary

~ubuntu-branches/ubuntu/precise/ipe/precise

« back to all changes in this revision

Viewing changes to doc/class_ipe_view.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve M. Robbins
  • Date: 2004-06-08 00:44:02 UTC
  • Revision ID: james.westby@ubuntu.com-20040608004402-72yu51xlh7vt6p9m
Tags: upstream-6.0pre16
Import upstream version 6.0pre16

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/class_ipe_view.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 
3
<title>Ipelib: IpeView class Reference</title>
 
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
5
</head><body>
 
6
<!-- Generated by Doxygen 1.3.4 -->
 
7
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a></div>
 
8
<h1>IpeView Class Reference<br>
 
9
<small>
 
10
[<a class="el" href="group__doc.html">Ipe Document</a>]</small>
 
11
</h1>A view of the page (set of layers, duration, effect, transition style).  
 
12
<a href="#_details">More...</a>
 
13
<p>
 
14
<a href="class_ipe_view-members.html">List of all members.</a><h2>Public Types</h2>
 
15
<ul>
 
16
<li>enum <a class="el" href="class_ipe_view.html#w17">TEffect</a> { <br>
 
17
&nbsp;&nbsp;<b>ENormal</b>, 
 
18
<b>ESplitHI</b>, 
 
19
<b>ESplitHO</b>, 
 
20
<b>ESplitVI</b>, 
 
21
<br>
 
22
&nbsp;&nbsp;<b>ESplitVO</b>, 
 
23
<b>EBlindsH</b>, 
 
24
<b>EBlindsV</b>, 
 
25
<b>EBoxI</b>, 
 
26
<br>
 
27
&nbsp;&nbsp;<b>EBoxO</b>, 
 
28
<b>EWipeLR</b>, 
 
29
<b>EWipeBT</b>, 
 
30
<b>EWipeRL</b>, 
 
31
<br>
 
32
&nbsp;&nbsp;<b>EWipeTB</b>, 
 
33
<b>EDissolve</b>, 
 
34
<b>EGlitterLR</b>, 
 
35
<b>EGlitterTB</b>, 
 
36
<br>
 
37
&nbsp;&nbsp;<b>EGlitterD</b>
 
38
<br>
 
39
 }
 
40
</ul>
 
41
<h2>Public Member Functions</h2>
 
42
<ul>
 
43
<li><a class="el" href="class_ipe_view.html#a0">IpeView</a> ()
 
44
<li><a class="el" href="class_ipe_view.html#a1">IpeView</a> (const  <a class="el" href="class_ipe_xml_attributes.html">IpeXmlAttributes</a> &amp;attr)
 
45
<li>void <a class="el" href="class_ipe_view.html#a2">SaveAsXml</a> (<a class="el" href="class_ipe_stream.html">IpeStream</a> &amp;stream) const 
 
46
<li>void <a class="el" href="class_ipe_view.html#a3">PageDictionary</a> (<a class="el" href="class_ipe_stream.html">IpeStream</a> &amp;stream) const 
 
47
</ul>
 
48
<h2>Public Attributes</h2>
 
49
<ul>
 
50
<li>std::vector&lt; <a class="el" href="class_ipe_string.html">IpeString</a> &gt; <a class="el" href="class_ipe_view.html#o0">iLayers</a>
 
51
<li><a class="el" href="class_ipe_string.html">IpeString</a> <a class="el" href="class_ipe_view.html#o1">iActive</a>
 
52
<li><a class="el" href="class_ipe_view.html#w17">TEffect</a> <a class="el" href="class_ipe_view.html#o2">iEffect</a>
 
53
<li>int <a class="el" href="class_ipe_view.html#o3">iTransitionTime</a>
 
54
<li>int <a class="el" href="class_ipe_view.html#o4">iDuration</a>
 
55
</ul>
 
56
<hr><a name="_details"></a><h2>Detailed Description</h2>
 
57
A view of the page (set of layers, duration, effect, transition style). 
 
58
<p>
 
59
An <a class="el" href="class_ipe_page.html">IpePage</a> contains a whole list of these. 
 
60
<p>
 
61
<hr><h2>Member Enumeration Documentation</h2>
 
62
<a class="anchor" name="w17" doxytag="IpeView::TEffect" ></a><p>
 
63
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
64
  <tr>
 
65
    <td class="mdRow">
 
66
      <table cellpadding="0" cellspacing="0" border="0">
 
67
        <tr>
 
68
          <td class="md" nowrap valign="top"> enum <a class="el" href="class_ipe_view.html#w17">IpeView::TEffect</a>
 
69
      </table>
 
70
    </td>
 
71
  </tr>
 
72
</table>
 
73
<table cellspacing=5 cellpadding=0 border=0>
 
74
  <tr>
 
75
    <td>
 
76
      &nbsp;
 
77
    </td>
 
78
    <td>
 
79
 
 
80
<p>
 
81
The various fancy effects that Acrobat Reader will show. 
 
82
<p>
 
83
    </td>
 
84
  </tr>
 
85
</table>
 
86
<hr><h2>Constructor &amp; Destructor Documentation</h2>
 
87
<a class="anchor" name="a0" doxytag="IpeView::IpeView" ></a><p>
 
88
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
89
  <tr>
 
90
    <td class="mdRow">
 
91
      <table cellpadding="0" cellspacing="0" border="0">
 
92
        <tr>
 
93
          <td class="md" nowrap valign="top"> IpeView::IpeView </td>
 
94
          <td class="md" valign="top">(&nbsp;</td>
 
95
          <td class="mdname1" valign="top" nowrap>          </td>
 
96
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
97
          <td class="md" nowrap></td>
 
98
        </tr>
 
99
 
 
100
      </table>
 
101
    </td>
 
102
  </tr>
 
103
</table>
 
104
<table cellspacing=5 cellpadding=0 border=0>
 
105
  <tr>
 
106
    <td>
 
107
      &nbsp;
 
108
    </td>
 
109
    <td>
 
110
 
 
111
<p>
 
112
Construct default view. 
 
113
<p>
 
114
    </td>
 
115
  </tr>
 
116
</table>
 
117
<a class="anchor" name="a1" doxytag="IpeView::IpeView" ></a><p>
 
118
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
119
  <tr>
 
120
    <td class="mdRow">
 
121
      <table cellpadding="0" cellspacing="0" border="0">
 
122
        <tr>
 
123
          <td class="md" nowrap valign="top"> IpeView::IpeView </td>
 
124
          <td class="md" valign="top">(&nbsp;</td>
 
125
          <td class="md" nowrap valign="top">const <a class="el" href="class_ipe_xml_attributes.html">IpeXmlAttributes</a> &amp;&nbsp;</td>
 
126
          <td class="mdname1" valign="top" nowrap> <em>attr</em>          </td>
 
127
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
128
          <td class="md" nowrap></td>
 
129
        </tr>
 
130
 
 
131
      </table>
 
132
    </td>
 
133
  </tr>
 
134
</table>
 
135
<table cellspacing=5 cellpadding=0 border=0>
 
136
  <tr>
 
137
    <td>
 
138
      &nbsp;
 
139
    </td>
 
140
    <td>
 
141
 
 
142
<p>
 
143
Create a view from XML tag. 
 
144
<p>
 
145
    </td>
 
146
  </tr>
 
147
</table>
 
148
<hr><h2>Member Function Documentation</h2>
 
149
<a class="anchor" name="a2" doxytag="IpeView::SaveAsXml" ></a><p>
 
150
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
151
  <tr>
 
152
    <td class="mdRow">
 
153
      <table cellpadding="0" cellspacing="0" border="0">
 
154
        <tr>
 
155
          <td class="md" nowrap valign="top"> void IpeView::SaveAsXml </td>
 
156
          <td class="md" valign="top">(&nbsp;</td>
 
157
          <td class="md" nowrap valign="top"><a class="el" href="class_ipe_stream.html">IpeStream</a> &amp;&nbsp;</td>
 
158
          <td class="mdname1" valign="top" nowrap> <em>stream</em>          </td>
 
159
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
160
          <td class="md" nowrap> const</td>
 
161
        </tr>
 
162
 
 
163
      </table>
 
164
    </td>
 
165
  </tr>
 
166
</table>
 
167
<table cellspacing=5 cellpadding=0 border=0>
 
168
  <tr>
 
169
    <td>
 
170
      &nbsp;
 
171
    </td>
 
172
    <td>
 
173
 
 
174
<p>
 
175
Write a single XML tag representing this view. 
 
176
<p>
 
177
    </td>
 
178
  </tr>
 
179
</table>
 
180
<a class="anchor" name="a3" doxytag="IpeView::PageDictionary" ></a><p>
 
181
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
182
  <tr>
 
183
    <td class="mdRow">
 
184
      <table cellpadding="0" cellspacing="0" border="0">
 
185
        <tr>
 
186
          <td class="md" nowrap valign="top"> void IpeView::PageDictionary </td>
 
187
          <td class="md" valign="top">(&nbsp;</td>
 
188
          <td class="md" nowrap valign="top"><a class="el" href="class_ipe_stream.html">IpeStream</a> &amp;&nbsp;</td>
 
189
          <td class="mdname1" valign="top" nowrap> <em>stream</em>          </td>
 
190
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
191
          <td class="md" nowrap> const</td>
 
192
        </tr>
 
193
 
 
194
      </table>
 
195
    </td>
 
196
  </tr>
 
197
</table>
 
198
<table cellspacing=5 cellpadding=0 border=0>
 
199
  <tr>
 
200
    <td>
 
201
      &nbsp;
 
202
    </td>
 
203
    <td>
 
204
 
 
205
<p>
 
206
Write part of page dictionary. 
 
207
<p>
 
208
Write part of page dictionary indicating effect, including the two keys /Dur and /Trans.     </td>
 
209
  </tr>
 
210
</table>
 
211
<hr><h2>Member Data Documentation</h2>
 
212
<a class="anchor" name="o0" doxytag="IpeView::iLayers" ></a><p>
 
213
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
214
  <tr>
 
215
    <td class="mdRow">
 
216
      <table cellpadding="0" cellspacing="0" border="0">
 
217
        <tr>
 
218
          <td class="md" nowrap valign="top"> std::vector&lt;<a class="el" href="class_ipe_string.html">IpeString</a>&gt; <a class="el" href="class_ipe_view.html#o0">IpeView::iLayers</a>
 
219
      </table>
 
220
    </td>
 
221
  </tr>
 
222
</table>
 
223
<table cellspacing=5 cellpadding=0 border=0>
 
224
  <tr>
 
225
    <td>
 
226
      &nbsp;
 
227
    </td>
 
228
    <td>
 
229
 
 
230
<p>
 
231
Names of layers being shown. 
 
232
<p>
 
233
    </td>
 
234
  </tr>
 
235
</table>
 
236
<a class="anchor" name="o1" doxytag="IpeView::iActive" ></a><p>
 
237
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
238
  <tr>
 
239
    <td class="mdRow">
 
240
      <table cellpadding="0" cellspacing="0" border="0">
 
241
        <tr>
 
242
          <td class="md" nowrap valign="top"> <a class="el" href="class_ipe_string.html">IpeString</a> <a class="el" href="class_ipe_view.html#o1">IpeView::iActive</a>
 
243
      </table>
 
244
    </td>
 
245
  </tr>
 
246
</table>
 
247
<table cellspacing=5 cellpadding=0 border=0>
 
248
  <tr>
 
249
    <td>
 
250
      &nbsp;
 
251
    </td>
 
252
    <td>
 
253
 
 
254
<p>
 
255
The layer active in this view. 
 
256
<p>
 
257
    </td>
 
258
  </tr>
 
259
</table>
 
260
<a class="anchor" name="o2" doxytag="IpeView::iEffect" ></a><p>
 
261
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
262
  <tr>
 
263
    <td class="mdRow">
 
264
      <table cellpadding="0" cellspacing="0" border="0">
 
265
        <tr>
 
266
          <td class="md" nowrap valign="top"> <a class="el" href="class_ipe_view.html#w17">TEffect</a> <a class="el" href="class_ipe_view.html#o2">IpeView::iEffect</a>
 
267
      </table>
 
268
    </td>
 
269
  </tr>
 
270
</table>
 
271
<table cellspacing=5 cellpadding=0 border=0>
 
272
  <tr>
 
273
    <td>
 
274
      &nbsp;
 
275
    </td>
 
276
    <td>
 
277
 
 
278
<p>
 
279
The fancy effect for showing the page. 
 
280
<p>
 
281
    </td>
 
282
  </tr>
 
283
</table>
 
284
<a class="anchor" name="o3" doxytag="IpeView::iTransitionTime" ></a><p>
 
285
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
286
  <tr>
 
287
    <td class="mdRow">
 
288
      <table cellpadding="0" cellspacing="0" border="0">
 
289
        <tr>
 
290
          <td class="md" nowrap valign="top"> int <a class="el" href="class_ipe_view.html#o3">IpeView::iTransitionTime</a>
 
291
      </table>
 
292
    </td>
 
293
  </tr>
 
294
</table>
 
295
<table cellspacing=5 cellpadding=0 border=0>
 
296
  <tr>
 
297
    <td>
 
298
      &nbsp;
 
299
    </td>
 
300
    <td>
 
301
 
 
302
<p>
 
303
Transition time for effect in showing page. 
 
304
<p>
 
305
    </td>
 
306
  </tr>
 
307
</table>
 
308
<a class="anchor" name="o4" doxytag="IpeView::iDuration" ></a><p>
 
309
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
310
  <tr>
 
311
    <td class="mdRow">
 
312
      <table cellpadding="0" cellspacing="0" border="0">
 
313
        <tr>
 
314
          <td class="md" nowrap valign="top"> int <a class="el" href="class_ipe_view.html#o4">IpeView::iDuration</a>
 
315
      </table>
 
316
    </td>
 
317
  </tr>
 
318
</table>
 
319
<table cellspacing=5 cellpadding=0 border=0>
 
320
  <tr>
 
321
    <td>
 
322
      &nbsp;
 
323
    </td>
 
324
    <td>
 
325
 
 
326
<p>
 
327
Duration during which page is shown. 
 
328
<p>
 
329
    </td>
 
330
  </tr>
 
331
</table>
 
332
<hr>The documentation for this class was generated from the following files:<ul>
 
333
<li>ipepage.h<li>ipepage.cpp</ul>
 
334
<hr>
 
335
</body></html>