Subversion Repositories Scribus

Rev

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

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