Commandes relatives aux pages

applyMasterPage(...)
applyMasterPage(nomGabarit, pageNr)

Applique le gabarit "nomGabarit" à la page donnée. Vous trouverez des exemples d'utilisation sur le wiki..

closeMasterPage(...)
closeMasterPage()

Termine l'édition du gabarit actif et retourne à l'édition des pages standards. L'édition d'un gabarit est initiée avec la fonction editMasterPage().

createMasterPage(...)
createMasterPage(nomGabarit)

Crée un nouveau gabarit nommé "nomGabarit". L'édition d'un gabarit est initiée avec la fonction editMasterPage().

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 le premier numéro de page affiché dans votre document.

deleteMasterPage(...)
deleteMasterPage(nomGabarit)

Supprime le gabarit avec le nom spécifié.

deletePage(...)
deletePage(nr)

Supprime la page donnée. Inopérant 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

editMasterPage(...)
editMasterPage(nomGabarit)

Active l'édition des gabarits et ouvre le gabarit avec le nom spécifié. Lorsque l'édition du gabarit est achevée, appelez la fonction closeMasterPage().

getAllObjects(...)
getAllObjects([type, page, "calque"]) -> liste

Retourne une liste contenant les noms de tous les objets du type spécifié et situés sur la page et/ou le calque spécifiés.

Cette fonction accepte les paramètres nommés suivants:

Peut générer ValueError if l'indice du page ou le nom du calque sont invalides.

getHGuides(...)
getHGuides() -> liste

Retourne une liste contenant les positions des guides horizontaux. Les valeurs sont dans les unités courantes du document - voir les constantes UNIT_<type>.

getMasterPage(...)
getMasterPage(nr) -> chaîne

Retourne le nom du gabarit appliqué à la page "nr".

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

getPageType(...)
getPageType() -> entier

Retourne le type de page : 0 indique une page gauche, 1 une page centrale et 2 une page droite

getPageItems(...)
getPageItems() -> liste

Retourne une liste de vecteurs contenant les éléments de la page courante. Le vecteur est le suivant : (nom, objetType, 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 page du document comme un vecteur (haut, gauche, droite, bas) dans les unités courantes du document. Voir les constantes UNIT_<type> et getPageSize().

getPageNMargins(...)
getPageNMargins(nr)

Retourne les marges d'une page donnée comme un vecteur (haut, gauche, droite, bas) dans les unités courantes du document. Voir les constantes UNIT_<type> et getPageSize().

getPageSize(...)
getPageSize() -> vecteur

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

getPageNSize(...)
getPageNSize(nr) -> vecteur

Retourne un vecteur avec les dimensions d'une page donnée mesurées dans les unités courantes du document. Voir les constantes UNIT_<type> et getPageMargins()

getVGuides(...)
getVGuides()

Voir getHGuides.

gotoPage(...)
gotoPage(nr)

Déplace à la page "nr" (c'est-à-dire, la page courante devient "nr"). Notez que gotoPage ne change pas (actuellement) la page affichée dans la vue de l'utilisateur; il établit simplement la page sur laquelle les commandes du script agiront.

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

newPage(...)
newPage(lieu [,"modele"])

Crée une nouvelle page. Si "lieu" est à -1, la nouvelle page est ajoutée à la fin du document, sinon la nouvelle page est insérée avant "lieu". Les numéros de page sont incrémentés à partir de 1, peu importe le premier numéro de page affiché dans votre document. Le paramètre optionnel "modèle" spécifie le nom du gabarit pour la nouvelle page.

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

pageCount(...)
pageCount() -> entier

Retourne le nombre de pages dans le document.

pageDimension(...)
getPageSize() -> vecteur

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

redrawAll(...)
redrawAll()

Redessine toutes les pages.

savePageAsEPS(...)
savePageAsEPS("nom")

Enregistre la page courante comme EPS dans le fichier "nom".

Peut générer ScribusError si l'enregistrement échoue.

setHGuides(...)
setHGuides(liste)

Établit les guides horizontaux. Le paramètre d'entrée doit être une liste de positions de guide mesurées dans le unités courantes du document - voir les constantes UNIT_<type>.

Exemple : setHGuides(getHGuides() + [200.0, 210.0] # ajoute de nouveaux guides sans en perdre aucun
setHGuides([90,250]) # remplace la totalité des guides courants

setRedraw(...)
setRedraw(bool)

Désactive le rafraîchissement d'écran quand "bool = False", sinon le rafraîchissement est activé. Ce changement persistera même après l'exécution du script, donc assurez-vous d'appeler setRedraw(True) dans une clause "finally:" au début de votre script.

setVGuides(...)
setVGuides()

Voir setHGuides.