summaryrefslogtreecommitdiffstats
path: root/scribus/doc/fr/scripterapi-dialogs.html
blob: d708501aa66a8951f53ba43365cd9e550347ec26 (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
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
	<title>Utiliser les bo&icirc;tes de dialogues &agrave; partir de Scribus</title>
</head>
<body>
<h2>Utiliser les bo&icirc;tes de dialogues &agrave; partir de Scribus</h2> 

<dl>

<dt><a name="-fileDialog"><strong>fileDialog</strong></a>(...)</dt>
<dd><code><a href="#-fileDialog">fileDialog</a>("titre", ["filtre", "nomDefaut",possedeApercu, estEnregistre])<br> -&gt;
cha&icirc;ne avec nom de fichier</code>
<p>Affiche une bo&icirc;te de dialogue Ouvrir un fichier portant le titre "titre". Les fichiers sont filtr&eacute;s par la cha&icirc;ne "filtre". Vous pouvez aussi donner un nom de fichier ou un chemin par d&eacute;faut, mais laissez cette cha&icirc;ne vide lorsque vous ne voulez pas l'utiliser. 
Une valeur True pour 'possedeApercu' d&eacute;clenche l'affichage d'une vue r&eacute;duire dans la bo&icirc;te FileSelect. Quand le param&egrave;tre estEnregistre est mis &agrave; True, le dialogue se comporte comme un dialogue "Enregistrer sous", sinon il se comporte comme un dialogue "Ouvrir". Quand le param&egrave;tre 'isdir' a une valeur True, la bo&icirc;te de dialogue s'ouvre et retourne uniquement les r&eacute;pertoires. La valeur par d&eacute;faut de tous les param&egrave;tres optionnels est False.<p> 
<p>Le filtre, si sp&eacute;cifi&eacute;, prend la forme 'commentaire (*.type *.type2 ...)'. Par exemple 'Images (*.png *.xpm *.jpg)'.</p> 
<p>Reportez-vous &agrave; la documentation de QFileDialog dans Qt pour plus de d&eacute;tails sur les filtres.</p>
<p>Exemple : <a href="#-fileDialog">fileDialog</a>('Ouvrir', 'CSV files (*.csv)')<br>
Exemple : <a href="#-fileDialog">fileDialog</a>('Enregistrer le
rapport',
nomDefaut='report.txt', estEnregistre=True)</p></dd>

<dt><a name="-fileQuit"><strong>fileQuit</strong></a>(...)</dt>
<dd><code><a href="#-fileQuit">fileQuit</a>()</code>
<p>Quitte l'application Scribus.</p></dd>
	
<dt><a name="-getGuiLanguage"><strong>getGuiLanguage</strong></a>(...)</dt>
<dd><code><a href="#-getGuiLanguage">getGuiLanguage</a>() -&gt; cha&icirc;ne</code>
<p>Retourne une cha&icirc;ne contenant la valeur de -lang.</p></dd>
	
<dt><a name="-messagebarText"><strong>messagebarText</strong></a>(...)</dt>
<dd><code><a href="#-messagebarText">messagebarText</a>("cha&icirc;ne")</code>
<p>&Eacute;crit "cha&icirc;ne" dans la barre de message de Scribus (ligne d'&eacute;tat). Le texte doit &ecirc;tre encod&eacute; en UTF8 ou en une cha&icirc;ne 'unicode' (recommand&eacute;).</p></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) -&gt; nombre entier</code>
<p>Affiche une bo&icirc;te de message contenant le "titre", le message
"message", une ic&ocirc;ne "icone" et jusqu'&agrave; 3 boutons. Par d&eacute;faut, aucune ic&ocirc;ne n'est utilis&eacute;e et un seul bouton, OK, est affich&eacute;. Seuls les arguments titre et message sont requis, mais on recommande de d&eacute;finir une ic&ocirc;ne et un ou plusieurs boutons appropri&eacute;s. Le message texte peut contenir des marqueurs de type HTML simples.</p>
<p>Retourne le num&eacute;ro du bouton que l'utilisateur a enfonc&eacute;. Les num&eacute;ros de boutons commencent &agrave; 1.</p>
<p>Pour les param&egrave;tres d'ic&ocirc;ne et de bouton, certaines constantes pr&eacute;d&eacute;finies sont disponibles et portent les m&ecirc;mes noms que dans la documentation Qt. 
Ce sont les constantes BUTTON_* et ICON_* d&eacute;finies dans ce module. Il y a &eacute;galement deux constantes suppl&eacute;mentaires qui peuvent &ecirc;tre combin&eacute;es par un OU aux constantes de bouton :</p>
<ul>
	<li>BUTTONOPT_DEFAULT - Appuyer sur Entr&eacute;e enfonce ce bouton.</li>
	<li>BUTTONOPT_ESCAPE - Appuyer sur Esc enfonce ce bouton.</li>
</ul>
<p>Exemples d'utilisation :</p>
<pre>
result = <a href="#-messageBox">messageBox</a>('Le script a &eacute;chou&eacute;', 'Ce script fonctionne seulement lorsqu'un cadre de texte est s&eacute;lectionn&eacute;.'
ICON_ERROR)result = <a href="#-messageBox">messageBox</a>('Singes!',
'Quelque chose s'est pass&eacute;! &lt;i&gt;&Eacute;tait-ce un singe? &lt;/i&gt;',
                    ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT,
                    BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE)
</pre>
<p>Les constantes de boutons et d'ic&ocirc;nes suivantes sont d&eacute;finies : BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO, BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL, ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL.</p></dd>
	
<dt><a name="-newDocDialog"><strong>newDocDialog</strong></a>(...)</dt>
<dd><code><a href="#-newDocDialog">newDocDialog</a>() -&gt; bool&eacute;en</code>
<p>Affiche la bo&icirc;te dialogue "Nouveau document". Cr&eacute;e un nouveau document si l'utilisateur accepte les param&egrave;tres. Ne cr&eacute;e pas de document si l'utilisateur appuie sur Annuler. Retourne
la valeur True si un document a &eacute;t&eacute; cr&eacute;&eacute;.</p></dd>
	
<dt><a name="-statusMessage"><strong>statusMessage</strong></a>(...)</dt>
<dd><code><a href="#-messagebarText">messagebarText</a>("cha&icirc;ne")</code>
<p>&Eacute;crit "cha&icirc;ne" dans la barre de message de Scribus (ligne d'&eacute;tat). Le texte doit &ecirc;tre encod&eacute; en UTF8 ou en une cha&icirc;ne 'unicode' (recommand&eacute;).</p></dd>
	
<dt><a name="-progressReset"><strong>progressReset</strong></a>(...)</dt>
<dd><code><a href="#-progressReset">progressReset</a>()</code>
<p>&Eacute;limine les r&eacute;glages pr&eacute;c&eacute;dents de la barre de progression de Scribus. La fonction est appel&eacute;e avant l'utilisation de la nouvelle barre de progression. Voir progressSet.</p></dd>

<dt><a name="-progressSet"><strong>progressSet</strong></a>(...)</dt>
<dd><code><a href="#-progressSet">progressSet</a>(nr)</code>
<p>&Eacute;tablit la position de la barre de progression &agrave; "nr", c'est-&agrave;-dire une valeur relative &agrave; la valeur pr&eacute;c&eacute;dente de progressTotal. La barre de progression utilise le concept d'&eacute;tapes; il suffit d'indiquer le nombre total d'&eacute;tapes et le nombre d'&eacute;tapes d&eacute;j&agrave; effectu&eacute;es, puis la fonction affichera le pourcentage d'avancement. Vous pouvez sp&eacute;cifier le nombre total d'&eacute;tapes avec <a href="#-progressTotal">progressTotal</a>(). Le nombre courant d'&eacute;tapes est indiqu&eacute; avec <a href="#-progressSet">progressSet</a>(). La barre de progression peut &ecirc;tre remise &agrave; z&eacute;ro avec <a href="#-progressReset">progressReset</a>(). [compte tenu de l'information provenant de la documentation QT de Trolltech]</p></dd>

<dt><a name="-progressTotal"><strong>progressTotal</strong></a>(...)</dt>
<dd><code><a href="#-progressTotal">progressTotal</a>(max)</code>
<p>&Eacute;tablit le nombre maximal d'&eacute;tapes de la barre de progression au nombre sp&eacute;cifi&eacute;. Voir progressSet.</p></dd>

<dt><a name="-valueDialog"><strong>valueDialog</strong></a>(...)</dt>
<dd><code><a href="#-valueDialog">valueDialog</a>(titre, message [,valeurDefaut]) -&gt; cha&icirc;ne</code>
<p>Affiche la bo&icirc;te de dialogue "Demande d'une cha&icirc;ne" et retourne la valeur recherch&eacute;e sous forme d'une cha&icirc;ne de param&egrave;tres: titre de la fen&ecirc;tre, texte dans la fen&ecirc;tre et valeur par "d&eacute;faut" optionnelle.</p>
<p>Exemple: <a href="#-valueDialog">valueDialog</a>('titre', 'texte
dans la fen&ecirc;tre', 'optionnel')</p></dd>

</dl>

</body>
</html>