← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/class_ipe_layer.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve M. Robbins
  • Date: 2009-12-11 21:22:35 UTC
  • mfrom: (4.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20091211212235-5iio4nzpra64snab
Tags: 7.0.10-1
http://bugs.debian.org/551192
* New upstream.  Closes: #551192.
  - New build-depends: libcairo2-dev, liblua5.1-0-dev, gsfonts
  - patches/config.diff: Remove.  Upstream build system replaced.
  - Runtime lib package changed to libipe7.0.10 from libipe1c2a
  - Devel package renamed to libipe-dev (from libipe1-dev)
  - Package ipe depends on lua5.1 due to ipe-update-master.

* rules: Re-write to use dh.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/class_ipe_layer.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: IpeLayer Class Reference</title>
4
 
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
 
<link href="tabs.css" rel="stylesheet" type="text/css">
6
 
</head><body>
7
 
<!-- Generated by Doxygen 1.5.1 -->
8
 
<div class="tabs">
9
 
  <ul>
10
 
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11
 
    <li><a href="modules.html"><span>Modules</span></a></li>
12
 
    <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
13
 
  </ul></div>
14
 
<div class="tabs">
15
 
  <ul>
16
 
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
17
 
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
18
 
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
19
 
  </ul></div>
20
 
<h1>IpeLayer Class Reference<br>
21
 
<small>
22
 
[<a class="el" href="group__doc.html">Ipe Document</a>]</small>
23
 
</h1><!-- doxytag: class="IpeLayer" -->A layer of an <a class="el" href="class_ipe_page.html">IpePage</a>.  
24
 
<a href="#_details">More...</a>
25
 
<p>
26
 
<a href="class_ipe_layer-members.html">List of all members.</a><h2>Public Types</h2>
27
 
<ul>
28
 
<li>enum { <b>EDim</b> =  0x01, 
29
 
<b>ELocked</b> =  0x02, 
30
 
<b>ENoSnapping</b> =  0x04
31
 
 }
32
 
</ul>
33
 
<h2>Public Member Functions</h2>
34
 
<ul>
35
 
<li><a class="el" href="class_ipe_layer.html#f5a25b6fab6ecf9c16230d9ff84c3bf1">IpeLayer</a> (<a class="el" href="class_ipe_string.html">IpeString</a> name)
36
 
<li><a class="el" href="class_ipe_layer.html#3998c1c89c9fa72997b0eeecd61cefa2">IpeLayer</a> (const <a class="el" href="class_ipe_xml_attributes.html">IpeXmlAttributes</a> &amp;attr)
37
 
<li>void <a class="el" href="class_ipe_layer.html#46655eb24164ab5e5f47c28bf3b236a9">SaveAsXml</a> (<a class="el" href="class_ipe_stream.html">IpeStream</a> &amp;stream) const
38
 
<li><a class="el" href="class_ipe_string.html">IpeString</a> <a class="el" href="class_ipe_layer.html#5ec425cafd968e828709dd6562211a09">Name</a> () const
39
 
<li>void <a class="el" href="class_ipe_layer.html#f8a03f3f6bfe115c5a6a0597142fbc2f">SetName</a> (const <a class="el" href="class_ipe_string.html">IpeString</a> &amp;name)
40
 
<li>bool <a class="el" href="class_ipe_layer.html#4366b9d45f27898e8f154ce336ed82ef">IsDimmed</a> () const
41
 
<li>bool <a class="el" href="class_ipe_layer.html#b7104917671a64507f9b8d496a4afdd4">IsLocked</a> () const
42
 
<li>bool <a class="el" href="class_ipe_layer.html#a4dbcecbe178291e0e1ebba3e3fcc156">IsSnapping</a> () const
43
 
<li>void <a class="el" href="class_ipe_layer.html#2fb7ea1abd20a187b24c4c654d9df1a8">SetDimmed</a> (bool flag)
44
 
<li>void <a class="el" href="class_ipe_layer.html#dc009f18fea7fc4422f9a78b67ba9dcc">SetLocked</a> (bool flag)
45
 
<li>void <a class="el" href="class_ipe_layer.html#ef35d7caf66176d4402a7525be31f1c3">SetSnapping</a> (bool flag)
46
 
</ul>
47
 
<h2>Public Attributes</h2>
48
 
<ul>
49
 
<li><a class="anchor" name="3c964625ff7711ba42580bb9f6e50c1a"></a><!-- doxytag: member="IpeLayer::iName" ref="3c964625ff7711ba42580bb9f6e50c1a" args="" -->
50
 
<a class="el" href="class_ipe_string.html">IpeString</a> <b>iName</b>
51
 
<li><a class="anchor" name="4e889a9e55690a5cc9d3e1a604c07d04"></a><!-- doxytag: member="IpeLayer::iFlags" ref="4e889a9e55690a5cc9d3e1a604c07d04" args="" -->
52
 
int <b>iFlags</b>
53
 
</ul>
54
 
<hr><a name="_details"></a><h2>Detailed Description</h2>
55
 
A layer of an <a class="el" href="class_ipe_page.html">IpePage</a>. 
56
 
<p>
57
 
Each object on an <a class="el" href="class_ipe_page.html">IpePage</a> belongs to one of the layers of the page. Layers are orthogonal to the back-to-front ordering of objects, so a "layer" is just another attribute of the object.<p>
58
 
Layers have several attributes:<p>
59
 
<ul>
60
 
<li>They may be editable or locked. Objects in a locked layer cannot be selected, and a locked layer cannot be made active in the Ipe UI. This more or less means that the contents of such a layer cannot be modified---but that's a consequence of the UI, Ipelib contains no special handling of locked layers.</li></ul>
61
 
<p>
62
 
<ul>
63
 
<li>A layer may be dimmed (on the screen - no dimming appears on PDF or Postscript output).</li></ul>
64
 
<p>
65
 
<ul>
66
 
<li>A layer may have snapping on or off---objects will behave magnetically only if their layer has snapping on.</li></ul>
67
 
<p>
68
 
The PDF output generated for an <a class="el" href="class_ipe_page.html">IpePage</a> depends on its <em>views</em>. Each view may list a number of layers to be displayed at that stage. Multiple <em>views</em> may show different subsets of layers. 
69
 
<p>
70
 
<hr><h2>Constructor &amp; Destructor Documentation</h2>
71
 
<a class="anchor" name="f5a25b6fab6ecf9c16230d9ff84c3bf1"></a><!-- doxytag: member="IpeLayer::IpeLayer" ref="f5a25b6fab6ecf9c16230d9ff84c3bf1" args="(IpeString name)" -->
72
 
<div class="memitem">
73
 
<div class="memproto">
74
 
      <table class="memname">
75
 
        <tr>
76
 
          <td class="memname">IpeLayer::IpeLayer           </td>
77
 
          <td>(</td>
78
 
          <td class="paramtype"><a class="el" href="class_ipe_string.html">IpeString</a>&nbsp;</td>
79
 
          <td class="paramname"> <em>name</em>          </td>
80
 
          <td>&nbsp;)&nbsp;</td>
81
 
          <td width="100%"><code> [explicit]</code></td>
82
 
        </tr>
83
 
      </table>
84
 
</div>
85
 
<div class="memdoc">
86
 
 
87
 
<p>
88
 
Construct with name. Default attributes. 
89
 
<p>
90
 
 
91
 
</div>
92
 
</div><p>
93
 
<a class="anchor" name="3998c1c89c9fa72997b0eeecd61cefa2"></a><!-- doxytag: member="IpeLayer::IpeLayer" ref="3998c1c89c9fa72997b0eeecd61cefa2" args="(const IpeXmlAttributes &amp;attr)" -->
94
 
<div class="memitem">
95
 
<div class="memproto">
96
 
      <table class="memname">
97
 
        <tr>
98
 
          <td class="memname">IpeLayer::IpeLayer           </td>
99
 
          <td>(</td>
100
 
          <td class="paramtype">const <a class="el" href="class_ipe_xml_attributes.html">IpeXmlAttributes</a> &amp;&nbsp;</td>
101
 
          <td class="paramname"> <em>attr</em>          </td>
102
 
          <td>&nbsp;)&nbsp;</td>
103
 
          <td width="100%"><code> [explicit]</code></td>
104
 
        </tr>
105
 
      </table>
106
 
</div>
107
 
<div class="memdoc">
108
 
 
109
 
<p>
110
 
Construct from a single XML tag. 
111
 
<p>
112
 
 
113
 
</div>
114
 
</div><p>
115
 
<hr><h2>Member Function Documentation</h2>
116
 
<a class="anchor" name="46655eb24164ab5e5f47c28bf3b236a9"></a><!-- doxytag: member="IpeLayer::SaveAsXml" ref="46655eb24164ab5e5f47c28bf3b236a9" args="(IpeStream &amp;stream) const" -->
117
 
<div class="memitem">
118
 
<div class="memproto">
119
 
      <table class="memname">
120
 
        <tr>
121
 
          <td class="memname">void IpeLayer::SaveAsXml           </td>
122
 
          <td>(</td>
123
 
          <td class="paramtype"><a class="el" href="class_ipe_stream.html">IpeStream</a> &amp;&nbsp;</td>
124
 
          <td class="paramname"> <em>stream</em>          </td>
125
 
          <td>&nbsp;)&nbsp;</td>
126
 
          <td width="100%"> const</td>
127
 
        </tr>
128
 
      </table>
129
 
</div>
130
 
<div class="memdoc">
131
 
 
132
 
<p>
133
 
Write a single XML tag describing this layer. 
134
 
<p>
135
 
 
136
 
</div>
137
 
</div><p>
138
 
<a class="anchor" name="5ec425cafd968e828709dd6562211a09"></a><!-- doxytag: member="IpeLayer::Name" ref="5ec425cafd968e828709dd6562211a09" args="() const" -->
139
 
<div class="memitem">
140
 
<div class="memproto">
141
 
      <table class="memname">
142
 
        <tr>
143
 
          <td class="memname"><a class="el" href="class_ipe_string.html">IpeString</a> IpeLayer::Name           </td>
144
 
          <td>(</td>
145
 
          <td class="paramname">          </td>
146
 
          <td>&nbsp;)&nbsp;</td>
147
 
          <td width="100%"> const<code> [inline]</code></td>
148
 
        </tr>
149
 
      </table>
150
 
</div>
151
 
<div class="memdoc">
152
 
 
153
 
<p>
154
 
Return name. 
155
 
<p>
156
 
 
157
 
</div>
158
 
</div><p>
159
 
<a class="anchor" name="f8a03f3f6bfe115c5a6a0597142fbc2f"></a><!-- doxytag: member="IpeLayer::SetName" ref="f8a03f3f6bfe115c5a6a0597142fbc2f" args="(const IpeString &amp;name)" -->
160
 
<div class="memitem">
161
 
<div class="memproto">
162
 
      <table class="memname">
163
 
        <tr>
164
 
          <td class="memname">void IpeLayer::SetName           </td>
165
 
          <td>(</td>
166
 
          <td class="paramtype">const <a class="el" href="class_ipe_string.html">IpeString</a> &amp;&nbsp;</td>
167
 
          <td class="paramname"> <em>name</em>          </td>
168
 
          <td>&nbsp;)&nbsp;</td>
169
 
          <td width="100%"><code> [inline]</code></td>
170
 
        </tr>
171
 
      </table>
172
 
</div>
173
 
<div class="memdoc">
174
 
 
175
 
<p>
176
 
Set name. 
177
 
<p>
178
 
 
179
 
</div>
180
 
</div><p>
181
 
<a class="anchor" name="4366b9d45f27898e8f154ce336ed82ef"></a><!-- doxytag: member="IpeLayer::IsDimmed" ref="4366b9d45f27898e8f154ce336ed82ef" args="() const" -->
182
 
<div class="memitem">
183
 
<div class="memproto">
184
 
      <table class="memname">
185
 
        <tr>
186
 
          <td class="memname">bool IpeLayer::IsDimmed           </td>
187
 
          <td>(</td>
188
 
          <td class="paramname">          </td>
189
 
          <td>&nbsp;)&nbsp;</td>
190
 
          <td width="100%"> const<code> [inline]</code></td>
191
 
        </tr>
192
 
      </table>
193
 
</div>
194
 
<div class="memdoc">
195
 
 
196
 
<p>
197
 
Is dimmed? 
198
 
<p>
199
 
 
200
 
</div>
201
 
</div><p>
202
 
<a class="anchor" name="b7104917671a64507f9b8d496a4afdd4"></a><!-- doxytag: member="IpeLayer::IsLocked" ref="b7104917671a64507f9b8d496a4afdd4" args="() const" -->
203
 
<div class="memitem">
204
 
<div class="memproto">
205
 
      <table class="memname">
206
 
        <tr>
207
 
          <td class="memname">bool IpeLayer::IsLocked           </td>
208
 
          <td>(</td>
209
 
          <td class="paramname">          </td>
210
 
          <td>&nbsp;)&nbsp;</td>
211
 
          <td width="100%"> const<code> [inline]</code></td>
212
 
        </tr>
213
 
      </table>
214
 
</div>
215
 
<div class="memdoc">
216
 
 
217
 
<p>
218
 
Is locked? 
219
 
<p>
220
 
 
221
 
</div>
222
 
</div><p>
223
 
<a class="anchor" name="a4dbcecbe178291e0e1ebba3e3fcc156"></a><!-- doxytag: member="IpeLayer::IsSnapping" ref="a4dbcecbe178291e0e1ebba3e3fcc156" args="() const" -->
224
 
<div class="memitem">
225
 
<div class="memproto">
226
 
      <table class="memname">
227
 
        <tr>
228
 
          <td class="memname">bool IpeLayer::IsSnapping           </td>
229
 
          <td>(</td>
230
 
          <td class="paramname">          </td>
231
 
          <td>&nbsp;)&nbsp;</td>
232
 
          <td width="100%"> const<code> [inline]</code></td>
233
 
        </tr>
234
 
      </table>
235
 
</div>
236
 
<div class="memdoc">
237
 
 
238
 
<p>
239
 
Is snapping enabled? 
240
 
<p>
241
 
 
242
 
</div>
243
 
</div><p>
244
 
<a class="anchor" name="2fb7ea1abd20a187b24c4c654d9df1a8"></a><!-- doxytag: member="IpeLayer::SetDimmed" ref="2fb7ea1abd20a187b24c4c654d9df1a8" args="(bool flag)" -->
245
 
<div class="memitem">
246
 
<div class="memproto">
247
 
      <table class="memname">
248
 
        <tr>
249
 
          <td class="memname">void IpeLayer::SetDimmed           </td>
250
 
          <td>(</td>
251
 
          <td class="paramtype">bool&nbsp;</td>
252
 
          <td class="paramname"> <em>flag</em>          </td>
253
 
          <td>&nbsp;)&nbsp;</td>
254
 
          <td width="100%"></td>
255
 
        </tr>
256
 
      </table>
257
 
</div>
258
 
<div class="memdoc">
259
 
 
260
 
<p>
261
 
Set dimming. 
262
 
<p>
263
 
 
264
 
</div>
265
 
</div><p>
266
 
<a class="anchor" name="dc009f18fea7fc4422f9a78b67ba9dcc"></a><!-- doxytag: member="IpeLayer::SetLocked" ref="dc009f18fea7fc4422f9a78b67ba9dcc" args="(bool flag)" -->
267
 
<div class="memitem">
268
 
<div class="memproto">
269
 
      <table class="memname">
270
 
        <tr>
271
 
          <td class="memname">void IpeLayer::SetLocked           </td>
272
 
          <td>(</td>
273
 
          <td class="paramtype">bool&nbsp;</td>
274
 
          <td class="paramname"> <em>flag</em>          </td>
275
 
          <td>&nbsp;)&nbsp;</td>
276
 
          <td width="100%"></td>
277
 
        </tr>
278
 
      </table>
279
 
</div>
280
 
<div class="memdoc">
281
 
 
282
 
<p>
283
 
Set locking. 
284
 
<p>
285
 
 
286
 
</div>
287
 
</div><p>
288
 
<a class="anchor" name="ef35d7caf66176d4402a7525be31f1c3"></a><!-- doxytag: member="IpeLayer::SetSnapping" ref="ef35d7caf66176d4402a7525be31f1c3" args="(bool flag)" -->
289
 
<div class="memitem">
290
 
<div class="memproto">
291
 
      <table class="memname">
292
 
        <tr>
293
 
          <td class="memname">void IpeLayer::SetSnapping           </td>
294
 
          <td>(</td>
295
 
          <td class="paramtype">bool&nbsp;</td>
296
 
          <td class="paramname"> <em>flag</em>          </td>
297
 
          <td>&nbsp;)&nbsp;</td>
298
 
          <td width="100%"></td>
299
 
        </tr>
300
 
      </table>
301
 
</div>
302
 
<div class="memdoc">
303
 
 
304
 
<p>
305
 
Set snapping. 
306
 
<p>
307
 
 
308
 
</div>
309
 
</div><p>
310
 
<hr>The documentation for this class was generated from the following files:<ul>
311
 
<li>ipepage.h<li>ipepage.cpp</ul>
312
 
<hr>
313
 
</body></html>