/usr/share/gtk-doc/html/goocanvas2/GooCanvasImage.html is in libgoocanvas-2.0-dev 2.0.2-0ubuntu2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GooCanvas Reference Manual: GooCanvasImage</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GooCanvas Reference Manual">
<link rel="up" href="ch03.html" title="Standard Canvas Items">
<link rel="prev" href="GooCanvasGrid.html" title="GooCanvasGrid">
<link rel="next" href="GooCanvasPath.html" title="GooCanvasPath">
<meta name="generator" content="GTK-Doc V1.19.1 (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="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
|
<a href="#GooCanvasImage.description" class="shortcut">Description</a>
|
<a href="#GooCanvasImage.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GooCanvasImage.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GooCanvasImage.properties" class="shortcut">Properties</a>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GooCanvasGrid.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GooCanvasPath.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GooCanvasImage"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GooCanvasImage.top_of_page"></a>GooCanvasImage</span></h2>
<p>GooCanvasImage — an image item.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GooCanvasImage.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="GooCanvasImage.html#GooCanvasImage-struct" title="struct GooCanvasImage">GooCanvasImage</a>;
<a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="returnvalue">GooCanvasItem</span></a> * <a class="link" href="GooCanvasImage.html#goo-canvas-image-new" title="goo_canvas_image_new ()">goo_canvas_image_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">GdkPixbuf</span> *pixbuf</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y</code></em>,
<em class="parameter"><code>...</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GooCanvasImage.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="GooCanvasItemSimple.html" title="GooCanvasItemSimple">GooCanvasItemSimple</a>
+----GooCanvasImage
</pre>
</div>
<div class="refsect1">
<a name="GooCanvasImage.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GooCanvasImage implements
<a class="link" href="GooCanvasItem.html" title="GooCanvasItem">GooCanvasItem</a>.</p>
</div>
<div class="refsect1">
<a name="GooCanvasImage.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GooCanvasImage.html#GooCanvasImage--alpha" title='The "alpha" property'>alpha</a>" <span class="type">gdouble</span> : Read / Write
"<a class="link" href="GooCanvasImage.html#GooCanvasImage--height" title='The "height" property'>height</a>" <span class="type">gdouble</span> : Read / Write
"<a class="link" href="GooCanvasImage.html#GooCanvasImage--pattern" title='The "pattern" property'>pattern</a>" <a class="link" href="goocanvas2-GooCanvas-Types.html#GooCairoPattern"><span class="type">GooCairoPattern</span></a>* : Read / Write
"<a class="link" href="GooCanvasImage.html#GooCanvasImage--pixbuf" title='The "pixbuf" property'>pixbuf</a>" <span class="type">GdkPixbuf</span>* : Write
"<a class="link" href="GooCanvasImage.html#GooCanvasImage--scale-to-fit" title='The "scale-to-fit" property'>scale-to-fit</a>" <span class="type">gboolean</span> : Read / Write
"<a class="link" href="GooCanvasImage.html#GooCanvasImage--width" title='The "width" property'>width</a>" <span class="type">gdouble</span> : Read / Write
"<a class="link" href="GooCanvasImage.html#GooCanvasImage--x" title='The "x" property'>x</a>" <span class="type">gdouble</span> : Read / Write
"<a class="link" href="GooCanvasImage.html#GooCanvasImage--y" title='The "y" property'>y</a>" <span class="type">gdouble</span> : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="GooCanvasImage.description"></a><h2>Description</h2>
<p>
GooCanvasImage represents an image item.
</p>
<p>
</p>
<div class="note">
<h3 class="title">Note</h3>
<p>
It is usually necessary to set the "scale-to-fit" property to <code class="literal">TRUE</code> to
scale the image to fit the given rectangle.
</p>
</div>
<p>
</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 "operator" and "pointer-events".
</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="GooCanvasImage.html" title="GooCanvasImage"><span class="type">GooCanvasImage</span></a> use <a class="link" href="GooCanvasImage.html#goo-canvas-image-new" title="goo_canvas_image_new ()"><code class="function">goo_canvas_image_new()</code></a>.
</p>
<p>
To get or set the properties of an existing <a class="link" href="GooCanvasImage.html" title="GooCanvasImage"><span class="type">GooCanvasImage</span></a>, use
<code class="function">g_object_get()</code> and <code class="function">g_object_set()</code>.
</p>
</div>
<div class="refsect1">
<a name="GooCanvasImage.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GooCanvasImage-struct"></a><h3>struct GooCanvasImage</h3>
<pre class="programlisting">struct GooCanvasImage;</pre>
<p>
The <a class="link" href="GooCanvasImage.html#GooCanvasImage-struct" title="struct GooCanvasImage"><span class="type">GooCanvasImage</span></a> struct contains private data only.
</p>
</div>
<hr>
<div class="refsect2">
<a name="goo-canvas-image-new"></a><h3>goo_canvas_image_new ()</h3>
<pre class="programlisting"><a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="returnvalue">GooCanvasItem</span></a> * goo_canvas_image_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">GdkPixbuf</span> *pixbuf</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
Creates a new image item.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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. <span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
<td>the <span class="type">GdkPixbuf</span> containing the image data, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>the x coordinate of the image.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>the y coordinate of the image.</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 image item. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p>
Here's an example showing how to create an image at (100.0, 100.0), using
the given pixbuf at its natural width and height:
</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</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">GooCanvasItem</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">image </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GooCanvasImage.html#goo-canvas-image-new">goo_canvas_image_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">mygroup</span><span class="symbol">,</span><span class="normal"> pixbuf</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"> NULL</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
<p>
This example creates an image scaled to a size of 200x200:
</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</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">GooCanvasItem</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">image </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GooCanvasImage.html#goo-canvas-image-new">goo_canvas_image_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">mygroup</span><span class="symbol">,</span><span class="normal"> pixbuf</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="string">"width"</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="string">"height"</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="string">"scale-to-fit"</span><span class="symbol">,</span><span class="normal"> TRUE</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">
<a name="GooCanvasImage.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GooCanvasImage--alpha"></a><h3>The <code class="literal">"alpha"</code> property</h3>
<pre class="programlisting"> "alpha" <span class="type">gdouble</span> : Read / Write</pre>
<p>The opacity of the image, 0.0 is fully transparent, and 1.0 is opaque.</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2">
<a name="GooCanvasImage--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 image.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GooCanvasImage--pattern"></a><h3>The <code class="literal">"pattern"</code> property</h3>
<pre class="programlisting"> "pattern" <a class="link" href="goocanvas2-GooCanvas-Types.html#GooCairoPattern"><span class="type">GooCairoPattern</span></a>* : Read / Write</pre>
<p>The cairo pattern to paint.</p>
</div>
<hr>
<div class="refsect2">
<a name="GooCanvasImage--pixbuf"></a><h3>The <code class="literal">"pixbuf"</code> property</h3>
<pre class="programlisting"> "pixbuf" <span class="type">GdkPixbuf</span>* : Write</pre>
<p>The GdkPixbuf to display.</p>
</div>
<hr>
<div class="refsect2">
<a name="GooCanvasImage--scale-to-fit"></a><h3>The <code class="literal">"scale-to-fit"</code> property</h3>
<pre class="programlisting"> "scale-to-fit" <span class="type">gboolean</span> : Read / Write</pre>
<p>If the image is scaled to fit the width and height settings.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GooCanvasImage--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 image.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GooCanvasImage--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 image.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GooCanvasImage--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 image.</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19.1</div>
</body>
</html>
|