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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Python : module scribus</title>
</head>
<body>
<h2>Python : module scribus</h2>
<h1>Module d'interface Python de Scribus</h1>
<p>Ce module est l'interface Python de Scribus. Il intègre des fonctions pour contrôler Scribus et manipuler les objets sur le canevas. Chaque fonction est décrite séparément ci-dessous. Il existe quelques éléments qu'on retrouve dans la plupart des zones de l'interface. La majorité des fonctions opèrent sur des cadres. Ces cadres sont identifiés par leur nom (une chaîne) - ils ne sont pas de vrais objets Python. Beaucoup de fonctions acceptent un paramètre optionnel (autre qu'un mot clé), c'est-à-dire un nom de cadre. La plupart des fonctions prévoient aussi de nombreuses exceptions.
Celles-ci ne sont pas documentées, pour le moment, dans le docstring de chacune des fonctions. </p>
<ul>
<li> Beaucoup de fonctions génèrent une erreur NoDocOpenError si vous essayez de les utiliser sans un document à traiter.</li>
<li> Si vous ne passez pas un nom de cadre à une fonction qui en réclame un, cette fonction utilisera le cadre sélectionné, s'il y en a un, ou générera une erreur NoValidObjectError si elle ne trouve aucun élément à traiter.</li>
<li> Beaucoup de fonctions généreront une erreur WrongFrameTypeError si vous essayez de les utiliser dans un type de cadre qu'elles ne peuvent interpréter. Par
exemple, l'application d'une couleur de texte dans un cadre de graphiques produira cette exception.</li>
<li> Les erreurs résultant d'appels aux librairies sous-jacentes de l'API de Python seront passées sans subir de modifications. Ainsi, la
liste des exceptions générées par les fonctions qui est fournie ici et dans leur docstring est incomplète.</li>
</ul>
<p>La documentation des fonctions détaille chaque exception pouvant être générée en cours d'utilisation.</p>
<hr />
<h3>Modules</h3>
<h4>Classes</h4>
<ul>
<li>exceptions.Exception
<ul>
<li>ScribusException</li>
<li>NameExistsError</li>
<li>NoDocOpenError</li>
<li>NoValidObjectError</li>
<li>NotFoundError</li>
<li>WrongFrameTypeError</li>
</ul>
</li>
</ul>
<hr />
<table>
<tr>
<td>
<a name="NameExistsError">class <strong>NameExistsError</strong></a>(<a href="scribus.html#ScribusException">ScribusException</a>)
</td>
</tr>
<tr>
<td>
<dl>
<dt>Ordre de résolution des méthodes :</dt>
<dd><a href="scribus.html#NameExistsError">NameExistsError</a></dd>
<dd><a href="scribus.html#ScribusException">ScribusException</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
</dl>
</td>
</tr>
<tr>
<td>
Méthodes héritées de <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl>
<dt><a name="NameExistsError-__getitem__"><strong>__getitem__</strong></a>(...)</dt>
<dt><a name="NameExistsError-__init__"><strong>__init__</strong></a>(...)</dt>
<dt><a name="NameExistsError-__str__"><strong>__str__</strong></a>(...)</dt>
</dl>
</td>
</tr>
</table>
<hr />
<table>
<tr>
<td>
<a name="NoDocOpenError">class <strong>NoDocOpenError</strong></a>(<a href="scribus.html#ScribusException">ScribusException</a>)
</td>
</tr>
<tr>
<td width="100%">
<dl>
<dt>Ordre de résolution des méthodes :</dt>
<dd><a href="scribus.html#NoDocOpenError">NoDocOpenError</a></dd>
<dd><a href="scribus.html#ScribusException">ScribusException</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
</dl>
</td>
</tr>
<tr>
<td>
Méthodes héritées de <a href="exceptions.html#Exception">exceptions.Exception</a> :<br>
<dl>
<dt><a name="NoDocOpenError-__getitem__"><strong>__getitem__</strong></a>(...)</dt>
<dt><a name="NoDocOpenError-__init__"><strong>__init__</strong></a>(...)</dt>
<dt><a name="NoDocOpenError-__str__"><strong>__str__</strong></a>(...)</dt>
</dl>
</td>
</tr>
</table>
<hr />
<table>
<tr>
<td>
<a name="NoValidObjectError">class <strong>NoValidObjectError</strong></a>(<a href="scribus.html#ScribusException">ScribusException</a>)
</td>
</tr>
<tr>
<td>
<dl>
<dt>Ordre de résolution des méthodes :</dt>
<dd><a href="scribus.html#NoValidObjectError">NoValidObjectError</a></dd>
<dd><a href="scribus.html#ScribusException">ScribusException</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
</dl>
</td>
</tr>
<tr>
<td>
Méthodes héritées de <a href="exceptions.html#Exception">exceptions.Exception</a> :<br>
<dl>
<dt><a name="NoValidObjectError-__getitem__"><strong>__getitem__</strong></a>(...)</dt>
<dt><a name="NoValidObjectError-__init__"><strong>__init__</strong></a>(...)</dt>
<dt><a name="NoValidObjectError-__str__"><strong>__str__</strong></a>(...)</dt>
</dl>
</td>
</tr>
</table>
<hr />
<table>
<tr>
<td>
<a name="NotFoundError">class <strong>NotFoundError</strong></a>(<a href="scribus.html#ScribusException">ScribusException</a>)
</td>
</tr>
<tr>
<td>
<dl>
<dt>Ordre de résolution des méthodes :</dt>
<dd><a href="scribus.html#NotFoundError">NotFoundError</a></dd>
<dd><a href="scribus.html#ScribusException">ScribusException</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
</dl>
</td>
</tr>
<tr>
<td>
Méthodes héritées de <a href="exceptions.html#Exception">exceptions.Exception</a> :<br>
<dl>
<dt><a name="NotFoundError-__getitem__"><strong>__getitem__</strong></a>(...)</dt>
<dt><a name="NotFoundError-__init__"><strong>__init__</strong></a>(...)</dt>
<dt><a name="NotFoundError-__str__"><strong>__str__</strong></a>(...)</dt>
</dl>
</td>
</tr>
</table>
<hr />
<table>
<tr>
<td>
<a name="ScribusException">class <strong>ScribusException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)
</td>
</tr>
<tr>
<td>
Méthodes héritées de <a href="exceptions.html#Exception">exceptions.Exception</a> :<br>
<dl>
<dt><a name="ScribusException-__getitem__"><strong>__getitem__</strong></a>(...)</dt>
<dt><a name="ScribusException-__init__"><strong>__init__</strong></a>(...)</dt>
<dt><a name="ScribusException-__str__"><strong>__str__</strong></a>(...)</dt>
</dl>
</td>
</tr>
</table>
<hr />
<table>
<tr>
<td>
<a name="WrongFrameTypeError">class <strong>WrongFrameTypeError</strong></a>(<a href="scribus.html#ScribusException">ScribusException</a>)
</td>
</tr>
<tr>
<td>
<dl>
<dt>Ordre de résolution des méthodes :</dt>
<dd><a href="scribus.html#WrongFrameTypeError">WrongFrameTypeError</a></dd>
<dd><a href="scribus.html#ScribusException">ScribusException</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
</dl>
</td>
</tr>
<tr>
<td>
Méthodes héritées de <a href="exceptions.html#Exception">exceptions.Exception</a> :<br>
<dl>
<dt><a name="WrongFrameTypeError-__getitem__"><strong>__getitem__</strong></a>(...)</dt>
<dt><a name="WrongFrameTypeError-__init__"><strong>__init__</strong></a>(...)</dt>
<dt><a name="WrongFrameTypeError-__str__"><strong>__str__</strong></a>(...)</dt>
</dl>
</td>
</tr>
</table>
<hr />
<h3>Fonctions</h3>
<dl>
<dt><a name="-changeColor"><strong>changeColor</strong></a>(...)</dt>
<dd><code><a href="#-changeColor">changeColor</a>("nom", c, m, j, n)<br><br>Change la couleur "nom" pour la valeur CMJN spécifiée. La valeur de la couleur est définie par quatre composants c = Cyan, m = Magenta, j = Jaune et n = Noir. Ces composants de couleur doivent se situer entre 0 et 255.<br /><br>Peut générer <a href="#NotFoundError">NotFoundError</a> si la couleur nommée n'est pas trouvée.<br>Peut générer ValueError si le nom de couleur spécifié n'est pas valide.</code></dd>
<dt><a name="-closeDoc"><strong>closeDoc</strong></a>(...)</dt>
<dd><code><a href="#-closeDoc">closeDoc</a>()<br><br>Ferme le document courant sans invite de sauvegarde.<br><br>Peut générer <a href="#NoDocOpenError">NoDocOpenError</a> s'il n'y a pas de document à fermer</code></dd>
<dt><a name="-createBezierLine"><strong>createBezierLine</strong></a>(...)</dt>
<dd><code><a href="#-createBezierLine">createBezierLine</a>(liste, ["nom"]) -> chaîne<br><br>Crée une nouvelle courbe de Bézier et retourne son nom. Les points de la courbe de Bézier sont conservés dans la liste ("list") dans l'ordre suivant :<br>[x1, y1, kx1, ky1, x2, y2, kx2, ky2...xn. yn, kxn. kyn]<br>Dans la liste de points, x et y sont les coordonnées x et y du point et kx et ky représentent le point de contrôle de la courbe. Les coordonnées s'affichent dans les unités de mesure du document (voir les constantes UNIT). Le nom ("name") doit être un identifiant unique pour l'objet, car vous en aurez besoin accéder plus tard à cet objet. Si le nom "name" n'est pas fourni, Scribus en créera un pour vous.<br /><br>Peut générer <a href="#NameExistsError">NameExistsError</a> si vous passez explicitement un nom déjà utilisé.<br>Peut générer ValueError si le nombre de points précisé est insuffisant ou si le nombre de valeurs passées ne forme pas un groupe de points entier, sans reste.</code></dd>
<dt><a name="-createEllipse"><strong>createEllipse</strong></a>(...)</dt>
<dd><<code><a href="#-createEllipse">createEllipse</a>(x, y, largeur, hauteur, ["nom"]) -> chaîne<br><br>Crée une nouvelle ellipse dans la page courante et retourne son nom. Les coordonnées sont affichées dans les unités de mesure du document (voir les constantes UNIT). Le "name" doit être un identifiant unique parce que vous en aurez besoin pour des références futures à l'objet désigné. Si le "name" n'est pas fourni, Scribus en créera un pour vous.<br><br>Peut générer <a href="#NameExistsError">NameExistsError</a> si vous passez explicitement un nom déjà utilisé.</code></dd>
<dt><a name="-createImage"><strong>createImage</strong></a>(...)</dt>
<dd><code><a href="#-createImage">createImage</a>(x, y, largeur, hauteur, ["nom"]) -> chaîne<br><br>Crée un nouveau cadre d'image dans la page courante et retourne son nom. Les coordonnées sont affichées dans les unités de mesure du document. La valeur de "name" doit être un identifiant unique parce que vous en aurez besoin pour accéder plus tard à l'objet désigné. Si le "name" n'est pas fourni, Scribus en créera un pour vous.<br><br>Peut générer <a href="#NameExistsError">NameExistsError</a> si vous passez explicitement un nom déjà utilisé.</code></dd>
<dt><a name="-createLayer"><strong>createLayer</strong></a>(...)</dt>
<dd><code><a href="#-createLayer">createLayer</a>("nom")<br><br>Crée un nouveau calque portant le nom précisé.<br><br>Peut générer ValueError si le nom du calque n'est pas admis.</code></dd>
<dt><a name="-createLine"><strong>createLine</strong></a>(...)</dt>
<dd><code><a href="#-createLine">createLine</a>(x1, y1, x2, y2, ["nom"]) -> chaîne<br><br>Crée une nouvelle ligne à partir du point(x1, y1) et du point(x2, y2) et retourne son nom. Les coordonnées sont affichées dans les unités de mesure du document (voir les constantes UNIT). La valeur de "name" doit être un identifiant unique parce que vous en aurez besoin pour accéder plus tard à l'objet désigné. Si le "name" n'est pas fourni, Scribus en créera un pour vous.<br><br>Peut générer <a href="#NameExistsError">NameExistsError</a> si vous passez explicitement un nom déjà utilisé.</code></dd>
<dt><a name="-createPathText"><strong>createPathText</strong></a>(...)</dt>
<dd><code><a href="#-createPathText">createPathText</a>(x, y, "boiteTexte", "courbeBezier", ["nom"]) -> chaîne<br><br>Crée un nouveau pathText en combinant les deux objets "boîte de texte" et "courbe de Bézier", puis retourne son nom. Les coordonnées sont affichées dans les unités de mesure du document (voir les constantes UNIT). La valeur de "name" doit être un identifiant unique parce que vous en aurez besoin pour accéder plus tard à l'objet désigné. Si le "name" n'est pas fourni, Scribus en créera un pour vous.<br><br>Peut générer <a href="#NameExistsError">NameExistsError</a> si vous passez explicitement un nom déjà utilisé.<br>Peut générer <a href="#NotFoundError">NotFoundError</a> si l'un des objets de base (ou les deux) n'existent pas.</code></dd>
<dt><a name="-createPolyLine"><strong>createPolyLine</strong></a>(...)</dt>
<dd><code><a href="#-createPolyLine">createPolyLine</a>(liste, ["nom"]) -> chaîne<br> <br>Crée un nouveau polyline et retourne son nom. Les points de l'élément polyline sont conservés dans la "liste", dans l'ordre suivant : [x1, y1, x2, y2...xn. yn]. Les coordonnées s'affichent dans les unités de mesure du document (voir les constantes UNIT). Le nom ("name") doit être un identifiant unique pour l'objet, car vous en aurez besoin accéder plus tard à cet objet. Si le nom "name" n'est pas fourni, Scribus en créera un pour vous.<br><br>Peut générer <a href="#NameExistsError">NameExistsError</a> si vous passez explicitement un nom déjà utilisé.<br>Peut générer ValueError si le nombre de points précisé est insuffisant ou si le nombre de valeurs passées ne forme pas un groupe de points entier, sans reste.</code></dd>
<dt><a name="-createPolygon"><strong>createPolygon</strong></a>(...)</dt>
<dd><code><a href="#-createPolygon">createPolygon</a>(liste, ["nom"]) -> chaîne<br><br>Crée un nouveau polygone et retourne son nom. Les points du polygone sont conservés dans la "liste", dans l'ordre suivant: [x1, y1, x2, y2...xn. yn]. Au moins trois points sont requis. Il n'est pas nécessaire de répéter le premier point pour fermer le polygone. Le polygone se ferme automatiquement avec la connexion du premier et du dernier point. Les coordonnées sont données dans les unités de mesure du document (voir les constantes UNIT). La valeur de "name" doit être un identifiant unique parce que vous en aurez besoin pour accéder plus tard à l'objet désigné. Si le "name" n'est pas fourni, Scribus en créera un pour vous.<br /><br>Peut générer <a href="#NameExistsError">NameExistsError</a> si vous passez explicitement un nom déjà utilisé.<br>Peut générer ValueError si le nombre de points est insuffisant ou si<br>le nombre de valeurs passées ne forme pas un groupe de points sans reste.</code></dd>
<dt><a name="-createRect"><strong>createRect</strong></a>(...)</dt>
<dd><code><a href="#-createRect">createRect</a>(x, y, largeur, hauteur, ["nom"]) -> chaîne<br><br>Crée un nouveau rectangle dans la page courante et retourne son nom. Les coordonnées sont données dans les unités de mesure du document (voir les constantes UNIT). Le "name" doit être un identifiant unique parce que vous en aurez besoin pour des références futures à l'objet désigné. Si le nom "name" n'est pas fourni, Scribus en créera un pour vous.<br><br>Peut générer <a href="#NameExistsError">NameExistsError</a> si vous passez explicitement un nom déjà utilisé.</code></dd>
<dt><a name="-createText"><strong>createText</strong></a>(...)</dt><dd><code><a href="#-createText">createText</a>(x, y, largeur, hauteur, ["nom"]) -> chaîne<br><br>Crée un nouveau cadre de texte dans la page courante et retourne son nom. Les coordonnées sont données dans les unités de mesure du document (voir les constantes UNIT). La valeur de "name" doit être un identifiant unique parce que vous en aurez besoin pour accéder plus tard à l'objet désigné. Si le "name" n'est pas fourni, Scribus en créera un pour vous.<br><br>Peut générer <a href="#NameExistsError">NameExistsError</a> si vous passez explicitement un nom déjà utilisé.</code></dd>
<dt><a name="-currentPage"><strong>currentPage</strong></a>(...)</dt>
<dd><code><a href="#-currentPage">currentPage</a>() -> nombre entier<br><br>Retourne le numéro de la page de travail courante. Les numéros de page sont incrémentés à partir de 1, peu importe quel est le premier numéro de page affiché dans votre document.</code></dd>
<dt><a name="-defineColor"><strong>defineColor</strong></a>(...)</dt>
<dd><code><a href="#-defineColor">defineColor</a>("nom", c, m, j, n)<br><br>Définit une nouvelle couleur "nom". La valeur de la couleur est définie par quatre composants :<br>c = Cyan, m = Magenta, j = Jaune et n = Noir. Les composants de la couleur doivent se situer entre 0 et 255.<br><br>Peut générer ValueError si le nom de couleur spécifié n'est pas valide.</code></dd>
<dt><a name="-deleteColor"><strong>deleteColor</strong></a>(...)</dt>
<dd><code><a href="#-deleteColor">deleteColor</a>("nom", "remplacement")<br><br>Supprime la couleur "nom". Chaque occurrence de cette couleur est remplacée par la couleur dite de "remplacement". Si elle n'est pas spécifiée, "remplacement" prendra par défaut la valeur "none" - transparente.<br><br>deleteColor s'applique au document par défaut s'il n'y a pas de document ouvert. Dans ce cas, le "remplacement", si spécifié, n'a pas d'effet.<br><br>Peut générer <a href="#NotFoundError">NotFoundError</a> si la couleur nommée n'est pas trouvée.<br>Peut générer ValueError si le nom de couleur spécifié n'est pas valide.</code></dd>
<dt><a name="-deleteLayer"><strong>deleteLayer</strong></a>(...)</dt>
<dd><code><a href="#-deleteLayer">deleteLayer</a>("calque")<br><br>Supprime le calque portant le nom "calque". Sans effet si le calque n'existe pas ou s'il n'y a qu'un seul calque dans le document.<br><br>Peut générer <a href="#NotFoundError">NotFoundError</a> si le calque est introuvable. <br>Peut générer ValueError si le nom du calque n'est pas admis.</code></dd>
<dt><a name="-deleteObject"><strong>deleteObject</strong></a>(...)</dt>
<dd><code><a href="#-deleteObject">deleteObject</a>(["nom"])<br><br>Supprime l'élément portant le nom "nom". Si le "nom" n'est pas fourni, l'élément courant est supprimé.</code></dd>
<dt><a name="-deletePage"><strong>deletePage</strong></a>(...)</dt>
<dd><code><a href="#-deletePage">deletePage</a>(nr)<br><br>Supprime la page donnée. Sans effet si le document contient seulement une page. Les numéros de page sont incrémentés à partir de 1, peu importe le premier numéro de page affiché dans votre document.<br><br>Peut générer IndexError si le numéro de page est hors limites</code></dd>
<dt><a name="-deleteText"><strong>deleteText</strong></a>(...)</dt>
<dd><code><a href="#-deleteText">deleteText</a>(["nom"])<br><br>Supprime le texte dans le cadre de texte "nom". S'il y a du texte sélectionné, seul ce texte sera supprimé. Si le "nom" n'est pas fourni, l'élément sélectionné courant est utilisé.</code></dd>
<dt><a name="-deselectAll"><strong>deselectAll</strong></a>(...)</dt>
<dd><code><a href="#-deselectAll">deselectAll</a>()<br><br>Désélectionne tous les objets du document au complet.</code></dd>
<dt><a name="-docChanged"><strong>docChanged</strong></a>(...)</dt>
<dd><code><a href="#-docChanged">docChanged</a>(bool)<br><br>Active/désactive l'icône enregistrer dans la barre d'icônes de Scribus et dans l'élément de menu Enregistrer. Il est utile d'appeler cette procédure lorsque vous changez de document, parce que Scribus ne remarquera pas automatiquement un changement de document en utilisant un script.</code></dd>
<dt><a name="-fileDialog"><strong>fileDialog</strong></a>(...)</dt><dd><code><a href="#-fileDialog">fileDialog</a>("titre", ["filtre", "nomDefaut" ,possedeApercu, estEnregistrer]) -> chaîne associée au nom du fichier<br><br>Affiche une boîte de dialogue Ouvrir un fichier portant le titre "titre". Les fichiers sont filtrés par la chaîne "filtre". Vous pouvez aussi donner un nom de fichier ou un chemin par défaut, mais laissez cette chaîne vide lorsque vous ne voulez pas l'utiliser. Une valeur True pour possedeApercu déclenche l'affichage d'une vue réduire dans la boîte FileSelect. Quand le paramètre estEnregistrer est mis à True, le dialogue se comporte comme un dialogue "Enregistrer sous", sinon il se comporte comme un dialogue "Ouvrir". La valeur par défaut de ces deux paramètres optionnels est False.<br><br>Le filtre, si spécifié, prend la forme 'commentaire (*.type *.type2 ...)'.<br>Par exemple 'Images (*.png *.xpm *.jpg)'.<br><br>Reportez-vous à la documentation de QFileDialog dans Qt pour plus de détails sur les filtres.<br><br>Exemple : <a href="#-fileDialog">fileDialog</a>('Ouvrir', 'CSV files (*.csv)')<br>Exemple : <a href="#-fileDialog">fileDialog</a>('Enregistrer le rapport', nomdefaut='report.txt', estenregistrer=True)</code></dd>
<dt><a name="-getActiveLayer"><strong>getActiveLayer</strong></a>(...)</dt>
<dd>c<code><a href="#-getActiveLayer">getActiveLayer</a>() -> chaîne<br><br>Retourne le nom du calque actif courant.</code></dd>
<dt><a name="-getAllObjects"><strong>getAllObjects</strong></a>(...)</dt>
<dd><code><a href="#-getAllObjects">getAllObjects</a>() -> liste<br><br>Retourne une liste contenant les noms de tous les objets de la page courante.</code></dd>
<dt><a name="-getAllStyles"><strong>getAllStyles</strong></a>(...)</dt>
<dd><code><a href="#-getAllStyles">getAllStyles</a>() -> liste<br><br>Retourne une liste des noms de tous les styles de paragraphe du document courant.</code></dd>
<dt><a name="-getAllText"><strong>getAllText</strong></a>(...)</dt>
<dd><code><a href="#-getAllText">getAllText</a>(["nom"]) -> chaîne<br><br>Retourne le texte d'un cadre de texte "nom" et de tous les cadres de texte qui sont y liés. Si du texte est sélectionné dans ce cadre, il est retourné. Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getColor"><strong>getColor</strong></a>(...)</dt>
<dd><code><a href="#-getColor">getColor</a>("nom") -> vecteur<br><br>Retourne un vecteur (C, M, J, N) contenant les quatre composants de la couleur "nom" du document courant. Si aucun document n'est ouvert, retourne la valeur de la couleur nommée à partir des couleur du document par défaut.<br><br>Peut générer <a href="#NotFoundError">NotFoundError</a> si la couleur nommée est introuvable.<br>Peut générer ValueError si le nom de couleur spécifié n'est pas valide.</code></dd>
<dt><a name="-getColorAsRGB"><strong>getColorAsRGB</strong></a>(...)</dt>
<dd><code><a href="#-getColorAsRGB">getColorAsRGB</a>("nom") -> vecteur</code>
<p>Retourne un vecteur (R,V,B) contenant les trois composantes de la couleur "nom" du document courant, converties à l'espace de couleur RVB. Si aucun document n'est ouvert, retourne la valeur de la couleur nommée à partir des couleur du document par défaut.</p>
<p>Peut générer NotFoundError si la couleur nommée est introuvable. Peut générer ValueError si le nom de couleur spécifié n'est pas valide.</p></dd>
<dt><a name="-getColorNames"><strong>getColorNames</strong></a>(...)</dt>
<dd><code><a href="#-getColorNames">getColorNames</a>() -> liste<br><br>Retourne une liste contenant les noms de toutes les couleurs définies dans le document. Si aucun document n'est ouvert, retourne une liste des couleurs du document par défaut.</code></dd>
<dt><a name="-getColumnGap"><strong>getColumnGap</strong></a>(...)</dt>
<dd><code><a href="#-getColumnGap">getColumnGap</a>(["nom"]) -> réel<br><br>Retourne la taille de la gouttière de colonne dans le cadre de texte "nom", exprimé en points. Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getColumns"><strong>getColumns</strong></a>(...)</dt>
<dd><code><a href="#-getColumns">getColumns</a>(["nom"]) -> nombre entier<br><br>Donne le nombre de colonnes du cadre de texte "nom". Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getCornerRadius"><strong>getCornerRadius</strong></a>(...)</dt>
<dd><code><a href="#-getCornerRadius">getCornerRadius</a>(["nom"]) -> nombre entier<br><br>Retourne le rayon du coin de l'objet "nom". Le rayon est exprimé en points. Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getFillColor"><strong>getFillColor</strong></a>(...)</dt>
<dd><code><a href="#-getFillColor">getFillColor</a>(["nom"]) -> chaîne<br><br>Retourne le nom de la couleur d'accompagnement de l'objet "nom". Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getFillShade"><strong>getFillShade</strong></a>(...)</dt>
<dd><code><a href="#-getFillShade">getFillShade</a>(["nom"]) -> entier<br><br>Retourne la valeur de la teinte de la couleur d'accompagnement de l'objet "nom". Si "nom" n'est pas fourni, l'élément sélectionné courant est utilisé.</code></dd>
<dt><a name="-getFont"><strong>getFont</strong></a>(...)</dt>
<dd><code><a href="#-getFont">getFont</a>(["nom"]) -> chaîne<br><br>Retourne le nom la police pour le cadre de texte "nom". Si le cadre contient du texte sélectionné, la valeur assignée au premier caractère de la sélection est retourné. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getFontNames"><strong>getFontNames</strong></a>(...)</dt>
<dd><code><a href="#-getFontNames">getFontNames</a>() -> liste<br /><br>Retourne une liste contenant les noms de toutes les polices disponibles.</code></dd>
<dt><a name="-getFontSize"><strong>getFontSize</strong></a>(...)</dt>
<dd><code><a href="#-getFontSize">getFontSize</a>(["nom"]) -> réel<br><br>Retourne la taille, en points, de la police du cadre de texte "nom". Si ce cadre contient du texte sélectionné, la valeur assignée au premier caractère de la sélection est retournée. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getGuiLanguage"><strong>getGuiLanguage</strong></a>(...)</dt>
<dd><code><a href="#-getGuiLanguage">getGuiLanguage</a>() -> chaîne<br><br>Retourne une contenant la valeur de -lang.</code></dd>
<dt><a name="-getHGuides"><strong>getHGuides</strong></a>(...)</dt>
<dd><code><a href="#-getHGuides">getHGuides</a>() -> liste<br><br>Retourne une liste contenant les positions des guides horizontaux. Les valeurs sont affichées dans les unités courantes du document - voir les constantes UNIT_<type>.</code></dd>
<dt><a name="-getImageFile"><strong>getImageFile</strong></a>(...)</dt>
<dd><code>getImageName(["nom"]) -> chaîne<br><br>Retourne le nom de fichier de l'image du cadre d'image. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getImageScale"><strong>getImageScale</strong></a>(...)</dt>
<dd><code><a href="#-getImageScale">getImageScale</a>(["nom"]) -> (x,y)<br><br>Retourne un vecteur (x, y) contenant les valeurs de redimensionnement du cadre d'image "nom". Si "nom" n'est pas fourni, l'élément sélectionné courant est utilisé.</code></dd>
<dt><a name="-getLayers"><strong>getLayers</strong></a>(...)</dt>
<dd><code><a href="#-getLayers">getLayers</a>() -> liste<br><br>Retourne une liste contenant les noms de tous les calques définis.</code></dd>
<dt><a name="-getLineCap"><strong>getLineCap</strong></a>(...)</dt>
<dd><code>getLineEnd(["nom"]) -> nombre entier (voir les constantes)<br><br>Retourne le style de bout de ligne de l'objet "nom". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. Les styles de bout de ligne sont :<br>CAP_FLAT, CAP_ROUND, CAP_SQUARE</code></dd>
<dt><a name="-getLineColor"><strong>getLineColor</strong></a>(...)</dt>
<dd><code><a href="#-getLineColor">getLineColor</a>(["nom"]) -> chaîne<br><br>Retourne le nom de la couleur de filet de l'objet "nom". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getLineJoin"><strong>getLineJoin</strong></a>(...)</dt>
<dd><code><a href="#-getLineJoin">getLineJoin</a>(["nom"]) -> nombre entier (voir les constantes)<br><br>Retourne le style de jointure de filet de l'objet "nom". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. Les types de jointure sont :<br>JOIN_BEVEL, JOIN_MITTER, JOIN_ROUND</code></dd>
<dt><a name="-getLineShade"><strong>getLineShade</strong></a>(...)</dt>
<dd><code><a href="#-getLineShade">getLineShade</a>(["nom"]) -> entier<br><br>Retourne la valeur de la teinte de la couleur de filet de l'objet "nom". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getLineSpacing"><strong>getLineSpacing</strong></a>(...)</dt>
<dd><code><a href="#-getLineSpacing">getLineSpacing</a>(["nom"]) -> réel<br><br>Retourne l'espacement de ligne ("leading") du cadre de texte "nom", exprimé en points. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getLineStyle"><strong>getLineStyle</strong></a>(...)</dt>
<dd><code><a href="#-getLineStyle">getLineStyle</a>(["nom"]) -> nombre entier (voir les constantes)<br><br>Retourne le style de filet de l'objet "nom". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. Les constantes de style de filet sont :<br />LINE_DASH, LINE_DASHDOT, LINE_DASHDOTDOT, LINE_DOT, LINE_SOLID</code></dd>
<dt><a name="-getLineWidth"><strong>getLineWidth</strong></a>(...)</dt>
<dd><code><a href="#-getLineWidth">getLineWidth</a>(["nom"]) -> nombre entier<br><br>Retourne la largeur de filet de l'objet "nom". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getPageItems"><strong>getPageItems</strong></a>(...)</dt>
<dd><code><a href="#-getPageItems">getPageItems</a>() -> liste<br><br>Retourne une liste de vecteurs contenant les éléments de la page courante. Le vecteur est :<br>(nom, typeObjet, ordre), par exemple [('Texte1', 4, 0), ('Image1', 2, 1)]<br>signifie que l'objet nommé 'Texte1' est un cadre de texte (type 4) et est le premier dans<br>la page...</code></dd>
<dt><a name="-getPageMargins"><strong>getPageMargins</strong></a>(...)</dt>
<dd><code><a href="#-getPageMargins">getPageMargins</a>()<br><br>Retourne les marges de la page sous la forme d'un vecteur (gauche, droite, haut, bas) dans les unités courantes. Voir les constantes UNIT_<type> et <a href="#-getPageSize">getPageSize</a>().</code></dd>
<dt><a name="-getPageSize"><strong>getPageSize</strong></a>(...)</dt>
<dd><code><a href="#-getPageSize">getPageSize</a>() -> vecteur<br><br>Retourne un vecteur contenant les dimensions de la page exprimées dans les unités courantes du document.<br>Voir les constantes UNIT_<type> et <a href="#-getPageMargins">getPageMargins</a>()</code></dd>
<dt><a name="-getPosition"><strong>getPosition</strong></a>(...)</dt>
<dd><code><a href="#-getPosition">getPosition</a>(["nom"]) -> (x,y)<br><br>Retourne un vecteur (x, y) indiquant la position de l'objet "nom". Si le "nom" n'est pas fourni,
l'élément sélectionnéest utilisé. La position est exprimée dans les unités de mesure courantes du document - voir UNIT_<type> pour référence.</code></dd>
<dt><a name="-getRotation"><strong>getRotation</strong></a>(...)</dt>
<dd><code><a href="#-getRotation">getRotation</a>(["nom"]) -> nombre entier<br><br>Retourne la rotation de l'objet "nom". La valeur est exprimée en degrés, et le sens des aiguilles d'une montre correspond au sens positif. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getSelectedObject"><strong>getSelectedObject</strong></a>(...)</dt>
<dd><code><a href="#-getSelectedObject">getSelectedObject</a>([nr]) -> chaîne<br><br>Retourne le nom de l'objet sélectionné. "nr", s'il est fourni, indique le numéro de l'objet sélectionné, par exemple 0 signifie le premier objet sélectionné, 1, le second objet sélectionné et ainsi de suite.</code></br></dd>
<dt><a name="-getSize"><strong>getSize</strong></a>(...)</dt>
<dd><code><a href="#-getSize">getSize</a>(["nom"]) -> (largeur,hauteur)<br><br>Retourne un vecteur (largeur, hauteur) décrivant la taille de l'objet "nom". Si le "nom" n'est pas fourni,
l'élément sélectionnéest utilisé. La taille est exprimée dans les unités de mesure courantes du document - voir UNIT_<type> pour référence.</code></dd>
<dt><a name="-getText"><strong>getText</strong></a>(...)</dt>
<dd><code><a href="#-getText">getText</a>(["nom"]) -> chaîne<br><br>Retourne le texte du cadre de texte "nom". Si ce cadre de texte contient du texte sélectionné, celui-ci est retourné. Tout le texte présent dans le cadre, et non seulement le texte visible, est retourné. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getTextColor"><strong>getTextColor</strong></a>(...)</dt>
<dd><code><a href="#-getLineColor">getLineColor</a>(["nom"]) -> chaîne<br><br>Retourne le nom de la couleur de filet de l'objet "nom". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getTextLength"><strong>getTextLength</strong></a>(...)</dt>
<dd><code><a href="#-getTextLength">getTextLength</a>(["nom"]) -> nombre entier<br><br>Retourne la longueur du texte dans le cadre de texte "nom". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getTextShade"><strong>getTextShade</strong></a>(...)</dt>
<dd><code><a href="#-getLineShade">getLineShade</a>(["nom"]) -> nombre entier<br><br>Retourne la valeur de la teinte de la couleur de filet de l'objet "nom". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-getUnit"><strong>getUnit</strong></a>(...)</dt>
<dd><code><a href="#-getUnit">getUnit</a>() -> nombre entier (constante d'unité de Scribus)<br><br>Retourne les unités de mesure du document. La valeur retournée sera une des constantes UNIT_* constants :<br>UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS.</code></dd>
<dt><a name="-getVGuides"><strong>getVGuides</strong></a>(...)</dt>
<dd><code><a href="#-getVGuides">getVGuides</a>()<br><br>Voir getHGuides.</code></dd>
<dt><a name="-getXFontNames"><strong>getXFontNames</strong></a>(...)</dt>
<dd><code><a href="#-getXFontNames">getXFontNames</a>() -> liste de vecteurs<br><br>Retourne une information détaillée sur la police. Il s'agit d'une liste de vecteurs :<br>[ (nom Scribus, Famille, Nom réel, sous-ensemble (1|0), PS inclus PS (1|0), fichier de police), (...), ... ]</code></dd>
<dt><a name="-getval"><strong>getval</strong></a>(...)</dt>
<dd><code>Interne à Scribus.</code></dd>
<dt><a name="-gotoPage"><strong>gotoPage</strong></a>(...)</dt>
<dd><code><a href="#-gotoPage">gotoPage</a>(nr)<br><br>Déplace à la page "nr" (la page courante devient "nr"). Notez que gotoPage ne modifie pas (actuellement) la page affichée dans la vue de l'utilisateur; ce paramètre établit simplement la page sur laquelle les commandes du script opéreront.<br><br>Peut générer IndexError si le numéro de page est hors limites.</code></dd>
<dt><a name="-groupObjects"><strong>groupObjects</strong></a>(...)</dt>
<dd><code><a href="#-groupObjects">groupObjects</a>(liste)<br><br>Groupe les objets énumérés dans "liste". La "liste" doit contenir les noms des objets à grouper. Si la "liste" n'est pas fournie, les éléments sélectionnés sont utilisés.</code></dd>
<dt><a name="-haveDoc"><strong>haveDoc</strong></a>(...)</dt>
<dd><code><a href="#-haveDoc">haveDoc</a>() -> booléen<br><br>Retourne la valeur "true" s'il y a un document ouvert.</code></dd>
<dt><a name="-insertText"><strong>insertText</strong></a>(...)</dt>
<dd><code><a href="#-insertText">insertText</a>("texte", pos, ["nom"])<br><br>Insère le "texte" à la position "pos" dans le cadre de texte. Le texte doit être encodé en UTF (voir <a href="#-setText">setText</a>() comme référence). Le premier caractère a un index de 0. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.<br><br>Peut générer IndexError dans le cas d'une insertion hors limites.</code></dd>
<dt><a name="-isLayerPrintable"><strong>isLayerPrintable</strong></a>(...)</dt>
<dd><code><a href="#-isLayerPrintable">isLayerPrintable</a>("calque") -> booléen<br><br>Indique si le "calque" est imprimable ou non; une valeur True signifie que le "calque" peut être imprimé et une valeur False, que l'impression est désactivée.<br><br>Peut générer <a href="#NotFoundError">NotFoundError</a> si le calque est introuvable. <br>Peut générer ValueError si le nom du calque n'est pas valide.</code></dd>
<dt><a name="-isLayerVisible"><strong>isLayerVisible</strong></a>(...)</dt>
<dd><code><a href="#-isLayerPrintable">isLayerPrintable</a>("calque") -> booléen<br><br>Indique si le "calque" est visible ou non; une valeur True signifie que le "calque" est visible, une valeur False signifie que le "calque" est invisible.<br><br>Peut générer <a href="#NotFoundError">NotFoundError</a> si le calque est introuvable. <br>Peut générer ValueError si le nom du calque n'est pas valide.</code></dd>
<dt><a name="-isLocked"><strong>isLocked</strong></a>(...)</dt>
<dd><code><a href="#-isLocked">isLocked</a>(["nom"]) -> booléen<br><br>Retourne la valeur True si l'objet "nom" est vérouillé. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-isPDFBookmark"><strong>isPDFBookmark</strong></a>(...)</dt>
<dd><code><a href="#-isPDFBookmark">isPDFBookmark</a>(["nom"]) -> booléen</code>
<p>Retourne la valeur True si le cadre de texte "nom" est un signet PDF. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. </p>
<p>Peut générer WrongFrameTypeError si le cadre cible n'est pas un cadre de texte.</p></dd>
<dt><a name="-linkTextFrames"><strong>linkTextFrames</strong></a>(...)</dt>
<dd><code><a href="#-linkTextFrames">linkTextFrames</a>("nomDepart", "nomArrivee")<br><br>Établit un lien entre deux cadres de texte. Le cadre nommé "nomDepart" est lié au cadre "nomArrivee". Le cadre cible doit être un cadre de texte vide et ne doit pas pointer vers d'autres cadres ni porter un lien provenant d'autres cadres.<br /><br>Peut
générer <a href="#ScribusException">ScribusException</a> en cas d'infraction des règles de liens. </code></dd>
<dt><a name="-loadImage"><strong>loadImage</strong></a>(...)</dt>
<dd><code><a href="#-loadImage">loadImage</a>("nomFichier" [, "nom"])<br><br>Charge l'image "nomFichier" dans le cadre d'image "nom". Si "nom" n'est pas fourni, l'élément sélectionné est utilisé. <br /><br>Peut générer <a href="#WrongFrameTypeError">WrongFrameTypeError</a> si le cadre cible n'est pas un cadre d'image</br></dd>
<dt><a name="-loadStylesFromFile"><strong>loadStylesFromFile</strong></a>(...)</dt>
<dd><code><a href="#-loadStylesFromFile">loadStylesFromFile</a>("nomFichier")<br><br>Charge des styles de paragraphe à partir du document Scribus "nomFichier" dans le document courant.</code></dd>
<dt><a name="-lockObject"><strong>lockObject</strong></a>(...)</dt>
<dd><code><a href="#-lockObject">lockObject</a>(["nom"]) -> booléen<br><br>Verrouille l'objet "nom" s'il est déverrouillé, ou le déverrouille s'il y a lieu. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. Retourne la valeur True si verrouillé.</code></dd>
<dt><a name="-messageBox"><strong>messageBox</strong></a>(...)</dt>
<dd><code><a href="#-messageBox">messageBox</a>("titre", "message", icone=ICON_NONE, bouton1=BUTTON_OK|BUTTONOPT_DEFAULT, bouton2=BUTTON_NONE, bouton3=BUTTON_NONE) -> nombre entier<br><br>Affiche une boîte de message contenant le "titre", le message "message", une icône "icone" et jusqu'à 3 boutons. Par défaut, aucune icône n'est utilisée et un seul bouton, OK, est affiché. Seuls les arguments titre et message sont requis, mais on recommande de définir une icône et un ou plusieurs boutons appropriés. Le message texte peut contenir des marqueurs de type HTML simples.<br /> <br>Retourne le numéro du bouton que l'utilisateur a enfoncé. Les numéros de boutons commencent à 1.<br><br>Pour les paramètres d'icône et de bouton, certaines constantes prédéfinies sont disponibles et portent les mêmes noms que dans la documentation Qt. Ce sont les constantes BUTTON_* et ICON_* définies dans ce module. Il y a également deux constantes supplémentaires qui peuvent être combinées par un OU aux constantes de bouton :<br>
BUTTONOPT_DEFAULT Appuyer sur Entrée enfonce ce bouton.<br>
BUTTONOPT_ESCAPE Appuyer sur Esc enrfonce ce bouton.<br>
<br>
Exemples d'utilisation :<br>
result = <a href="#-messageBox">messageBox</a>('Le script a échoué',<br>
'Ce script fonctionne seulement lorsqu'un cadre de texte est sélectionné.',<br>
ICON_ERROR)<br>
result = <a href="#-messageBox">messageBox</a>('Singes!'Qu'est-ce qui fait ook?<i>C'est le singe?</i>',<br>
ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT,<br>
BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE)<br>
<br>
Constantes de bouton et d'icône définies :<br>
BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO,<br>
BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL,<br>
ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL.</code></dd>
<dt><a name="-messagebarText"><strong>messagebarText</strong></a>(...)</dt><dd><code><a href="#-messagebarText">messagebarText</a>("chaîne")<br>
<br>
Écrit "chaîne" dans la barre de message de Scribus (ligne d'état). Le texte<br>
doit être encodé en une chaîne UTF8 ou en une chaîne 'unicode' (recommandé).</code></dd></dl>
<dt><a name="-moveObject"><strong>moveObject</strong></a>(...)</dt><dd><code><a href="#-moveObject">moveObject</a>(dx, dy [, "nom"])<br>
<br>
Déplace l'objet "nom" de dx et dy par rapport à sa position courante. Les<br>
distances sont exprimées dans les unités de mesure courantes du document (voir<br>
les constantes UNIT). Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. <br>
Si l'objet "nom" appartient à un groupe, tout le groupe est déplacé.</code></dd></dl>
<dt><a name="-moveObjectAbs"><strong>moveObjectAbs</strong></a>(...)</dt><dd><code><a href="#-moveObjectAbs">moveObjectAbs</a>(x, y [, "nom"])<br>
<br>
Déplace l'objet "nom" à une nouvelle position. Les coordonnées sont exprimées dans<br>
les unités de mesure courantes du document (voir les constantes UNIT). Si "nom"<br>
n'est pas fourni, l'élément sélectionné courant est utilisé. Si l'objet "nom"<br>
appartient à un groupe, tout le groupe est déplacé.</code></dd></dl>
<dt><a name="-newDoc"><strong>newDoc</strong></a>(...)</dt><dd><code><a href="#-newDoc">newDoc</a>(taille, marges, orientation, numeroPremierePage,<br>
unite, pagesRegard, premierePageGauche) -> booléen<br>
<br>
Crée un nouveau document et retourne la valeur True si l'opération réussit. Les paramètres ont la<br>
signification suivante :<br>
<br>
taille = un vecteur (largeur, hauteur) décrivant la taille du document. Vous pouvez<br>
utiliser des constantes prédéfinies nommées PAPER_<paper_type> c'est-à-dire PAPER_A4 etc.<br>
<br>
marges = un vecteur (gauche, droite, haut, bas) décrivant les marges du<br>
document<br>
<br>
orientation = l'orientation de la page - constantes PORTRAIT, LANDSCAPE<br>
<br>
numeroPremierePage = est le numéro de la première page dans le document utilisé<br>
pour pagenumbering. Même si habituellement vous choisirez la valeur 1, il est utile d'avoir<br>
de plus grands nombres si vous créez un document en plusieurs parties.<br>
<br>
unité = cette valeurs définit les unités de mesure utilisées par le document. Utilisez une<br>
constante prédéfinie pour cela, parmi les suivantes : UNIT_INCHES, UNIT_MILLIMETERS,<br>
UNIT_PICAS, UNIT_POINTS.<br>
<br>
pagesRegard = FACINGPAGES, NOFACINGPAGES<br>
<br>
premierPageGauche = FIRSTPAGELEFT, FIRSTPAGERIGHT<br>
<br>
Les valeurs établies pour la largeur, la hauteur et les marges sont exprimées dans les unités choisies<br>
pour le document. Les constantes PAPER_* sont exprimées en points. Si votre document<br>
n'est pas défini en points, assurez-vous d'en tenir compte.<br>
<br>
exemple : <a href="#-newDoc">newDoc</a>(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 1, UNIT_POINTS,<br>
FACINGPAGES, FIRSTPAGERIGHT)</code></dd></dl>
<dt><a name="-newDocDialog"><strong>newDocDialog</strong></a>(...)</dt><dd><code><a href="#-newDocDialog">newDocDialog</a>() -> booléen<br>
<br>
Affiche la boîte dialogue "Nouveau document". Crée un nouveau document si l'utilisateur accepte les paramètres. Ne crée pas de document si l'utilisateur appuie sur Annuler. Retourne la valeur True si un nouveau document a été créé.</code></dd>
<dt><a name="-newPage"><strong>newPage</strong></a>(...)</dt>
<dd><code><a href="#-newPage">newPage</a>(lieu [,"modèle"])<br><br>Crée une nouvelle page. Si "lieu" est à -1, la nouvelle page est ajoutée à la fin du document, sinon la nouvelle page est insérée avant "lieu". Les numéros de page sont incrémentés à partir de 1, peu importe le premier numéro de page affiché dans votre document. Le
paramètre optionnel "modèle" spécifie le nom du gabarit pour la nouvelle page.<br><br>Peut générer IndexError si le numéro de page est hors limites</code></dd>
<dt><a name="-objectExists"><strong>objectExists</strong></a>(...)</dt>
<dd><code><a href="#-objectExists">objectExists</a>(["nom"]) -> booléen<br><br>Teste si un objet avec le nom spécifié existe réellement dans le document. Le paramètre optionnel est le nom de l'objet. Lorsqu'aucun nom d'objet n'est donné, retourne la valeur True si un élément est sélectionné.</code></dd>
<dt><a name="-openDoc"><strong>openDoc</strong></a>(...)</dt>
<dd><code><a href="#-openDoc">openDoc</a>("nom")<br><br>Ouvre le document "nom".<br> <br>Peut générer ScribusError si le document ne peut pas être ouvert.</code></dd>
<dt><a name="-pageCount"><strong>pageCount</strong></a>(...)</dt>
<dd><code><a href="#-pageCount">pageCount</a>() -> entier<br><br>Retourne le nombre de pages dans le document.</code></dd>
<dt><a name="-pageDimension"><strong>pageDimension</strong></a>(...)</dt>
<dd><code><a href="#-getPageSize">getPageSize</a>() -> vecteur<br><br>Retourne un vecteur précisant les dimensions de la page mesurées dans les unités courantes du document.<br>Voir les constantes UNIT_<type> et <a href="#-getPageMargins">getPageMargins</a>()</code></dd>
<dt><a name="-progressReset"><strong>progressReset</strong></a>(...)</dt>
<dd><code><a href="#-progressReset">progressReset</a>()<br><br>Élimine les réglages précédents de la barre de progression de Scribus. La fonction est appelée avant l'utilisation de la
nouvelle barre de progression. Voir progressSet.</code></dd>
<dt><a name="-progressSet"><strong>progressSet</strong></a>(...)</dt>
<dd><code><a href="#-progressSet">progressSet</a>(nr)<br><br>Établit la position de la barre de progression à "nr", , c'est-à-dire une valeur relative à la valeur précédente de progressTotal. La
barre de progression utilise le concept d'étapes; il suffit d'indiquer le nombre total d'étapes et le nombre d'étapes déjà effectuées, puis la fonction affichera le pourcentage d'avancement. Vous pouvez spécifier le nombre total d'étapes avec <a href="#-progressTotal">progressTotal</a>(). Le nombre courant d'étapes est indiqué avec <a href="#-progressSet">progressSet</a>(). La barre de progression peut être remise à zéro avec <a href="#-progressReset">progressReset</a>(). [compte tenu de l'information provenant de la documentation QT de Trolltech]</code></dd>
<dt><a name="-progressTotal"><strong>progressTotal</strong></a>(...)</dt>
<dd><code><a href="#-progressTotal">progressTotal</a>(max)<br><br>Établit le nombre maximal d'étapes de la barre de progression au nombre spécifié. Voir progressSet.</code></dd>
<dt><a name="-redrawAll"><strong>redrawAll</strong></a>(...)</dt>
<dd><code><a href="#-redrawAll">redrawAll</a>()<br><br>Redessine toutes les pages.</code></dd>
<dt><a name="-renderFont"><strong>renderFont</strong></a>(...)</dt>
<dd><code>renderFont("nom", "nomFichier", "example", taille, format="PPM") -> booléen</code>
<p>Crée un aperçu image de la police "nom" avec le texte "exemple" et la taille "taille". L'image est enregistrée dans "nomFichier". Retourne la valeur True si l'opération réussit. L'argument optionnel "format" spécifie le format de l'image à générer et supporte tout format admis par QPixmap.save(). Les
formats courants sont PPM, JPEG, PNG et XPM.</p>
<p>Peut générer <a href="scripterapi.html#NotFoundError">NotFoundError</a> si la police spécifiée n'est pas trouvée. Peut générer ValueError si un "example" ou un "nomFichier" vide est passé.</p></dd></dl>
<dt><a name="-replaceColor"><strong>replaceColor</strong></a>(...)</dt>
<dd><code><a href="#-replaceColor">replaceColor</a>("nom", "remplacement")<br><br>Chaque occurrence de la couleur "nom" est remplacée par la couleur "remplacement".<br><br>Peut générer <a href="#NotFoundError">NotFoundError</a> si une couleur nommée n'est pas trouvée.<br>Peut générer ValueError si un nom de couleur invalide est spécifié.</code></dd>
<dt><a name="-retval"><strong>retval</strong></a>(...)</dt>
<dd><code>Interne à Scribus.</code></dd>
<dt><a name="-rotateObject"><strong>rotateObject</strong></a>(...)</dt>
<dd><code><a href="#-rotateObject">rotateObject</a>(rot [, "nom"])<br><br>Fait pivoter l'objet "nom" de la valeur "rot" en degrés relatifs. La rotation est activée par le sommet
sélectionné comme point de rotation - par défaut, le sommet en haut à gauche est le point de zéro rotation. Les valeurs positives signifient une rotation dans le sens des aiguilles d'une montre, lorsque le point de rotation par défaut est utilisé. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-rotateObjectAbs"><strong>rotateObjectAbs</strong></a>(...)</dt>
<dd><code><a href="#-rotateObjectAbs">rotateObjectAbs</a>(rot [, "nom"])<br><br>Établit la rotation de l'objet "nom" à "rot". Des valeurs positives signifient
une rotation dans le sens des aiguilles d'une montre. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-saveDoc"><strong>saveDoc</strong></a>(...)</dt>
<dd><code><a href="#-saveDoc">saveDoc</a>()<br><br>Enregistre le document ouvert sous son nom courant, et retourne la valeur True si l'opération réussit. Si le document
n'a pas déjà été enregistré, le système peut afficher le dialogue interactif Enregistrer sous.<br><br>Si l'enregistrement
échoue, il n'y a actuellement aucun moyen de le savoir.</code></dd>
<dt><a name="-saveDocAs"><strong>saveDocAs</strong></a>(...)</dt><dd><code><a href="#-saveDocAs">saveDocAs</a>("nom")<br><br>Enregistre le document courant sous le nouveau "nom" (qui peut être un chemin complet ou relatif).<br><br>Peut générer ScribusError si l'enregistrement échoue.</code></dd>
<dt><a name="-savePageAsEPS"><strong>savePageAsEPS</strong></a>(...)</dt>
<dd><code><a href="#-savePageAsEPS">savePageAsEPS</a>("nom")<br><br>Enregistre la page courante comme EPS dans le fichier "nom".<br><br>Peut générer ScribusError si l'enregistrement échoue.</code></dd>
<dt><a name="-scaleGroup"><strong>scaleGroup</strong></a>(...)</dt>
<dd><code><a href="#-scaleGroup">scaleGroup</a>(facteur [,"nom"])<br><br>Redimensionne le groupe auquel l'objet "nom" appartient. Les valeurs supérieures à 1 agrandissent le groupe, les valeurs inférieures à 1 rendent le groupe plus petit, par exemple une valeur de 0.5 redimensionne le groupe à 50 % de sa taille originale, tandis qu'une valeur de 1.5 redimensionne le groupe à 150 % de sa taille originale. La valeur de "facteur" doit être supérieure à 0. Si le "nom" n'est pas fourni, l'élément sélectionné courant est utilisé.<br><br>Peut générer ValueError si le facteur de redimensionnement n'est pas valide.</code></dd>
<dt><a name="-scaleImage"><strong>scaleImage</strong></a>(...)</dt>
<dd><code><a href="#-scaleImage">scaleImage</a>(x, y [, "nom"])<br><br>Définit les facteurs de redimensionnement de l'image dans le cadre d'image "nom". Si le "nom" n'est
pas fourni, l'élément sélectionné est utilisé. Un nombre de 1 signifie 100 %.<br><br>Peut générer <a href="#WrongFrameTypeError">WrongFrameTypeError</a> si le cadre cible n'est pas un cadre d'image.</code></dd>
<dt><a name="-selectObject"><strong>selectObject</strong></a>(...)</dt><dd><code><a href="#-selectObject">selectObject</a>("nom")<br><br>Sélectionne l'objet avec le nom "nom".</code></dd>
<dt><a name="-selectText"><strong>selectText</strong></a>(...)</dt>
<dd><code><a href="#-selectText">selectText</a>(depart, compte, ["nom"])<br><br>Sélectionne le nombre ("compte") de caractères
de texte dand le cadre de texte "nom" en partant du caractère "départ". Le comptage des caractères commence à 0. Si "compte" est à zéro, tout le texte sera effacé. Si le "nom"
n'est pas fourni, l'élément sélectionné est utilisé. <br><br>Peut générer IndexError si la sélection dépasse les limites du texte.</code></dd>
<dt><a name="-selectionCount"><strong>selectionCount</strong></a>(...)</dt>
<dd><code><a href="#-selectionCount">selectionCount</a>() -> entier<br><br>Retourne le nombre d'objets sélectionnés.</code></dd>
<dt><a name="-sentToLayer"><strong>sentToLayer</strong></a>(...)</dt>
<dd><code><a href="#-sentToLayer">sentToLayer</a>("calque" [, "nom"])<br><br>Envoie l'objet "nom" au calque "calque". Le calque doit exister. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. <br><br>Peut générer <a href="#NotFoundError">NotFoundError</a> si le calque est introuvable. <br>Peut générer ValueError si le nom du calque n'est pas valide. </code></dd>
<dt><a name="-setActiveLayer"><strong>setActiveLayer</strong></a>(...)</dt>
<dd><code><a href="#-setActiveLayer">setActiveLayer</a>("nom")<br><br>Rend actif le calque nommé "nom".<br><br>Peut générer <a href="#NotFoundError">NotFoundError</a> si le calque est introuvable. <br>Peut générer ValueError si le nom du calque n'est pas valide.</code></dd>
<dt><a name="-setColumnGap"><strong>setColumnGap</strong></a>(...)</dt>
<dd><code><a href="#-setColumnGap">setColumnGap</a>(taille, ["nom"])<br><br>Établit la gouttière de colonne du cadre de texte "nom" à la valeur "taille". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. <br><br>Peut générer ValueError si la gouttière de colonne est hors limites (elle doit être positive).</code></dd>
<dt><a name="-setColumns"><strong>setColumns</strong></a>(...)</dt>
<dd><code><a href="#-setColumns">setColumns</a>(nr, ["nom"])<br><br>Établit le nombre de colonnes du cadre de texte "nom" à la valeur entière "nr". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. <br><br>Peut générer ValueError si le nombre de colonnes n'est pas au moins égal à un.</code></dd>
<dt><a name="-setCornerRadius"><strong>setCornerRadius</strong></a>(...)</dt>
<dd><code><a href="#-setCornerRadius">setCornerRadius</a>(rayon, ["nom"])<br><br>Établit le rayon de coin de l'objet "nom". Le rayon est exprimé en points. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. <br><br>Peut générer ValueError si le rayon de coin est négatif.</code></dd>
<dt><a name="-setCursor"><strong>setCursor</strong></a>(...)</dt>
<dd><code><a href="#-setCursor">setCursor</a>()<br><br>[NON SUPPORTÉ !] Cette fonction peut créer des dommages, donc évitez de l'utiliser.</code></dd>
<dt><a name="-setDocType"><strong>setDocType</strong></a>(...)</dt><dd><code><a href="#-setDocType">setDocType</a>(pagesRegard, premierePageGauche)<br>
<br>Assigne le type de document. Pour obtenir des pages en regard, mettez le premier paramètre à FACINGPAGES; pour désactiver facingPages, utilisez NOFACINGPAGES à la place. Si vous voulez que la première page soit à gauche, mettez le deuxième paramètre à FIRSTPAGELEFT; pour une première page à droite, utilisez FIRSTPAGERIGHT.</code></dd>
<dt><a name="-setFillColor"><strong>setFillColor</strong></a>(...)</dt>
<dd><code><a href="#-setFillColor">setFillColor</a>("couleur", ["nom"])<br><br>Établit la couleur de fond de l'objet "nom" à la couleur "couleur". La "couleur" est le nom d'une des couleurs définies. Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-setFillShade"><strong>setFillShade</strong></a>(...)</dt>
<dd><code><a href="#-setFillShade">setFillShade</a>(teinte, ["nom"])<br><br>Établit la teinte de la couleur de fond de l'objet "nom" à "teinte". La "teinte" doit être
une valeur entière entre 0 (le plus pâle) et 100 (toute l'intensité couleur). Si "nom" n'est pas fourni, l'élément sélectionné est utilisé. Peut générer ValueError si la couleur de fond est hors limites.</code></dd>
<dt><a name="-setFont"><strong>setFont</strong></a>(...)</dt>
<dd><code><a href="#-setFont">setFont</a>("police", ["nom"])<br><br>Assigne la police du cadre de texte "nom" à la "police". S'il y a du texte sélectionné, seul ce texte sera modifié. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. <br><br>Peut générer ValueError si la police est introuvable. </code></dd>
<dt><a name="-setFontSize"><strong>setFontSize</strong></a>(...)</dt>
<dd><code><a href="#-setFontSize">setFontSize</a>(police, ["nom"])<br><br>Établit la taille de police du cadre de texte "nom" à la valeur "taille". La "taille" est traitée comme une valeur en points. S'il y a du texte sélectionné, seul ce texte sera modifié. La "taille" doit être réglée entre 1 et 512. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. <br><br>Peut générer ValueError pour une taille de police qui est hors limites.</code></dd>
<dt><a name="-setGradientFill"><strong>setGradientFill</strong></a>(...)</dt><dd><code><a href="#-setGradientFill">setGradientFill</a>(type, "couleur1", teinte1, "couleur2", teinte2, ["nom"])<br><br>Établit le dégradé de fond de l'objet "nom" à "type". Les descriptions des couleurs sont identiques à celles de <a href="#-setFillColor">setFillColor</a>() et de<a href="#-setFillShade">setFillShade</a>(). Voir les constantes pour les types disponibles (FILL_<type>).</code></dd>
<dt><a name="-setHGuides"><strong>setHGuides</strong></a>(...)</dt>
<dd><code><a href="#-setHGuides">setHGuides</a>(liste)<br><br>Établit les guides horizontaux. Le paramètre en entrée doit être une liste de positions de guide
exprimées dans les unités courantes du document - voir les constantes UNIT_<type>.<br><br>Exemple : <a href="#-setHGuides">setHGuides</a>(<a href="#-getHGuides">getHGuides</a>() + [200.0, 210.0] # ajoute de nouveaux guides sans en perdre aucun<br>
<a href="#-setHGuides">setHGuides</a>([90,250]) # remplace la totalité des guides courants</code></dd>
<dt><a name="-setInfo"><strong>setInfo</strong></a>(...)</dt>
<dd><code><a href="#-saveDocAs">saveDocAs</a>("auteur", "info", "description") -> booléen<br><br>Établit l'information relative au document. "Auteur", "Info", "Description" sont des chaînes.</code></dd>
<dt><a name="-setLayerPrintable"><strong>setLayerPrintable</strong></a>(...)</dt><dd><code><a href="#-setLayerPrintable">setLayerPrintable</a>("calque", imprimable)<br><br>Autorise ou non l'impression du "calque". Si la valeur "imprimable" est à False, le calque ne sera pas imprimé.<br><br>Peut générer <a href="#NotFoundError">NotFoundError</a> si le calque est introuvable. <br>Peut générer ValueError si le nom du calque n'est pas valide.</code></dd>
<dt><a name="-setLayerVisible"><strong>setLayerVisible</strong></a>(...)</dt><dd><code><a href="#-setLayerVisible">setLayerVisible</a>("calque", visible)<br><br>Affiche ou masque le "calque". Si "visible" prend la valeur False, le calque est invisible.<br> <br>Peut générer <a href="#NotFoundError">NotFoundError</a> si le calque est introuvable. <br>Peut générer ValueError si le nom du calque n'est pas valide. </code></dd>
<dt><a name="-setLineCap"><strong>setLineCap</strong></a>(...)</dt>
<dd><code>setLineEnd(typeFin, ["nom"])<br><br>Établit la valeur de style "typeFin" pour le bout de ligne de l'objet "nom".<br>Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. Il y a des constantes prédéfinies pour "typeFin" - CAP_<type>.</code></dd>
<dt><a name="-setLineColor"><strong>setLineColor</strong></a>(...)</dt>
<dd><code><a href="#-setLineColor">setLineColor</a>("couleur", ["nom"])<br><br>Établit la valeur "couleur" pour le filet de l'objet "nom". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-setLineJoin"><strong>setLineJoin</strong></a>(...)</dt>
<dd><code><a href="#-setLineJoin">setLineJoin</a>(jonction, ["nom"])<br><br>Établit la valeur du style "jonction# pour le filet de l'objet "nom". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. Il y a des constantes prédéfinies pour "jonction" - JOIN_<type>.</code></dd>
<dt><a name="-setLineShade"><strong>setLineShade</strong></a>(...)</dt>
<dd><code><a href="#-setLineShade">setLineShade</a>(teinte, ["nom"])<br><br>Établit la valeur "teinte" pour la couleur de filet de l'objet "nom". La valeur de "teinte" doit être un nombre entier entre 0 (pâle) et 100 (intensité maximale). Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. <br><br>Peut générer ValueError si la teinte du filet est hors limites.</code></dd>
<dt><a name="-setLineSpacing"><strong>setLineSpacing</strong></a>(...)</dt><dd><code><a href="#-setLineSpacing">setLineSpacing</a>(taille, ["nom"])<br><br>Établit la valeur "taille" pour l'interlignage ("leading") du cadre de texte "nom". La
"taille" est une valeur en points. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. <br><br>Peut générer ValueError si l'interlignage est hors limites.</code></dd>
<dt><a name="-setLineStyle"><strong>setLineStyle</strong></a>(...)</dt>
<dd><code><a href="#-setLineStyle">setLineStyle</a>(style, ["nom"])<br><br>Établit la valeur "style" pour le filet de l'objet "nom". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. Il y a des constantes prédéfinies pour "style" - LINE_<style>.</code></dd>
<dt><a name="-setLineWidth"><strong>setLineWidth</strong></a>(...)</dt>
<dd><code><a href="#-setLineWidth">setLineWidth</a>(épaisseur, ["nom"])<br><br>Établit la valeur "épaisseur" pour le filet de l'objet "nom". La valeur "épaisseur" doit être entre 0.0 et 12.0 inclusivement, exprimée en points. Si "nom" n'est pas fourni, l'élément sélectionné courant est utilisé. <br><br>Peut générer ValueError si l'épaisseur de filet est hors limites.</code></dd>
<dt><a name="-setMargins"><strong>setMargins</strong></a>(...)</dt>
<dd><code><a href="#-setMargins">setMargins</a>(gr, dr, hr, br)<br><br>Établit les marges du document, les marges gauche(gr), droite(dr), haut(hr) et bas(br) sont indiquées dans les unités de mesure du document - voir les constantesUNIT_<type>.</code></dd>
<dt><a name="-setMultiLine"><strong>setMultiLine</strong></a>(...)</dt>
<dd><code><a href="#-setMultiLine">setMultiLine</a>("styleNomme", ["nom"])<br><br>Établit la valeur "styleNomme" pour le style de filet de l'objet "nom". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. <br/><br/>Peut générer <a href="#NotFoundError">NotFoundError</a> si le style de filet n'existe pas.</code></dd>
<dt><a name="-setPDFBookmark"><strong>setPDFBookmark</strong></a>(...)</dt>
<dd><code><a href="#-setPDFBookmark">setPDFBookmark</a>("toggle", ["nom"])</code>
<p>Définit si le cadre de texte "nom" est un signet (toggle = 1) ou non. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. </p>
<p>Peut générer WrongFrameTypeError si le cadre cible n'est pas un cadre de texte.</p></dd>
<dt><a name="-setRedraw"><strong>setRedraw</strong></a>(...)</dt>
<dd><code><a href="#-setRedraw">setRedraw</a>(bool)<br><br>Désactive le rafraîchissement d'écran quand bool = False, sinon le rafraîchissement est activé. Comme ce changement garde son effet après la fin du script, vous devez appeler <a href="#-setRedraw">setRedraw</a>(True) dans une clause finally: au début de votre script.</code></dd>
<dt><a name="-setScaleImageToFrame"><strong>setScaleImageToFrame</strong></a>(...)</dt>
<dd><code><a href="#-setScaleImageToFrame">setScaleImageToFrame</a>(redimAuCadre, proportionnel=None, nom=<selection>)</code>
<p>Établit le mode de redimensionnement par rapport au cadre d'image sélectionné, ou spécifié dans 'redimAuCadre'. Si 'proportionnel' est spécifié, établit le redimensionnement en maintenant des proportions fixes. 'redimAuCadre' et 'proportionnel' sont booléens.</p>
<p>Peut générer WrongFrameTypeError.</p></dd>
<dt><a name="-setStyle"><strong>setStyle</strong></a>(...)</dt>
<dd><code><a href="#-setStyle">setStyle</a>("style" [, "nom"])<br><br>Établit le "style" désigné à l'objet "nom". Si aucun objet n'est fourni, le style est appliqué à l'objet sélectionné.</code></dd>
<dt><a name="-setText"><strong>setText</strong></a>(...)</dt>
<dd><code><a href="#-setText">setText</a>("texte", ["nom"])<br><br>Établit la chaîne "texte" pour contenu du cadre de texte "nom". Le texte doit être encodé en UTF8 - utilisez par exemple Unicode(texte, 'iso-8859-2'). Voir les FAQ pour plus de détails. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-setTextAlignment"><strong>setTextAlignment</strong></a>(...)</dt>
<dd><code><a href="#-setTextAlignment">setTextAlignment</a>(alignement, ["nom"])<br><br>Établit la valeur spécifiée pour l'alignement du contenu du cadre de texte "nom". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé. La valeur "alignement" doit être une des constantes ALIGN_ définies dans ce module - voir dir(scribus).<br><br>Peut générer ValueError si la constante d'alignement n'est pas valide.</code></dd>
<dt><a name="-setTextColor"><strong>setTextColor</strong></a>(...)</dt>
<dd><code><a href="#-setTextColor">setTextColor</a>("couleur", ["nom"])<br /><br>Établit la "couleur" du contenu du cadre de texte "nom". S'il y a du texte sélectionné, seul ce texte sera modifié. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-setTextShade"><strong>setTextShade</strong></a>(...)</dt>
<dd><code><a href="#-setTextShade">setTextShade</a>(teinte, ["nom"])<br><br>Établit la valeur "teinte" pour la couleur du texte de l'objet "nom". S'il y a du texte sélectionné, seul cetexte sera modifié. La valeur "teinte" doit être un nombre entier compris entre 0 (pâle) et 100 (intensité maximale). Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-setTextStroke"><strong>setTextStroke</strong></a>(...)</dt>
<dd><code><a href="#-setTextStroke">setTextStroke</a>("couleur", ["nom"])<br><br>Établit la "couleur" au contour des caractères. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-setUnit"><strong>setUnit</strong></a>(...)</dt>
<dd><code><a href="#-setUnit">setUnit</a>(unite)<br><br>Change l'unité de mesure du document. Les valeurs possibles de l'"unité" sont définies par les constantes UNIT_<type>.<br> <br>Peut générer ValueError si l'unité passée n'est pas valide.</code></dd>
<dt><a name="-setVGuides"><strong>setVGuides</strong></a>(...)</dt>
<dd><code><a href="#-setVGuides">setVGuides</a>()<br><br>Voir setHGuides.</code></dd>
<dt><a name="-sizeObject"><strong>sizeObject</strong></a>(...)</dt>
<dd><code><a href="#-sizeObject">sizeObject</a>(largeur, hauteur [, "nom"])<br><br>Redimensionne l'objet "nom" à la largeur et à la hauteur données. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-statusMessage"><strong>statusMessage</strong></a>(...)</dt>
<dd><code><a href="#-messagebarText">messagebarText</a>("chaîne")<br><br>Écrit "chaîne" dans la barre de message de Scribus (ligne d'état). Le texte doit être encodé en UTF8 ou en une chaîne 'unicode' (recommandé).</code></dd>
<dt><a name="-textFlowsAroundFrame"><strong>textFlowsAroundFrame</strong></a>(...)</dt>
<dd><code><a href="#-textFlowsAroundFrame">textFlowsAroundFrame</a>("nom" [, état])<br> <br>Active ou désactive l'"habillage" (le texte défile autour de l'objet) pour l'objet "nom". Appelé
avec les paramètres chaîne "nom" et le booléen optionnel "état". Si "état" n'est pas passé, cette fonctionnalité change de valeur (activée si inactive ou désactivée si active).</code></dd>
<dt><a name="-traceText"><strong>traceText</strong></a>(...)</dt>
<dd><code><a href="#-traceText">traceText</a>(["nom"])<br><br>Convertit le cadre de texte "nom" en contours. Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-unGroupObject"><strong>unGroupObject</strong></a>(...)</dt>
<dd><code>unGroupObjects("nom")<br><br>Détruit le groupe auquel appartient l'objet "nom". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.</code></dd>
<dt><a name="-unlinkTextFrames"><strong>unlinkTextFrames</strong></a>(...)</dt><dd>
<code><a href="#-unlinkTextFrames">unlinkTextFrames</a>("nom")<br><br>Retire l'objet désigné de la séquence de liens du cadre de texte. Si le cadre se trouvait au milieu d'une chaîne de liens, les cadres précédent et suivant seront connectés, par exemple 'a->b->c' devient 'a->c' lorsque vous déconnectez <a href="#-unlinkTextFrames">unlinkTextFrames</a>(b)'<br><br>Peut
générer <a href="#ScribusException">ScribusException</a> en cas d'infraction des règles de liens. </code></dd>
<dt><a name="-valueDialog"><strong>valueDialog</strong></a>(...)</dt><dd><code><a href="#-valueDialog">valueDialog</a>(titre, message [,valeurDefaut]) -> chaîne<br> <br>Affiche la boîte de dialogue "Demande d'une chaîne" et retourne la valeur recherchée sous la forme d'une chaîne<br>Paramètres : titre de la fenêtre, texte dans la fenêtre et une valeur par 'défaut' optionnelle.<br> <br>Exemple : <a href="#-valueDialog">valueDialog</a>('titre', 'texte dans la fenêtre', 'optionnel')</code></dd>
</dl>
<hr />
<h3>Données</h3>
<strong>ALIGN_BLOCK</strong> = 4<br>
<strong>ALIGN_CENTERED</strong> = 1<br>
<strong>ALIGN_FORCED</strong> = 4<br>
<strong>ALIGN_LEFT</strong> = 0<br>
<strong>ALIGN_RIGHT</strong> = 2<br>
<strong>Abort</strong> = 5<br>
<strong>BUTTON_ABORT</strong> = 5<br>
<strong>BUTTON_CANCEL</strong> = 2<br>
<strong>BUTTON_IGNORE</strong> = 7<br>
<strong>BUTTON_NO</strong> = 4<br>
<strong>BUTTON_NONE</strong> = 0<br>
<strong>BUTTON_OK</strong> = 1<br>
<strong>BUTTON_RETRY</strong> = 6<br>
<strong>BUTTON_YES</strong> = 3<br>
<strong>BevelJoin</strong> = 64<br>
<strong>CAP_FLAT</strong> = 0<br>
<strong>CAP_ROUND</strong> = 32<br>
<strong>CAP_SQUARE</strong> = 16<br>
<strong>Cancel</strong> = 2<br>
<strong>Centered</strong> = 1<br>
<strong>Critical</strong> = 3<br>
<strong>CrossDiagonalGradient</strong> = 4<br>
<strong>DashDotDotLine</strong> = 5<br>
<strong>DashDotLine</strong> = 4<br>
<strong>DashLine</strong> = 2<br>
<strong>DiagonalGradient</strong> = 3<br>
<strong>DotLine</strong> = 3<br>
<strong>FACINGPAGES</strong> = 1<br>
<strong>FILL_CROSSDIAGONALG</strong> = 4<br>
<strong>FILL_DIAGONALG</strong> = 3<br>
<strong>FILL_HORIZONTALG</strong> = 1<br>
<strong>FILL_NOG</strong> = 0<br>
<strong>FILL_RADIALG</strong> = 5<br>
<strong>FILL_VERTICALG</strong> = 2<br>
<strong>FIRSTPAGELEFT</strong> = 1<br>
<strong>FIRSTPAGERIGHT</strong> = 0<br>
<strong>FacingPages</strong> = 1<br>
<strong>FirstPageLeft</strong> = 1<br>
<strong>FirstPageRight</strong> = 0<br>
<strong>FlatCap</strong> = 0<br>
<strong>Forced</strong> = 4<br>
<strong>HorizontalGradient</strong> = 1<br>
<strong>ICON_CRITICAL</strong> = 3<br>
<strong>ICON_INFORMATION</strong> = 1<br>
<strong>ICON_NONE</strong> = 0<br>
<strong>ICON_WARNING</strong> = 2<br>
<strong>Ignore</strong> = 7<br>
<strong>Inches</strong> = 2<br>
<strong>Information</strong> = 1<br>
<strong>JOIN_BEVEL</strong> = 64<br>
<strong>JOIN_MITTER</strong> = 0<br>
<strong>JOIN_ROUND</strong> = 128<br>
<strong>LANDSCAPE</strong> = 1<br>
<strong>LINE_DASH</strong> = 2<br>
<strong>LINE_DASHDOT</strong> = 4<br>
<strong>LINE_DASHDOTDOT</strong> = 5<br>
<strong>LINE_DOT</strong> = 3<br>
<strong>LINE_SOLID</strong> = 1<br>
<strong>Landscape</strong> = 1<br>
<strong>LeftAlign</strong> = 0<br>
<strong>Millimeters</strong> = 1<br>
<strong>MiterJoin</strong> = 0<br>
<strong>NOFACINGPAGES</strong> = 0<br>
<strong>No</strong> = 4<br>
<strong>NoButton</strong> = 0<br>
<strong>NoFacingPages</strong> = 0<br>
<strong>NoGradient</strong> = 0<br>
<strong>NoIcon</strong> = 0<br>
<strong>Ok</strong> = 1<br>
<strong>PAPER_A0</strong> = (2380.0, 3368.0)<br>
<strong>PAPER_A1</strong> = (1684.0, 2380.0)<br>
<strong>PAPER_A2</strong> = (1190.0, 1684.0)<br>
<strong>PAPER_A3</strong> = (842.0, 1190.0)<br>
<strong>PAPER_A4</strong> = (595.0, 842.0)<br>
<strong>PAPER_A5</strong> = (421.0, 595.0)<br>
<strong>PAPER_A6</strong> = (297.0, 421.0)<br>
<strong>PAPER_A7</strong> = (210.0, 297.0)<br>
<strong>PAPER_A8</strong> = (148.0, 210.0)<br>
<strong>PAPER_A9</strong> = (105.0, 148.0)<br>
<strong>PAPER_B0</strong> = (2836.0, 4008.0)<br>
<strong>PAPER_B1</strong> = (2004.0, 2836.0)<br>
<strong>PAPER_B10</strong> = (89.0, 125.0)<br>
<strong>PAPER_B2</strong> = (1418.0, 2004.0)<br>
<strong>PAPER_B3</strong> = (1002.0, 1418.0)<br>
<strong>PAPER_B4</strong> = (709.0, 1002.0)<br>
<strong>PAPER_B5</strong> = (501.0, 709.0)<br>
<strong>PAPER_B6</strong> = (355.0, 501.0)<br>
<strong>PAPER_B7</strong> = (250.0, 355.0)<br>
<strong>PAPER_B8</strong> = (178.0, 250.0)<br>
<strong>PAPER_B9</strong> = (125.0, 178.0)<br>
<strong>PAPER_C5E</strong> = (462.0, 649.0)<br>
<strong>PAPER_COMM10E</strong> = (298.0, 683.0)<br>
<strong>PAPER_DLE</strong> = (312.0, 624.0)<br>
<strong>PAPER_EXECUTIVE</strong> = (542.0, 720.0)<br>
<strong>PAPER_FOLIO</strong> = (595.0, 935.0)<br>
<strong>PAPER_LEDGER</strong> = (1224.0, 792.0)<br>
<strong>PAPER_LEGAL</strong> = (612.0, 1008.0)<br>
<strong>PAPER_LETTER</strong> = (612.0, 792.0)<br>
<strong>PAPER_TABLOID</strong> = (792.0, 1224.0)<br>
<strong>PORTRAIT</strong> = 0<br>
<strong>Paper_A0</strong> = (2380.0, 3368.0)<br>
<strong>Paper_A1</strong> = (1684.0, 2380.0)<br>
<strong>Paper_A2</strong> = (1190.0, 1684.0)<br>
<strong>Paper_A3</strong> = (842.0, 1190.0)<br>
<strong>Paper_A4</strong> = (595.0, 842.0)<br>
<strong>Paper_A5</strong> = (421.0, 595.0)<br>
<strong>Paper_A6</strong> = (297.0, 421.0)<br>
<strong>Paper_A7</strong> = (210.0, 297.0)<br>
<strong>Paper_A8</strong> = (148.0, 210.0)<br>
<strong>Paper_A9</strong> = (105.0, 148.0)<br>
<strong>Paper_B0</strong> = (2836.0, 4008.0)<br>
<strong>Paper_B1</strong> = (2004.0, 2836.0)<br>
<strong>Paper_B10</strong> = (89.0, 125.0)<br>
<strong>Paper_B2</strong> = (1418.0, 2004.0)<br>
<strong>Paper_B3</strong> = (1002.0, 1418.0)<br>
<strong>Paper_B4</strong> = (709.0, 1002.0)<br>
<strong>Paper_B5</strong> = (501.0, 709.0)<br>
<strong>Paper_B6</strong> = (355.0, 501.0)<br>
<strong>Paper_B7</strong> = (250.0, 355.0)<br>
<strong>Paper_B8</strong> = (178.0, 250.0)<br>
<strong>Paper_B9</strong> = (125.0, 178.0)<br>
<strong>Paper_C5E</strong> = (462.0, 649.0)<br>
<strong>Paper_Comm10E</strong> = (298.0, 683.0)<br>
<strong>Paper_DLE</strong> = (312.0, 624.0)<br>
<strong>Paper_Executive</strong> = (542.0, 720.0)<br>
<strong>Paper_Folio</strong> = (595.0, 935.0)<br>
<strong>Paper_Ledger</strong> = (1224.0, 792.0)<br>
<strong>Paper_Legal</strong> = (612.0, 1008.0)<br>
<strong>Paper_Letter</strong> = (612.0, 792.0)<br>
<strong>Paper_Tabloid</strong> = (792.0, 1224.0)<br>
<strong>Picas</strong> = 3<br>
<strong>Points</strong> = 0<br>
<strong>Portrait</strong> = 0<br>
<strong>RadialGradient</strong> = 5<br>
<strong>Retry</strong> = 6<br>
<strong>RightAlign</strong> = 2<br>
<strong>RoundCap</strong> = 32<br>
<strong>RoundJoin</strong> = 128<br>
<strong>SolidLine</strong> = 1<br>
<strong>SquareCap</strong> = 16<br>
<strong>UNIT_INCHES</strong> = 2<br>
<strong>UNIT_MILLIMETERS</strong> = 1<br>
<strong>UNIT_PICAS</strong> = 3<br>
<strong>UNIT_POINTS</strong> = 0<br>
<strong>VerticalGradient</strong> = 2<br>
<strong>Warning</strong> = 2<br>
<strong>Yes</strong> = 3<br>
<br>
<strong>scribus_version</strong> = '1.2.2'<br>
<strong>scribus_version_info</strong> = (1, 2, 2, '', 0)<br>
</body>
</html>
y
|
