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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GooCanvasImageModel: GooCanvas Reference Manual</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="ch04.html" title="Standard Canvas Item Models">
<link rel="prev" href="GooCanvasGridModel.html" title="GooCanvasGridModel">
<link rel="next" href="GooCanvasPathModel.html" title="GooCanvasPathModel">
<meta name="generator" content="GTK-Doc V1.26 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GooCanvasImageModel.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GooCanvasImageModel.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GooCanvasImageModel.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GooCanvasImageModel.properties" class="shortcut">Properties</a></span>
</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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GooCanvasGridModel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GooCanvasPathModel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GooCanvasImageModel"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GooCanvasImageModel.top_of_page"></a>GooCanvasImageModel</span></h2>
<p>GooCanvasImageModel — a model for image items.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GooCanvasImageModel.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<a class="link" href="GooCanvasItemModel.html" title="GooCanvasItemModel"><span class="returnvalue">GooCanvasItemModel</span></a> *
</td>
<td class="function_name">
<a class="link" href="GooCanvasImageModel.html#goo-canvas-image-model-new" title="goo_canvas_image_model_new ()">goo_canvas_image_model_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GooCanvasImageModel.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="GooCanvasImageModel.html#GooCanvasImageModel--alpha" title="The “alpha” property">alpha</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="GooCanvasImageModel.html#GooCanvasImageModel--height" title="The “height” property">height</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="goocanvas2-GooCanvas-Types.html#GooCairoPattern"><span class="type">GooCairoPattern</span></a> *</td>
<td class="property_name"><a class="link" href="GooCanvasImageModel.html#GooCanvasImageModel--pattern" title="The “pattern” property">pattern</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="type">GdkPixbuf</span></a> *</td>
<td class="property_name"><a class="link" href="GooCanvasImageModel.html#GooCanvasImageModel--pixbuf" title="The “pixbuf” property">pixbuf</a></td>
<td class="property_flags">Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GooCanvasImageModel.html#GooCanvasImageModel--scale-to-fit" title="The “scale-to-fit” property">scale-to-fit</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="GooCanvasImageModel.html#GooCanvasImageModel--width" title="The “width” property">width</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="GooCanvasImageModel.html#GooCanvasImageModel--x" title="The “x” property">x</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="GooCanvasImageModel.html#GooCanvasImageModel--y" title="The “y” property">y</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GooCanvasImageModel.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GooCanvasImageModel.html#GooCanvasImageModel-struct" title="struct GooCanvasImageModel">GooCanvasImageModel</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GooCanvasImageModel.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a class="link" href="GooCanvasItemModelSimple.html" title="GooCanvasItemModelSimple">GooCanvasItemModelSimple</a>
<span class="lineart">╰──</span> GooCanvasImageModel
</pre>
</div>
<div class="refsect1">
<a name="GooCanvasImageModel.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GooCanvasImageModel implements
<a class="link" href="GooCanvasItemModel.html" title="GooCanvasItemModel">GooCanvasItemModel</a>.</p>
</div>
<div class="refsect1">
<a name="GooCanvasImageModel.description"></a><h2>Description</h2>
<p>GooCanvasImageModel represent a model for image items.</p>
<div class="note"><p>
It is usually necessary to set the "scale-to-fit" property to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to
scale the image to fit the given rectangle. When using units other than
<a href="/usr/share/gtk-doc/html/gtk2/GtkPaperSize.html#GTK-UNIT-PIXEL:CAPS"><code class="literal">GTK_UNIT_PIXEL</code></a> it is also necessary to set the "width" and "height"
properties to set the desired size.
</p></div>
<p>It is a subclass of <a class="link" href="GooCanvasItemModelSimple.html" title="GooCanvasItemModelSimple"><span class="type">GooCanvasItemModelSimple</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="GooCanvasItemModel.html" title="GooCanvasItemModel"><span class="type">GooCanvasItemModel</span></a> interface, so you can use the
<a class="link" href="GooCanvasItemModel.html" title="GooCanvasItemModel"><span class="type">GooCanvasItemModel</span></a> functions such as <a class="link" href="GooCanvasItemModel.html#goo-canvas-item-model-raise" title="goo_canvas_item_model_raise ()"><code class="function">goo_canvas_item_model_raise()</code></a> and
<a class="link" href="GooCanvasItemModel.html#goo-canvas-item-model-rotate" title="goo_canvas_item_model_rotate ()"><code class="function">goo_canvas_item_model_rotate()</code></a>.</p>
<p>To create a <a class="link" href="GooCanvasImageModel.html" title="GooCanvasImageModel"><span class="type">GooCanvasImageModel</span></a> use <a class="link" href="GooCanvasImageModel.html#goo-canvas-image-model-new" title="goo_canvas_image_model_new ()"><code class="function">goo_canvas_image_model_new()</code></a>.</p>
<p>To get or set the properties of an existing <a class="link" href="GooCanvasImageModel.html" title="GooCanvasImageModel"><span class="type">GooCanvasImageModel</span></a>, use
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-get"><code class="function">g_object_get()</code></a> and <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-set"><code class="function">g_object_set()</code></a>.</p>
<p>To respond to events such as mouse clicks on the image you must connect
to the signal handlers of the corresponding <a class="link" href="GooCanvasImage.html" title="GooCanvasImage"><span class="type">GooCanvasImage</span></a> objects.
(See <a class="link" href="GooCanvas.html#goo-canvas-get-item" title="goo_canvas_get_item ()"><code class="function">goo_canvas_get_item()</code></a> and <a class="link" href="GooCanvas.html#GooCanvas-item-created" title="The “item-created” signal"><span class="type">“item-created”</span></a>.)</p>
</div>
<div class="refsect1">
<a name="GooCanvasImageModel.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="goo-canvas-image-model-new"></a><h3>goo_canvas_image_model_new ()</h3>
<pre class="programlisting"><a class="link" href="GooCanvasItemModel.html" title="GooCanvasItemModel"><span class="returnvalue">GooCanvasItemModel</span></a> *
goo_canvas_image_model_new (<em class="parameter"><code><a class="link" href="GooCanvasItemModel.html" title="GooCanvasItemModel"><span class="type">GooCanvasItemModel</span></a> *parent</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> y</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Creates a new image model.</p>
<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>
<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">GooCanvasItemModel</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="GooCanvasImageModel.html#goo-canvas-image-model-new">goo_canvas_image_model_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"> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>This example creates an image scaled to a size of 200x200:</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">GooCanvasItemModel</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="GooCanvasImageModel.html#goo-canvas-image-model-new">goo_canvas_image_model_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"> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span>
<span class="normal"> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<div class="refsect3">
<a name="goo-canvas-image-model-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>parent</p></td>
<td class="parameter_description"><p>the parent model, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. 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 <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> to free it. </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>pixbuf</p></td>
<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="type">GdkPixbuf</span></a> containing the image data, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>the x coordinate of the image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>the y coordinate of the image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>optional pairs of property names and values, and a terminating <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="goo-canvas-image-model-new.returns"></a><h4>Returns</h4>
<p>a new image model. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GooCanvasImageModel.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GooCanvasImageModel-struct"></a><h3>struct GooCanvasImageModel</h3>
<pre class="programlisting">struct GooCanvasImageModel;</pre>
<p>The <a class="link" href="GooCanvasImageModel.html#GooCanvasImageModel-struct" title="struct GooCanvasImageModel"><span class="type">GooCanvasImageModel</span></a> struct contains private data only.</p>
</div>
</div>
<div class="refsect1">
<a name="GooCanvasImageModel.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GooCanvasImageModel--alpha"></a><h3>The <code class="literal">“alpha”</code> property</h3>
<pre class="programlisting"> “alpha” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>The opacity of the image, 0.0 is fully transparent, and 1.0 is opaque.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2">
<a name="GooCanvasImageModel--height"></a><h3>The <code class="literal">“height”</code> property</h3>
<pre class="programlisting"> “height” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>The height of the image.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GooCanvasImageModel--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> *</pre>
<p>The cairo pattern to paint.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="GooCanvasImageModel--pixbuf"></a><h3>The <code class="literal">“pixbuf”</code> property</h3>
<pre class="programlisting"> “pixbuf” <a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="type">GdkPixbuf</span></a> *</pre>
<p>The GdkPixbuf to display.</p>
<p>Flags: Write</p>
</div>
<hr>
<div class="refsect2">
<a name="GooCanvasImageModel--scale-to-fit"></a><h3>The <code class="literal">“scale-to-fit”</code> property</h3>
<pre class="programlisting"> “scale-to-fit” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>If the image is scaled to fit the width and height settings.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GooCanvasImageModel--width"></a><h3>The <code class="literal">“width”</code> property</h3>
<pre class="programlisting"> “width” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>The width of the image.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GooCanvasImageModel--x"></a><h3>The <code class="literal">“x”</code> property</h3>
<pre class="programlisting"> “x” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>The x coordinate of the image.</p>
<p>Flags: Read / Write</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GooCanvasImageModel--y"></a><h3>The <code class="literal">“y”</code> property</h3>
<pre class="programlisting"> “y” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>The y coordinate of the image.</p>
<p>Flags: Read / Write</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.26</div>
</body>
</html>
|
