File: GnomeCanvasLine.html

package info (click to toggle)
libgnomecanvas 2.30.3-1.2
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 4,868 kB
  • sloc: ansic: 15,402; sh: 11,080; makefile: 204
file content (265 lines) | stat: -rw-r--r-- 16,329 bytes parent folder | download | duplicates (5)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GnomeCanvasLine</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="GnomeCanvasItem.html" title="GnomeCanvasItem">
<link rel="next" href="GnomeCanvasPixbuf.html" title="GnomeCanvasPixbuf">
<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="GnomeCanvasItem.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="GnomeCanvasPixbuf.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GnomeCanvasLine.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GnomeCanvasLine.description" class="shortcut">Description</a>
                   | 
                  <a href="#GnomeCanvasLine.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GnomeCanvasLine.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="GnomeCanvasLine"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GnomeCanvasLine.top_of_page"></a>GnomeCanvasLine</span></h2>
<p>GnomeCanvasLine — Line canvas item</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GnomeCanvasLine.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libgnomecanvas/libgnomecanvas.h&gt;

struct              <a class="link" href="GnomeCanvasLine.html#GnomeCanvasLine-struct" title="struct GnomeCanvasLine">GnomeCanvasLine</a>;
</pre>
</div>
<div class="refsect1">
<a name="GnomeCanvasLine.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>
                     +----GnomeCanvasLine
</pre>
</div>
<div class="refsect1">
<a name="GnomeCanvasLine.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GnomeCanvasLine.html#GnomeCanvasLine--arrow-shape-a" title='The "arrow-shape-a" property'>arrow-shape-a</a>"            <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  "<a class="link" href="GnomeCanvasLine.html#GnomeCanvasLine--arrow-shape-b" title='The "arrow-shape-b" property'>arrow-shape-b</a>"            <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  "<a class="link" href="GnomeCanvasLine.html#GnomeCanvasLine--arrow-shape-c" title='The "arrow-shape-c" property'>arrow-shape-c</a>"            <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  "<a class="link" href="GnomeCanvasLine.html#GnomeCanvasLine--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="GnomeCanvasLine.html#GnomeCanvasLine--fill-color" title='The "fill-color" property'>fill-color</a>"               <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  "<a class="link" href="GnomeCanvasLine.html#GnomeCanvasLine--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="GnomeCanvasLine.html#GnomeCanvasLine--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="GnomeCanvasLine.html#GnomeCanvasLine--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="GnomeCanvasLine.html#GnomeCanvasLine--first-arrowhead" title='The "first-arrowhead" property'>first-arrowhead</a>"          <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  "<a class="link" href="GnomeCanvasLine.html#GnomeCanvasLine--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="GnomeCanvasLine.html#GnomeCanvasLine--last-arrowhead" title='The "last-arrowhead" property'>last-arrowhead</a>"           <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  "<a class="link" href="GnomeCanvasLine.html#GnomeCanvasLine--line-style" title='The "line-style" property'>line-style</a>"               <a href="../gdk/gdk-Graphics-Contexts.html#GdkLineStyle"><span class="type">GdkLineStyle</span></a>          : Read / Write
  "<a class="link" href="GnomeCanvasLine.html#GnomeCanvasLine--points" title='The "points" property'>points</a>"                   <a class="link" href="libgnomecanvas-gnome-canvas-util.html#GnomeCanvasPoints"><span class="type">GnomeCanvasPoints</span></a>*    : Read / Write
  "<a class="link" href="GnomeCanvasLine.html#GnomeCanvasLine--smooth" title='The "smooth" property'>smooth</a>"                   <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  "<a class="link" href="GnomeCanvasLine.html#GnomeCanvasLine--spline-steps" title='The "spline-steps" property'>spline-steps</a>"             <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  "<a class="link" href="GnomeCanvasLine.html#GnomeCanvasLine--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="GnomeCanvasLine.html#GnomeCanvasLine--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
</pre>
</div>
<div class="refsect1">
<a name="GnomeCanvasLine.description"></a><h2>Description</h2>
<p>
A canvas item for drawing lines. This canvas item uses a <a class="link" href="libgnomecanvas-gnome-canvas-util.html#GnomeCanvasPoints"><span class="type">GnomeCanvasPoints</span></a>
structure so one or multiple joined lined segments can be drawn with a single
<a class="link" href="GnomeCanvasLine.html" title="GnomeCanvasLine"><span class="type">GnomeCanvasLine</span></a> item.
</p>
</div>
<div class="refsect1">
<a name="GnomeCanvasLine.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GnomeCanvasLine-struct"></a><h3>struct GnomeCanvasLine</h3>
<pre class="programlisting">struct GnomeCanvasLine;</pre>
<p>
This structure should not be accessed directly. Use the object's properties
for querying or changing its parameters.
</p>
</div>
</div>
<div class="refsect1">
<a name="GnomeCanvasLine.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GnomeCanvasLine--arrow-shape-a"></a><h3>The <code class="literal">"arrow-shape-a"</code> property</h3>
<pre class="programlisting">  "arrow-shape-a"            <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
<p>
Distance from tip of arrowhead to center.
</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasLine--arrow-shape-b"></a><h3>The <code class="literal">"arrow-shape-b"</code> property</h3>
<pre class="programlisting">  "arrow-shape-b"            <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
<p>
Distance from tip of arrowhead to trailing point, measured along shaft.
</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasLine--arrow-shape-c"></a><h3>The <code class="literal">"arrow-shape-c"</code> property</h3>
<pre class="programlisting">  "arrow-shape-c"            <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
<p>
Distance of arrowhead trailing points from outside edge of shaft.
</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasLine--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>
Determines how the ends of lines are drawn (the line cap style).
</p>
<p>Default value: GDK_CAP_BUTT</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasLine--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>*                : Read / Write</pre>
<p>
X color specification for line.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasLine--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>
Pointer to an allocated GdkColor to draw the line with.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasLine--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>
Line color with an alpha component (in the format 0xRRGGBBAA).
</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasLine--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 the line.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasLine--first-arrowhead"></a><h3>The <code class="literal">"first-arrowhead"</code> property</h3>
<pre class="programlisting">  "first-arrowhead"          <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
<p>
Specifies whether to draw an arrowhead on the first point of the line.
</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasLine--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 line segments (GDK_JOIN_MITER to join by
extending each line to meet at an angle, GDK_JOIN_ROUND to join by a
circular arc, and GDK_JOIN_BEVEL to join by a straight line which
makes an equal angle with each line).
</p>
<p>Default value: GDK_JOIN_MITER</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasLine--last-arrowhead"></a><h3>The <code class="literal">"last-arrowhead"</code> property</h3>
<pre class="programlisting">  "last-arrowhead"           <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
<p>
Specifies whether to draw an arrowhead on the last point of the line.
</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasLine--line-style"></a><h3>The <code class="literal">"line-style"</code> property</h3>
<pre class="programlisting">  "line-style"               <a href="../gdk/gdk-Graphics-Contexts.html#GdkLineStyle"><span class="type">GdkLineStyle</span></a>          : Read / Write</pre>
<p>
Line dash style.
</p>
<p>Default value: GDK_LINE_SOLID</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasLine--points"></a><h3>The <code class="literal">"points"</code> property</h3>
<pre class="programlisting">  "points"                   <a class="link" href="libgnomecanvas-gnome-canvas-util.html#GnomeCanvasPoints"><span class="type">GnomeCanvasPoints</span></a>*    : Read / Write</pre>
<p>
Pointer to a <a class="link" href="libgnomecanvas-gnome-canvas-util.html#GnomeCanvasPoints"><span class="type">GnomeCanvasPoints</span></a> structure. This can be created by a
call to <a class="link" href="libgnomecanvas-gnome-canvas-util.html#gnome-canvas-points-new" title="gnome_canvas_points_new ()"><code class="function">gnome_canvas_points_new()</code></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasLine--smooth"></a><h3>The <code class="literal">"smooth"</code> property</h3>
<pre class="programlisting">  "smooth"                   <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
<p>
Specifies whether to smooth the line using parabolic splines.
</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasLine--spline-steps"></a><h3>The <code class="literal">"spline-steps"</code> property</h3>
<pre class="programlisting">  "spline-steps"             <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
<p>
Specifies the number of steps to use when rendering curves.
</p>
<p>Default value: 12</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasLine--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 line in pixels.  The line width will not be scaled when
the canvas zoom factor changes.
</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeCanvasLine--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 line in canvas units.  The line width will be scaled when
the canvas zoom factor changes.
</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.16</div>
</body>
</html>