Subversion Repositories Scribus

Rev

Rev 19706 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
10646 cbradney 1
<html>
2
<head>
3
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
4
        <title>Python: class PDFfile</title>
5
</head>
6
<body>
1006 cbradney 7
<h2>Python: class PDFfile</h2>
8
<p><a name="PDFfile">class <strong>PDFfile</strong></a>(<a href="__builtin__.html#object">object</a>)
9
</p>  
10
<hr />
11
<p>Methods defined here:</p>
12
<dl>
13
        <dt><a name="PDFfile-Save"><strong>Save</strong></a>(...)</dt>
14
        <dd><code>This method is deprecated - use <a href="#PDFfile-save">save</a>() instead.</code></dd>
1003 subik 15
 
19706 jghali 16
        <dt><a name="PDFfile-__init__"><strong>__init__</strong></a>(...)</dt>
17
        <dd><code>x.<a href="#PDFfile-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</code></dd>
1003 subik 18
 
19706 jghali 19
        <dt><a name="PDFfile-save"><strong>save</strong></a>(...)</dt>
20
        <dd><code>Save selected pages to pdf file</code></dd>
1006 cbradney 21
</dl>
1003 subik 22
 
23
<hr>
1006 cbradney 24
<p>Data and other attributes defined here:</p>
19706 jghali 25
<dl>
1006 cbradney 26
        <dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;</dt>
27
        <dd><code>T.<a href="#PDFfile-__new__">__new__</a>(S, ...) -&gt; a new object with type S, a subtype of T</code></dd>
1003 subik 28
 
1006 cbradney 29
        <dt><strong>aanot</strong> = &lt;member 'aanot' of 'PDFfile' objects&gt;</dt>
30
        <dd><code>Allow Adding Annotations and Fields. Bool value</code></dd>
1003 subik 31
 
1006 cbradney 32
        <dt><strong>achange</strong> = &lt;member 'achange' of 'PDFfile' objects&gt;</dt>
33
        <dd><code>Allow Changing the Document. Bool value</code></dd>
1003 subik 34
 
1006 cbradney 35
        <dt><strong>acopy</strong> = &lt;member 'acopy' of 'PDFfile' objects&gt;</dt>
36
        <dd><code>Allow Copying Text and Graphics. Bool value</code></dd>
1003 subik 37
 
1006 cbradney 38
        <dt><strong>aprint</strong> = &lt;member 'aprint' of 'PDFfile' objects&gt;</dt>
39
        <dd><code>Allow Printing the Document. Bool value</code></dd>
1003 subik 40
 
1006 cbradney 41
        <dt><strong>article</strong> = &lt;member 'article' of 'PDFfile' objects&gt;</dt>
42
        <dd><code>Save Linked Text Frames as PDF Articles<br> Bool value</code></dd>
1003 subik 43
 
1006 cbradney 44
        <dt><strong>binding</strong> = &lt;member 'binding' of 'PDFfile' objects&gt;</dt>
45
        <dd><code>Choose binding.<br>
46
 
47
        1 - Right binding</code></dd>
1003 subik 48
 
1006 cbradney 49
        <dt><strong>bleedb</strong> = &lt;member 'bleedb' of 'PDFfile' objects&gt;</dt>
50
        <dd><code>Bleed Bottom<br>Distance for bleed from the bottom of the physical page</code></dd>
1003 subik 51
 
1006 cbradney 52
        <dt><strong>bleedl</strong> = &lt;member 'bleedl' of 'PDFfile' objects&gt;</dt>
53
        <dd><code>Bleed Left<br>Distance for bleed from the left of the physical page</code></dd>
1003 subik 54
 
1006 cbradney 55
        <dt><strong>bleedr</strong> = &lt;member 'bleedr' of 'PDFfile' objects&gt;</dt>
56
        <dd><code>Bleed Right<br>Distance for bleed from the right of the physical page</code></dd>
1003 subik 57
 
1006 cbradney 58
        <dt><strong>bleedt</strong> = &lt;member 'bleedt' of 'PDFfile' objects&gt;</dt>
19706 jghali 59
        <dd><code>Bleed Top<br>Distance for bleed from the top of the physical page</code></dd>
1003 subik 60
 
1006 cbradney 61
        <dt><strong>bookmarks</strong> = &lt;member 'bookmarks' of 'PDFfile' objects&gt;</dt>
62
        <dd><code>Embed the bookmarks you created in your document.<br>These are useful for navigating long PDF documents.<br>Bool value</code></dd>
1003 subik 63
 
1006 cbradney 64
        <dt><strong>compress</strong> = &lt;member 'compress' of 'PDFfile' objects&gt;</dt>
65
        <dd><code>Compression switch. Bool value.</code></dd>
1003 subik 66
 
1006 cbradney 67
        <dt><strong>compressmtd</strong> = &lt;member 'compressmtd' of 'PDFfile' objects&gt;</dt>
68
        <dd><code>Compression method.<br>
69
 
70
        1 - JPEG<br>
71
        2 - zip<br>
72
        3 - None.</code></dd>
1003 subik 73
 
1006 cbradney 74
        <dt><strong>downsample</strong> = &lt;attribute 'downsample' of 'PDFfile' objects&gt;</dt>
75
        <dd><code>Downsample image resolusion to this value. Values from 35 to 4000<br>Set 0 for not to downsample</code></dd>
1003 subik 76
 
1006 cbradney 77
        <dt><strong>effval</strong> = &lt;attribute 'effval' of 'PDFfile' objects&gt;</dt>
78
        <dd><code>List of effection values for each saved page.<br>
79
        <pre>
80
It is list of list of six integers. Those int have the following meaning:
81
        - Length of time the page is shown before the presentation
82
        starts on the selected page. (1-3600)
83
        - Length of time the effect runs. (1 - 3600)
84
                A shorter time will speed up the effect, a longer one will slow it down
85
        - Type of the display effect
86
 
87
                1 - Blinds
88
                2 - Box
89
                3 - Dissolve
90
                4 - Glitter
91
                5 - Split
92
                6 - Wipe
93
        - Direction of the effect of moving lines for the split and blind effects.
94
 
95
                1 - Vertical
96
        - Starting position for the box and split effects.
97
 
98
                1 - Outside
99
        - Direction of the glitter or wipe effects.
100
 
101
                1 - Top to Bottom
102
                2 - Bottom to Top
103
                3 - Right to Left
104
                4 - Top-left to Bottom-Right
19706 jghali 105
</pre></code></dd>
1003 subik 106
 
1006 cbradney 107
<dt><strong>encrypt</strong> = &lt;member 'encrypt' of 'PDFfile' objects&gt;</dt>
108
<dd><code>Use Encription. Bool value</code></dd>
1003 subik 109
 
1006 cbradney 110
<dt><strong>file</strong> = &lt;attribute 'file' of 'PDFfile' objects&gt;</dt>
111
<dd><code>Name of file to save into</code></dd>
1003 subik 112
 
1006 cbradney 113
<dt><strong>fonts</strong> = &lt;attribute 'fonts' of 'PDFfile' objects&gt;</dt>
114
<dd><code>List of fonts to embed.</code></dd>
1003 subik 115
 
1006 cbradney 116
<dt><strong>imagepr</strong> = &lt;attribute 'imagepr' of 'PDFfile' objects&gt;</dt>
117
<dd><code>Color profile for images</code></dd>
1003 subik 118
 
1006 cbradney 119
<dt><strong>info</strong> = &lt;attribute 'info' of 'PDFfile' objects&gt;</dt>
120
<dd><code>Mandatory string for PDF/X-3 or the PDF will fail PDF/X-3 conformance. We recommend you use the title of the document.</code></dd>
1003 subik 121
 
1006 cbradney 122
<dt><strong>intenti</strong> = &lt;member 'intenti' of 'PDFfile' objects&gt;</dt>
123
<dd><code>Rendering intent for images<br>
1003 subik 124
 
125
1 - Relative Colorimetric<br>
126
2 - Saturation<br>
1006 cbradney 127
3 - Absolute Colorimetric</code></dd>
1003 subik 128
 
1006 cbradney 129
<dt><strong>intents</strong> = &lt;member 'intents' of 'PDFfile' objects&gt;</dt>
130
<dd><code>Rendering intent for solid colors<br>
1003 subik 131
 
132
1 - Relative Colorimetric<br>
133
2 - Saturation<br>
1006 cbradney 134
3 - Absolute Colorimetric</code></dd>
1003 subik 135
 
1006 cbradney 136
<dt><strong>lpival</strong> = &lt;attribute 'lpival' of 'PDFfile' objects&gt;</dt>
137
<dd><code>Rendering Settings for individual colors.<br>
138
<pre>
139
This is list of values for each color.
140
Color values have structure [siii] which stand for:
141
        s - Color name ('Black', 'Cyan', 'Magenta', 'Yellow')
142
        i - Frequency (10 to 1000)
143
        i - Angle (-180 to 180)
144
        i - Spot Function
145
 
146
                1 - Line
147
                2 - Round
148
                3 - Ellipse
149
</pre>
150
Be careful when supplying these values as they are not checked for validity.</code></dd>
1003 subik 151
 
1006 cbradney 152
<dt><strong>noembicc</strong> = &lt;member 'noembicc' of 'PDFfile' objects&gt;</dt>
153
<dd><code>Don't use embedded ICC profiles. Bool value</code></dd>
1003 subik 154
 
1006 cbradney 155
<dt><strong>outdst</strong> = &lt;member 'outdst' of 'PDFfile' objects&gt;</dt>
156
<dd><code>Output destination.<br>
1003 subik 157
 
1006 cbradney 158
1 - printer</code></dd>
1003 subik 159
 
1006 cbradney 160
<dt><strong>owner</strong> = &lt;attribute 'owner' of 'PDFfile' objects&gt;</dt>
161
<dd><code>Owner's password</code></dd>
1003 subik 162
 
1006 cbradney 163
<dt><strong>pages</strong> = &lt;attribute 'pages' of 'PDFfile' objects&gt;</dt>
164
<dd><code>List of pages to print</code></dd>
1003 subik 165
 
1006 cbradney 166
<dt><strong>presentation</strong> = &lt;member 'presentation' of 'PDFfile' objects&gt;</dt>
167
<dd><code>Enable Presentation Effects.Bool value</code></dd>
1003 subik 168
 
1006 cbradney 169
<dt><strong>printprofc</strong> = &lt;attribute 'printprofc' of 'PDFfile' objects&gt;</dt>
170
<dd><code>Output profile for printing. If possible, get some guidance from your printer on profile selection.</code></dd>
1003 subik 171
 
1006 cbradney 172
<dt><strong>profilei</strong> = &lt;member 'profilei' of 'PDFfile' objects&gt;</dt>
173
<dd><code>Embed a color profile for images. Bool value.</code></dd>
1003 subik 174
 
1006 cbradney 175
<dt><strong>profiles</strong> = &lt;member 'profiles' of 'PDFfile' objects&gt;</dt>
176
<dd><code>Embed a color profile for solid colors. Bool value.</code></dd>
1003 subik 177
 
1006 cbradney 178
<dt><strong>quality</strong> = &lt;member 'quality' of 'PDFfile' objects&gt;</dt>
179
<dd><code>Image quality<br>
1003 subik 180
 
181
1 - High<br>
182
2 - Medium<br>
183
3 - Low<br>
1006 cbradney 184
4 - Minimum</code></dd>
1003 subik 185
 
1006 cbradney 186
<dt><strong>resolution</strong> = &lt;attribute 'resolution' of 'PDFfile' objects&gt;</dt>
187
<dd><code>Resolution of output file. Values from 35 to 4000.</code></dd>
1003 subik 188
 
1006 cbradney 189
<dt><strong>solidpr</strong> = &lt;attribute 'solidpr' of 'PDFfile' objects&gt;</dt>
190
<dd><code>Color profile for solid colors</code></dd>
1003 subik 191
 
19706 jghali 192
<dt><strong>thumbnails</strong> = &lt;member 'thumbnails' of 'PDFfile' objects&gt;</dt>
193
<dd><code>Generate thumbnails. Bool value.</code></dd>
1003 subik 194
 
19739 jghali 195
<dt><strong>usedocbleeds</strong> = &lt;attribute 'usedocbleeds' of 'PDFfile' objects&gt;</dt>
196
<dd><code>Use the existing bleed settings from the document preferences. Bool value.</code></dd>
197
 
1006 cbradney 198
<dt><strong>uselpi</strong> = &lt;member 'uselpi' of 'PDFfile' objects&gt;</dt>
199
<dd><code>Use Custom Rendering Settings. Bool value</code></dd>
1003 subik 200
 
1006 cbradney 201
<dt><strong>user</strong> = &lt;attribute 'user' of 'PDFfile' objects&gt;</dt>
202
<dd><code>User's password</code></dd>
1003 subik 203
 
1006 cbradney 204
<dt><strong>version</strong> = &lt;member 'version' of 'PDFfile' objects&gt;</dt>
205
<dd><code>Choose PDF version to use:<br>
19706 jghali 206
11 = PDF/X-1a<br>
1003 subik 207
12 = PDF/X-3<br>
208
13 = PDF 1.3 (Acrobat 4)<br>
19706 jghali 209
14 = PDF 1.4 (Acrobat 5)<br>
210
15 = PDF 1.5 (Acrobat 6)</code></dd>
1003 subik 211
 
19706 jghali 212
</dl>
10646 cbradney 213
</body>
214
</html>