File: scripterapi-layer.html

package info (click to toggle)
scribus-doc 1.2.1-2
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 2,920 kB
  • ctags: 374
  • sloc: makefile: 387; xml: 110
file content (56 lines) | stat: -rw-r--r-- 3,936 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
<qt>
<title>Layer related Commands</title>
<h2>Layer related Commands</h2>

<dl>

<dt><a name="-createLayer"><strong>createLayer</strong></a>(...)</dt>
<dd><code><a href="#-createLayer">createLayer</a>(layer)</code>
<p>Creates a new layer with the name "name".</p>
<p>May raise ValueError if the layer name isn't acceptable.</p></dd>

<dt><a name="-deleteLayer"><strong>deleteLayer</strong></a>(...)</dt>
<dd><code><a href="#-deleteLayer">deleteLayer</a>("layer")</code>
<p>Deletes the layer with the name "layer". Nothing happens if the layer doesn't exists or if it's the only layer in the document.</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>

<dt><a name="-getActiveLayer"><strong>getActiveLayer</strong></a>(...)</dt>
<dd><code><a href="#-getActiveLayer">getActiveLayer</a>() -&gt; string</code>
<p>Returns the name of the current active layer.</p></dd>

<dt><a name="-getLayers"><strong>getLayers</strong></a>(...)</dt>
<dd><code><a href="#-getLayers">getLayers</a>() -&gt; list</code>
<p>Returns a list with the names of all defined layers.</p></dd>

<dt><a name="-isLayerPrintable"><strong>isLayerPrintable</strong></a>(...)</dt>
<dd><code><a href="#-isLayerPrintable">isLayerPrintable</a>("layer") -&gt; bool</code>
<p>Returns wether the layer "layer" is printable or not, a value of True means that the layer "layer" can be printed, a value of False means that printing the layer "layer" is disabled.</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>

<dt><a name="-isLayerVisible"><strong>isLayerVisible</strong></a>(...)</dt>
<dd><code><a href="#-isLayerVisible">isLayerVisible</a>("layer") -&gt; bool</code>
<p>Returns wether the Layer "layer" is visible or not, a value of True means that the layer "layer" is visible, a value of False means that the layer "layer" is invisible.</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>

<dt><a name="-sentToLayer"><strong>sentToLayer</strong></a>(...)</dt>
<dd><code><a href="#-sentToLayer">sentToLayer</a>("layer" [, "name"])</code>
<p>Sends the object "name" to the layer "layer". The layer must exist. If "name" is not given the currently selected item is used.</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>

<dt><a name="-setActiveLayer"><strong>setActiveLayer</strong></a>(...)</dt>
<dd><code><a href="#-setActiveLayer">setActiveLayer</a>("name")</code>
<p>Sets the active layer to the layer named "name".</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>

<dt><a name="-setLayerPrintable"><strong>setLayerPrintable</strong></a>(...)</dt>
<dd><code><a href="#-setLayerPrintable">setLayerPrintable</a>("layer", printable)</code>
<p>Sets the layer "layer" to be printable or not. If is the printable set to false the layer won't be printed.</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>

<dt><a name="-setLayerVisible"><strong>setLayerVisible</strong></a>(...)</dt>
<dd><code><a href="#-setLayerVisible">setLayerVisible</a>("layer", visible)</code>
<p>Sets the layer "layer" to be visible or not. If is the visible set to false the layer is invisible.</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>

</dl>
</qt>