Python : module scribus

Module d'interface Python de Scribus

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.

• 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 y en a un, ou générera une erreur NoValidObjectError si elle ne trouve aucun élément à traiter.
• 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.
• 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.

Modules

Classes

• exceptions.Exception
  • ScribusException
  • NameExistsError
  • NoDocOpenError
  • NoValidObjectError
  • NotFoundError
  • WrongFrameTypeError

Fonctions

changeColor(...)

changeColor("nom", c, m, j, n)

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.

Peut générer NotFoundError si la couleur nommée n'est pas trouvée.
Peut générer ValueError si le nom de couleur spécifié n'est pas valide.

closeDoc(...)

closeDoc()

Ferme le document courant sans invite de sauvegarde.

Peut générer NoDocOpenError s'il n'y a pas de document à fermer

createBezierLine(...)

createBezierLine(liste, ["nom"]) -> chaîne

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 :
[x1, y1, kx1, ky1, x2, y2, kx2, ky2...xn. yn, kxn. kyn]
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.

Peut générer NameExistsError si vous passez explicitement un nom déjà utilisé.
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.

createEllipse(...)

<createEllipse(x, y, largeur, hauteur, ["nom"]) -> chaîne

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.

Peut générer NameExistsError si vous passez explicitement un nom déjà utilisé.

createImage(...)

createImage(x, y, largeur, hauteur, ["nom"]) -> chaîne

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.

Peut générer NameExistsError si vous passez explicitement un nom déjà utilisé.

createLayer(...)

createLayer("nom")

Crée un nouveau calque portant le nom précisé.

Peut générer ValueError si le nom du calque n'est pas admis.

createLine(...)

createLine(x1, y1, x2, y2, ["nom"]) -> chaîne

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.

Peut générer NameExistsError si vous passez explicitement un nom déjà utilisé.

createPathText(...)

createPathText(x, y, "boiteTexte", "courbeBezier", ["nom"]) -> chaîne

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.

Peut générer NameExistsError si vous passez explicitement un nom déjà utilisé.
Peut générer NotFoundError si l'un des objets de base (ou les deux) n'existent pas.

createPolyLine(...)

createPolyLine(liste, ["nom"]) -> chaîne

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.

Peut générer NameExistsError si vous passez explicitement un nom déjà utilisé.
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.

createPolygon(...)

createPolygon(liste, ["nom"]) -> chaîne

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.

Peut générer NameExistsError si vous passez explicitement un nom déjà utilisé.
Peut générer ValueError si le nombre de points est insuffisant ou si
le nombre de valeurs passées ne forme pas un groupe de points sans reste.

createRect(...)

createRect(x, y, largeur, hauteur, ["nom"]) -> chaîne

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.

Peut générer NameExistsError si vous passez explicitement un nom déjà utilisé.

createText(...)

createText(x, y, largeur, hauteur, ["nom"]) -> chaîne

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.

Peut générer NameExistsError si vous passez explicitement un nom déjà utilisé.

currentPage(...)

currentPage() -> nombre entier

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.

defineColor(...)

defineColor("nom", c, m, j, n)

Définit une nouvelle couleur "nom". La valeur de la couleur est définie par quatre composants :
c = Cyan, m = Magenta, j = Jaune et n = Noir. Les composants de la couleur doivent se situer entre 0 et 255.

Peut générer ValueError si le nom de couleur spécifié n'est pas valide.

deleteColor(...)

deleteColor("nom", "remplacement")

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.

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.

Peut générer NotFoundError si la couleur nommée n'est pas trouvée.
Peut générer ValueError si le nom de couleur spécifié n'est pas valide.

deleteLayer(...)

deleteLayer("calque")

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.

Peut générer NotFoundError si le calque est introuvable.
Peut générer ValueError si le nom du calque n'est pas admis.

deleteObject(...)

deleteObject(["nom"])

Supprime l'élément portant le nom "nom". Si le "nom" n'est pas fourni, l'élément courant est supprimé.

deletePage(...)

deletePage(nr)

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.

Peut générer IndexError si le numéro de page est hors limites

deleteText(...)

deleteText(["nom"])

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é.

deselectAll(...)

deselectAll()

Désélectionne tous les objets du document au complet.

docChanged(...)

docChanged(bool)

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.

fileDialog(...)

fileDialog("titre", ["filtre", "nomDefaut" ,possedeApercu, estEnregistrer]) -> chaîne associée au nom du fichier

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.

Le filtre, si spécifié, prend la forme 'commentaire (*.type *.type2 ...)'.
Par exemple 'Images (*.png *.xpm *.jpg)'.

Reportez-vous à la documentation de QFileDialog dans Qt pour plus de détails sur les filtres.

Exemple : fileDialog('Ouvrir', 'CSV files (*.csv)')
Exemple : fileDialog('Enregistrer le rapport', nomdefaut='report.txt', estenregistrer=True)

getActiveLayer(...)

cgetActiveLayer() -> chaîne

Retourne le nom du calque actif courant.

getAllObjects(...)

getAllObjects() -> liste

Retourne une liste contenant les noms de tous les objets de la page courante.

getAllStyles(...)

getAllStyles() -> liste

Retourne une liste des noms de tous les styles de paragraphe du document courant.

getAllText(...)

getAllText(["nom"]) -> chaîne

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é.

getColor(...)

getColor("nom") -> vecteur

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.

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.

getColorAsRGB(...)

getColorAsRGB("nom") -> vecteur

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.

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.

getColorNames(...)

getColorNames() -> liste

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.

getColumnGap(...)

getColumnGap(["nom"]) -> réel

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é.

getColumns(...)

getColumns(["nom"]) -> nombre entier

Donne le nombre de colonnes du cadre de texte "nom". Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.

getCornerRadius(...)

getCornerRadius(["nom"]) -> nombre entier

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é.

getFillColor(...)

getFillColor(["nom"]) -> chaîne

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é.

getFillShade(...)

getFillShade(["nom"]) -> entier

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é.

getFont(...)

getFont(["nom"]) -> chaîne

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é.

getFontNames(...)

getFontNames() -> liste

Retourne une liste contenant les noms de toutes les polices disponibles.

getFontSize(...)

getFontSize(["nom"]) -> réel

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é.

getGuiLanguage(...)

getGuiLanguage() -> chaîne

Retourne une contenant la valeur de -lang.

getHGuides(...)

getHGuides() -> liste

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>.

getImageFile(...)

getImageName(["nom"]) -> chaîne

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é.

getImageScale(...)

getImageScale(["nom"]) -> (x,y)

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é.

getLayers(...)

getLayers() -> liste

Retourne une liste contenant les noms de tous les calques définis.

getLineCap(...)

getLineEnd(["nom"]) -> nombre entier (voir les constantes)

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 :
CAP_FLAT, CAP_ROUND, CAP_SQUARE

getLineColor(...)

getLineColor(["nom"]) -> chaîne

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é.

getLineJoin(...)

getLineJoin(["nom"]) -> nombre entier (voir les constantes)

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 :
JOIN_BEVEL, JOIN_MITTER, JOIN_ROUND

getLineShade(...)

getLineShade(["nom"]) -> entier

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é.

getLineSpacing(...)

getLineSpacing(["nom"]) -> réel

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é.

getLineStyle(...)

getLineStyle(["nom"]) -> nombre entier (voir les constantes)

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 :
LINE_DASH, LINE_DASHDOT, LINE_DASHDOTDOT, LINE_DOT, LINE_SOLID

getLineWidth(...)

getLineWidth(["nom"]) -> nombre entier

Retourne la largeur de filet de l'objet "nom". Si le "nom" n'est pas fourni, l'élément sélectionné est utilisé.

getPageItems(...)

getPageItems() -> liste

Retourne une liste de vecteurs contenant les éléments de la page courante. Le vecteur est :
(nom, typeObjet, ordre), par exemple [('Texte1', 4, 0), ('Image1', 2, 1)]
signifie que l'objet nommé 'Texte1' est un cadre de texte (type 4) et est le premier dans
la page...

getPageMargins(...)

getPageMargins()

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 getPageSize().

getPageSize(...)

getPageSize() -> vecteur

Retourne un vecteur contenant les dimensions de la page exprimées dans les unités courantes du document.
Voir les constantes UNIT_<type> et getPageMargins()

getPosition(...)

getPosition(["nom"]) -> (x,y)

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.

getRotation(...)

getRotation(["nom"]) -> nombre entier

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é.

getSelectedObject(...)

getSelectedObject([nr]) -> chaîne

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.

getSize(...)

getSize(["nom"]) -> (largeur,hauteur)

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.

getText(...)

getText(["nom"]) -> chaîne

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é.

getTextColor(...)

getLineColor(["nom"]) -> chaîne

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é.

getTextLength(...)

getTextLength(["nom"]) -> nombre entier

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é.

getTextShade(...)

getLineShade(["nom"]) -> nombre entier

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é.

getUnit(...)

getUnit() -> nombre entier (constante d'unité de Scribus)

Retourne les unités de mesure du document. La valeur retournée sera une des constantes UNIT_* constants :
UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS.

getVGuides(...)

getVGuides()

Voir getHGuides.

getXFontNames(...)

getXFontNames() -> liste de vecteurs

Retourne une information détaillée sur la police. Il s'agit d'une liste de vecteurs :
[ (nom Scribus, Famille, Nom réel, sous-ensemble (1|0), PS inclus PS (1|0), fichier de police), (...), ... ]

getval(...)

Interne à Scribus.

gotoPage(...)

gotoPage(nr)

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.

Peut générer IndexError si le numéro de page est hors limites.

groupObjects(...)

groupObjects(liste)

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.

haveDoc(...)

haveDoc() -> booléen

Retourne la valeur "true" s'il y a un document ouvert.

insertText(...)

insertText("texte", pos, ["nom"])

Insère le "texte" à la position "pos" dans le cadre de texte. Le texte doit être encodé en UTF (voir setText() 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é.

Peut générer IndexError dans le cas d'une insertion hors limites.

isLayerPrintable(...)

isLayerPrintable("calque") -> booléen

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.

Peut générer NotFoundError si le calque est introuvable.
Peut générer ValueError si le nom du calque n'est pas valide.

isLayerVisible(...)

isLayerPrintable("calque") -> booléen

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.

Peut générer NotFoundError si le calque est introuvable.
Peut générer ValueError si le nom du calque n'est pas valide.

isLocked(...)

isLocked(["nom"]) -> booléen

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é.

isPDFBookmark(...)

isPDFBookmark(["nom"]) -> booléen

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é.

Peut générer WrongFrameTypeError si le cadre cible n'est pas un cadre de texte.

linkTextFrames(...)

linkTextFrames("nomDepart", "nomArrivee")

É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.

Peut générer ScribusException en cas d'infraction des règles de liens.

loadImage(...)

loadImage("nomFichier" [, "nom"])

Charge l'image "nomFichier" dans le cadre d'image "nom". Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.

Peut générer WrongFrameTypeError si le cadre cible n'est pas un cadre d'image


loadStylesFromFile(...)

loadStylesFromFile("nomFichier")

Charge des styles de paragraphe à partir du document Scribus "nomFichier" dans le document courant.

lockObject(...)

lockObject(["nom"]) -> booléen

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é.

messageBox(...)

messageBox("titre", "message", icone=ICON_NONE, bouton1=BUTTON_OK|BUTTONOPT_DEFAULT, bouton2=BUTTON_NONE, bouton3=BUTTON_NONE) -> nombre entier

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.

Retourne le numéro du bouton que l'utilisateur a enfoncé. Les numéros de boutons commencent à 1.

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 :
BUTTONOPT_DEFAULT Appuyer sur Entrée enfonce ce bouton.
BUTTONOPT_ESCAPE Appuyer sur Esc enrfonce ce bouton.

Exemples d'utilisation :
result = messageBox('Le script a échoué',
'Ce script fonctionne seulement lorsqu'un cadre de texte est sélectionné.',
ICON_ERROR)
result = messageBox('Singes!'Qu'est-ce qui fait ook?<i>C'est le singe?</i>',
ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT,
BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE)

Constantes de bouton et d'icône dé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.

messagebarText(...)

messagebarText("chaîne")

Écrit "chaîne" dans la barre de message de Scribus (ligne d'état). Le texte
doit être encodé en une chaîne UTF8 ou en une chaîne 'unicode' (recommandé).