gtkimage.sgml 7.55 KB
Newer Older
Owen Taylor's avatar
Owen Taylor committed
1 2 3 4
<!-- ##### SECTION Title ##### -->
GtkImage

<!-- ##### SECTION Short_Description ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
5
A widget displaying an image
Owen Taylor's avatar
Owen Taylor committed
6 7 8

<!-- ##### SECTION Long_Description ##### -->
<para>
Havoc Pennington's avatar
Havoc Pennington committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
The #GtkImage widget displays an image. Various kinds of object 
can be displayed as an image; most typically, you would load a 
#GdkPixbuf ("pixel buffer") from a file, and then display that. 
There's a convenience function to do this, gtk_image_new_from_file(),
used as follows:
<programlisting>
  GtkWidget *image;
  image = gtk_image_new_from_file ("myfile.png");
</programlisting>
If the file isn't loaded successfully, the image will contain a
"broken image" icon similar to that used in many web browsers.
If you want to handle errors in loading the file yourself, 
for example by displaying an error message, then load the image with
gdk_pixbuf_new_from_file(), then create the #GtkImage with 
gtk_image_new_from_pixbuf().
24 25
</para>
<para>
Havoc Pennington's avatar
Havoc Pennington committed
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
The image file may contain an animation, if so the #GtkImage will 
display an animation (#GdkPixbufAnimation) instead of a static image.
</para>
<para>
#GtkImage is a subclass of #GtkMisc, which implies that you can 
align it (center, left, right) and add padding to it, using 
#GtkMisc methods.
</para>
<para>
#GtkImage is a "no window" widget (has no #GdkWindow of its own), 
so by default does not receive events. If you want to receive events
on the image, such as button clicks, place the image inside a 
#GtkEventBox, then connect to the event signals on the event box.
For example, here is some code that handles button press events 
on a #GtkImage:
<programlisting>
  static void
  button_press_callback (GtkWidget      *event_box, 
                         GdkEventButton *event,
                         gpointer        data)
  {
    g_print ("Event box clicked at coordinates %d,%d\n", 
             event->x, event->y);

    /* Returning TRUE means we handled the event, so the signal 
     * emission should be stopped (don't call any further 
     * callbacks that may be connected). Return FALSE
     * to continue invoking callbacks.
     */
    return TRUE;
  }

  static GtkWidget*
  create_image (void)
  {
    GtkWidget *image;
    GtkWidget *event_box;

    image = gtk_image_new_from_file ("myfile.png");

    event_box = gtk_event_box_new ();

    gtk_container_add (GTK_CONTAINER (event_box), image);

    g_signal_connect (G_OBJECT (event_box), 
                      "button_press_event",
                      G_CALLBACK (button_press_callback),
                      image);

    return image;
  }
</programlisting>
</para>
<para>
When handling events on the event box, keep in mind that coordinates
in the image may be different from event box coordinates due to 
the alignment and padding settings on the image (see #GtkMisc). 
The simplest way to solve this is to set the alignment to 0.0
(left/top), and set the padding to zero. Then the origin of 
the image will be the same as the origin of the event box.
</para>

<para>
Sometimes an application will want to avoid depending on external data
files, such as image files. GTK+ comes with a program to avoid this,
called <application>gdk-pixbuf-csource</application>. This program
allows you to convert an image into a C variable declaration, which
can then be loaded into a #GdkPixbuf using
gdk_pixbuf_new_from_inline().
Owen Taylor's avatar
Owen Taylor committed
95 96 97 98
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
Havoc Pennington's avatar
Havoc Pennington committed
99
#GdkPixbuf
Owen Taylor's avatar
Owen Taylor committed
100 101 102 103
</para>

<!-- ##### STRUCT GtkImage ##### -->
<para>
104 105
This struct contain private data only and should be accessed by the functions
below.
Owen Taylor's avatar
Owen Taylor committed
106 107 108
</para>


Havoc Pennington's avatar
Havoc Pennington committed
109 110
<!-- ##### ENUM GtkImageType ##### -->
<para>
Havoc Pennington's avatar
Havoc Pennington committed
111 112 113 114 115 116 117
Describes the image data representation used by a #GtkImage. If you
want to get the image from the widget, you can only get the
currently-stored representation. e.g.  if the
gtk_image_get_storage_type() returns #GTK_IMAGE_PIXBUF, then you can
call gtk_image_get_pixbuf() but not gtk_image_get_stock().  For empty
images, you can request any storage type (call any of the "get"
functions), but they will all return %NULL values.
Havoc Pennington's avatar
Havoc Pennington committed
118 119 120 121 122 123 124 125
</para>

@GTK_IMAGE_EMPTY: there is no image displayed by the widget
@GTK_IMAGE_PIXMAP: the widget contains a #GdkPixmap
@GTK_IMAGE_IMAGE: the widget contains a #GdkImage
@GTK_IMAGE_PIXBUF: the widget contains a #GdkPixbuf
@GTK_IMAGE_STOCK: the widget contains a stock icon name
@GTK_IMAGE_ICON_SET: the widget contains a #GtkIconSet
Havoc Pennington's avatar
Havoc Pennington committed
126
@GTK_IMAGE_ANIMATION: the widget contains a #GdkPixbufAnimation
Havoc Pennington's avatar
Havoc Pennington committed
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
<!-- ##### FUNCTION gtk_image_get_icon_set ##### -->
<para>

</para>

@image: 
@icon_set: 
@size: 


<!-- ##### FUNCTION gtk_image_get_image ##### -->
<para>

</para>

@image: 
@gdk_image: 
@mask: 


<!-- ##### FUNCTION gtk_image_get_pixbuf ##### -->
<para>

</para>

@image: 
@Returns: 


<!-- ##### FUNCTION gtk_image_get_pixmap ##### -->
<para>

</para>

@image: 
@pixmap: 
@mask: 


<!-- ##### FUNCTION gtk_image_get_stock ##### -->
<para>

</para>

@image: 
@stock_id: 
@size: 


Havoc Pennington's avatar
Havoc Pennington committed
177 178 179 180 181 182 183 184 185
<!-- ##### FUNCTION gtk_image_get_animation ##### -->
<para>

</para>

@image: 
@Returns: 


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
<!-- ##### FUNCTION gtk_image_get_storage_type ##### -->
<para>

</para>

@image: 
@Returns: 


<!-- ##### FUNCTION gtk_image_new_from_file ##### -->
<para>

</para>

@filename: 
@Returns: 


<!-- ##### FUNCTION gtk_image_new_from_icon_set ##### -->
<para>

</para>

@icon_set: 
@size: 
@Returns: 


<!-- ##### FUNCTION gtk_image_new_from_image ##### -->
<para>

</para>

@image: 
@mask: 
@Returns: 


<!-- ##### FUNCTION gtk_image_new_from_pixbuf ##### -->
<para>

</para>

@pixbuf: 
@Returns: 


<!-- ##### FUNCTION gtk_image_new_from_pixmap ##### -->
<para>

</para>

@pixmap: 
@mask: 
@Returns: 


<!-- ##### FUNCTION gtk_image_new_from_stock ##### -->
<para>

</para>

@stock_id: 
@size: 
@Returns: 


Havoc Pennington's avatar
Havoc Pennington committed
253 254 255 256 257 258 259 260 261
<!-- ##### FUNCTION gtk_image_new_from_animation ##### -->
<para>

</para>

@animation: 
@Returns: 


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
<!-- ##### FUNCTION gtk_image_set_from_file ##### -->
<para>

</para>

@image: 
@filename: 


<!-- ##### FUNCTION gtk_image_set_from_icon_set ##### -->
<para>

</para>

@image: 
@icon_set: 
@size: 


<!-- ##### FUNCTION gtk_image_set_from_image ##### -->
<para>

</para>

@image: 
@gdk_image: 
@mask: 


<!-- ##### FUNCTION gtk_image_set_from_pixbuf ##### -->
<para>

</para>

@image: 
@pixbuf: 


<!-- ##### FUNCTION gtk_image_set_from_pixmap ##### -->
<para>

</para>

@image: 
@pixmap: 
@mask: 


<!-- ##### FUNCTION gtk_image_set_from_stock ##### -->
<para>

</para>

@image: 
@stock_id: 
@size: 


Havoc Pennington's avatar
Havoc Pennington committed
320 321 322 323 324 325 326 327 328
<!-- ##### FUNCTION gtk_image_set_from_animation ##### -->
<para>

</para>

@image: 
@animation: 


Owen Taylor's avatar
Owen Taylor committed
329 330
<!-- ##### FUNCTION gtk_image_new ##### -->
<para>
331
Creates the new GtkImage using the value and the mask.
Owen Taylor's avatar
Owen Taylor committed
332 333
</para>

334 335
@Returns: the GtkImage
<!-- # Unused Parameters # -->
Owen Taylor's avatar
Owen Taylor committed
336
@val: 
337
@mask: a GDKBitmap that indicates which parts of the image should be transparent.
Owen Taylor's avatar
Owen Taylor committed
338 339 340 341


<!-- ##### FUNCTION gtk_image_set ##### -->
<para>
342
Sets the GtkImage
Owen Taylor's avatar
Owen Taylor committed
343 344
</para>

345
@image: a #GdkPixmap
Owen Taylor's avatar
Owen Taylor committed
346
@val: 
347
@mask: a GDKBitmap that indicates which parts of the image should be transparent.
Owen Taylor's avatar
Owen Taylor committed
348 349 350 351


<!-- ##### FUNCTION gtk_image_get ##### -->
<para>
352
Gets the GtkImage
Owen Taylor's avatar
Owen Taylor committed
353 354
</para>

355
@image: a #GdkPixmap
Owen Taylor's avatar
Owen Taylor committed
356
@val: 
357
@mask: a GDKBitmap that indicates which parts of the image should be transparent.
Owen Taylor's avatar
Owen Taylor committed
358 359


Havoc Pennington's avatar
Havoc Pennington committed
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
<!-- ##### ARG GtkImage:pixbuf ##### -->
<para>

</para>

<!-- ##### ARG GtkImage:pixmap ##### -->
<para>

</para>

<!-- ##### ARG GtkImage:image ##### -->
<para>

</para>

<!-- ##### ARG GtkImage:mask ##### -->
<para>

</para>

<!-- ##### ARG GtkImage:file ##### -->
<para>

</para>

<!-- ##### ARG GtkImage:stock ##### -->
<para>

</para>

<!-- ##### ARG GtkImage:icon-set ##### -->
<para>

</para>

<!-- ##### ARG GtkImage:icon-size ##### -->
<para>

</para>

<!-- ##### ARG GtkImage:pixbuf-animation ##### -->
<para>

</para>

<!-- ##### ARG GtkImage:storage-type ##### -->
<para>

</para>