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
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Les commandes disponibles</title>
</head>
<body>
<h2>Les commandes disponibles</h2>
<p>L'extension installe un module "scribus" incorporé. Donc pour
utiliser les extensions du langage Python, vous devez effectuer
"import scribus" ou "from scribus import *".</p>
<p>Le scripteur 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
existe, ou, dans le cas contraire, générera une erreur NoValidObjectError.
</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 graphique n'a pas de sens, et cette exception
sera produite.</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>
<p>Conventions utilisées dans ce document :</p>
<dl>
<dt><strong>nombre</strong></dt>
<dd>signifie que "nombre" est un entier ordinaire ou un nombre à
virgule flottante.</dd>
<dt><strong>"nom"</strong></dt>
<dd>signifie que "nom" est une chaîne de caractères ou une variable.</dd>
<dt><strong><i>liste</i></strong></dt>
<dd>signifie que "<i>liste</i>" est une liste Python.</dd>
</dl>
<p>Les variables entre crochets sont optionnelles.</p>
<h2>Exceptions</h2>
<dl>
<dt><a href="#Exception">exceptions.Exception</a></dt><dd>
<dl>
<dt><a href="#ScribusException">ScribusException</a></dt><dd>
<dl>
<dt><a href="#NameExistsError">NameExistsError</a></dt>
<dt><a href="#NoDocOpenError">NoDocOpenError</a></dt>
<dt><a href="#NoValidObjectError">NoValidObjectError</a></dt>
<dt><a href="#NotFoundError">NotFoundError</a></dt>
<dt><a href="#WrongFrameTypeError">WrongFrameTypeError</a></dt>
</dl>
</dd>
</dl>
</dd>
</dl>
<h3>NameExistsError</h3>
<a name="NameExistsError">class NameExistsError</a>(<a href="#ScribusException">ScribusException</a>)
<dl><dt>Ordre de résolution des méthodes :</dt>
<dd><a href="#NameExistsError">NameExistsError</a></dd>
<dd><a href="#ScribusException">ScribusException</a></dd>
<dd><a href="#Exception">exceptions.Exception</a></dd>
</dl>
Méthodes héritées de <a href="#Exception">exceptions.Exception</a> :<br>
<dl><dt><a name="NameExistsError-__getitem__"><strong>__getitem__</strong></a>(...)</dt></dl>
<dl><dt><a name="NameExistsError-__init__"><strong>__init__</strong></a>(...)</dt></dl>
<dl><dt><a name="NameExistsError-__str__"><strong>__str__</strong></a>(...)</dt></dl>
<h3>NoDocOpenError</h3>
<a name="NoDocOpenError">class NoDocOpenError</a>(<a href="#ScribusException">ScribusException</a>)
<dl><dt>Ordre de résolution des méthodes :</dt>
<dd><a href="#NoDocOpenError">NoDocOpenError</a></dd>
<dd><a href="#ScribusException">ScribusException</a></dd>
<dd><a href="#Exception">exceptions.Exception</a></dd>
</dl>
Méthodes héritées de <a href="#Exception">exceptions.Exception</a> :<br>
<dl><dt><a name="NoDocOpenError-__getitem__"><strong>__getitem__</strong></a>(...)</dt></dl>
<dl><dt><a name="NoDocOpenError-__init__"><strong>__init__</strong></a>(...)</dt></dl>
<dl><dt><a name="NoDocOpenError-__str__"><strong>__str__</strong></a>(...)</dt></dl>
<h3>NoValidObjectError</h3>
<a name="NoValidObjectError">class NoValidObjectError</a>(<a href="#ScribusException">ScribusException</a>)
<dl><dt>Ordre de résolution des méthodes :</dt>
<dd><a href="#NoValidObjectError">NoValidObjectError</a></dd>
<dd><a href="#ScribusException">ScribusException</a></dd>
<dd><a href="#Exception">exceptions.Exception</a></dd>
</dl>
Méthodes héritées de <a href="#Exception">exceptions.Exception</a>:<br>
<dl><dt><a name="NoValidObjectError-__getitem__"><strong>__getitem__</strong></a>(...)</dt></dl>
<dl><dt><a name="NoValidObjectError-__init__"><strong>__init__</strong></a>(...)</dt></dl>
<dl><dt><a name="NoValidObjectError-__str__"><strong>__str__</strong></a>(...)</dt></dl>
<h3>NotFoundError</h3>
<a name="NotFoundError">class NotFoundError</a>(<a href="#ScribusException">ScribusException</a>)
<dl><dt>Ordre de résolution des méthodes :</dt>
<dd><a href="#NotFoundError">NotFoundError</a></dd>
<dd><a href="#ScribusException">ScribusException</a></dd>
<dd><a href="#Exception">exceptions.Exception</a></dd>
</dl>
Méthodes héritées de <a href="#Exception">exceptions.Exception</a>:<br>
<dl><dt><a name="NotFoundError-__getitem__"><strong>__getitem__</strong></a>(...)</dt></dl>
<dl><dt><a name="NotFoundError-__init__"><strong>__init__</strong></a>(...)</dt></dl>
<dl><dt><a name="NotFoundError-__str__"><strong>__str__</strong></a>(...)</dt></dl>
<h3>ScribusException</h3>
<a name="ScribusException">class ScribusException</a>(<a href="#Exception">exceptions.Exception</a>)
Méthodes héritées de <a href="#Exception">exceptions.Exception</a> :<br>
<dl><dt><a name="ScribusException-__getitem__"><strong>__getitem__</strong></a>(...)</dt></dl>
<dl><dt><a name="ScribusException-__init__"><strong>__init__</strong></a>(...)</dt></dl>
<dl><dt><a name="ScribusException-__str__"><strong>__str__</strong></a>(...)</dt></dl>
<h3>WrongFrameTypeError</h3>
<a name="WrongFrameTypeError">class <strong>WrongFrameTypeError</strong></a>(<a href="#ScribusException">ScribusException</a>)
<dl>
<dt>Ordre de résolution des méthodes :</dt>
<dd><a href="#WrongFrameTypeError">WrongFrameTypeError</a></dd>
<dd><a href="#ScribusException">ScribusException</a></dd>
<dd><a href="#Exception">exceptions.Exception</a></dd>
</dl>
Méthodes héritées de <a href="#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>
</body>
</html>
|