Subversion Repositories Applications.gtt

Rev

Rev 61 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
60 jpm 1
<html>
2
	<head>
3
		<title>Documentation</title>
4
		<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
5
		<link rel='stylesheet' href='style.css' />
6
	</head>
7
 
8
	<body>
9
		<div align='center'>
10
		<table cellpadding='0' cellspacing='0' id='contenu' class='round' style='width: 80%; margin-bottom: 20px'>
11
			<tr>
12
				<td class='borderhg'>&nbsp;</td>
13
				<td class='borderh'>&nbsp;</td>
14
				<td class='cornerhd'></td>
15
			</tr>
16
			<tr>
17
				<td class='borderg'>&nbsp;</td>
18
				<td><a id="top"></a><h2> Class Text</h2><div class="description">
19
		<p>
20
			La classe <a href="Text.html">Text</a> permet de manipuler du texte de manière uniforme sur Artichow.
21
		</p>
22
	</div><ul class="links"><li><a href="index.html">Retourner voir la liste de toutes les classes</a></li></ul><h2>Méthodes et propriétés</h2><ul class="properties"><li>
23
<span class="access">public</span> <a href="Border.html"><span class="type">Border</span></a> <a href="Text.html#property.border"><span class="argument">$border</span></a>
24
</li></ul><ul class="methods">
25
<li>
26
<span class="access">public</span> <a href="Text.html#method.__construct">__construct</a>(<span class="type">string</span> <span class="argument">$text</span>, <a href="Font.html"><span class="type">Font</span></a> <span class="argument">$font</span> := <span class="default">new Font(Text::FONT_2)</span>, <a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span> := <span class="default">NULL</span>, <span class="type">int</span> <span class="argument">$angle</span> := <span class="default">0</span>)
27
	</li>
28
<li>
29
<span class="access">public</span> <span class="type">string</span> <a href="Text.html#method.getText">getText</a>()
30
	</li>
31
<li>
32
<span class="access">public</span> <a href="Text.html#method.setText">setText</a>(<span class="type">string</span> <span class="argument">$text</span>)
33
	</li>
34
<li>
35
<span class="access">public</span> <a href="Font.html"><span class="type">Font</span></a> <a href="Text.html#method.getFont">getFont</a>()
36
	</li>
37
<li>
38
<span class="access">public</span> <a href="Text.html#method.setFont">setFont</a>(<a href="Font.html"><span class="type">Font</span></a> <span class="argument">$font</span>)
39
	</li>
40
<li>
41
<span class="access">public</span> <span class="type">int</span> <a href="Text.html#method.getAngle">getAngle</a>()
42
	</li>
43
<li>
44
<span class="access">public</span> <a href="Text.html#method.setAngle">setAngle</a>(<span class="type">int</span> <span class="argument">$angle</span>)
45
	</li>
46
<li>
47
<span class="access">public</span> <span class="type">int</span> <a href="Text.html#method.getColor">getColor</a>()
48
	</li>
49
<li>
50
<span class="access">public</span> <a href="Text.html#method.setColor">setColor</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
51
	</li>
52
<li>
53
<span class="access">public</span> <span class="type">mixed</span> <a href="Text.html#method.getBackground">getBackground</a>()
54
	</li>
55
<li>
56
<span class="access">public</span> <a href="Text.html#method.setBackgroundColor">setBackgroundColor</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
57
	</li>
58
<li>
59
<span class="access">public</span> <a href="Text.html#method.setBackgroundGradient">setBackgroundGradient</a>(<a href="Gradient.html"><span class="type">Gradient</span></a> <span class="argument">$gradient</span>)
60
	</li>
61
<li>
62
<span class="access">public</span> <span class="type">array</span> <a href="Text.html#method.getPadding">getPadding</a>()
63
	</li>
64
<li>
65
<span class="access">public</span> <a href="Text.html#method.setPadding">setPadding</a>(<span class="type">int</span> <span class="argument">$left</span>, <span class="type">int</span> <span class="argument">$right</span>, <span class="type">int</span> <span class="argument">$top</span>, <span class="type">int</span> <span class="argument">$bottom</span>)
66
	</li>
67
</ul><h2>Documentation</h2><ul class="doc">
68
<li class="property">
69
<a id="property.border"></a><span class="access">public</span> <a href="Border.html"><span class="type">Border</span></a> <a href="Text.html#property.border"><span class="argument">$border</span></a><div class="description">
70
				La bordure qui entoure le texte.
71
			</div>
72
<div class="description-bottom"><a href="Text.html#top">Remonter</a></div>
73
</li>
74
<li class="method">
75
<a id="method.__construct"></a><span class="access">public</span> <a href="Text.html#method.__construct">__construct</a>(<span class="type">string</span> <span class="argument">$text</span>, <a href="Font.html"><span class="type">Font</span></a> <span class="argument">$font</span> := <span class="default">new Font(Text::FONT_2)</span>, <a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span> := <span class="default">NULL</span>, <span class="type">int</span> <span class="argument">$angle</span> := <span class="default">0</span>)
76
	<div class="description">
77
				Créé un nouveau pavé de texte avec pour texte $text. $font représente la police utilisée pour le texte tandis que $color représente sa couleur.
78
				L'angle est définit par le paramètre $angle, qui peut prendre les valeurs de 0 et 90°.
79
			</div>
80
<div class="description-bottom"><a href="Text.html#top">Remonter</a></div>
81
</li>
82
<li class="method">
83
<a id="method.getText"></a><span class="access">public</span> <span class="type">string</span> <a href="Text.html#method.getText">getText</a>()
84
	<div class="description">
85
				Retourne le texte de la classe.
86
			</div>
87
<div class="description-bottom"><a href="Text.html#top">Remonter</a></div>
88
</li>
89
<li class="method">
90
<a id="method.setText"></a><span class="access">public</span> <a href="Text.html#method.setText">setText</a>(<span class="type">string</span> <span class="argument">$text</span>)
91
	<div class="description">
92
				Change le texte associé à l'objet pour $text.
93
			</div>
94
<div class="description-bottom"><a href="Text.html#top">Remonter</a></div>
95
</li>
96
<li class="method">
97
<a id="method.getFont"></a><span class="access">public</span> <a href="Font.html"><span class="type">Font</span></a> <a href="Text.html#method.getFont">getFont</a>()
98
	<div class="description">
99
				Retourne la police utilisée pour le texte.
100
			</div>
101
<div class="description-bottom"><a href="Text.html#top">Remonter</a></div>
102
</li>
103
<li class="method">
104
<a id="method.setFont"></a><span class="access">public</span> <a href="Text.html#method.setFont">setFont</a>(<a href="Font.html"><span class="type">Font</span></a> <span class="argument">$font</span>)
105
	<div class="description">
106
				Change la police utilisée pour le texte.
107
			</div>
108
<div class="description-bottom"><a href="Text.html#top">Remonter</a></div>
109
</li>
110
<li class="method">
111
<a id="method.getAngle"></a><span class="access">public</span> <span class="type">int</span> <a href="Text.html#method.getAngle">getAngle</a>()
112
	<div class="description">
113
				Retourne l'angle du texte.
114
			</div>
115
<div class="description-bottom"><a href="Text.html#top">Remonter</a></div>
116
</li>
117
<li class="method">
118
<a id="method.setAngle"></a><span class="access">public</span> <a href="Text.html#method.setAngle">setAngle</a>(<span class="type">int</span> <span class="argument">$angle</span>)
119
	<div class="description">
120
				Change l'angle du texte. Les valeurs possibles sont 0 ou 90°.
121
			</div>
122
<div class="description-bottom"><a href="Text.html#top">Remonter</a></div>
123
</li>
124
<li class="method">
125
<a id="method.getColor"></a><span class="access">public</span> <span class="type">int</span> <a href="Text.html#method.getColor">getColor</a>()
126
	<div class="description">
127
				Retourne la couleur du texte.
128
			</div>
129
<div class="description-bottom"><a href="Text.html#top">Remonter</a></div>
130
</li>
131
<li class="method">
132
<a id="method.setColor"></a><span class="access">public</span> <a href="Text.html#method.setColor">setColor</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
133
	<div class="description">
134
				Change la couleur du texte.
135
			</div>
136
<div class="description-bottom"><a href="Text.html#top">Remonter</a></div>
137
</li>
138
<li class="method">
139
<a id="method.getBackground"></a><span class="access">public</span> <span class="type">mixed</span> <a href="Text.html#method.getBackground">getBackground</a>()
140
	<div class="description">
141
				Retourne le fond du texte. Si aucun fond n'a été spécifié, cette méthode retourne NULL.
142
				Dans le cas contraire, elle retourne un objet de la classe Color pour les couleurs, soit une instance de Gradient pour les dégradés.
143
			</div>
144
<div class="description-bottom"><a href="Text.html#top">Remonter</a></div>
145
</li>
146
<li class="method">
147
<a id="method.setBackgroundColor"></a><span class="access">public</span> <a href="Text.html#method.setBackgroundColor">setBackgroundColor</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
148
	<div class="description">
149
				Change la couleur de fond du texte.
150
			</div>
151
<div class="description-bottom"><a href="Text.html#top">Remonter</a></div>
152
</li>
153
<li class="method">
154
<a id="method.setBackgroundGradient"></a><span class="access">public</span> <a href="Text.html#method.setBackgroundGradient">setBackgroundGradient</a>(<a href="Gradient.html"><span class="type">Gradient</span></a> <span class="argument">$gradient</span>)
155
	<div class="description">
156
				Change le dégradé de fond du texte.
157
			</div>
158
<div class="description-bottom"><a href="Text.html#top">Remonter</a></div>
159
</li>
160
<li class="method">
161
<a id="method.getPadding"></a><span class="access">public</span> <span class="type">array</span> <a href="Text.html#method.getPadding">getPadding</a>()
162
	<div class="description">
163
				Retourne la valeur de l'espace qui entoure le texte par rapport à sa bordure. Cette méthode retourne un tableau de quatre valeurs, qui correspondent à l'espace de gauche, droite, haut et bas.
164
			</div>
165
<div class="description-bottom"><a href="Text.html#top">Remonter</a></div>
166
</li>
167
<li class="method">
168
<a id="method.setPadding"></a><span class="access">public</span> <a href="Text.html#method.setPadding">setPadding</a>(<span class="type">int</span> <span class="argument">$left</span>, <span class="type">int</span> <span class="argument">$right</span>, <span class="type">int</span> <span class="argument">$top</span>, <span class="type">int</span> <span class="argument">$bottom</span>)
169
	<div class="description">
170
				Change la valeur de l'espace qui entoure le texte par rapport à sa bordure.
171
			</div>
172
<div class="description-bottom"><a href="Text.html#top">Remonter</a></div>
173
</li>
174
</ul>
175
</td>
176
				<td class='borderd'>&nbsp;</td>
177
			</tr>
178
			<tr>
179
				<td class='cornerbg'></td>
180
				<td class='borderb'>&nbsp;</td>
181
				<td class='cornerbd'></td>
182
			</tr>
183
		</table>
184
		</div>
185
	</body>
186
</html>