|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /proc/21572/root/usr/share/gtk-doc/html/libgnomecanvas/ |
Upload File : |
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GnomeCanvasShape</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" 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="GnomeCanvasText.html" title="GnomeCanvasText">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="GNOME Canvas Library (libgnomecanvas)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" 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="GnomeCanvasText.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry" lang="en">
<a name="GnomeCanvasShape"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">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">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <libgnomecanvas/libgnomecanvas.h>
<a href="GnomeCanvasShape.html#GnomeCanvasShape-struct">GnomeCanvasShape</a>;
void <a href="GnomeCanvasShape.html#gnome-canvas-shape-set-path-def">gnome_canvas_shape_set_path_def</a> (<a href="GnomeCanvasShape.html" title="GnomeCanvasShape">GnomeCanvasShape</a> *shape,
<a href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef">GnomeCanvasPathDef</a> *def);
<a href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef">GnomeCanvasPathDef</a>* <a href="GnomeCanvasShape.html#gnome-canvas-shape-get-path-def">gnome_canvas_shape_get_path_def</a>
(<a href="GnomeCanvasShape.html" title="GnomeCanvasShape">GnomeCanvasShape</a> *shape);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2684867"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
>GtkObject</a>
+----<a href="GnomeCanvasItem.html" title="GnomeCanvasItem">GnomeCanvasItem</a>
+----GnomeCanvasShape
+----<a href="GnomeCanvasBpath.html" title="GnomeCanvasBpath">GnomeCanvasBpath</a>
+----<a href="GnomeCanvasRE.html" title="GnomeCanvasRE">GnomeCanvasRE</a>
+----<a href="GnomeCanvasPolygon.html" title="GnomeCanvasPolygon">GnomeCanvasPolygon</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2684924"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GnomeCanvasShape.html#GnomeCanvasShape--cap-style">cap-style</a>" <a
href="/usr/share/gtk-doc/html/gdk/gdk-Graphics-Contexts.html#GdkCapStyle"
>GdkCapStyle</a> : Read / Write
"<a href="GnomeCanvasShape.html#GnomeCanvasShape--dash">dash</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> : Read / Write
"<a href="GnomeCanvasShape.html#GnomeCanvasShape--fill-color">fill-color</a>" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Write
"<a href="GnomeCanvasShape.html#GnomeCanvasShape--fill-color-gdk">fill-color-gdk</a>" <a
href="/usr/share/gtk-doc/html/gdk/gdk-Colormaps-and-Colors.html#GdkColor"
>GdkColor</a> : Read / Write
"<a href="GnomeCanvasShape.html#GnomeCanvasShape--fill-color-rgba">fill-color-rgba</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a> : Read / Write
"<a href="GnomeCanvasShape.html#GnomeCanvasShape--fill-stipple">fill-stipple</a>" <a
href="/usr/share/gtk-doc/html/gdk/gdk-Drawing-Primitives.html#GdkDrawable"
>GdkDrawable</a> : Read / Write
"<a href="GnomeCanvasShape.html#GnomeCanvasShape--join-style">join-style</a>" <a
href="/usr/share/gtk-doc/html/gdk/gdk-Graphics-Contexts.html#GdkJoinStyle"
>GdkJoinStyle</a> : Read / Write
"<a href="GnomeCanvasShape.html#GnomeCanvasShape--miterlimit">miterlimit</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"
>gdouble</a> : Read / Write
"<a href="GnomeCanvasShape.html#GnomeCanvasShape--outline-color">outline-color</a>" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Write
"<a href="GnomeCanvasShape.html#GnomeCanvasShape--outline-color-gdk">outline-color-gdk</a>" <a
href="/usr/share/gtk-doc/html/gdk/gdk-Colormaps-and-Colors.html#GdkColor"
>GdkColor</a> : Read / Write
"<a href="GnomeCanvasShape.html#GnomeCanvasShape--outline-color-rgba">outline-color-rgba</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a> : Read / Write
"<a href="GnomeCanvasShape.html#GnomeCanvasShape--outline-stipple">outline-stipple</a>" <a
href="/usr/share/gtk-doc/html/gdk/gdk-Drawing-Primitives.html#GdkDrawable"
>GdkDrawable</a> : Read / Write
"<a href="GnomeCanvasShape.html#GnomeCanvasShape--width-pixels">width-pixels</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a> : Read / Write
"<a href="GnomeCanvasShape.html#GnomeCanvasShape--width-units">width-units</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"
>gdouble</a> : Read / Write
"<a href="GnomeCanvasShape.html#GnomeCanvasShape--wind">wind</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a> : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2685194"></a><h2>Description</h2>
<p>
Provides a base class for canvas item shapes, including: <a href="GnomeCanvasBpath.html" title="GnomeCanvasBpath"><span class="type">GnomeCanvasBpath</span></a>,
<a href="GnomeCanvasEllipse.html" title="GnomeCanvasEllipse"><span class="type">GnomeCanvasEllipse</span></a>, <a href="GnomeCanvasRect.html" title="GnomeCanvasRect"><span class="type">GnomeCanvasRect</span></a>, and <a href="GnomeCanvasPolygon.html" title="GnomeCanvasPolygon"><span class="type">GnomeCanvasPolygon</span></a>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2685238"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2685243"></a><h3>
<a name="GnomeCanvasShape-struct"></a>GnomeCanvasShape</h3>
<a class="indexterm" name="id2685254"></a><pre class="programlisting">typedef struct _GnomeCanvasShape 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" lang="en">
<a name="id2685272"></a><h3>
<a name="gnome-canvas-shape-set-path-def"></a>gnome_canvas_shape_set_path_def ()</h3>
<a class="indexterm" name="id2685283"></a><pre class="programlisting">void gnome_canvas_shape_set_path_def (<a href="GnomeCanvasShape.html" title="GnomeCanvasShape">GnomeCanvasShape</a> *shape,
<a href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef">GnomeCanvasPathDef</a> *def);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>shape</code></em> :</span></td>
<td> a GnomeCanvasShape
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>def</code></em> :</span></td>
<td> a GnomeCanvasPathDef
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2685357"></a><h3>
<a name="gnome-canvas-shape-get-path-def"></a>gnome_canvas_shape_get_path_def ()</h3>
<a class="indexterm" name="id2685368"></a><pre class="programlisting"><a href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef">GnomeCanvasPathDef</a>* gnome_canvas_shape_get_path_def
(<a href="GnomeCanvasShape.html" title="GnomeCanvasShape">GnomeCanvasShape</a> *shape);</pre>
<p>
This function returns the <a 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 href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef"><span class="type">GnomeCanvasPathDef</span></a> and
returns it, if there is not a <a href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef"><span class="type">GnomeCanvasPathDef</span></a> set for the shape
it returns NULL.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>shape</code></em> :</span></td>
<td> a GnomeCanvasShape
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a <a 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" lang="en">
<a name="id2685467"></a><h2>Properties</h2>
<div class="refsect2" lang="en">
<a name="id2685473"></a><h3>
<a name="GnomeCanvasShape--cap-style"></a>The "<code class="literal">cap-style</code>" property</h3>
<pre class="programlisting"> "cap-style" <a
href="/usr/share/gtk-doc/html/gdk/gdk-Graphics-Contexts.html#GdkCapStyle"
>GdkCapStyle</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" lang="en">
<a name="id2685510"></a><h3>
<a name="GnomeCanvasShape--dash"></a>The "<code class="literal">dash</code>" property</h3>
<pre class="programlisting"> "dash" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> : Read / Write</pre>
<p>
Dashing pattern.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2685543"></a><h3>
<a name="GnomeCanvasShape--fill-color"></a>The "<code class="literal">fill-color</code>" property</h3>
<pre class="programlisting"> "fill-color" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</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" lang="en">
<a name="id2685581"></a><h3>
<a name="GnomeCanvasShape--fill-color-gdk"></a>The "<code class="literal">fill-color-gdk</code>" property</h3>
<pre class="programlisting"> "fill-color-gdk" <a
href="/usr/share/gtk-doc/html/gdk/gdk-Colormaps-and-Colors.html#GdkColor"
>GdkColor</a> : Read / Write</pre>
<p>
Allocated GdkColor for fill.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2685614"></a><h3>
<a name="GnomeCanvasShape--fill-color-rgba"></a>The "<code class="literal">fill-color-rgba</code>" property</h3>
<pre class="programlisting"> "fill-color-rgba" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</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" lang="en">
<a name="id2685652"></a><h3>
<a name="GnomeCanvasShape--fill-stipple"></a>The "<code class="literal">fill-stipple</code>" property</h3>
<pre class="programlisting"> "fill-stipple" <a
href="/usr/share/gtk-doc/html/gdk/gdk-Drawing-Primitives.html#GdkDrawable"
>GdkDrawable</a> : Read / Write</pre>
<p>
Stipple pattern for fill.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2685687"></a><h3>
<a name="GnomeCanvasShape--join-style"></a>The "<code class="literal">join-style</code>" property</h3>
<pre class="programlisting"> "join-style" <a
href="/usr/share/gtk-doc/html/gdk/gdk-Graphics-Contexts.html#GdkJoinStyle"
>GdkJoinStyle</a> : Read / Write</pre>
<p>
Vertex join style for the bpath.
</p>
<p>Default value: GDK_JOIN_MITER</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2685724"></a><h3>
<a name="GnomeCanvasShape--miterlimit"></a>The "<code class="literal">miterlimit</code>" property</h3>
<pre class="programlisting"> "miterlimit" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"
>gdouble</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" lang="en">
<a name="id2685765"></a><h3>
<a name="GnomeCanvasShape--outline-color"></a>The "<code class="literal">outline-color</code>" property</h3>
<pre class="programlisting"> "outline-color" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</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" lang="en">
<a name="id2685804"></a><h3>
<a name="GnomeCanvasShape--outline-color-gdk"></a>The "<code class="literal">outline-color-gdk</code>" property</h3>
<pre class="programlisting"> "outline-color-gdk" <a
href="/usr/share/gtk-doc/html/gdk/gdk-Colormaps-and-Colors.html#GdkColor"
>GdkColor</a> : Read / Write</pre>
<p>
Allocated GdkColor for outline.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2685837"></a><h3>
<a name="GnomeCanvasShape--outline-color-rgba"></a>The "<code class="literal">outline-color-rgba</code>" property</h3>
<pre class="programlisting"> "outline-color-rgba" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</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" lang="en">
<a name="id2685876"></a><h3>
<a name="GnomeCanvasShape--outline-stipple"></a>The "<code class="literal">outline-stipple</code>" property</h3>
<pre class="programlisting"> "outline-stipple" <a
href="/usr/share/gtk-doc/html/gdk/gdk-Drawing-Primitives.html#GdkDrawable"
>GdkDrawable</a> : Read / Write</pre>
<p>
Stipple pattern for outline.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2685909"></a><h3>
<a name="GnomeCanvasShape--width-pixels"></a>The "<code class="literal">width-pixels</code>" property</h3>
<pre class="programlisting"> "width-pixels" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</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" lang="en">
<a name="id2685948"></a><h3>
<a name="GnomeCanvasShape--width-units"></a>The "<code class="literal">width-units</code>" property</h3>
<pre class="programlisting"> "width-units" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"
>gdouble</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" lang="en">
<a name="id2685991"></a><h3>
<a name="GnomeCanvasShape--wind"></a>The "<code class="literal">wind</code>" property</h3>
<pre class="programlisting"> "wind" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a> : Read / Write</pre>
<p>
Winding rule for the bpath (ArtWindRule).
</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="GnomeCanvasRichText.html"><b><< GnomeCanvasRichText</b></a></td>
<td align="right"><a accesskey="n" href="GnomeCanvasText.html"><b>GnomeCanvasText >></b></a></td>
</tr></table>
</body>
</html>