Manipuler les cadres de texte

Manipuler les cadres de texte

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 "nom" n'est pas fourni, l'élément sélectionné est utilisé.

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

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

Retourne la taille de la gouttière de colonne dans le cadre de texte "nom", exprimée 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é.

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

Retourne le nom de la police pour le 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 "nom" n'est pas fourni, l'élément sélectionné est utilisé.

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 "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 "nom" n'est pas fourni, l'élément sélectionné est utilisé.

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 "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 "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 "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 "nom" n'est pas fourni, l'élément sélectionné est utilisé.

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. Insérer du texte à la position -1 l'ajoute à la fin du cadre. Si "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.

selectText(...)
selectText(depart, compte, ["nom"])

Sélectionne le nombre ("compte") de caractères de texte dans le cadre de texte "nom" en partant du caractère "départ". Le décompte des caractères commence à 0. Si "compte" est à zéro, tout le texte sera effacé. Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.

Peut générer IndexError si la sélection dépasse les limites du texte.

setColumns(...)
setColumns(nr, ["nom"])

Établit le nombre de colonnes du cadre de texte "nom" à la valeur entière "nr". Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.

Peut générer ValueError si le nombre de colonnes n'est pas au moins égal à un.

setColumnGap(...)
setColumnGap(taille, ["nom"])

Établit la gouttière de colonne du cadre de texte "nom" à la valeur "taille". Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.

Peut générer ValueError si la gouttière de colonne est hors limites (elle doit être positive).

setFont(...)
setFont("police", ["nom"])

Assigne la police du cadre de texte "nom" à la "police". S'il y a du texte sélectionné, seul ce texte sera modifié. Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.

Peut générer ValueError si la police est introuvable.

setFontSize(...)
setFontSize(taille, ["nom"])

Établit la taille de police du cadre de texte "nom" à la valeur "taille". La "taille" est traitée comme une valeur en points. S'il y a du texte sélectionné, seul ce texte sera modifié. La "taille" doit être réglée entre 1 et 512. Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.

Peut générer ValueError pour une taille de police qui est hors limites.

setLineSpacing(...)
setLineSpacing(taille, ["nom"])

Établit la valeur "taille" pour l'interlignage ("leading") du cadre de texte "nom". La "taille" est une valeur en points. Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.

Peut générer ValueError si l'interlignage est hors limites.

setText(...)
setText("texte", ["nom"])

Établit la chaîne "texte" pour contenu du cadre de texte "nom". Le texte doit être encodé en UTF8 - utilisez par exemple unicode(texte, 'iso-8859-2'). Voir les FAQ pour plus de détails. Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.

setTextAlignment(...)
setTextAlignment(alignement, ["nom"])

Établit la valeur spécifiée pour l'alignement du contenu du cadre de texte "nom". Si "nom" n'est pas fourni, l'élément sélectionnéest utilisé. La valeur "alignement" doit être une des constantes ALIGN_ définies dans ce module - voir dir(scribus).

Peut générer ValueError si la constante d'alignement n'est pas valide.

setTextColor(...)
setTextColor("couleur", ["nom"])

Établit la "couleur" du contenu du cadre de texte "nom". S'il y a du texte sélectionné, seul ce texte sera modifié. Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.

setTextShade(...)
setTextShade(teinte, ["nom"])

Établit la valeur "teinte" pour la couleur du texte de l'objet "nom". S'il y a du texte sélectionné, seul ce texte sera modifié. La valeur "teinte" doit être un nombre entier compris entre 0 (pâle) et 100 (intensité maximale). Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.

setTextStroke(...)
setTextStroke("couleur", ["nom"])

Établit la "couleur" au contour des caractères. Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.

textOverflows(...)
textOverflows(["nom", sansLiens]) -> nombre entier

Retourne le nombre actuel de caractères en surplus dans le cadre de texte "nom". Si sansLiens est une valeur non nulle, il prend seulement un cadre - il n'utilise pas les liens de cadre. Sans ce paramètre, il cherche toute les chaînes liées.

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