summaryrefslogtreecommitdiffstats
path: root/scribus/doc/fr/scripterapi-textframes.html
blob: 62201edb1e37a976ad58d77ef2fbd5d821e7bd6f (plain)
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
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
	<title>Manipuler les cadres de texte</title>
</head>
<body>
<h2>Manipuler les cadres de texte</h2>

<dl>

<dt><a name="-deleteText"><strong>deleteText</strong></a>(...)</dt>
<dd><code><a href="#-deleteText">deleteText</a>(["nom"])</code>
<p>Supprime le texte dans le cadre de texte "nom". S'il y a du texte s&eacute;lectionn&eacute;, seul ce texte sera supprim&eacute;. Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p></dd>

<dt><a name="-getAllText"><strong>getAllText</strong></a>(...)</dt>
<dd><code><a href="#-getAllText">getAllText</a>(["nom"]) -&gt; cha&icirc;ne</code>
<p>Retourne le texte d'un cadre de texte "nom" et de tous les cadres de texte qui sont y li&eacute;s. Si du texte est s&eacute;lectionn&eacute; dans ce cadre, il est retourn&eacute;. 
Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p></dd></dt>

<dt><a name="-getColumnGap"><strong>getColumnGap</strong></a>(...)</dt>
<dd><code><a href="#-getColumnGap">getColumnGap</a>(["nom"]) -&gt;
r&eacute;el</code>
<p>Retourne la taille de la goutti&egrave;re de colonne dans le cadre de texte "nom", exprim&eacute;e en points. Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p></dd>

<dt><a name="-getColumns"><strong>getColumns</strong></a>(...)</dt>
<dd><code><a href="#-getColumns">getColumns</a>(["nom"]) -&gt; nombre entier</code>
<p>Donne le nombre de colonnes du cadre de texte "nom". Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p></dd>

<dt><a name="-getFont"><strong>getFont</strong></a>(...)</dt>
<dd><code><a href="#-getFont">getFont</a>(["nom"]) -&gt; cha&icirc;ne</code>
<p>Retourne le nom de la police pour le cadre de texte "nom". Si ce cadre contient du texte s&eacute;lectionn&eacute;, la valeur assign&eacute;e au premier caract&egrave;re de la s&eacute;lection est retourn&eacute;e. Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p></dd>

<dt><a name="-getFontSize"><strong>getFontSize</strong></a>(...)</dt>
<dd><code><a href="#-getFontSize">getFontSize</a>(["nom"]) -&gt; r&eacute;el</code>
<p>Retourne la taille, en points, de la police du cadre de texte "nom". Si ce cadre contient du texte s&eacute;lectionn&eacute;, la valeur assign&eacute;e au premier caract&egrave;re de la s&eacute;lection est retourn&eacute;e. 
Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p></dd>

<dt><a name="-getLineSpacing"><strong>getLineSpacing</strong></a>(...)</dt>
<dd><code><a href="#-getLineSpacing">getLineSpacing</a>(["nom"]) -&gt; r&eacute;el</code>
<p>Retourne l'espacement de ligne ("leading") du cadre de texte "nom", exprim&eacute; en points. Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p></dd>

<dt><a name="-getText"><strong>getText</strong></a>(...)</dt>
<dd><code><a href="#-getText">getText</a>(["nom"]) -&gt; cha&icirc;ne</code>
<p>Retourne le texte du cadre de texte "nom". Si ce cadre de texte contient du texte s&eacute;lectionn&eacute;, celui-ci est retourn&eacute;. 
Tout le texte pr&eacute;sent dans le cadre, et non seulement le texte visible, est retourn&eacute;. Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p></dd>

<dt><a name="-getTextColor"><strong>getTextColor</strong></a>(...)</dt>
<dd><code><a href="#-getLineColor">getLineColor</a>(["nom"]) -&gt; cha&icirc;ne</code>
<p>Retourne le nom de la couleur de filet de l'objet "nom". Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p></dd>

<dt><a name="-getTextLength"><strong>getTextLength</strong></a>(...)</dt>
<dd><code><a href="#-getTextLength">getTextLength</a>(["nom"]) -&gt; nombre entier</code>
<p>Retourne la longueur du texte dans le cadre de texte "nom". Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p></dd>

<dt><a name="-getTextShade"><strong>getTextShade</strong></a>(...)</dt>
<dd><code><a href="#-getLineShade">getLineShade</a>(["nom"]) -&gt; nombre entier</code>
<p>Retourne la valeur de la teinte de la couleur de filet de l'objet "nom". Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p></dd>

<dt><a name="-insertText"><strong>insertText</strong></a>(...)</dt>
<dd><code><a href="#-insertText">insertText</a>("texte", pos, ["nom"])</code>
<p>Ins&egrave;re le "texte" &agrave; la position "pos" dans le cadre de texte. Le
texte doit &ecirc;tre encod&eacute; en UTF (voir <a href="#-setText">setText</a>()
comme r&eacute;f&eacute;rence). Le premier caract&egrave;re a un index de 0.
Ins&eacute;rer du texte &agrave; la position -1 l'ajoute &agrave; la fin du cadre. Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p>
<p>Peut g&eacute;n&eacute;rer IndexError dans le cas d'une insertion hors limites.</p></dd>

<dt><a name="-selectText"><strong>selectText</strong></a>(...)</dt>
<dd><code><a href="#-selectText">selectText</a>(depart, compte, ["nom"])</code>
<p>S&eacute;lectionne le nombre ("compte") de caract&egrave;res de texte dans le cadre de texte "nom" en partant du caract&egrave;re "d&eacute;part". Le d&eacute;compte des caract&egrave;res commence &agrave; 0. Si "compte" est &agrave; z&eacute;ro, tout le texte sera effac&eacute;. Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p>
<p>Peut g&eacute;n&eacute;rer IndexError si la s&eacute;lection d&eacute;passe les limites du texte.</p></dd>

<dt><a name="-setColumns"><strong>setColumns</strong></a>(...)</dt>
<dd><code><a href="#-setColumns">setColumns</a>(nr, ["nom"])</code>
<p>&Eacute;tablit le nombre de colonnes du cadre de texte "nom" &agrave; la valeur enti&egrave;re "nr". Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p>
<p>Peut g&eacute;n&eacute;rer ValueError si le nombre de colonnes n'est pas au
moins &eacute;gal &agrave; un.</p></dd>

<dt><a name="-setColumnGap"><strong>setColumnGap</strong></a>(...)</dt>
<dd><code><a href="#-setColumnGap">setColumnGap</a>(taille, ["nom"])</code>
<p>&Eacute;tablit la goutti&egrave;re de colonne du cadre de texte "nom" &agrave; la valeur "taille". Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p>
<p>Peut g&eacute;n&eacute;rer ValueError si la goutti&egrave;re de colonne est hors
limites (elle doit &ecirc;tre positive).</p></dd>

<dt><a name="-setFont"><strong>setFont</strong></a>(...)</dt>
<dd><code><a href="#-setFont">setFont</a>("police", ["nom"])</code>
<p>Assigne la police du cadre de texte "nom" &agrave; la "police". S'il y a du texte s&eacute;lectionn&eacute;, seul ce texte  sera modifi&eacute;. Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p>
<p>Peut g&eacute;n&eacute;rer ValueError si la police est introuvable.</p></dd>

<dt><a name="-setFontSize"><strong>setFontSize</strong></a>(...)</dt>
<dd><code><a href="#-setFontSize">setFontSize</a>(taille, ["nom"])</code>
<p>&Eacute;tablit la taille de police du cadre de texte "nom" &agrave; la valeur "taille". La "taille" est trait&eacute;e comme une valeur en points. S'il y a du texte s&eacute;lectionn&eacute;, seul ce texte  sera modifi&eacute;. La "taille" doit &ecirc;tre r&eacute;gl&eacute;e entre 1 et 512. Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p>
<p>Peut g&eacute;n&eacute;rer ValueError pour une taille de police qui est hors limites.</p></dd>

<dt><a name="-setLineSpacing"><strong>setLineSpacing</strong></a>(...)</dt>
<dd><code><a href="#-setLineSpacing">setLineSpacing</a>(taille, ["nom"])</code>
<p>&Eacute;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'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p>
<p>Peut g&eacute;n&eacute;rer ValueError si l'interlignage est hors limites.</p></dd>

<dt><a name="-setText"><strong>setText</strong></a>(...)</dt>
<dd><code><a href="#-setText">setText</a>("texte", ["nom"])</code>
<p>&Eacute;tablit la cha&icirc;ne "texte" pour contenu du cadre de texte "nom". Le texte doit &ecirc;tre encod&eacute; en UTF8 - utilisez par exemple unicode(texte, 'iso-8859-2'). 
Voir les FAQ pour plus de d&eacute;tails. Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p></dd>

<dt><a name="-setTextAlignment"><strong>setTextAlignment</strong></a>(...)</dt>
<dd><code><a href="#-setTextAlignment">setTextAlignment</a>(alignement, ["nom"])</code>
<p>&Eacute;tablit la valeur sp&eacute;cifi&eacute;e pour l'alignement du contenu du cadre de texte "nom". Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;est utilis&eacute;. La valeur "alignement" doit &ecirc;tre une des constantes ALIGN_ d&eacute;finies dans ce module - voir dir(scribus).</p>
<p>Peut g&eacute;n&eacute;rer ValueError si la constante d'alignement n'est pas valide.</p></dd>

<dt><a name="-setTextColor"><strong>setTextColor</strong></a>(...)</dt>
<dd><code><a href="#-setTextColor">setTextColor</a>("couleur", ["nom"])</code>
<p>&Eacute;tablit la "couleur" du contenu du cadre de texte "nom". S'il y a du texte s&eacute;lectionn&eacute;, seul ce texte  sera modifi&eacute;. Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p></dd>

<dt><a name="-setTextShade"><strong>setTextShade</strong></a>(...)</dt>
<dd><code><a href="#-setTextShade">setTextShade</a>(teinte, ["nom"])</code>
<p>&Eacute;tablit la valeur "teinte" pour la couleur du texte de l'objet "nom". S'il y a du texte s&eacute;lectionn&eacute;, seul ce texte sera modifi&eacute;. La valeur "teinte" doit &ecirc;tre un nombre entier compris entre 0 (p&acirc;le) et 100 (intensit&eacute; maximale). Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p></dd>

<dt><a name="-setTextStroke"><strong>setTextStroke</strong></a>(...)</dt>
<dd><code><a href="#-setTextStroke">setTextStroke</a>("couleur", ["nom"])</code>
<p>&Eacute;tablit la "couleur" au contour des caract&egrave;res. Si "nom" n'est pas fourni, l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est utilis&eacute;. </p></dd>

<dt><a name="-textOverflows"><strong>textOverflows</strong></a>(...)</dt>
<dd><code><a href="#-textOverflows">textOverflows</a>(["nom",
sansLiens]) -&gt; nombre entier</code>
<p>Retourne 1 en cas de pr&eacute;sence de caract&egrave;res en surplus dans le
cadre de texte "nom", 0 sinon. Si sansLiens est une valeur non nulle, il prend
seulement un cadre - il n'utilise pas les liens de cadre. Sans
ce param&egrave;tre, il cherche toute les cha&icirc;nes li&eacute;es.</p>
<p>Peut g&eacute;n&eacute;rer WrongFrameTypeError si le cadre cible n'est pas un
cadre de texte. </p></dd>

</dl>
</body>
</html>