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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GnomeCanvasShape</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GNOME Canvas Library Reference Manual">
<link rel="up" href="ch02.html" title="GNOME Canvas Library (libgnomecanvas)">
<link rel="prev" href="GnomeCanvasRichText.html" title="GnomeCanvasRichText">
<link rel="next" href="libgnomecanvas-gnome-canvas-text.html" title="GnomeCanvasText">
<meta name="generator" content="GTK-Doc V1.16 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GnomeCanvasRichText.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME Canvas Library Reference Manual</th>
<td><a accesskey="n" href="libgnomecanvas-gnome-canvas-text.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GnomeCanvasShape.synopsis" class="shortcut">Top</a>
|
<a href="#GnomeCanvasShape.description" class="shortcut">Description</a>
|
<a href="#GnomeCanvasShape.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GnomeCanvasShape.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="GnomeCanvasShape"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GnomeCanvasShape.top_of_page"></a>GnomeCanvasShape</span></h2>
<p>GnomeCanvasShape — Base class for canvas item shapes</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GnomeCanvasShape.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgnomecanvas/libgnomecanvas.h>
struct <a class="link" href="GnomeCanvasShape.html#GnomeCanvasShape-struct" title="struct GnomeCanvasShape">GnomeCanvasShape</a>;
<span class="returnvalue">void</span> <a class="link" href="GnomeCanvasShape.html#gnome-canvas-shape-set-path-def" title="gnome_canvas_shape_set_path_def ()">gnome_canvas_shape_set_path_def</a> (<em class="parameter"><code><a class="link" href="GnomeCanvasShape.html" title="GnomeCanvasShape"><span class="type">GnomeCanvasShape</span></a> *shape</code></em>,
<em class="parameter"><code><a class="link" href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef"><span class="type">GnomeCanvasPathDef</span></a> *def</code></em>);
<a class="link" href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef"><span class="returnvalue">GnomeCanvasPathDef</span></a> * <a class="link" href="GnomeCanvasShape.html#gnome-canvas-shape-get-path-def" title="gnome_canvas_shape_get_path_def ()">gnome_canvas_shape_get_path_def</a> (<em class="parameter"><code><a class="link" href="GnomeCanvasShape.html" title="GnomeCanvasShape"><span class="type">GnomeCanvasShape</span></a> *shape</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GnomeCanvasShape.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="../gtk/GtkObject.html">GtkObject</a>
+----<a class="link" href="GnomeCanvasItem.html" title="GnomeCanvasItem">GnomeCanvasItem</a>
+----GnomeCanvasShape
+----<a class="link" href="GnomeCanvasBpath.html" title="GnomeCanvasBpath">GnomeCanvasBpath</a>
+----<a class="link" href="GnomeCanvasRE.html" title="GnomeCanvasRE">GnomeCanvasRE</a>
+----<a class="link" href="GnomeCanvasPolygon.html" title="GnomeCanvasPolygon">GnomeCanvasPolygon</a>
</pre>
</div>
<div class="refsect1">
<a name="GnomeCanvasShape.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GnomeCanvasShape.html#GnomeCanvasShape--cap-style" title='The "cap-style" property'>cap-style</a>" <a href="../gdk/gdk-Graphics-Contexts.html#GdkCapStyle"><span class="type">GdkCapStyle</span></a> : Read / Write
"<a class="link" href="GnomeCanvasShape.html#GnomeCanvasShape--dash" title='The "dash" property'>dash</a>" <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> : Read / Write
"<a class="link" href="GnomeCanvasShape.html#GnomeCanvasShape--fill-color" title='The "fill-color" property'>fill-color</a>" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write
"<a class="link" href="GnomeCanvasShape.html#GnomeCanvasShape--fill-color-gdk" title='The "fill-color-gdk" property'>fill-color-gdk</a>" <a href="../gdk/gdk-Colormaps-and-Colors.html#GdkColor"><span class="type">GdkColor</span></a>* : Read / Write
"<a class="link" href="GnomeCanvasShape.html#GnomeCanvasShape--fill-color-rgba" title='The "fill-color-rgba" property'>fill-color-rgba</a>" <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
"<a class="link" href="GnomeCanvasShape.html#GnomeCanvasShape--fill-stipple" title='The "fill-stipple" property'>fill-stipple</a>" <a href="../gdk/gdk-Drawing-Primitives.html#GdkDrawable"><span class="type">GdkDrawable</span></a>* : Read / Write
"<a class="link" href="GnomeCanvasShape.html#GnomeCanvasShape--join-style" title='The "join-style" property'>join-style</a>" <a href="../gdk/gdk-Graphics-Contexts.html#GdkJoinStyle"><span class="type">GdkJoinStyle</span></a> : Read / Write
"<a class="link" href="GnomeCanvasShape.html#GnomeCanvasShape--miterlimit" title='The "miterlimit" property'>miterlimit</a>" <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
"<a class="link" href="GnomeCanvasShape.html#GnomeCanvasShape--outline-color" title='The "outline-color" property'>outline-color</a>" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write
"<a class="link" href="GnomeCanvasShape.html#GnomeCanvasShape--outline-color-gdk" title='The "outline-color-gdk" property'>outline-color-gdk</a>" <a href="../gdk/gdk-Colormaps-and-Colors.html#GdkColor"><span class="type">GdkColor</span></a>* : Read / Write
"<a class="link" href="GnomeCanvasShape.html#GnomeCanvasShape--outline-color-rgba" title='The "outline-color-rgba" property'>outline-color-rgba</a>" <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
"<a class="link" href="GnomeCanvasShape.html#GnomeCanvasShape--outline-stipple" title='The "outline-stipple" property'>outline-stipple</a>" <a href="../gdk/gdk-Drawing-Primitives.html#GdkDrawable"><span class="type">GdkDrawable</span></a>* : Read / Write
"<a class="link" href="GnomeCanvasShape.html#GnomeCanvasShape--width-pixels" title='The "width-pixels" property'>width-pixels</a>" <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
"<a class="link" href="GnomeCanvasShape.html#GnomeCanvasShape--width-units" title='The "width-units" property'>width-units</a>" <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
"<a class="link" href="GnomeCanvasShape.html#GnomeCanvasShape--wind" title='The "wind" property'>wind</a>" <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="GnomeCanvasShape.description"></a><h2>Description</h2>
<p>
Provides a base class for canvas item shapes, including: <a class="link" href="GnomeCanvasBpath.html" title="GnomeCanvasBpath"><span class="type">GnomeCanvasBpath</span></a>,
<a class="link" href="GnomeCanvasEllipse.html" title="GnomeCanvasEllipse"><span class="type">GnomeCanvasEllipse</span></a>, <a class="link" href="GnomeCanvasRect.html" title="GnomeCanvasRect"><span class="type">GnomeCanvasRect</span></a>, and <a class="link" href="GnomeCanvasPolygon.html" title="GnomeCanvasPolygon"><span class="type">GnomeCanvasPolygon</span></a>.
</p>
</div>
<div class="refsect1">
<a name="GnomeCanvasShape.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GnomeCanvasShape-struct"></a><h3>struct GnomeCanvasShape</h3>
<pre class="programlisting">struct GnomeCanvasShape;</pre>
<p>
This structure should not be accessed directly. Use the object's properties
and functions for querying or changing its parameters.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gnome-canvas-shape-set-path-def"></a><h3>gnome_canvas_shape_set_path_def ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_canvas_shape_set_path_def (<em class="parameter"><code><a class="link" href="GnomeCanvasShape.html" title="GnomeCanvasShape"><span class="type">GnomeCanvasShape</span></a> *shape</code></em>,
<em class="parameter"><code><a class="link" href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef"><span class="type">GnomeCanvasPathDef</span></a> *def</code></em>);</pre>
<p>
This function sets the the GnomeCanvasPathDef used by the
GnomeCanvasShape. Notice, that it does not request updates, as
it is meant to be used from item implementations, from inside
update queue.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shape</code></em> :</span></p></td>
<td>a GnomeCanvasShape</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>def</code></em> :</span></p></td>
<td>a GnomeCanvasPathDef</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-canvas-shape-get-path-def"></a><h3>gnome_canvas_shape_get_path_def ()</h3>
<pre class="programlisting"><a class="link" href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef"><span class="returnvalue">GnomeCanvasPathDef</span></a> * gnome_canvas_shape_get_path_def (<em class="parameter"><code><a class="link" href="GnomeCanvasShape.html" title="GnomeCanvasShape"><span class="type">GnomeCanvasShape</span></a> *shape</code></em>);</pre>
<p>
This function returns the <a class="link" href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef"><span class="type">GnomeCanvasPathDef</span></a> that the shape
currently uses. It adds a reference to the <a class="link" href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef"><span class="type">GnomeCanvasPathDef</span></a> and
returns it, if there is not a <a class="link" href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef"><span class="type">GnomeCanvasPathDef</span></a> set for the shape
it returns NULL.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shape</code></em> :</span></p></td>
<td>a GnomeCanvasShape</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef"><span class="type">GnomeCanvasPathDef</span></a> or NULL if none is set for the shape.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GnomeCanvasShape.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GnomeCanvasShape--cap-style"></a><h3>The <code class="literal">"cap-style"</code> property</h3>
<pre class="programlisting"> "cap-style" <a href="../gdk/gdk-Graphics-Contexts.html#GdkCapStyle"><span class="type">GdkCapStyle</span></a> : Read / Write</pre>
<p>
Cap (end point) style for the bpath.
</p>
<p>Default value: GDK_CAP_BUTT</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasShape--dash"></a><h3>The <code class="literal">"dash"</code> property</h3>
<pre class="programlisting"> "dash" <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> : Read / Write</pre>
<p>
Dashing pattern.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasShape--fill-color"></a><h3>The <code class="literal">"fill-color"</code> property</h3>
<pre class="programlisting"> "fill-color" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write</pre>
<p>
X color specification for fill color, or NULL pointer for no color
(transparent).
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasShape--fill-color-gdk"></a><h3>The <code class="literal">"fill-color-gdk"</code> property</h3>
<pre class="programlisting"> "fill-color-gdk" <a href="../gdk/gdk-Colormaps-and-Colors.html#GdkColor"><span class="type">GdkColor</span></a>* : Read / Write</pre>
<p>
Allocated GdkColor for fill.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasShape--fill-color-rgba"></a><h3>The <code class="literal">"fill-color-rgba"</code> property</h3>
<pre class="programlisting"> "fill-color-rgba" <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
<p>
Fill color with an alpha component (in the format 0xRRGGBBAA).
</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasShape--fill-stipple"></a><h3>The <code class="literal">"fill-stipple"</code> property</h3>
<pre class="programlisting"> "fill-stipple" <a href="../gdk/gdk-Drawing-Primitives.html#GdkDrawable"><span class="type">GdkDrawable</span></a>* : Read / Write</pre>
<p>
Stipple pattern for fill.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasShape--join-style"></a><h3>The <code class="literal">"join-style"</code> property</h3>
<pre class="programlisting"> "join-style" <a href="../gdk/gdk-Graphics-Contexts.html#GdkJoinStyle"><span class="type">GdkJoinStyle</span></a> : Read / Write</pre>
<p>
Vertex join style for the bpath.
</p>
<p>Default value: GDK_JOIN_MITER</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasShape--miterlimit"></a><h3>The <code class="literal">"miterlimit"</code> property</h3>
<pre class="programlisting"> "miterlimit" <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre>
<p>
Minimum angle between segments, where miter join rule is applied.
</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasShape--outline-color"></a><h3>The <code class="literal">"outline-color"</code> property</h3>
<pre class="programlisting"> "outline-color" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write</pre>
<p>
X color specification for outline color, or NULL pointer for no color
(transparent).
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasShape--outline-color-gdk"></a><h3>The <code class="literal">"outline-color-gdk"</code> property</h3>
<pre class="programlisting"> "outline-color-gdk" <a href="../gdk/gdk-Colormaps-and-Colors.html#GdkColor"><span class="type">GdkColor</span></a>* : Read / Write</pre>
<p>
Allocated GdkColor for outline.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasShape--outline-color-rgba"></a><h3>The <code class="literal">"outline-color-rgba"</code> property</h3>
<pre class="programlisting"> "outline-color-rgba" <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
<p>
Outline color with an alpha component (in the format 0xRRGGBBAA).
</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasShape--outline-stipple"></a><h3>The <code class="literal">"outline-stipple"</code> property</h3>
<pre class="programlisting"> "outline-stipple" <a href="../gdk/gdk-Drawing-Primitives.html#GdkDrawable"><span class="type">GdkDrawable</span></a>* : Read / Write</pre>
<p>
Stipple pattern for outline.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasShape--width-pixels"></a><h3>The <code class="literal">"width-pixels"</code> property</h3>
<pre class="programlisting"> "width-pixels" <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
<p>
Width of the outline in pixels. The outline will not be scaled when the
canvas zoom factor is changed.
</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasShape--width-units"></a><h3>The <code class="literal">"width-units"</code> property</h3>
<pre class="programlisting"> "width-units" <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre>
<p>
Width of the outline in canvas units. The outline will be scaled when
the canvas zoom factor is changed.
</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasShape--wind"></a><h3>The <code class="literal">"wind"</code> property</h3>
<pre class="programlisting"> "wind" <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
<p>
Winding rule for the bpath (ArtWindRule).
</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.16</div>
</body>
</html>
|
