~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: 2005-02-24 22:09:16 UTC
  • mfrom: (2.1.1 hoary)
  • Revision ID: james.westby@ubuntu.com-20050224220916-9vxiiqjz066r5489
Tags: 6.0pre23-2
debian/control: Ipe should depend on exact version of libipe.
Closes: #296771.

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<title>Ipelib: IpeLayer class Reference</title>
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
5
</head><body>
6
 
<!-- Generated by Doxygen 1.3.4 -->
 
6
<!-- Generated by Doxygen 1.3.6 -->
7
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
8
<h1>IpeLayer Class Reference<br>
9
9
<small>
13
13
<p>
14
14
<a href="class_ipe_layer-members.html">List of all members.</a><h2>Public Types</h2>
15
15
<ul>
16
 
<li>enum { <b>EHidden</b> =  0x01, 
17
 
<b>EDim</b> =  0x02, 
18
 
<b>ELocked</b> =  0x04, 
19
 
<b>ENoSnapping</b> =  0x08
 
16
<li>enum { <b>EDim</b> =  0x01, 
 
17
<b>ELocked</b> =  0x02, 
 
18
<b>ENoSnapping</b> =  0x04
20
19
 }
21
20
</ul>
22
21
<h2>Public Member Functions</h2>
23
22
<ul>
24
23
<li><a class="el" href="class_ipe_layer.html#a0">IpeLayer</a> (<a class="el" href="class_ipe_string.html">IpeString</a> name)
25
 
<li><a class="el" href="class_ipe_layer.html#a1">IpeLayer</a> (const  <a class="el" href="class_ipe_xml_attributes.html">IpeXmlAttributes</a> &amp;attr)
 
24
<li><a class="el" href="class_ipe_layer.html#a1">IpeLayer</a> (const <a class="el" href="class_ipe_xml_attributes.html">IpeXmlAttributes</a> &amp;attr)
26
25
<li>void <a class="el" href="class_ipe_layer.html#a2">SaveAsXml</a> (<a class="el" href="class_ipe_stream.html">IpeStream</a> &amp;stream) const 
27
26
<li><a class="el" href="class_ipe_string.html">IpeString</a> <a class="el" href="class_ipe_layer.html#a3">Name</a> () const 
28
 
<li>void <a class="el" href="class_ipe_layer.html#a4">SetName</a> (const  <a class="el" href="class_ipe_string.html">IpeString</a> &amp;name)
29
 
<li>bool <a class="el" href="class_ipe_layer.html#a5">IsVisible</a> () const 
30
 
<li>bool <a class="el" href="class_ipe_layer.html#a6">IsDimmed</a> () const 
31
 
<li>bool <a class="el" href="class_ipe_layer.html#a7">IsLocked</a> () const 
32
 
<li>bool <a class="el" href="class_ipe_layer.html#a8">IsSnapping</a> () const 
33
 
<li>void <a class="el" href="class_ipe_layer.html#a9">SetVisible</a> (bool flag)
34
 
<li>void <a class="el" href="class_ipe_layer.html#a10">SetDimmed</a> (bool flag)
35
 
<li>void <a class="el" href="class_ipe_layer.html#a11">SetLocked</a> (bool flag)
36
 
<li>void <a class="el" href="class_ipe_layer.html#a12">SetSnapping</a> (bool flag)
 
27
<li>void <a class="el" href="class_ipe_layer.html#a4">SetName</a> (const <a class="el" href="class_ipe_string.html">IpeString</a> &amp;name)
 
28
<li>bool <a class="el" href="class_ipe_layer.html#a5">IsDimmed</a> () const 
 
29
<li>bool <a class="el" href="class_ipe_layer.html#a6">IsLocked</a> () const 
 
30
<li>bool <a class="el" href="class_ipe_layer.html#a7">IsSnapping</a> () const 
 
31
<li>void <a class="el" href="class_ipe_layer.html#a8">SetDimmed</a> (bool flag)
 
32
<li>void <a class="el" href="class_ipe_layer.html#a9">SetLocked</a> (bool flag)
 
33
<li>void <a class="el" href="class_ipe_layer.html#a10">SetSnapping</a> (bool flag)
37
34
</ul>
38
35
<h2>Public Attributes</h2>
39
36
<ul>
51
48
<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>
52
49
<p>
53
50
<ul>
54
 
<li>A layer may be visible, invisible, or dimmed.</li></ul>
 
51
<li>A layer may be dimmed.</li></ul>
55
52
<p>
56
53
<ul>
57
54
<li>A layer may have snapping on or off---objects will behave magnetically only if their layer has snapping on.</li></ul>
214
211
    </td>
215
212
  </tr>
216
213
</table>
217
 
<a class="anchor" name="a5" doxytag="IpeLayer::IsVisible" ></a><p>
218
 
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
219
 
  <tr>
220
 
    <td class="mdRow">
221
 
      <table cellpadding="0" cellspacing="0" border="0">
222
 
        <tr>
223
 
          <td class="md" nowrap valign="top"> bool IpeLayer::IsVisible </td>
224
 
          <td class="md" valign="top">(&nbsp;</td>
225
 
          <td class="mdname1" valign="top" nowrap>          </td>
226
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
227
 
          <td class="md" nowrap> const<code> [inline]</code></td>
228
 
        </tr>
229
 
 
230
 
      </table>
231
 
    </td>
232
 
  </tr>
233
 
</table>
234
 
<table cellspacing=5 cellpadding=0 border=0>
235
 
  <tr>
236
 
    <td>
237
 
      &nbsp;
238
 
    </td>
239
 
    <td>
240
 
 
241
 
<p>
242
 
Is visible? 
243
 
<p>
244
 
    </td>
245
 
  </tr>
246
 
</table>
247
 
<a class="anchor" name="a6" doxytag="IpeLayer::IsDimmed" ></a><p>
 
214
<a class="anchor" name="a5" doxytag="IpeLayer::IsDimmed" ></a><p>
248
215
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
249
216
  <tr>
250
217
    <td class="mdRow">
274
241
    </td>
275
242
  </tr>
276
243
</table>
277
 
<a class="anchor" name="a7" doxytag="IpeLayer::IsLocked" ></a><p>
 
244
<a class="anchor" name="a6" doxytag="IpeLayer::IsLocked" ></a><p>
278
245
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
279
246
  <tr>
280
247
    <td class="mdRow">
304
271
    </td>
305
272
  </tr>
306
273
</table>
307
 
<a class="anchor" name="a8" doxytag="IpeLayer::IsSnapping" ></a><p>
 
274
<a class="anchor" name="a7" doxytag="IpeLayer::IsSnapping" ></a><p>
308
275
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
309
276
  <tr>
310
277
    <td class="mdRow">
334
301
    </td>
335
302
  </tr>
336
303
</table>
337
 
<a class="anchor" name="a9" doxytag="IpeLayer::SetVisible" ></a><p>
338
 
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
339
 
  <tr>
340
 
    <td class="mdRow">
341
 
      <table cellpadding="0" cellspacing="0" border="0">
342
 
        <tr>
343
 
          <td class="md" nowrap valign="top"> void IpeLayer::SetVisible </td>
344
 
          <td class="md" valign="top">(&nbsp;</td>
345
 
          <td class="md" nowrap valign="top">bool&nbsp;</td>
346
 
          <td class="mdname1" valign="top" nowrap> <em>flag</em>          </td>
347
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
348
 
          <td class="md" nowrap></td>
349
 
        </tr>
350
 
 
351
 
      </table>
352
 
    </td>
353
 
  </tr>
354
 
</table>
355
 
<table cellspacing=5 cellpadding=0 border=0>
356
 
  <tr>
357
 
    <td>
358
 
      &nbsp;
359
 
    </td>
360
 
    <td>
361
 
 
362
 
<p>
363
 
Set visibility. 
364
 
<p>
365
 
    </td>
366
 
  </tr>
367
 
</table>
368
 
<a class="anchor" name="a10" doxytag="IpeLayer::SetDimmed" ></a><p>
 
304
<a class="anchor" name="a8" doxytag="IpeLayer::SetDimmed" ></a><p>
369
305
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
370
306
  <tr>
371
307
    <td class="mdRow">
396
332
    </td>
397
333
  </tr>
398
334
</table>
399
 
<a class="anchor" name="a11" doxytag="IpeLayer::SetLocked" ></a><p>
 
335
<a class="anchor" name="a9" doxytag="IpeLayer::SetLocked" ></a><p>
400
336
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
401
337
  <tr>
402
338
    <td class="mdRow">
427
363
    </td>
428
364
  </tr>
429
365
</table>
430
 
<a class="anchor" name="a12" doxytag="IpeLayer::SetSnapping" ></a><p>
 
366
<a class="anchor" name="a10" doxytag="IpeLayer::SetSnapping" ></a><p>
431
367
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
432
368
  <tr>
433
369
    <td class="mdRow">