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 Color</h2><div class="description">
19
		<p>
20
			La classe <a href="Color.html">Color</a> permet de gérer les couleurs de manière uniforme sur Artichow.
21
		</p>
22
		<p>
23
			Afin de simplifier l'utilisation de cette classe, plusieurs couleurs sont déjà prédéfinies sur Artichow.
24
			Chacune de ces couleurs est une classe qui dérive de <a href="Color.html">Color</a> et dont le constructeur ne prend qu'un paramètre, le degré de transparence. Voici les couleurs prédéfinies triées par ton :
25
		</p>
26
		<ul>
27
			<li>
28
<em>Gris :</em>  Black, AlmostBlack, VeryDarkGray, DarkGray, MidGray, LightGray, VeryLightGray, White</li>
29
			<li>
30
<em>Rouge :</em>  VeryDarkRed, DarkRed, MidRed, Red, LightRed</li>
31
			<li>
32
<em>Vert :</em>  VeryDarkGreen, DarkGreen, MidGreen, Green, LightGreen</li>
33
			<li>
34
<em>Bleu :</em>  VeryDarkBlue, DarkBlue, MidBlue, Blue, LightBlue</li>
35
			<li>
36
<em>Jaune :</em>  VeryDarkYellow, DarkYellow, MidYellow, Yellow, LightYellow</li>
37
			<li>
38
<em>Cyan :</em>  VeryDarkCyan, DarkCyan, MidCyan, Cyan, LightCyan</li>
39
			<li>
40
<em>Magenta :</em>  VeryDarkMagenta, DarkMagenta, MidMagenta, Magenta, LightMagenta</li>
41
			<li>
42
<em>Orange :</em>  DarkOrange, Orange, LightOrange, VeryLightOrange</li>
43
			<li>
44
<em>Rose :</em>  DarkPink, Pink, LightPink, VeryLightPink</li>
45
			<li>
46
<em>Violet :</em>  DarkPurple, Purple, LightPurple, VeryLightPurple</li>
47
		</ul>
48
		<p>
49
			Voici un exemple d'utilisation pour les couleurs prédéfinies :
50
<pre>
51
 
52
&lt;?php
53
 
54
// On créé un bleu foncé
55
$blue = new DarkBlue; // Equivalent à new <a href="Color.html">Color</a>(0, 0, 128);
56
 
57
// On créé de l'orange transparent à 50 %
58
$orange = new Orange(50); // Equivalent à new <a href="Color.html">Color</a>(255, 128, 0, 50);
59
 
60
?&gt;
61
 
62
</pre>
63
		</p>
64
	</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">
65
<li>
66
<span class="access">public</span> <span class="type">int</span> <a href="Color.html#property.red"><span class="argument">$red</span></a>
67
</li>
68
<li>
69
<span class="access">public</span> <span class="type">int</span> <a href="Color.html#property.green"><span class="argument">$green</span></a>
70
</li>
71
<li>
72
<span class="access">public</span> <span class="type">int</span> <a href="Color.html#property.blue"><span class="argument">$blue</span></a>
73
</li>
74
<li>
75
<span class="access">public</span> <span class="type">int</span> <a href="Color.html#property.alpha"><span class="argument">$alpha</span></a>
76
</li>
77
</ul><ul class="methods">
78
<li>
79
<span class="access">public</span> <a href="Color.html#method.__construct">__construct</a>(<span class="type">int</span> <span class="argument">$red</span>, <span class="type">int</span> <span class="argument">$green</span>, <span class="type">int</span> <span class="argument">$blue</span>, <span class="type">int</span> <span class="argument">$alpha</span> := <span class="default">0</span>)
80
	</li>
81
<li>
82
<span class="access">public</span> <a href="Color.html#method.brightness">brightness</a>(<span class="type">int</span> <span class="argument">$brightness</span>)
83
	</li>
84
<li>
85
<span class="access">public</span> <span class="type">array</span> <a href="Color.html#method.getColor">getColor</a>()
86
	</li>
87
<li>
88
<span class="access">public</span> <span class="type">array</span> <a href="Color.html#method.rgba">rgba</a>()
89
	</li>
90
<li>
91
<span class="access">public</span> <a href="Color.html#method.free">free</a>()
92
	</li>
93
</ul><h2>Documentation</h2><ul class="doc">
94
<li class="property">
95
<a id="property.red"></a><span class="access">public</span> <span class="type">int</span> <a href="Color.html#property.red"><span class="argument">$red</span></a><div class="description">
96
				Intensité en rouge de la couleur (entre 0 et 255)
97
			</div>
98
<div class="description-bottom"><a href="Color.html#top">Remonter</a></div>
99
</li>
100
<li class="property">
101
<a id="property.green"></a><span class="access">public</span> <span class="type">int</span> <a href="Color.html#property.green"><span class="argument">$green</span></a><div class="description">
102
				Intensité en vert de la couleur (entre 0 et 255)
103
			</div>
104
<div class="description-bottom"><a href="Color.html#top">Remonter</a></div>
105
</li>
106
<li class="property">
107
<a id="property.blue"></a><span class="access">public</span> <span class="type">int</span> <a href="Color.html#property.blue"><span class="argument">$blue</span></a><div class="description">
108
				Intensité en blue de la couleur (entre 0 et 255)
109
			</div>
110
<div class="description-bottom"><a href="Color.html#top">Remonter</a></div>
111
</li>
112
<li class="property">
113
<a id="property.alpha"></a><span class="access">public</span> <span class="type">int</span> <a href="Color.html#property.alpha"><span class="argument">$alpha</span></a><div class="description">
114
				Degré de transparence de la couleur (entre 0 et 100)
115
			</div>
116
<div class="description-bottom"><a href="Color.html#top">Remonter</a></div>
117
</li>
118
<li class="method">
119
<a id="method.__construct"></a><span class="access">public</span> <a href="Color.html#method.__construct">__construct</a>(<span class="type">int</span> <span class="argument">$red</span>, <span class="type">int</span> <span class="argument">$green</span>, <span class="type">int</span> <span class="argument">$blue</span>, <span class="type">int</span> <span class="argument">$alpha</span> := <span class="default">0</span>)
120
	<div class="description">
121
				Construit une nouvelle couleur. Les trois premiers paramètres représentent l'intensité en rouge, vert et bleu pour cette couleur. L'intensité de chaque couleur est un nombre compris entre 0 et 255 (du foncé vers le clair). Le paramètre $alpha représente le dégré de transparence de la couleur, et doit être compris entre 0 et 100.
122
			</div>
123
<div class="description-bottom"><a href="Color.html#top">Remonter</a></div>
124
</li>
125
<li class="method">
126
<a id="method.brightness"></a><span class="access">public</span> <a href="Color.html#method.brightness">brightness</a>(<span class="type">int</span> <span class="argument">$brightness</span>)
127
	<div class="description">
128
				Change la luminosité de la couleur, en ajoutant la valeur $brightness à chaque composante (rouge, vert, bleu) de cette couleur.
129
				$brightness peut prendre des valeurs comprises entre -255 et +255.
130
			</div>
131
<div class="description-bottom"><a href="Color.html#top">Remonter</a></div>
132
</li>
133
<li class="method">
134
<a id="method.getColor"></a><span class="access">public</span> <span class="type">array</span> <a href="Color.html#method.getColor">getColor</a>()
135
	<div class="description">
136
				Retourne un tableau de quatre valeurs qui représentent l'intensité en rouge, vert et bleu ainsi que le degré de transparence de la couleur.
137
			</div>
138
<div class="description-bottom"><a href="Color.html#top">Remonter</a></div>
139
</li>
140
<li class="method">
141
<a id="method.rgba"></a><span class="access">public</span> <span class="type">array</span> <a href="Color.html#method.rgba">rgba</a>()
142
	<div class="description">
143
				Retourne un tableau de quatre valeurs qui représentent l'intensité en rouge, vert et bleu ainsi que le degré de transparence de la couleur.
144
			</div>
145
<div class="description-bottom"><a href="Color.html#top">Remonter</a></div>
146
</li>
147
<li class="method">
148
<a id="method.free"></a><span class="access">public</span> <a href="Color.html#method.free">free</a>()
149
	<ul class="version"><li>
150
						Supprimé à partir d'Artichow 1.1.0</li></ul>
151
<div class="description">
152
				Libère les ressources allouées lors de l'appel à <a href="Color.html#method.getColor">getColor()</a>.
153
			</div>
154
<div class="description-bottom"><a href="Color.html#top">Remonter</a></div>
155
</li>
156
</ul>
157
</td>
158
				<td class='borderd'>&nbsp;</td>
159
			</tr>
160
			<tr>
161
				<td class='cornerbg'></td>
162
				<td class='borderb'>&nbsp;</td>
163
				<td class='cornerbd'></td>
164
			</tr>
165
		</table>
166
		</div>
167
	</body>
168
</html>