Subversion Repositories Scribus

Rev

Rev 20092 | Rev 22339 | 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>
18507 gpittman 6
<style>
7
@import "manual.css";
8
</style>
10646 cbradney 9
<body>
1006 cbradney 10
<h2>Python: class PDFfile</h2>
11
<p><a name="PDFfile">class <strong>PDFfile</strong></a>(<a href="__builtin__.html#object">object</a>)
12
</p>  
13
<hr />
14
<p>Methods defined here:</p>
15
<dl>
16
        <dt><a name="PDFfile-Save"><strong>Save</strong></a>(...)</dt>
18508 gpittman 17
        <dd><p>This method is deprecated - use <a href="#PDFfile-save">save</a>() instead.</p></dd>
1003 subik 18
 
19705 jghali 19
        <dt><a name="PDFfile-__init__"><strong>__init__</strong></a>(...)</dt>
20
        <dd><p>x.<a href="#PDFfile-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</p></dd>
1003 subik 21
 
19705 jghali 22
        <dt><a name="PDFfile-save"><strong>save</strong></a>(...)</dt>
23
        <dd><p>Save selected pages to pdf file</p></dd>
1006 cbradney 24
</dl>
1003 subik 25
 
26
<hr>
1006 cbradney 27
<p>Data and other attributes defined here:</p>
18508 gpittman 28
<dl>
1006 cbradney 29
        <dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;</dt>
18508 gpittman 30
        <dd><p>T.<a href="#PDFfile-__new__">__new__</a>(S, ...) -&gt; a new object with type S, a subtype of T</p></dd>
1003 subik 31
 
20092 jghali 32
        <dt><strong>allowAnnots</strong> = &lt;member 'allowAnnots' of 'PDFfile' objects&gt;</dt>
19705 jghali 33
        <dd><p>Allow adding annotations and fields. Bool value</p></dd>
1003 subik 34
 
20092 jghali 35
        <dt><strong>allowChange</strong> = &lt;member 'allowChange' of 'PDFfile' objects&gt;</dt>
19705 jghali 36
        <dd><p>Allow changing the Document. Bool value</p></dd>
1003 subik 37
 
20092 jghali 38
        <dt><strong>allowCopy</strong> = &lt;member 'allowCopy' of 'PDFfile' objects&gt;</dt>
19705 jghali 39
        <dd><p>Allow copying text and graphics. Bool value</p></dd>
1003 subik 40
 
20092 jghali 41
        <dt><strong>allowPrinting</strong> = &lt;member 'allowPrinting' of 'PDFfile' objects&gt;</dt>
19705 jghali 42
        <dd><p>Allow printing the Document. Bool value</p></dd>
1003 subik 43
 
1006 cbradney 44
        <dt><strong>article</strong> = &lt;member 'article' of 'PDFfile' objects&gt;</dt>
20126 jghali 45
        <dd><p>Save linked text frames as PDF articles<br/> Bool value</p></dd>
1003 subik 46
 
1006 cbradney 47
        <dt><strong>binding</strong> = &lt;member 'binding' of 'PDFfile' objects&gt;</dt>
20126 jghali 48
        <dd><p>Choose binding.<br/>
49
 
18508 gpittman 50
        1 - Right binding</p></dd>
19705 jghali 51
 
52
        <dt><strong>bleedMarks</strong> = &lt;attribute 'bleedMarks' of 'PDFfile' objects&gt;</dt>
53
        <dd><p>Create marks delimiting the bleed area.</p></dd>
1003 subik 54
 
1006 cbradney 55
        <dt><strong>bleedb</strong> = &lt;member 'bleedb' of 'PDFfile' objects&gt;</dt>
20126 jghali 56
        <dd><p>Bleed Bottom<br/>Distance for bleed from the bottom of the physical page</p></dd>
1003 subik 57
 
1006 cbradney 58
        <dt><strong>bleedl</strong> = &lt;member 'bleedl' of 'PDFfile' objects&gt;</dt>
20126 jghali 59
        <dd><p>Bleed Left<br/>Distance for bleed from the left of the physical page</p></dd>
1003 subik 60
 
1006 cbradney 61
        <dt><strong>bleedr</strong> = &lt;member 'bleedr' of 'PDFfile' objects&gt;</dt>
20126 jghali 62
        <dd><p>Bleed Right<br/>Distance for bleed from the right of the physical page</p></dd>
1003 subik 63
 
1006 cbradney 64
        <dt><strong>bleedt</strong> = &lt;member 'bleedt' of 'PDFfile' objects&gt;</dt>
20126 jghali 65
        <dd><p>Bleed Top<br/>Distance for bleed from the top of the physical page</p></dd>
1003 subik 66
 
1006 cbradney 67
        <dt><strong>bookmarks</strong> = &lt;member 'bookmarks' of 'PDFfile' objects&gt;</dt>
20126 jghali 68
        <dd><p>Embed the bookmarks you created in your document.<br/>These are useful for navigating long PDF documents.<br/>Bool value</p></dd>
1003 subik 69
 
19705 jghali 70
        <dt><strong>colorMarks</strong> = &lt;member 'colorMarks' of 'PDFfile' objects&gt;</dt>
71
        <dd><p>Add color calibration bars.</p></dd>
72
 
1006 cbradney 73
        <dt><strong>compress</strong> = &lt;member 'compress' of 'PDFfile' objects&gt;</dt>
18508 gpittman 74
        <dd><p>Compression switch. Bool value.</p></dd>
1003 subik 75
 
1006 cbradney 76
        <dt><strong>compressmtd</strong> = &lt;member 'compressmtd' of 'PDFfile' objects&gt;</dt>
20126 jghali 77
        <dd><p>Compression method.<br/>
78
 
79
        1 - JPEG<br/>
80
        2 - zip<br/>
18508 gpittman 81
        3 - None.</p></dd>
19705 jghali 82
 
83
        <dt><strong>cropMarks</strong> = &lt;attribute 'cropMarks' of 'PDFfile' objects&gt;</dt>
84
        <dd><p>Create crop marks in the PDF indicating where the paper should be cut or trimmed after printing.</p></dd>
85
 
86
        <dt><strong>displayBookmarks</strong> = &lt;attribute 'displayBookmarks' of 'PDFfile' objects&gt;</dt>
87
        <dd><p>Display the bookmarks upon opening.</p></dd>
88
 
89
        <dt><strong>displayFullscreen</strong> = &lt;attribute 'displayFullscreen' of 'PDFfile' objects&gt;</dt>
90
        <dd><p>Display the document in full screen mode upon opening.</p></dd>
91
 
92
        <dt><strong>displayLayers</strong> = &lt;attribute 'displayLayers' of 'PDFfile' objects&gt;</dt>
93
        <dd><p>Display the layer list upon opening. Useful only for PDF 1.5+.</p></dd>
94
 
95
        <dt><strong>displayThumbs</strong> = &lt;attribute 'displayThumbs' of 'PDFfile' objects&gt;</dt>
96
        <dd><p>Display the page thumbnails upon opening.</p></dd>
97
 
98
        <dt><strong>docInfoMarks</strong> = &lt;member 'docInfoMarks' of 'PDFfile' objects&gt;</dt>
99
        <dd><p>Add document information which includes the document title and page numbers.</p></dd>
100
 
101
        <dt><strong>doClip</strong> = &lt;attribute 'doClip' of 'PDFfile' objects&gt;</dt>
102
        <dd><p>Do not show objects outside the margins in the exported file.</p></dd>
1003 subik 103
 
1006 cbradney 104
        <dt><strong>downsample</strong> = &lt;attribute 'downsample' of 'PDFfile' objects&gt;</dt>
20126 jghali 105
        <dd><p>Downsample image resolusion to this value. Values from 35 to 4000<br/>Set 0 for not to downsample</p></dd>
1003 subik 106
 
1006 cbradney 107
        <dt><strong>effval</strong> = &lt;attribute 'effval' of 'PDFfile' objects&gt;</dt>
20126 jghali 108
        <dd><p>List of effection values for each saved page.<br/>
1006 cbradney 109
        <pre>
110
It is list of list of six integers. Those int have the following meaning:
111
        - Length of time the page is shown before the presentation
112
        starts on the selected page. (1-3600)
113
        - Length of time the effect runs. (1 - 3600)
114
                A shorter time will speed up the effect, a longer one will slow it down
115
        - Type of the display effect
116
 
117
                1 - Blinds
118
                2 - Box
119
                3 - Dissolve
120
                4 - Glitter
121
                5 - Split
122
                6 - Wipe
123
        - Direction of the effect of moving lines for the split and blind effects.
124
 
125
                1 - Vertical
126
        - Starting position for the box and split effects.
127
 
128
                1 - Outside
129
        - Direction of the glitter or wipe effects.
130
 
131
                1 - Top to Bottom
132
                2 - Bottom to Top
133
                3 - Right to Left
134
                4 - Top-left to Bottom-Right
19705 jghali 135
</pre></p></dd>
18508 gpittman 136
</dl>
137
<dl>
19705 jghali 138
<dt><strong>embedPDF</strong> = &lt;member 'embedPDF' of 'PDFfile' objects&gt;</dt>
20126 jghali 139
<dd><p>Export PDFs in image frames as embedded PDFs.<br/>
140
This does *not* yet take care of colorspaces, so you should know what you are doing before setting this to 'true'.<br/>
19705 jghali 141
Bool value.</p></dd>
142
 
1006 cbradney 143
<dt><strong>encrypt</strong> = &lt;member 'encrypt' of 'PDFfile' objects&gt;</dt>
18508 gpittman 144
<dd><p>Use Encription. Bool value</p></dd>
1003 subik 145
 
1006 cbradney 146
<dt><strong>file</strong> = &lt;attribute 'file' of 'PDFfile' objects&gt;</dt>
18508 gpittman 147
<dd><p>Name of file to save into</p></dd>
1003 subik 148
 
19705 jghali 149
<dt><strong>fitWindow</strong> = &lt;attribute 'fitWindow' of 'PDFfile' objects&gt;</dt>
150
<dd><p>Fit the document page or pages to the available space in the viewer window.</p></dd>
151
 
20126 jghali 152
<dt><strong>fontEmbedding</strong> = &lt;attribute 'fontEmbedding' of 'PDFfile' objects&gt;</dt>
153
<dd><p>Choose the font embedding mode :<br/>
154
 
155
1 - Outline fonts: fonts will be converted to vector<br/>
156
2 - No embedding: no font will be embedded.</p></dd>
157
 
1006 cbradney 158
<dt><strong>fonts</strong> = &lt;attribute 'fonts' of 'PDFfile' objects&gt;</dt>
18508 gpittman 159
<dd><p>List of fonts to embed.</p></dd>
1003 subik 160
 
19705 jghali 161
<dt><strong>hideMenuBar</strong> = &lt;attribute 'hideMenuBar' of 'PDFfile' objects&gt;</dt>
162
<dd><p>Hides the viewer menu bar, the PDF will display in a plain window.</p></dd>
163
 
164
<dt><strong>hideToolBar</strong> = &lt;attribute 'hideToolBar' of 'PDFfile' objects&gt;</dt>
165
<dd><p>Hides the viewer toolbar. The toolbar has usually selection and other editing capabilities.</p></dd>
166
 
1006 cbradney 167
<dt><strong>imagepr</strong> = &lt;attribute 'imagepr' of 'PDFfile' objects&gt;</dt>
18508 gpittman 168
<dd><p>Color profile for images</p></dd>
1003 subik 169
 
1006 cbradney 170
<dt><strong>info</strong> = &lt;attribute 'info' of 'PDFfile' objects&gt;</dt>
18508 gpittman 171
<dd><p>Mandatory string for PDF/X-3 or the PDF will fail PDF/X-3 conformance. We recommend you use the title of the document.</p></dd>
1003 subik 172
 
1006 cbradney 173
<dt><strong>intenti</strong> = &lt;member 'intenti' of 'PDFfile' objects&gt;</dt>
20126 jghali 174
<dd><p>Rendering intent for images<br/>
175
 
176
1 - Relative Colorimetric<br/>
177
2 - Saturation<br/>
18508 gpittman 178
3 - Absolute Colorimetric</p></dd>
1003 subik 179
 
1006 cbradney 180
<dt><strong>intents</strong> = &lt;member 'intents' of 'PDFfile' objects&gt;</dt>
20126 jghali 181
<dd><p>Rendering intent for solid colors<br/>
182
 
183
1 - Relative Colorimetric<br/>
184
2 - Saturation<br/>
18508 gpittman 185
3 - Absolute Colorimetric</p></dd>
1003 subik 186
 
19705 jghali 187
<dt><strong>isGrayscale</strong> = &lt;attribute 'isGrayscale' of 'PDFfile' objects&gt;</dt>
188
<dd><p>Export PDF in grayscale.</p></dd>
189
 
1006 cbradney 190
<dt><strong>lpival</strong> = &lt;attribute 'lpival' of 'PDFfile' objects&gt;</dt>
20126 jghali 191
<dd><p>Rendering Settings for individual colors.<br/>
1006 cbradney 192
<pre>
193
This is list of values for each color.
194
Color values have structure [siii] which stand for:
195
        s - Color name ('Black', 'Cyan', 'Magenta', 'Yellow')
196
        i - Frequency (10 to 1000)
197
        i - Angle (-180 to 180)
198
        i - Spot Function
199
 
200
                1 - Line
201
                2 - Round
202
                3 - Ellipse
203
</pre>
18508 gpittman 204
Be careful when supplying these values as they are not checked for validity.</p></dd>
1003 subik 205
 
19705 jghali 206
<dt><strong>markOffset</strong> = &lt;member 'markOffset' of 'PDFfile' objects&gt;</dt>
207
<dd><p>Indicate the distance offset between mark and page area.</p></dd>
208
 
19746 jghali 209
<dt><strong>markLength</strong> = &lt;member 'markLength' of 'PDFfile' objects&gt;</dt>
210
<dd><p>Indicate the length of crop and bleed marks.</p></dd>
211
 
19705 jghali 212
<dt><strong>mirrorH</strong> = &lt;member 'mirrorH' of 'PDFfile' objects&gt;</dt>
213
<dd><p>Mirror Page(s) horizontally. Bool value.</p></dd>
214
 
215
<dt><strong>mirrorV</strong> = &lt;member 'mirrorV' of 'PDFfile' objects&gt;</dt>
216
<dd><p>Mirror Page(s) vertically. Bool value.</p></dd>
217
 
1006 cbradney 218
<dt><strong>noembicc</strong> = &lt;member 'noembicc' of 'PDFfile' objects&gt;</dt>
18508 gpittman 219
<dd><p>Don't use embedded ICC profiles. Bool value</p></dd>
1003 subik 220
 
1006 cbradney 221
<dt><strong>outdst</strong> = &lt;member 'outdst' of 'PDFfile' objects&gt;</dt>
20126 jghali 222
<dd><p>Output destination.<br/>
223
 
18508 gpittman 224
1 - printer</p></dd>
1003 subik 225
 
1006 cbradney 226
<dt><strong>owner</strong> = &lt;attribute 'owner' of 'PDFfile' objects&gt;</dt>
18508 gpittman 227
<dd><p>Owner's password</p></dd>
1003 subik 228
 
19705 jghali 229
<dt><strong>pageLayout</strong> = &lt;attribute 'pageLayout' of 'PDFfile' objects&gt;</dt>
20126 jghali 230
<dd><p>Document layout in PDF viewer:<br/>
231
 
232
1 - Show the document in single page mode with the pages displayed continuously end to end like a scroll<br/>
233
2 - Show the document with facing pages, starting with the first page displayed on the left<br/>
19705 jghali 234
3 - Show the document with facing pages, starting with the first page displayed on the right</p></dd>
235
 
1006 cbradney 236
<dt><strong>pages</strong> = &lt;attribute 'pages' of 'PDFfile' objects&gt;</dt>
18508 gpittman 237
<dd><p>List of pages to print</p></dd>
1003 subik 238
 
1006 cbradney 239
<dt><strong>presentation</strong> = &lt;member 'presentation' of 'PDFfile' objects&gt;</dt>
18508 gpittman 240
<dd><p>Enable Presentation Effects.Bool value</p></dd>
1003 subik 241
 
1006 cbradney 242
<dt><strong>printprofc</strong> = &lt;attribute 'printprofc' of 'PDFfile' objects&gt;</dt>
18508 gpittman 243
<dd><p>Output profile for printing. If possible, get some guidance from your printer on profile selection.</p></dd>
1003 subik 244
 
1006 cbradney 245
<dt><strong>profilei</strong> = &lt;member 'profilei' of 'PDFfile' objects&gt;</dt>
18508 gpittman 246
<dd><p>Embed a color profile for images. Bool value.</p></dd>
1003 subik 247
 
1006 cbradney 248
<dt><strong>profiles</strong> = &lt;member 'profiles' of 'PDFfile' objects&gt;</dt>
18508 gpittman 249
<dd><p>Embed a color profile for solid colors. Bool value.</p></dd>
1003 subik 250
 
1006 cbradney 251
<dt><strong>quality</strong> = &lt;member 'quality' of 'PDFfile' objects&gt;</dt>
20126 jghali 252
<dd><p>Image quality<br/>
253
 
254
1 - High<br/>
255
2 - Medium<br/>
256
3 - Low<br/>
18508 gpittman 257
4 - Minimum</p></dd>
1003 subik 258
 
19705 jghali 259
<dt><strong>registrationMarks</strong> = &lt;attribute 'registrationMarks' of 'PDFfile' objects&gt;</dt>
260
<dd><p>Add registration marks to each separation.</p></dd>
261
 
1006 cbradney 262
<dt><strong>resolution</strong> = &lt;attribute 'resolution' of 'PDFfile' objects&gt;</dt>
18508 gpittman 263
<dd><p>Resolution of output file. Values from 35 to 4000.</p></dd>
1003 subik 264
 
1006 cbradney 265
<dt><strong>solidpr</strong> = &lt;attribute 'solidpr' of 'PDFfile' objects&gt;</dt>
18508 gpittman 266
<dd><p>Color profile for solid colors</p></dd>
1003 subik 267
 
19705 jghali 268
<dt><strong>thumbnails</strong> = &lt;member 'thumbnails' of 'PDFfile' objects&gt;</dt>
269
<dd><p>Generate thumbnails. Bool value.</p></dd>
1003 subik 270
 
20092 jghali 271
<dt><strong>useDocBleeds</strong> = &lt;attribute 'useDocBleeds' of 'PDFfile' objects&gt;</dt>
19705 jghali 272
<dd><p>Use the existing bleed settings from the document preferences. Bool value.</p></dd>
273
 
274
<dt><strong>useLayers</strong> = &lt;attribute 'useLayers' of 'PDFfile' objects&gt;</dt>
275
<dd><p>Layers in your document are exported to the PDF. Only available with PDF >= 1.5.</p></dd>
276
 
1006 cbradney 277
<dt><strong>uselpi</strong> = &lt;member 'uselpi' of 'PDFfile' objects&gt;</dt>
18508 gpittman 278
<dd><p>Use Custom Rendering Settings. Bool value</p></dd>
1003 subik 279
 
1006 cbradney 280
<dt><strong>user</strong> = &lt;attribute 'user' of 'PDFfile' objects&gt;</dt>
18508 gpittman 281
<dd><p>User's password</p></dd>
1003 subik 282
 
1006 cbradney 283
<dt><strong>version</strong> = &lt;member 'version' of 'PDFfile' objects&gt;</dt>
20126 jghali 284
<dd><p>Choose PDF version to use:<br/>
285
11 = PDF/X-1a<br/>
286
12 = PDF/X-3<br/>
287
13 = PDF 1.3 (Acrobat 4)<br/>
288
14 = PDF 1.4 (Acrobat 5)<br/>
19705 jghali 289
15 = PDF 1.5 (Acrobat 6)</p></dd>
19746 jghali 290
 
18508 gpittman 291
</dl>
10646 cbradney 292
</body>
18507 gpittman 293
</html>