diff options
| author | craig <craig@11d20701-8431-0410-a711-e3c959e3b870> | 2012-01-01 11:40:09 +0000 |
|---|---|---|
| committer | craig <craig@11d20701-8431-0410-a711-e3c959e3b870> | 2012-01-01 11:40:09 +0000 |
| commit | 7ed83b6c6666eb8b6b104c211ae7e52907350372 (patch) | |
| tree | 4430b556abac0ad660a0aacf1887d77f85d8be02 /scribus/doc/fr/scripterapi-doc.html | |
| download | scribus-7ed83b6c6666eb8b6b104c211ae7e52907350372.tar.gz scribus-7ed83b6c6666eb8b6b104c211ae7e52907350372.tar.xz scribus-7ed83b6c6666eb8b6b104c211ae7e52907350372.zip | |
Branch 1.3.5 tree to 1.4.x tree, goodbye 1.3.x
git-svn-id: svn://scribus.net/branches/Version14x/Scribus@17163 11d20701-8431-0410-a711-e3c959e3b870
Diffstat (limited to 'scribus/doc/fr/scripterapi-doc.html')
| -rw-r--r-- | scribus/doc/fr/scripterapi-doc.html | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/scribus/doc/fr/scripterapi-doc.html b/scribus/doc/fr/scripterapi-doc.html new file mode 100644 index 0000000..d200e8d --- /dev/null +++ b/scribus/doc/fr/scripterapi-doc.html @@ -0,0 +1,105 @@ +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> + <title>Commandes relatives au document</title> +</head> +<body> +<h2>Commandes relatives au document</h2> + +<dl> + +<dt><a name="-closeDoc"><strong>closeDoc</strong></a>(...)</dt> +<dd><code><a href="#-closeDoc">closeDoc</a>()</code> +<p>Ferme le document courant sans invite de sauvegarde.</p> +<p>Peut générer <a href="#NoDocOpenError">NoDocOpenError</a> +s'il n'y a pas de document à fermer</p></dd> + +<dt><a name="-docChanged"><strong>docChanged</strong></a>(...)</dt> +<dd><code><a href="#-docChanged">docChanged</a>(booléen)</code> +<p>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.</p></dd> + +<dt><a name="-getUnit"><strong>getUnit</strong></a>(...)</dt> +<dd><code><a href="#-getUnit">getUnit</a>() -> nombre entier +(constante d'unité de Scribus)</code> +<p>Retourne les unités de mesure du document. La valeur retournée +sera une des constantes UNIT_*: UNIT_INCHES, +UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS.</p></dd> + +<dt><a name="-haveDoc"><strong>haveDoc</strong></a>(...)</dt> +<dd><code><a href="#-haveDoc">haveDoc</a>() -> booléen</code> +<p>Retourne la valeur true s'il y a un document ouvert.</p></dd> + +<dt><a name="-loadStylesFromFile"><strong>loadStylesFromFile</strong></a>(...)</dt> +<dd><code><a href="#-loadStylesFromFile">loadStylesFromFile</a>("nomFichier")</code> +<p>Charge des styles de paragraphe à partir du document Scribus +"nomFichier" dans le document courant.</p></dd> + +<dt><a name="-newDoc"><strong>newDoc</strong></a>(...)</dt> +<dd><code><a href="#-newDoc">newDoc</a>(taille, marges, orientation, numeroPremierePage, unite, pagesRegard, premierePageGauche) +-> booléen</code> +<p>Crée un nouveau document et retourne la valeur True si l'opération +réussit. Les paramètres ont la signification suivante :</p> +<ul> + <li>taille = un vecteur (largeur, hauteur) décrivant la taille du document. Vous pouvez utiliser des constantes prédéfinies nommées PAPER_<paper_type> c'est-à-dire PAPER_A4 etc.</li> + <li>marges = un vecteur (gauche, droite, haut, bas) décrivant les +marges du document</li> + <li>orientation = l'orientation de la page - constantes PORTRAIT, LANDSCAPE</li> + <li>numeroPremierePage = est le numéro de la première page dans le +document utilisé pour la numérotation. Même si habituellement vous +choisirez la valeur 1, il est utile d'avoir de plus grands +chiffres si vous créez un document en plusieurs parties.</li> + <li>unité = cette valeurs définit les unités de mesure utilisées par le document. Utilisez +une constante prédéfinie pour cela, parmi les suivantes: UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS.</li> + <li>pagesRegard = FACINGPAGES, NOFACINGPAGES</li> + <li>premierPageGauche = FIRSTPAGELEFT, FIRSTPAGERIGHT</li> + </ul> +<p>Les valeurs établies pour la largeur, la hauteur et les marges +sont exprimées dans les unités choisies pour le document. Les constantes PAPER_* sont exprimées en points. Si +votre document n'est pas défini en points, assurez-vous d'en tenir +compte.</p> +<p>exemple: <a href="#-newDoc">newDoc</a>(PAPER_A4, (10, 10, 20, 20), +LANDSCAPE, 1, UNIT_POINTS, FACINGPAGES, FIRSTPAGERIGHT)</p></dd> + +<dt><a name="-openDoc"><strong>openDoc</strong></a>(...)</dt> +<dd><code><a href="#-openDoc">openDoc</a>("nom")</code> +<p>Ouvre le document "nom".</p> +<p>Peut générer ScribusError si le document ne peut pas être ouvert.</p></dd> + +<dt><a name="-saveDoc"><strong>saveDoc</strong></a>(...)</dt> +<dd><code><a href="#-saveDoc">saveDoc</a>()</code> +<p>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.Si l'enregistrement échoue, il n'y a actuellement aucun moyen de le savoir.</p></dd> + +<dt><a name="-saveDocAs"><strong>saveDocAs</strong></a>(...)</dt> +<dd><code><a href="#-saveDocAs">saveDocAs</a>("nom")</code> +<p>Enregistre le document courant sous le nouveau "nom" (qui peut être un chemin complet ou relatif).</p> +<p>Peut générer ScribusError si l'enregistrement échoue.</p></dd> + +<dt><a name="-setInfo"><strong>setInfo</strong></a>(...)</dt> +<dd><code><a href="#-saveDocAs">saveDocAs</a>("auteur", "info", +"description") -> booléen</code> +<p>Établit l'information relative au document. "Auteur", "Info", +"Description" sont des chaînes.</p></dd> + +<dt><a name="-setMargins"><strong>setMargins</strong></a>(...)</dt> +<dd><code><a href="#-setMargins">setMargins</a>(lr, rr, tr, br)</code> +<p>Établit les marges du document, les marges Gauche(lr), Droite(rr), +Haut(tr) et Bas(br) sont indiquées dans les unités de mesure du +document - voir les constantes UNIT_<type>.</p></dd> + +<dt><a name="-setDocType"><strong>setDocType</strong></a>(...)</dt> +<dd><code><a href="#-setDocType">setDocType</a>(pagesRegard, premierePageGauche)</code> +<p>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.</p></dd> + +<dt><a name="-setUnit"><strong>setUnit</strong></a>(...)</dt> +<dd><code><a href="#-setUnit">setUnit</a>(type)</code> +<p>Change l'unité de mesure du document. Les valeurs possibles de l'"unité" sont définies par les constantes UNIT_<type>.</p> +<p>Peut générer ValueError si l'unité passée n'est pas valide.</p></dd> + +</dl> +</body> +</html> + |