Debian Codegraph @

docs/html/GooCanvasEllipse.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>GooCanvasEllipse: GooCanvas Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="index.html" title="GooCanvas Reference Manual">
8 <link rel="up" href="ch03.html" title="Standard Canvas Items">
9 <link rel="prev" href="GooCanvasGroup.html" title="GooCanvasGroup">
10 <link rel="next" href="GooCanvasGrid.html" title="GooCanvasGrid">
11 <meta name="generator" content="GTK-Doc V1.26 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#GooCanvasEllipse.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19 <a href="#GooCanvasEllipse.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
20 <a href="#GooCanvasEllipse.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
21 <a href="#GooCanvasEllipse.properties" class="shortcut">Properties</a></span>
22 </td>
23 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
24 <td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
25 <td><a accesskey="p" href="GooCanvasGroup.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26 <td><a accesskey="n" href="GooCanvasGrid.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
27 </tr></table>
28 <div class="refentry">
29 <a name="GooCanvasEllipse"></a><div class="titlepage"></div>
30 <div class="refnamediv"><table width="100%"><tr>
31 <td valign="top">
32 <h2><span class="refentrytitle"><a name="GooCanvasEllipse.top_of_page"></a>GooCanvasEllipse</span></h2>
33 <p>GooCanvasEllipse — an ellipse item.</p>
34 </td>
35 <td class="gallery_image" valign="top" align="right"></td>
36 </tr></table></div>
37 <div class="refsect1">
38 <a name="GooCanvasEllipse.functions"></a><h2>Functions</h2>
39 <div class="informaltable"><table width="100%" border="0">
40 <colgroup>
41 <col width="150px" class="functions_return">
42 <col class="functions_name">
43 </colgroup>
44 <tbody><tr>
45 <td class="function_type">
46 <a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="returnvalue">GooCanvasItem</span></a> *
47 </td>
48 <td class="function_name">
49 <a class="link" href="GooCanvasEllipse.html#goo-canvas-ellipse-new" title="goo_canvas_ellipse_new ()">goo_canvas_ellipse_new</a> <span class="c_punctuation">()</span>
50 </td>
51 </tr></tbody>
52 </table></div>
53 </div>
54 <div class="refsect1">
55 <a name="GooCanvasEllipse.properties"></a><h2>Properties</h2>
56 <div class="informaltable"><table border="0">
57 <colgroup>
58 <col width="150px" class="properties_type">
59 <col width="300px" class="properties_name">
60 <col width="200px" class="properties_flags">
61 </colgroup>
62 <tbody>
63 <tr>
64 <td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
65 <td class="property_name"><a class="link" href="GooCanvasEllipse.html#GooCanvasEllipse--center-x" title="The “center-x” property">center-x</a></td>
66 <td class="property_flags">Read / Write</td>
67 </tr>
68 <tr>
69 <td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
70 <td class="property_name"><a class="link" href="GooCanvasEllipse.html#GooCanvasEllipse--center-y" title="The “center-y” property">center-y</a></td>
71 <td class="property_flags">Read / Write</td>
72 </tr>
73 <tr>
74 <td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
75 <td class="property_name"><a class="link" href="GooCanvasEllipse.html#GooCanvasEllipse--height" title="The “height” property">height</a></td>
76 <td class="property_flags">Read / Write</td>
77 </tr>
78 <tr>
79 <td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
80 <td class="property_name"><a class="link" href="GooCanvasEllipse.html#GooCanvasEllipse--radius-x" title="The “radius-x” property">radius-x</a></td>
81 <td class="property_flags">Read / Write</td>
82 </tr>
83 <tr>
84 <td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
85 <td class="property_name"><a class="link" href="GooCanvasEllipse.html#GooCanvasEllipse--radius-y" title="The “radius-y” property">radius-y</a></td>
86 <td class="property_flags">Read / Write</td>
87 </tr>
88 <tr>
89 <td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
90 <td class="property_name"><a class="link" href="GooCanvasEllipse.html#GooCanvasEllipse--width" title="The “width” property">width</a></td>
91 <td class="property_flags">Read / Write</td>
92 </tr>
93 <tr>
94 <td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
95 <td class="property_name"><a class="link" href="GooCanvasEllipse.html#GooCanvasEllipse--x" title="The “x” property">x</a></td>
96 <td class="property_flags">Read / Write</td>
97 </tr>
98 <tr>
99 <td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
100 <td class="property_name"><a class="link" href="GooCanvasEllipse.html#GooCanvasEllipse--y" title="The “y” property">y</a></td>
101 <td class="property_flags">Read / Write</td>
102 </tr>
103 </tbody>
104 </table></div>
105 </div>
106 <div class="refsect1">
107 <a name="GooCanvasEllipse.other"></a><h2>Types and Values</h2>
108 <div class="informaltable"><table width="100%" border="0">
109 <colgroup>
110 <col width="150px" class="name">
111 <col class="description">
112 </colgroup>
113 <tbody><tr>
114 <td class="datatype_keyword">struct</td>
115 <td class="function_name"><a class="link" href="GooCanvasEllipse.html#GooCanvasEllipse-struct" title="struct GooCanvasEllipse">GooCanvasEllipse</a></td>
116 </tr></tbody>
117 </table></div>
118 </div>
119 <div class="refsect1">
120 <a name="GooCanvasEllipse.object-hierarchy"></a><h2>Object Hierarchy</h2>
121 <pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
122 <span class="lineart">╰──</span> <a class="link" href="GooCanvasItemSimple.html" title="GooCanvasItemSimple">GooCanvasItemSimple</a>
123 <span class="lineart">╰──</span> GooCanvasEllipse
124 </pre>
125 </div>
126 <div class="refsect1">
127 <a name="GooCanvasEllipse.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
128 <p>
129 GooCanvasEllipse implements
130 <a class="link" href="GooCanvasItem.html" title="GooCanvasItem">GooCanvasItem</a>.</p>
131 </div>
132 <div class="refsect1">
133 <a name="GooCanvasEllipse.description"></a><h2>Description</h2>
134 <p>GooCanvasEllipse represents an ellipse item.</p>
135 <p>It is a subclass of <a class="link" href="GooCanvasItemSimple.html" title="GooCanvasItemSimple"><span class="type">GooCanvasItemSimple</span></a> and so inherits all of the style
136 properties such as "stroke-color", "fill-color" and "line-width".</p>
137 <p>It also implements the <a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="type">GooCanvasItem</span></a> interface, so you can use the
138 <a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="type">GooCanvasItem</span></a> functions such as <a class="link" href="GooCanvasItem.html#goo-canvas-item-raise" title="goo_canvas_item_raise ()"><code class="function">goo_canvas_item_raise()</code></a> and
139 <a class="link" href="GooCanvasItem.html#goo-canvas-item-rotate" title="goo_canvas_item_rotate ()"><code class="function">goo_canvas_item_rotate()</code></a>.</p>
140 <p>To create a <a class="link" href="GooCanvasEllipse.html" title="GooCanvasEllipse"><span class="type">GooCanvasEllipse</span></a> use <a class="link" href="GooCanvasEllipse.html#goo-canvas-ellipse-new" title="goo_canvas_ellipse_new ()"><code class="function">goo_canvas_ellipse_new()</code></a>.</p>
141 <p>To get or set the properties of an existing <a class="link" href="GooCanvasEllipse.html" title="GooCanvasEllipse"><span class="type">GooCanvasEllipse</span></a>, use
142 <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-get"><code class="function">g_object_get()</code></a> and <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-set"><code class="function">g_object_set()</code></a>.</p>
143 <p>The ellipse can be specified either with the "center-x", "center-y",
144 "radius-x" and "radius-y" properties, or with the "x", "y", "width" and
145 "height" properties.</p>
146 </div>
147 <div class="refsect1">
148 <a name="GooCanvasEllipse.functions_details"></a><h2>Functions</h2>
149 <div class="refsect2">
150 <a name="goo-canvas-ellipse-new"></a><h3>goo_canvas_ellipse_new ()</h3>
151 <pre class="programlisting"><a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="returnvalue">GooCanvasItem</span></a> *
152 goo_canvas_ellipse_new (<em class="parameter"><code><a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="type">GooCanvasItem</span></a> *parent</code></em>,
153 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> center_x</code></em>,
154 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> center_y</code></em>,
155 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> radius_x</code></em>,
156 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> radius_y</code></em>,
157 <em class="parameter"><code>...</code></em>);</pre>
158 <p>Creates a new ellipse item.</p>
159 <p>Here's an example showing how to create an ellipse centered at (100.0,
160 100.0), with a horizontal radius of 50.0 and a vertical radius of 30.0.
161 It is drawn with a red outline with a width of 5.0 and filled with blue:</p>
162 <div class="informalexample">
163 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
164 <tbody>
165 <tr>
166 <td class="listing_lines" align="right"><pre>1
167 2
168 3
169 4
170 5</pre></td>
171 <td class="listing_code"><pre class="programlisting"><span class="usertype">GooCanvasItem</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">ellipse </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GooCanvasEllipse.html#goo-canvas-ellipse-new">goo_canvas_ellipse_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">mygroup</span><span class="symbol">,</span><span class="normal"> </span><span class="number">100.0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">100.0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">50.0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">30.0</span><span class="symbol">,</span>
172 <span class="normal"> </span><span class="string">"stroke-color"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"red"</span><span class="symbol">,</span>
173 <span class="normal"> </span><span class="string">"line-width"</span><span class="symbol">,</span><span class="normal"> </span><span class="number">5.0</span><span class="symbol">,</span>
174 <span class="normal"> </span><span class="string">"fill-color"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"blue"</span><span class="symbol">,</span>
175 <span class="normal"> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span></pre></td>
176 </tr>
177 </tbody>
178 </table>
179 </div>
180
181 <div class="refsect3">
182 <a name="goo-canvas-ellipse-new.parameters"></a><h4>Parameters</h4>
183 <div class="informaltable"><table width="100%" border="0">
184 <colgroup>
185 <col width="150px" class="parameters_name">
186 <col class="parameters_description">
187 <col width="200px" class="parameters_annotations">
188 </colgroup>
189 <tbody>
190 <tr>
191 <td class="parameter_name"><p>parent</p></td>
192 <td class="parameter_description"><p>the parent item, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. If a parent is specified, it will assume
193 ownership of the item, and the item will automatically be freed when it is
194 removed from the parent. Otherwise call <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> to free it. </p></td>
195 <td class="parameter_annotations"><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></td>
196 </tr>
197 <tr>
198 <td class="parameter_name"><p>center_x</p></td>
199 <td class="parameter_description"><p>the x coordinate of the center of the ellipse.</p></td>
200 <td class="parameter_annotations"> </td>
201 </tr>
202 <tr>
203 <td class="parameter_name"><p>center_y</p></td>
204 <td class="parameter_description"><p>the y coordinate of the center of the ellipse.</p></td>
205 <td class="parameter_annotations"> </td>
206 </tr>
207 <tr>
208 <td class="parameter_name"><p>radius_x</p></td>
209 <td class="parameter_description"><p>the horizontal radius of the ellipse.</p></td>
210 <td class="parameter_annotations"> </td>
211 </tr>
212 <tr>
213 <td class="parameter_name"><p>radius_y</p></td>
214 <td class="parameter_description"><p>the vertical radius of the ellipse.</p></td>
215 <td class="parameter_annotations"> </td>
216 </tr>
217 <tr>
218 <td class="parameter_name"><p>...</p></td>
219 <td class="parameter_description"><p>optional pairs of property names and values, and a terminating <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
220 <td class="parameter_annotations"> </td>
221 </tr>
222 </tbody>
223 </table></div>
224 </div>
225 <div class="refsect3">
226 <a name="goo-canvas-ellipse-new.returns"></a><h4>Returns</h4>
227 <p>a new ellipse item. </p>
228 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
229 </div>
230 </div>
231 </div>
232 <div class="refsect1">
233 <a name="GooCanvasEllipse.other_details"></a><h2>Types and Values</h2>
234 <div class="refsect2">
235 <a name="GooCanvasEllipse-struct"></a><h3>struct GooCanvasEllipse</h3>
236 <pre class="programlisting">struct GooCanvasEllipse;</pre>
237 <p>The <a class="link" href="GooCanvasEllipse.html#GooCanvasEllipse-struct" title="struct GooCanvasEllipse"><span class="type">GooCanvasEllipse</span></a> struct contains private data only.</p>
238 </div>
239 </div>
240 <div class="refsect1">
241 <a name="GooCanvasEllipse.property-details"></a><h2>Property Details</h2>
242 <div class="refsect2">
243 <a name="GooCanvasEllipse--center-x"></a><h3>The <code class="literal">“center-x”</code> property</h3>
244 <pre class="programlisting"> “center-x” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
245 <p>The x coordinate of the center of the ellipse.</p>
246 <p>Flags: Read / Write</p>
247 <p>Default value: 0</p>
248 </div>
249 <hr>
250 <div class="refsect2">
251 <a name="GooCanvasEllipse--center-y"></a><h3>The <code class="literal">“center-y”</code> property</h3>
252 <pre class="programlisting"> “center-y” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
253 <p>The y coordinate of the center of the ellipse.</p>
254 <p>Flags: Read / Write</p>
255 <p>Default value: 0</p>
256 </div>
257 <hr>
258 <div class="refsect2">
259 <a name="GooCanvasEllipse--height"></a><h3>The <code class="literal">“height”</code> property</h3>
260 <pre class="programlisting"> “height” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
261 <p>The height of the ellipse.</p>
262 <p>Flags: Read / Write</p>
263 <p>Allowed values: &gt;= 0</p>
264 <p>Default value: 0</p>
265 </div>
266 <hr>
267 <div class="refsect2">
268 <a name="GooCanvasEllipse--radius-x"></a><h3>The <code class="literal">“radius-x”</code> property</h3>
269 <pre class="programlisting"> “radius-x” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
270 <p>The horizontal radius of the ellipse.</p>
271 <p>Flags: Read / Write</p>
272 <p>Allowed values: &gt;= 0</p>
273 <p>Default value: 0</p>
274 </div>
275 <hr>
276 <div class="refsect2">
277 <a name="GooCanvasEllipse--radius-y"></a><h3>The <code class="literal">“radius-y”</code> property</h3>
278 <pre class="programlisting"> “radius-y” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
279 <p>The vertical radius of the ellipse.</p>
280 <p>Flags: Read / Write</p>
281 <p>Allowed values: &gt;= 0</p>
282 <p>Default value: 0</p>
283 </div>
284 <hr>
285 <div class="refsect2">
286 <a name="GooCanvasEllipse--width"></a><h3>The <code class="literal">“width”</code> property</h3>
287 <pre class="programlisting"> “width” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
288 <p>The width of the ellipse.</p>
289 <p>Flags: Read / Write</p>
290 <p>Allowed values: &gt;= 0</p>
291 <p>Default value: 0</p>
292 </div>
293 <hr>
294 <div class="refsect2">
295 <a name="GooCanvasEllipse--x"></a><h3>The <code class="literal">“x”</code> property</h3>
296 <pre class="programlisting"> “x” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
297 <p>The x coordinate of the left side of the ellipse.</p>
298 <p>Flags: Read / Write</p>
299 <p>Default value: 0</p>
300 </div>
301 <hr>
302 <div class="refsect2">
303 <a name="GooCanvasEllipse--y"></a><h3>The <code class="literal">“y”</code> property</h3>
304 <pre class="programlisting"> “y” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
305 <p>The y coordinate of the top of the ellipse.</p>
306 <p>Flags: Read / Write</p>
307 <p>Default value: 0</p>
308 </div>
309 </div>
310 </div>
311 <div class="footer">
312 <hr>Generated by GTK-Doc V1.26</div>
313 </body>
314 </html>