Les commandes disponibles
Les commandes disponibles
L'extension installe un module "scribus" incorporé. Donc pour
utiliser les extensions du langage Python, vous devez effectuer
"import scribus" ou "from scribus import *".
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.
- Beaucoup de fonctions génèrent une erreur NoDocOpenError si vous
essayez de les utiliser sans un document à traiter.
- 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.
- 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.
- 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.
La documentation des fonctions détaille chaque exception pouvant
être générée en cours d'utilisation.
Conventions utilisées dans ce document :
- nombre
- signifie que "nombre" est un entier ordinaire ou un nombre à
virgule flottante.
- "nom"
- signifie que "nom" est une chaîne de caractères ou une variable.
- liste
- signifie que "liste" est une liste Python.
Les variables entre crochets sont optionnelles.
Exceptions
- exceptions.Exception
-
- ScribusException
-
- NameExistsError
- NoDocOpenError
- NoValidObjectError
- NotFoundError
- WrongFrameTypeError
NameExistsError
class NameExistsError(ScribusException)
- Ordre de résolution des méthodes :
- NameExistsError
- ScribusException
- exceptions.Exception
Méthodes héritées de exceptions.Exception :
- __getitem__(...)
- __init__(...)
- __str__(...)
NoDocOpenError
class NoDocOpenError(ScribusException)
- Ordre de résolution des méthodes :
- NoDocOpenError
- ScribusException
- exceptions.Exception
Méthodes héritées de exceptions.Exception :
- __getitem__(...)
- __init__(...)
- __str__(...)
NoValidObjectError
class NoValidObjectError(ScribusException)
- Ordre de résolution des méthodes :
- NoValidObjectError
- ScribusException
- exceptions.Exception
Méthodes héritées de exceptions.Exception:
- __getitem__(...)
- __init__(...)
- __str__(...)
NotFoundError
class NotFoundError(ScribusException)
- Ordre de résolution des méthodes :
- NotFoundError
- ScribusException
- exceptions.Exception
Méthodes héritées de exceptions.Exception:
- __getitem__(...)
- __init__(...)
- __str__(...)
ScribusException
class ScribusException(exceptions.Exception)
Méthodes héritées de exceptions.Exception :
- __getitem__(...)
- __init__(...)
- __str__(...)
WrongFrameTypeError
class WrongFrameTypeError(ScribusException)
- Ordre de résolution des méthodes :
- WrongFrameTypeError
- ScribusException
- exceptions.Exception
Méthodes héritées de exceptions.Exception:
- __getitem__(...)
- __init__(...)
- __str__(...)