| 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'> </td>
|
|
|
13 |
<td class='borderh'> </td>
|
|
|
14 |
<td class='cornerhd'></td>
|
|
|
15 |
</tr>
|
|
|
16 |
<tr>
|
|
|
17 |
<td class='borderg'> </td>
|
|
|
18 |
<td><a id="top"></a><h2> Class Border</h2><div class="description">
|
|
|
19 |
<p>La classe <a href="Border.html">Border</a> permet de centraliser la gestion des bordures sur Artichow.</p>
|
|
|
20 |
</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">
|
|
|
21 |
<li>
|
|
|
22 |
<span class="access">protected</span> <a href="Color.html"><span class="type">Color</span></a> <a href="Border.html#property.color"><span class="argument">$color</span></a> := <span class="default">new Black</span>
|
|
|
23 |
</li>
|
|
|
24 |
<li>
|
|
|
25 |
<span class="access">protected</span> <span class="type">int</span> <a href="Border.html#property.style"><span class="argument">$style</span></a> := <span class="default">Line::SOLID</span>
|
|
|
26 |
</li>
|
|
|
27 |
<li>
|
|
|
28 |
<span class="access">protected</span> <span class="type">bool</span> <a href="Border.html#property.hide"><span class="argument">$hide</span></a> := <span class="default">FALSE</span>
|
|
|
29 |
</li>
|
|
|
30 |
</ul><ul class="methods">
|
|
|
31 |
<li>
|
|
|
32 |
<span class="access">public</span> <a href="Border.html#method.__construct">__construct</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span> := <span class="default">new Black</span>, <span class="type">int</span> <span class="argument">$style</span> := <span class="default">Line::SOLID</span>)
|
|
|
33 |
</li>
|
|
|
34 |
<li>
|
|
|
35 |
<span class="access">public</span> <a href="Border.html#method.setColor">setColor</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
|
|
|
36 |
</li>
|
|
|
37 |
<li>
|
|
|
38 |
<span class="access">public</span> <a href="Border.html#method.setStyle">setStyle</a>(<span class="type">int</span> <span class="argument">$style</span>)
|
|
|
39 |
</li>
|
|
|
40 |
<li>
|
|
|
41 |
<span class="access">public</span> <a href="Border.html#method.hide">hide</a>(<span class="type">bool</span> <span class="argument">$hide</span> := <span class="default">TRUE</span>)
|
|
|
42 |
</li>
|
|
|
43 |
<li>
|
|
|
44 |
<span class="access">public</span> <a href="Border.html#method.show">show</a>(<span class="type">bool</span> <span class="argument">$show</span> := <span class="default">TRUE</span>)
|
|
|
45 |
</li>
|
|
|
46 |
<li>
|
|
|
47 |
<span class="access">public</span> <span class="type">bool</span> <a href="Border.html#method.visible">visible</a>()
|
|
|
48 |
</li>
|
|
|
49 |
<li>
|
|
|
50 |
<span class="access">public</span> <a href="Border.html#method.rectangle">rectangle</a>(<a href="Driver.html"><span class="type">Driver</span></a> <span class="argument">$driver</span>, <a href="Point.html"><span class="type">Point</span></a> <span class="argument">$p1</span>, <a href="Point.html"><span class="type">Point</span></a> <span class="argument">$p2</span>)
|
|
|
51 |
</li>
|
|
|
52 |
<li>
|
|
|
53 |
<span class="access">public</span> <a href="Border.html#method.ellipse">ellipse</a>(<a href="Driver.html"><span class="type">Driver</span></a> <span class="argument">$driver</span>, <a href="Point.html"><span class="type">Point</span></a> <span class="argument">$center</span>, <span class="type">int</span> <span class="argument">$width</span>, <span class="type">int</span> <span class="argument">$height</span>)
|
|
|
54 |
</li>
|
|
|
55 |
<li>
|
|
|
56 |
<span class="access">public</span> <a href="Border.html#method.polygon">polygon</a>(<a href="Driver.html"><span class="type">Driver</span></a> <span class="argument">$driver</span>, <a href="Polygon.html"><span class="type">Polygon</span></a> <span class="argument">$polygon</span>)
|
|
|
57 |
</li>
|
|
|
58 |
</ul><h2>Documentation</h2><ul class="doc">
|
|
|
59 |
<li class="property">
|
|
|
60 |
<a id="property.color"></a><span class="access">protected</span> <a href="Color.html"><span class="type">Color</span></a> <a href="Border.html#property.color"><span class="argument">$color</span></a> := <span class="default">new Black</span><div class="description">
|
|
|
61 |
La couleur de la bordure
|
|
|
62 |
</div>
|
|
|
63 |
<div class="description-bottom"><a href="Border.html#top">Remonter</a></div>
|
|
|
64 |
</li>
|
|
|
65 |
<li class="property">
|
|
|
66 |
<a id="property.style"></a><span class="access">protected</span> <span class="type">int</span> <a href="Border.html#property.style"><span class="argument">$style</span></a> := <span class="default">Line::SOLID</span><div class="description">
|
|
|
67 |
Style de la ligne qui compose la bordure.
|
|
|
68 |
</div>
|
|
|
69 |
<div class="description-bottom"><a href="Border.html#top">Remonter</a></div>
|
|
|
70 |
</li>
|
|
|
71 |
<li class="property">
|
|
|
72 |
<a id="property.hide"></a><span class="access">protected</span> <span class="type">bool</span> <a href="Border.html#property.hide"><span class="argument">$hide</span></a> := <span class="default">FALSE</span><div class="description">
|
|
|
73 |
Est-ce que la bordure doit être cachée ?
|
|
|
74 |
</div>
|
|
|
75 |
<div class="description-bottom"><a href="Border.html#top">Remonter</a></div>
|
|
|
76 |
</li>
|
|
|
77 |
<li class="method">
|
|
|
78 |
<a id="method.__construct"></a><span class="access">public</span> <a href="Border.html#method.__construct">__construct</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span> := <span class="default">new Black</span>, <span class="type">int</span> <span class="argument">$style</span> := <span class="default">Line::SOLID</span>)
|
|
|
79 |
<div class="description">
|
|
|
80 |
Déclare une nouvelle bordure de couleur $color et avec pour style $style.
|
|
|
81 |
</div>
|
|
|
82 |
<div class="description-bottom"><a href="Border.html#top">Remonter</a></div>
|
|
|
83 |
</li>
|
|
|
84 |
<li class="method">
|
|
|
85 |
<a id="method.setColor"></a><span class="access">public</span> <a href="Border.html#method.setColor">setColor</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
|
|
|
86 |
<div class="description">
|
|
|
87 |
Change la couleur de la bordure pour $color.
|
|
|
88 |
</div>
|
|
|
89 |
<div class="description-bottom"><a href="Border.html#top">Remonter</a></div>
|
|
|
90 |
</li>
|
|
|
91 |
<li class="method">
|
|
|
92 |
<a id="method.setStyle"></a><span class="access">public</span> <a href="Border.html#method.setStyle">setStyle</a>(<span class="type">int</span> <span class="argument">$style</span>)
|
|
|
93 |
<div class="description">
|
|
|
94 |
Change le style de la bordure pour $style.
|
|
|
95 |
</div>
|
|
|
96 |
<div class="description-bottom"><a href="Border.html#top">Remonter</a></div>
|
|
|
97 |
</li>
|
|
|
98 |
<li class="method">
|
|
|
99 |
<a id="method.hide"></a><span class="access">public</span> <a href="Border.html#method.hide">hide</a>(<span class="type">bool</span> <span class="argument">$hide</span> := <span class="default">TRUE</span>)
|
|
|
100 |
<div class="description">
|
|
|
101 |
Détermine si la bordure doit être cachée ou non.
|
|
|
102 |
</div>
|
|
|
103 |
<div class="description-bottom"><a href="Border.html#top">Remonter</a></div>
|
|
|
104 |
</li>
|
|
|
105 |
<li class="method">
|
|
|
106 |
<a id="method.show"></a><span class="access">public</span> <a href="Border.html#method.show">show</a>(<span class="type">bool</span> <span class="argument">$show</span> := <span class="default">TRUE</span>)
|
|
|
107 |
<div class="description">
|
|
|
108 |
Détermine si la bordure doit être affichée ou non.
|
|
|
109 |
</div>
|
|
|
110 |
<div class="description-bottom"><a href="Border.html#top">Remonter</a></div>
|
|
|
111 |
</li>
|
|
|
112 |
<li class="method">
|
|
|
113 |
<a id="method.visible"></a><span class="access">public</span> <span class="type">bool</span> <a href="Border.html#method.visible">visible</a>()
|
|
|
114 |
<div class="description">
|
|
|
115 |
Retourne TRUE si la bordure doit être affichée, FALSE sinon.
|
|
|
116 |
</div>
|
|
|
117 |
<div class="description-bottom"><a href="Border.html#top">Remonter</a></div>
|
|
|
118 |
</li>
|
|
|
119 |
<li class="method">
|
|
|
120 |
<a id="method.rectangle"></a><span class="access">public</span> <a href="Border.html#method.rectangle">rectangle</a>(<a href="Driver.html"><span class="type">Driver</span></a> <span class="argument">$driver</span>, <a href="Point.html"><span class="type">Point</span></a> <span class="argument">$p1</span>, <a href="Point.html"><span class="type">Point</span></a> <span class="argument">$p2</span>)
|
|
|
121 |
<div class="description">
|
|
|
122 |
Dessine la bordure sous la forme d'un rectangle dont la diagonale s'étend des points $p1 à $p2.
|
|
|
123 |
</div>
|
|
|
124 |
<div class="description-bottom"><a href="Border.html#top">Remonter</a></div>
|
|
|
125 |
</li>
|
|
|
126 |
<li class="method">
|
|
|
127 |
<a id="method.ellipse"></a><span class="access">public</span> <a href="Border.html#method.ellipse">ellipse</a>(<a href="Driver.html"><span class="type">Driver</span></a> <span class="argument">$driver</span>, <a href="Point.html"><span class="type">Point</span></a> <span class="argument">$center</span>, <span class="type">int</span> <span class="argument">$width</span>, <span class="type">int</span> <span class="argument">$height</span>)
|
|
|
128 |
<div class="description">
|
|
|
129 |
Dessine la bordure sous la forme d'une ellipse de centre $center et de largeur et hauteur respectives $width et $height.
|
|
|
130 |
</div>
|
|
|
131 |
<div class="description-bottom"><a href="Border.html#top">Remonter</a></div>
|
|
|
132 |
</li>
|
|
|
133 |
<li class="method">
|
|
|
134 |
<a id="method.polygon"></a><span class="access">public</span> <a href="Border.html#method.polygon">polygon</a>(<a href="Driver.html"><span class="type">Driver</span></a> <span class="argument">$driver</span>, <a href="Polygon.html"><span class="type">Polygon</span></a> <span class="argument">$polygon</span>)
|
|
|
135 |
<ul class="version"><li>
|
|
|
136 |
Disponible depuis Artichow 1.0.9</li></ul>
|
|
|
137 |
<div class="description">
|
|
|
138 |
Dessine la bordure comme un polygone entourant celui passé en argument.
|
|
|
139 |
</div>
|
|
|
140 |
<div class="description-bottom"><a href="Border.html#top">Remonter</a></div>
|
|
|
141 |
</li>
|
|
|
142 |
</ul>
|
|
|
143 |
</td>
|
|
|
144 |
<td class='borderd'> </td>
|
|
|
145 |
</tr>
|
|
|
146 |
<tr>
|
|
|
147 |
<td class='cornerbg'></td>
|
|
|
148 |
<td class='borderb'> </td>
|
|
|
149 |
<td class='cornerbd'></td>
|
|
|
150 |
</tr>
|
|
|
151 |
</table>
|
|
|
152 |
</div>
|
|
|
153 |
</body>
|
|
|
154 |
</html>
|