← Back to branch summary

~ubuntu-branches/ubuntu/breezy/libgnomecanvas/breezy

« back to all changes in this revision

Viewing changes to docs/reference/html/GnomeCanvasShape.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2004-09-13 22:40:39 UTC
  • Revision ID: james.westby@ubuntu.com-20040913224039-giftt9jhvyoorcuv
Tags: upstream-2.8.0
Import upstream version 2.8.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/GnomeCanvasShape.html
 
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>GnomeCanvasShape</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.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="previous" href="GnomeCanvasRichText.html" title="GnomeCanvasRichText"><link rel="next" href="GnomeCanvasText.html" title="GnomeCanvasText"><link rel="chapter" href="ch01.html" title="Object Hierarchy"><link rel="chapter" href="ch02.html" title="GNOME Canvas Library (libgnomecanvas)"><link rel="refentry" href="GnomeCanvas.html" title="GnomeCanvas"><link rel="refentry" href="GnomeCanvasBpath.html" title="GnomeCanvasBpath"><link rel="refentry" href="GnomeCanvasClipgroup.html" title="GnomeCanvasClipgroup"><link rel="refentry" href="GnomeCanvasEllipse.html" title="GnomeCanvasEllipse"><link rel="refentry" href="GnomeCanvasGroup.html" title="GnomeCanvasGroup"><link rel="refentry" href="GnomeCanvasItem.html" title="GnomeCanvasItem"><link rel="refentry" href="GnomeCanvasLine.html" title="GnomeCanvasLine"><link rel="refentry" href="GnomeCanvasPixbuf.html" title="GnomeCanvasPixbuf"><link rel="refentry" href="GnomeCanvasPolygon.html" title="GnomeCanvasPolygon"><link rel="refentry" href="GnomeCanvasRE.html" title="GnomeCanvasRE"><link rel="refentry" href="GnomeCanvasRect.html" title="GnomeCanvasRect"><link rel="refentry" href="GnomeCanvasRichText.html" title="GnomeCanvasRichText"><link rel="refentry" href="GnomeCanvasShape.html" title="GnomeCanvasShape"><link rel="refentry" href="GnomeCanvasText.html" title="GnomeCanvasText"><link rel="refentry" href="GnomeCanvasWidget.html" title="GnomeCanvasWidget"><link rel="refentry" href="libgnomecanvas-gnome-canvas-path-def.html" title="gnome-canvas-path-def"><link rel="refentry" href="libgnomecanvas-gnome-canvas-util.html" title="gnome-canvas-util"><link rel="section" href="GnomeCanvasShape.html#id3001407" title="Object Hierarchy"><link rel="section" href="GnomeCanvasShape.html#id3001464" title="Properties"><link rel="section" href="GnomeCanvasShape.html#id3001737" title="Description"><link rel="section" href="GnomeCanvasShape.html#id3001781" title="Details"><link rel="section" href="GnomeCanvasShape.html#id3002012" title="Properties"><meta name="generator" content="GTK-Doc V1.2 (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" 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><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">GnomeCanvasShape</span></h2><p>GnomeCanvasShape &#8212; Base class for canvas item shapes</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
 
2
 
 
3
#include &lt;libgnomecanvas/libgnomecanvas.h&gt;
 
4
 
 
5
 
 
6
struct      <a href="GnomeCanvasShape.html#GnomeCanvasShape-struct">GnomeCanvasShape</a>;
 
7
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,
 
8
                                             <a href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef">GnomeCanvasPathDef</a> *def);
 
9
<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>
 
10
                                            (<a href="GnomeCanvasShape.html" title="GnomeCanvasShape">GnomeCanvasShape</a> *shape);
 
11
 
 
12
</pre></div><div class="refsect1" lang="en"><a name="id3001407"></a><h2>Object Hierarchy</h2><pre class="synopsis">
 
13
 
 
14
  GObject
 
15
   +----GtkObject
 
16
         +----<a href="GnomeCanvasItem.html" title="GnomeCanvasItem">GnomeCanvasItem</a>
 
17
               +----GnomeCanvasShape
 
18
                     +----<a href="GnomeCanvasBpath.html" title="GnomeCanvasBpath">GnomeCanvasBpath</a>
 
19
                     +----<a href="GnomeCanvasRE.html" title="GnomeCanvasRE">GnomeCanvasRE</a>
 
20
                     +----<a href="GnomeCanvasPolygon.html" title="GnomeCanvasPolygon">GnomeCanvasPolygon</a>
 
21
</pre></div><div class="refsect1" lang="en"><a name="id3001464"></a><h2>Properties</h2><pre class="synopsis">
 
22
 
 
23
  "<a href="GnomeCanvasShape.html#GnomeCanvasShape--cap-style">cap-style</a>"            GdkCapStyle           : Read / Write
 
24
  "<a href="GnomeCanvasShape.html#GnomeCanvasShape--dash">dash</a>"                 gpointer              : Read / Write
 
25
  "<a href="GnomeCanvasShape.html#GnomeCanvasShape--fill-color">fill-color</a>"           gchararray            : Write
 
26
  "<a href="GnomeCanvasShape.html#GnomeCanvasShape--fill-color-gdk">fill-color-gdk</a>"       GdkColor              : Read / Write
 
27
  "<a href="GnomeCanvasShape.html#GnomeCanvasShape--fill-color-rgba">fill-color-rgba</a>"      guint                 : Read / Write
 
28
  "<a href="GnomeCanvasShape.html#GnomeCanvasShape--fill-stipple">fill-stipple</a>"         GdkDrawable           : Read / Write
 
29
  "<a href="GnomeCanvasShape.html#GnomeCanvasShape--join-style">join-style</a>"           GdkJoinStyle          : Read / Write
 
30
  "<a href="GnomeCanvasShape.html#GnomeCanvasShape--miterlimit">miterlimit</a>"           gdouble               : Read / Write
 
31
  "<a href="GnomeCanvasShape.html#GnomeCanvasShape--outline-color">outline-color</a>"        gchararray            : Write
 
32
  "<a href="GnomeCanvasShape.html#GnomeCanvasShape--outline-color-gdk">outline-color-gdk</a>"    GdkColor              : Read / Write
 
33
  "<a href="GnomeCanvasShape.html#GnomeCanvasShape--outline-color-rgba">outline-color-rgba</a>"   guint                 : Read / Write
 
34
  "<a href="GnomeCanvasShape.html#GnomeCanvasShape--outline-stipple">outline-stipple</a>"      GdkDrawable           : Read / Write
 
35
  "<a href="GnomeCanvasShape.html#GnomeCanvasShape--width-pixels">width-pixels</a>"         guint                 : Read / Write
 
36
  "<a href="GnomeCanvasShape.html#GnomeCanvasShape--width-units">width-units</a>"          gdouble               : Write
 
37
  "<a href="GnomeCanvasShape.html#GnomeCanvasShape--wind">wind</a>"                 guint                 : Read / Write
 
38
</pre></div><div class="refsect1" lang="en"><a name="id3001737"></a><h2>Description</h2><p>
 
39
Provides a base class for canvas item shapes, including: <a href="GnomeCanvasBpath.html" title="GnomeCanvasBpath"><span class="type">GnomeCanvasBpath</span></a>,
 
40
<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>.
 
41
</p></div><div class="refsect1" lang="en"><a name="id3001781"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id3001787"></a><h3><a name="GnomeCanvasShape-struct"></a>struct GnomeCanvasShape</h3><a class="indexterm" name="id3001797"></a><pre class="programlisting">struct GnomeCanvasShape;</pre><p>
 
42
This structure should not be accessed directly. Use the object's properties
 
43
and functions for querying or changing its parameters.
 
44
</p></div><hr><div class="refsect2" lang="en"><a name="id3001815"></a><h3><a name="gnome-canvas-shape-set-path-def"></a>gnome_canvas_shape_set_path_def ()</h3><a class="indexterm" name="id3001827"></a><pre class="programlisting">void        gnome_canvas_shape_set_path_def (<a href="GnomeCanvasShape.html" title="GnomeCanvasShape">GnomeCanvasShape</a> *shape,
 
45
                                             <a href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef">GnomeCanvasPathDef</a> *def);</pre><p>
 
46
This function sets the the GnomeCanvasPathDef used by the
 
47
GnomeCanvasShape. Notice, that it does not request updates, as
 
48
it is meant to be used from item implementations, from inside
 
49
update queue.</p><p>
 
50
 
 
51
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>shape</tt></i>�:</span></td><td> a GnomeCanvasShape
 
52
</td></tr><tr><td><span class="term"><i class="parameter"><tt>def</tt></i>�:</span></td><td> a GnomeCanvasPathDef 
 
53
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id3001902"></a><h3><a name="gnome-canvas-shape-get-path-def"></a>gnome_canvas_shape_get_path_def ()</h3><a class="indexterm" name="id3001913"></a><pre class="programlisting"><a href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef">GnomeCanvasPathDef</a>* gnome_canvas_shape_get_path_def
 
54
                                            (<a href="GnomeCanvasShape.html" title="GnomeCanvasShape">GnomeCanvasShape</a> *shape);</pre><p>
 
55
This function returns the <a href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef"><span class="type">GnomeCanvasPathDef</span></a> that the shape
 
56
currently uses.  It adds a reference to the <a href="libgnomecanvas-gnome-canvas-path-def.html#GnomeCanvasPathDef"><span class="type">GnomeCanvasPathDef</span></a> and
 
57
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
 
58
it returns NULL.</p><p>
 
59
 
 
60
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>shape</tt></i>�:</span></td><td> a GnomeCanvasShape
 
61
</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.
 
62
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id3002012"></a><h2>Properties</h2><div class="refsect2" lang="en"><a name="id3002018"></a><h3><a name="GnomeCanvasShape--cap-style"></a>The "<tt class="literal">cap-style</tt>" property</h3><pre class="programlisting">  "cap-style"            GdkCapStyle           : Read / Write</pre><p>
 
63
Cap (end point) style for the bpath.
 
64
</p><p>Default value: GDK_CAP_BUTT</p></div><hr><div class="refsect2" lang="en"><a name="id3002055"></a><h3><a name="GnomeCanvasShape--dash"></a>The "<tt class="literal">dash</tt>" property</h3><pre class="programlisting">  "dash"                 gpointer              : Read / Write</pre><p>
 
65
Dashing pattern.
 
66
</p></div><hr><div class="refsect2" lang="en"><a name="id3002089"></a><h3><a name="GnomeCanvasShape--fill-color"></a>The "<tt class="literal">fill-color</tt>" property</h3><pre class="programlisting">  "fill-color"           gchararray            : Write</pre><p>
 
67
X color specification for fill color, or NULL pointer for no color
 
68
(transparent).
 
69
</p><p>Default value: NULL</p></div><hr><div class="refsect2" lang="en"><a name="id3002127"></a><h3><a name="GnomeCanvasShape--fill-color-gdk"></a>The "<tt class="literal">fill-color-gdk</tt>" property</h3><pre class="programlisting">  "fill-color-gdk"       GdkColor              : Read / Write</pre><p>
 
70
Allocated GdkColor for fill.
 
71
</p></div><hr><div class="refsect2" lang="en"><a name="id3002161"></a><h3><a name="GnomeCanvasShape--fill-color-rgba"></a>The "<tt class="literal">fill-color-rgba</tt>" property</h3><pre class="programlisting">  "fill-color-rgba"      guint                 : Read / Write</pre><p>
 
72
Fill color with an alpha component (in the format 0xRRGGBBAA).
 
73
</p><p>Default value: 0</p></div><hr><div class="refsect2" lang="en"><a name="id3002200"></a><h3><a name="GnomeCanvasShape--fill-stipple"></a>The "<tt class="literal">fill-stipple</tt>" property</h3><pre class="programlisting">  "fill-stipple"         GdkDrawable           : Read / Write</pre><p>
 
74
Stipple pattern for fill.
 
75
</p></div><hr><div class="refsect2" lang="en"><a name="id3002235"></a><h3><a name="GnomeCanvasShape--join-style"></a>The "<tt class="literal">join-style</tt>" property</h3><pre class="programlisting">  "join-style"           GdkJoinStyle          : Read / Write</pre><p>
 
76
Vertex join style for the bpath.
 
77
</p><p>Default value: GDK_JOIN_MITER</p></div><hr><div class="refsect2" lang="en"><a name="id3002273"></a><h3><a name="GnomeCanvasShape--miterlimit"></a>The "<tt class="literal">miterlimit</tt>" property</h3><pre class="programlisting">  "miterlimit"           gdouble               : Read / Write</pre><p>
 
78
Minimum angle between segments, where miter join rule is applied.
 
79
</p><p>Allowed values: &gt;= 0</p><p>Default value: 0</p></div><hr><div class="refsect2" lang="en"><a name="id3002315"></a><h3><a name="GnomeCanvasShape--outline-color"></a>The "<tt class="literal">outline-color</tt>" property</h3><pre class="programlisting">  "outline-color"        gchararray            : Write</pre><p>
 
80
X color specification for outline color, or NULL pointer for no color
 
81
(transparent).
 
82
</p><p>Default value: NULL</p></div><hr><div class="refsect2" lang="en"><a name="id3002355"></a><h3><a name="GnomeCanvasShape--outline-color-gdk"></a>The "<tt class="literal">outline-color-gdk</tt>" property</h3><pre class="programlisting">  "outline-color-gdk"    GdkColor              : Read / Write</pre><p>
 
83
Allocated GdkColor for outline.
 
84
</p></div><hr><div class="refsect2" lang="en"><a name="id3002388"></a><h3><a name="GnomeCanvasShape--outline-color-rgba"></a>The "<tt class="literal">outline-color-rgba</tt>" property</h3><pre class="programlisting">  "outline-color-rgba"   guint                 : Read / Write</pre><p>
 
85
Outline color with an alpha component (in the format 0xRRGGBBAA).
 
86
</p><p>Default value: 0</p></div><hr><div class="refsect2" lang="en"><a name="id3002428"></a><h3><a name="GnomeCanvasShape--outline-stipple"></a>The "<tt class="literal">outline-stipple</tt>" property</h3><pre class="programlisting">  "outline-stipple"      GdkDrawable           : Read / Write</pre><p>
 
87
Stipple pattern for outline.
 
88
</p></div><hr><div class="refsect2" lang="en"><a name="id3002462"></a><h3><a name="GnomeCanvasShape--width-pixels"></a>The "<tt class="literal">width-pixels</tt>" property</h3><pre class="programlisting">  "width-pixels"         guint                 : Read / Write</pre><p>
 
89
Width of the outline in pixels. The outline will not be scaled when the
 
90
canvas zoom factor is changed.
 
91
</p><p>Default value: 0</p></div><hr><div class="refsect2" lang="en"><a name="id3002501"></a><h3><a name="GnomeCanvasShape--width-units"></a>The "<tt class="literal">width-units</tt>" property</h3><pre class="programlisting">  "width-units"          gdouble               : Write</pre><p>
 
92
Width of the outline in canvas units.  The outline will be scaled when
 
93
the canvas zoom factor is changed.
 
94
</p><p>Allowed values: &gt;= 0</p><p>Default value: 0</p></div><hr><div class="refsect2" lang="en"><a name="id3002545"></a><h3><a name="GnomeCanvasShape--wind"></a>The "<tt class="literal">wind</tt>" property</h3><pre class="programlisting">  "wind"                 guint                 : Read / Write</pre><p>
 
95
Winding rule for the bpath (ArtWindRule).
 
96
</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>&lt;&lt;�GnomeCanvasRichText</b></a></td><td align="right"><a accesskey="n" href="GnomeCanvasText.html"><b>GnomeCanvasText�&gt;&gt;</b></a></td></tr></table></body></html>