/usr/share/gtk-doc/html/goocanvas/GooCanvasPolyline.html is in libgoocanvas-dev 1.0.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GooCanvasPolyline</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GooCanvas Reference Manual">
<link rel="up" href="ch03.html" title="Standard Canvas Items">
<link rel="prev" href="GooCanvasPath.html" title="GooCanvasPath">
<link rel="next" href="GooCanvasRect.html" title="GooCanvasRect">
<meta name="generator" content="GTK-Doc V1.14 (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="GooCanvasPath.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.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">GooCanvas Reference Manual</th>
<td><a accesskey="n" href="GooCanvasRect.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GooCanvasPolyline.synopsis" class="shortcut">Top</a>
|
<a href="#GooCanvasPolyline.description" class="shortcut">Description</a>
|
<a href="#GooCanvasPolyline.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GooCanvasPolyline.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GooCanvasPolyline.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="GooCanvasPolyline">
<a name="GooCanvasPolyline"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GooCanvasPolyline.top_of_page"></a>GooCanvasPolyline</span></h2>
<p>GooCanvasPolyline — a polyline item (a series of lines with optional arrows).</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="GooCanvasPolyline.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="GooCanvasPolyline.html#GooCanvasPolyline-struct" title="GooCanvasPolyline">GooCanvasPolyline</a>;
<a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="returnvalue">GooCanvasItem</span></a>* <a class="link" href="GooCanvasPolyline.html#goo-canvas-polyline-new" title="goo_canvas_polyline_new ()">goo_canvas_polyline_new</a> (<em class="parameter"><code><a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="type">GooCanvasItem</span></a> *parent</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> close_path</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_points</code></em>,
<em class="parameter"><code>...</code></em>);
<a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="returnvalue">GooCanvasItem</span></a>* <a class="link" href="GooCanvasPolyline.html#goo-canvas-polyline-new-line" title="goo_canvas_polyline_new_line ()">goo_canvas_polyline_new_line</a> (<em class="parameter"><code><a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="type">GooCanvasItem</span></a> *parent</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x1</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y1</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x2</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y2</code></em>,
<em class="parameter"><code>...</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="GooCanvasPolyline.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="GooCanvasItemSimple.html" title="GooCanvasItemSimple">GooCanvasItemSimple</a>
+----GooCanvasPolyline
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="GooCanvasPolyline.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GooCanvasPolyline implements
<a class="link" href="GooCanvasItem.html" title="GooCanvasItem">GooCanvasItem</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="GooCanvasPolyline.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GooCanvasPolyline.html#GooCanvasPolyline--arrow-length" title='The "arrow-length" property'>arrow-length</a>" <span class="type">gdouble</span> : Read / Write
"<a class="link" href="GooCanvasPolyline.html#GooCanvasPolyline--arrow-tip-length" title='The "arrow-tip-length" property'>arrow-tip-length</a>" <span class="type">gdouble</span> : Read / Write
"<a class="link" href="GooCanvasPolyline.html#GooCanvasPolyline--arrow-width" title='The "arrow-width" property'>arrow-width</a>" <span class="type">gdouble</span> : Read / Write
"<a class="link" href="GooCanvasPolyline.html#GooCanvasPolyline--close-path" title='The "close-path" property'>close-path</a>" <span class="type">gboolean</span> : Read / Write
"<a class="link" href="GooCanvasPolyline.html#GooCanvasPolyline--end-arrow" title='The "end-arrow" property'>end-arrow</a>" <span class="type">gboolean</span> : Read / Write
"<a class="link" href="GooCanvasPolyline.html#GooCanvasPolyline--height" title='The "height" property'>height</a>" <span class="type">gdouble</span> : Read / Write
"<a class="link" href="GooCanvasPolyline.html#GooCanvasPolyline--points" title='The "points" property'>points</a>" <a class="link" href="goocanvas-GooCanvas-Types.html#GooCanvasPoints" title="GooCanvasPoints"><span class="type">GooCanvasPoints</span></a>* : Read / Write
"<a class="link" href="GooCanvasPolyline.html#GooCanvasPolyline--start-arrow" title='The "start-arrow" property'>start-arrow</a>" <span class="type">gboolean</span> : Read / Write
"<a class="link" href="GooCanvasPolyline.html#GooCanvasPolyline--width" title='The "width" property'>width</a>" <span class="type">gdouble</span> : Read / Write
"<a class="link" href="GooCanvasPolyline.html#GooCanvasPolyline--x" title='The "x" property'>x</a>" <span class="type">gdouble</span> : Read / Write
"<a class="link" href="GooCanvasPolyline.html#GooCanvasPolyline--y" title='The "y" property'>y</a>" <span class="type">gdouble</span> : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="GooCanvasPolyline.description"></a><h2>Description</h2>
<p>
GooCanvasPolyline represents a polyline item, which is a series of one or
more lines, with optional arrows at either end.
</p>
<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
properties such as "stroke-color", "fill-color" and "line-width".
</p>
<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
<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
<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>
<p>
To create a <a class="link" href="GooCanvasPolyline.html" title="GooCanvasPolyline"><span class="type">GooCanvasPolyline</span></a> use <a class="link" href="GooCanvasPolyline.html#goo-canvas-polyline-new" title="goo_canvas_polyline_new ()"><code class="function">goo_canvas_polyline_new()</code></a>, or
<a class="link" href="GooCanvasPolyline.html#goo-canvas-polyline-new-line" title="goo_canvas_polyline_new_line ()"><code class="function">goo_canvas_polyline_new_line()</code></a> for a simple line between two points.
</p>
<p>
To get or set the properties of an existing <a class="link" href="GooCanvasPolyline.html" title="GooCanvasPolyline"><span class="type">GooCanvasPolyline</span></a>, use
<code class="function">g_object_get()</code> and <code class="function">g_object_set()</code>.
</p>
</div>
<div class="refsect1" title="Details">
<a name="GooCanvasPolyline.details"></a><h2>Details</h2>
<div class="refsect2" title="GooCanvasPolyline">
<a name="GooCanvasPolyline-struct"></a><h3>GooCanvasPolyline</h3>
<pre class="programlisting">typedef struct _GooCanvasPolyline GooCanvasPolyline;</pre>
<p>
The <a class="link" href="GooCanvasPolyline.html#GooCanvasPolyline-struct" title="GooCanvasPolyline"><span class="type">GooCanvasPolyline</span></a> struct contains private data only.
</p>
</div>
<hr>
<div class="refsect2" title="goo_canvas_polyline_new ()">
<a name="goo-canvas-polyline-new"></a><h3>goo_canvas_polyline_new ()</h3>
<pre class="programlisting"><a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="returnvalue">GooCanvasItem</span></a>* goo_canvas_polyline_new (<em class="parameter"><code><a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="type">GooCanvasItem</span></a> *parent</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> close_path</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_points</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
Creates a new polyline item.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>the parent item, or <code class="literal">NULL</code>. If a parent is specified, it will assume
ownership of the item, and the item will automatically be freed when it is
removed from the parent. Otherwise call <code class="function">g_object_unref()</code> to free it.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>close_path</code></em> :</span></p></td>
<td>if the last point should be connected to the first.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_points</code></em> :</span></p></td>
<td>the number of points in the polyline.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>the pairs of coordinates for each point in the line, followed by
optional pairs of property names and values, and a terminating <code class="literal">NULL</code>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new polyline item.
</td>
</tr>
</tbody>
</table></div>
<p>
Here's an example showing how to create a filled triangle with vertices
at (100,100), (300,100), and (200,300).
</p>
<p>
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="normal"><a href="GooCanvasItem.html">GooCanvasItem</a> </span><span class="symbol">*</span><span class="normal">polyline </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GooCanvasPolyline.html#goo-canvas-polyline-new">goo_canvas_polyline_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">mygroup</span><span class="symbol">,</span><span class="normal"> TRUE</span><span class="symbol">,</span><span class="normal"> </span><span class="number">3</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">300.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">200.0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">300.0</span><span class="symbol">,</span>
<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>
<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>
<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>
<span class="normal"> NULL</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="goo_canvas_polyline_new_line ()">
<a name="goo-canvas-polyline-new-line"></a><h3>goo_canvas_polyline_new_line ()</h3>
<pre class="programlisting"><a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="returnvalue">GooCanvasItem</span></a>* goo_canvas_polyline_new_line (<em class="parameter"><code><a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="type">GooCanvasItem</span></a> *parent</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x1</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y1</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x2</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y2</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
Creates a new polyline item with a single line.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>the parent item, or <code class="literal">NULL</code>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x1</code></em> :</span></p></td>
<td>the x coordinate of the start of the line.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y1</code></em> :</span></p></td>
<td>the y coordinate of the start of the line.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x2</code></em> :</span></p></td>
<td>the x coordinate of the end of the line.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y2</code></em> :</span></p></td>
<td>the y coordinate of the end of the line.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>optional pairs of property names and values, and a terminating <code class="literal">NULL</code>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new polyline item.
</td>
</tr>
</tbody>
</table></div>
<p>
Here's an example showing how to create a line from (100,100) to (300,300).
</p>
<p>
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="normal"><a href="GooCanvasItem.html">GooCanvasItem</a> </span><span class="symbol">*</span><span class="normal">polyline </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GooCanvasPolyline.html#goo-canvas-polyline-new-line">goo_canvas_polyline_new_line</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">300.0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">300.0</span><span class="symbol">,</span>
<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>
<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>
<span class="normal"> NULL</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="GooCanvasPolyline.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "arrow-length" property'>
<a name="GooCanvasPolyline--arrow-length"></a><h3>The <code class="literal">"arrow-length"</code> property</h3>
<pre class="programlisting"> "arrow-length" <span class="type">gdouble</span> : Read / Write</pre>
<p>The length of the arrows, as a multiple of the line width.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 5</p>
</div>
<hr>
<div class="refsect2" title='The "arrow-tip-length" property'>
<a name="GooCanvasPolyline--arrow-tip-length"></a><h3>The <code class="literal">"arrow-tip-length"</code> property</h3>
<pre class="programlisting"> "arrow-tip-length" <span class="type">gdouble</span> : Read / Write</pre>
<p>The length of the arrow tip, as a multiple of the line width.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 4</p>
</div>
<hr>
<div class="refsect2" title='The "arrow-width" property'>
<a name="GooCanvasPolyline--arrow-width"></a><h3>The <code class="literal">"arrow-width"</code> property</h3>
<pre class="programlisting"> "arrow-width" <span class="type">gdouble</span> : Read / Write</pre>
<p>The width of the arrows, as a multiple of the line width.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 4</p>
</div>
<hr>
<div class="refsect2" title='The "close-path" property'>
<a name="GooCanvasPolyline--close-path"></a><h3>The <code class="literal">"close-path"</code> property</h3>
<pre class="programlisting"> "close-path" <span class="type">gboolean</span> : Read / Write</pre>
<p>If the last point should be connected to the first.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" title='The "end-arrow" property'>
<a name="GooCanvasPolyline--end-arrow"></a><h3>The <code class="literal">"end-arrow"</code> property</h3>
<pre class="programlisting"> "end-arrow" <span class="type">gboolean</span> : Read / Write</pre>
<p>If an arrow should be displayed at the end of the polyline.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" title='The "height" property'>
<a name="GooCanvasPolyline--height"></a><h3>The <code class="literal">"height"</code> property</h3>
<pre class="programlisting"> "height" <span class="type">gdouble</span> : Read / Write</pre>
<p>The height of the polyline.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "points" property'>
<a name="GooCanvasPolyline--points"></a><h3>The <code class="literal">"points"</code> property</h3>
<pre class="programlisting"> "points" <a class="link" href="goocanvas-GooCanvas-Types.html#GooCanvasPoints" title="GooCanvasPoints"><span class="type">GooCanvasPoints</span></a>* : Read / Write</pre>
<p>The array of points.</p>
</div>
<hr>
<div class="refsect2" title='The "start-arrow" property'>
<a name="GooCanvasPolyline--start-arrow"></a><h3>The <code class="literal">"start-arrow"</code> property</h3>
<pre class="programlisting"> "start-arrow" <span class="type">gboolean</span> : Read / Write</pre>
<p>If an arrow should be displayed at the start of the polyline.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" title='The "width" property'>
<a name="GooCanvasPolyline--width"></a><h3>The <code class="literal">"width"</code> property</h3>
<pre class="programlisting"> "width" <span class="type">gdouble</span> : Read / Write</pre>
<p>The width of the polyline.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "x" property'>
<a name="GooCanvasPolyline--x"></a><h3>The <code class="literal">"x"</code> property</h3>
<pre class="programlisting"> "x" <span class="type">gdouble</span> : Read / Write</pre>
<p>The x coordinate of the left-most point of the polyline.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "y" property'>
<a name="GooCanvasPolyline--y"></a><h3>The <code class="literal">"y"</code> property</h3>
<pre class="programlisting"> "y" <span class="type">gdouble</span> : Read / Write</pre>
<p>The y coordinate of the top-most point of the polyline.</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|