summaryrefslogtreecommitdiffstats
path: root/scribus/doc/fr/scripterapi-constants.html
blob: 60a6cde6ae88ae03fde1fbfb013759d1903a50cc (plain)
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
	<title>Constantes pr&eacute;d&eacute;finies</title>
</head>
<body>
<h2>Constantes pr&eacute;d&eacute;finies</h2>

<p>Des constantes sont d&eacute;finies pour aider &agrave; utiliser les commandes: </p>

<h4>Version Scribus :</h4>
	<p>L'interface de script fournit deux variables contenant la version
courante de Scribus dans le module <code>Scribus</code>. Les scripts peuvent utiliser ces variables pour v&eacute;rifier qu'ils tournent sous la bonne version de Scribus et pour informer l'utilisateur d'&eacute;ventuelles incompatibilit&eacute;s. Ces
deux variables, <code>scribus_version</code> et
<code>scribus_version_info</code>, ont &eacute;t&eacute; ajout&eacute;es dans les versions
1.2.1 et 1.3.0cvs et sont absentes des versions
pr&eacute;c&eacute;dentes. Si n&eacute;cessaire, vous pouvez v&eacute;rifier leur pr&eacute;sence avec <code>hasattr(scribus, 'scribus_version')</code>.</p>
	<p><code>scribus_version</code> est une cha&icirc;ne qui contient la version courante de Scribus. Sa valeur ressemble habituellement &agrave; <code>'1.2.1cvs'</code> ou <code>'1.3.0'</code>, par exemple, mais il n'est pas garanti que le format sera toujours le m&ecirc;me. Cette
variable est utile pour afficher la version &agrave; l'utilisateur, par exemple pour signaler une incompatibilit&eacute;. N'analysez pas et ne comparez pas cette variable, car <code>scribus_version_info</code> est fait pour cela.</p>
	<p><code>scribus_version_info</code> est un vecteur semblable au vecteur <code>sys.version_info</code> fourni par Python. 
C'est un vecteur de la forme (majorversion, minorversion, patchlevel,
extraversion, build), par exemple 1.2.1cvs correspond &agrave;
<code>(1,2,1,'cvs',0)</code> et 1.3.2 correspond &agrave; <code>(1,3,2,'',0)<code> . Ces vecteurs sont id&eacute;aux pour v&eacute;rifier les versions minimum, etc., parce que Python compare les vecteurs &eacute;l&eacute;ment par &eacute;l&eacute;ment, de gauche &agrave; droite. Par exemple :</p>
<pre>
if scribus.scribus_version_info[:3] &lt; (1,2,2):
    messageBox("Scribus - script Python",
        "Ce script requiert 1.2.2 ou plus r&eacute;cent."+\
        "Vous roulez %s." % scribus.scribus_version,
        ICON_CRITICAL)
    sys.exit()
</pre>

<h4>Constantes d'&eacute;num&eacute;ration d'unit&eacute;s : </h4>
<dl>
	<dt>UNIT_POINTS</dt>
	<dd>Unit&eacute; de mesure point = 0</dd>
	<dt>UNIT_MILLIMETERS</dt>
	<dd>Unit&eacute; de mesure millim&egrave;tre = 1</dd>
	<dt>UNIT_INCHES</dt>
	<dd>Unit&eacute; de mesure pouce = 2</dd>
	<dt>UNIT_PICAS</dt>
	<dd>Unit&eacute; de mesure pica = 3</dd>
</dl>

<h4>Constantes de conversion d'unit&eacute;s</h4>

<p>Ces facteurs de conversion peuvent &ecirc;tre utilis&eacute;s pour convertir les unit&eacute;s en points et vice versa.
Ainsi, pour convertir les pouces en points, il suffit d'&eacute;crire 'valeur/inch'; pour convertir les points en pouces vous &eacute;crirez 'valeur*inch', et pour convertir les pouces en mm vous &eacute;crirez 'valeur*mm/inch'.</p>

<dl>
	<dt>pt</dt>
	<dd>points dans 1 pt</dd>
	<dt>inch</dt>
	<dd>pouces dans 1 pt</dt>
	<dt>p</dt>
	<dt>pica dans 1 pt</dt>
	<dt>cm<dt>
	<dt>centim&egrave;tres dans 1 pt</dt>
	<dt>mm</dt>
	<dt>millim&egrave;tres dans 1 pt</dt>
	<dt>...</dt>
	<dt>D'autres constantes seront fournies si le coeur de Scribus les reconna&icirc;t.</dt>
</dl>

<h4>D&eacute;finitions d'orientation de page :</h4>
<dl>
	<dt>PORTRAIT</dt>
	<dd>Pageformat Portrait = 0</dd>
	<dt>LANDSCAPE</dt>
	<dd>Pageformat Landscape = 1</dd>
</dl>

<h4>R&eacute;glages de format de page : </h4>
<dl>
	<dt>PAPER_A0</dt>
	<dd>Paperformat A0 = 2380 x 3368 Points</dd>
	<dt>PAPER_A1</dt>
	<dd>Paperformat A1 = 1684 x 2380 Points</dd>
	<dt>PAPER_A2</dt>
	<dd>Paperformat A2 = 1190 x 1684 Points</dd>
	<dt>PAPER_A3</dt>
	<dd>Paperformat A3 = 842 x 1190 Points</dd>
	<dt>PAPER_A4</dt>
	<dd>Paperformat A4 = 595 x 842 Points</dd>
	<dt>PAPER_A5</dt>
	<dd>Paperformat A5 = 421 x 595 Points</dd>
	<dt>PAPER_A6</dt>
	<dd>Paperformat A6 = 297 x 421 Points</dd>
	<dt>PAPER_A7</dt>
	<dd>Paperformat A7 = 210 x 297 Points</dd>
	<dt>PAPER_A8</dt>
	<dd>Paperformat A8 = 148 x 210 Points</dd>
	<dt>PAPER_A9</dt>
	<dd>Paperformat A9 = 105 x 148 Points</dd>
	<dt>PAPER_B0</dt>
	<dd>Paperformat B0 = 2836 x 4008 Points</dd>
	<dt>PAPER_B1</dt>
	<dd>Paperformat B1 = 2004 x 2836 Points</dd>
	<dt>PAPER_B2</dt>
	<dd>Paperformat B2 = 1418 x 2004 Points</dd>
	<dt>PAPER_B3</dt>
	<dd>Paperformat B3 = 1002 x 1418 Points</dd>
	<dt>PAPER_B4</dt>
	<dd>Paperformat B4 = 709 x 1002 Points</dd>
	<dt>PAPER_B5</dt>
	<dd>Paperformat B5 = 501 x 709 Points</dd>
	<dt>PAPER_B6</dt>
	<dd>Paperformat B6 = 355 x 501 Points</dd>
	<dt>PAPER_B7</dt>
	<dd>Paperformat B7 = 250 x 355 Points</dd>
	<dt>PAPER_B8</dt>
	<dd>Paperformat B8 = 178 x 250 Points</dd>
	<dt>PAPER_B9</dt>
	<dd>Paperformat B9 = 125 x 178 Points</dd>
	<dt>PAPER_B10</dt>
	<dd>Paperformat B10 = 89 x 125 Points</dd>
	<dt>PAPER_C5E</dt>
	<dd>Paperformat C5E = 462 x 649 Points</dd>
	<dt>PAPER_COMM10E</dt>
	<dd>Paperformat Comm10E = 298 x 683 Points</dd>
	<dt>PAPER_DLE</dt>
	<dd>Paperformat DLE = 312 x 624 Points</dd>
	<dt>PAPER_EXECUTIVE</dt>
	<dd>Paperformat Executive = 542 x 720 Points</dd>
	<dt>PAPER_FOLIO</dt>
	<dd>Paperformat Folio = 595 x 935 Points</dd>
	<dt>PAPER_LEDGER</dt>
	<dd>Paperformat Ledger = 1224 x 792 Points</dd>
	<dt>PAPER_LEGAL</dt>
	<dd>Paperformat Legal = 612 x 1008 Points</dd>
	<dt>PAPER_LETTER</dt>
	<dd>Paperformat Letter = 612 x 792 Points</dd>
	<dt>PAPER_TABLOID</dt>
	<dd>Paperformat Tabloid = 792 x 1224 Points</dd>
</dl>

<h4>R&eacute;glages de la disposition du document :</h4>
<dl>
	<dt>FACINGPAGES</dt>
	<dd>Disposition avec des pages en regard.</dd>
	<dt>NOFACINGPAGES</dt>
	<dd>Disposition normale du document.</dd>
	<dt>FIRSTPAGELEFT</dt>
	<dd>La premi&egrave;re page du document est une page de droite.</dd>
	<dt>FIRSTPAGERIGHT</dt>
	<dd>La premi&egrave;re page du document est une premi&egrave;re de droite.</dd>
</dl>

<h4>R&eacute;glages d'alignement</h4>
<dl>
	<dt>ALIGN_LEFTK</dt>
	<dd>Le texte est align&eacute; &agrave; gauche.</dd>
	<dt>ALIGN_CENTERED</dt>
	<dd>Le texte est centr&eacute; dans le cadre de texte.</dd>
	<dt>ALIGN_RIGHT</dt>
	<dd>Le texte est align&eacute; sur le c&ocirc;t&eacute; droit du cadre de texte.</dd>
	<dt>ALIGN_FORCED</dt>
	<dd>Le texte a un alignement forc&eacute;.</dd>
  	<dt>ALIGN_BLOCK</dt>
	<dd>Le texte a un alignement bloqu&eacute;.</dd>
</dl>

<h4>R&eacute;glages relatifs aux lignes : </h4>
<dl>
    <dt>LINE_DASH</dt>
    <dt>LINE_DASHDOT</dt>
    <dt>LINE_DASHDOTDOT</dt>
    <dt>LINE_DOT</dt>
    <dt>LINE_SOLID</dt>
    <dt>JOIN_BEVEL</dt>
    <dt>JOIN_MITTER</dt>
    <dt>JOIN_ROUND</dt>
    <dt>CAP_FLAT</dt>
    <dt>CAP_ROUND</dt>
    <dt>CAP_SQUARE</dt>
</dl>

<h4>R&eacute;glages relatifs au fond : </h4>
<dl>
	<dt>FILL_NOG</dt>
    <dd>Pas de d&eacute;grad&eacute;, couleur unie</dd>
	<dt>FILL_HORIZONTALG</dt>
	<dt>FILL_VERTICALG</dt>
	<dt>FILL_DIAGONALG</dt>
	<dt>FILL_CROSSDIAGONALG</dt>
	<dt>FILL_RADIALG</dt>
</dl>

<h4>Boutons de dialogue</h4>
<dl>
    <dt>BUTTON_ABORT</dt>
    <dt>BUTTON_CANCEL</dt>
    <dt>BUTTON_IGNORE</dt>
    <dt>BUTTON_NO</dt>
    <dt>BUTTON_NONE</dt>
    <dt>BUTTON_OK</dt>
    <dt>BUTTON_RETRY</dt>
    <dt>BUTTON_YES</dt>
</dl>

<h4>Ic&ocirc;nes de dialogue</h4>
<dl>
    <dt>ICON_CRITICAL</dt>
    <dt>ICON_INFORMATION</dt>
    <dt>ICON_NONE</dt>
    <dt>ICON_WARNING</dt>
</dl>

</body>
</html>