gtkimage.c 66.7 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2
3
4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6
7
8
9
10
11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15
16
17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19
20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22
23
24
25
26
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

27
#include "config.h"
28
#include <math.h>
29
30
#include <string.h>

Elliot Lee's avatar
Elliot Lee committed
31
32
#include "gtkcontainer.h"
#include "gtkimage.h"
33
#include "gtkiconfactory.h"
34
#include "gtkstock.h"
35
#include "gtkicontheme.h"
Havoc Pennington's avatar
Havoc Pennington committed
36
#include "gtkintl.h"
37
#include "gtkprivate.h"
38
#include "gtkalias.h"
Elliot Lee's avatar
Elliot Lee committed
39

40
41
42
43
typedef struct _GtkImagePrivate GtkImagePrivate;

struct _GtkImagePrivate
{
44
45
46
  /* Only used with GTK_IMAGE_ANIMATION, GTK_IMAGE_PIXBUF */
  gchar *filename;

47
  gint pixel_size;
48
  guint need_calc_size : 1;
49
50
51
};

#define GTK_IMAGE_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_IMAGE, GtkImagePrivate))
52
53


Havoc Pennington's avatar
Havoc Pennington committed
54
#define DEFAULT_ICON_SIZE GTK_ICON_SIZE_BUTTON
55
56
static gint gtk_image_expose       (GtkWidget      *widget,
                                    GdkEventExpose *event);
Havoc Pennington's avatar
Havoc Pennington committed
57
static void gtk_image_unmap        (GtkWidget      *widget);
58
static void gtk_image_unrealize    (GtkWidget      *widget);
59
60
static void gtk_image_size_request (GtkWidget      *widget,
                                    GtkRequisition *requisition);
61
62
static void gtk_image_style_set    (GtkWidget      *widget,
				    GtkStyle       *prev_style);
63
64
static void gtk_image_screen_changed (GtkWidget    *widget,
				      GdkScreen    *prev_screen);
65
66
static void gtk_image_destroy      (GtkObject      *object);
static void gtk_image_reset        (GtkImage       *image);
67
68
static void gtk_image_calc_size    (GtkImage       *image);

69
70
71
static void gtk_image_update_size  (GtkImage       *image,
                                    gint            image_width,
                                    gint            image_height);
Elliot Lee's avatar
Elliot Lee committed
72

Havoc Pennington's avatar
Havoc Pennington committed
73
74
75
76
77
78
79
80
81
static void gtk_image_set_property      (GObject          *object,
					 guint             prop_id,
					 const GValue     *value,
					 GParamSpec       *pspec);
static void gtk_image_get_property      (GObject          *object,
					 guint             prop_id,
					 GValue           *value,
					 GParamSpec       *pspec);

82
83
static void icon_theme_changed          (GtkImage         *image);

Havoc Pennington's avatar
Havoc Pennington committed
84
85
86
87
88
89
90
91
92
93
94
enum
{
  PROP_0,
  PROP_PIXBUF,
  PROP_PIXMAP,
  PROP_IMAGE,
  PROP_MASK,
  PROP_FILE,
  PROP_STOCK,
  PROP_ICON_SET,
  PROP_ICON_SIZE,
95
  PROP_PIXEL_SIZE,
Havoc Pennington's avatar
Havoc Pennington committed
96
  PROP_PIXBUF_ANIMATION,
97
  PROP_ICON_NAME,
98
99
  PROP_STORAGE_TYPE,
  PROP_GICON
Havoc Pennington's avatar
Havoc Pennington committed
100
101
};

Matthias Clasen's avatar
Matthias Clasen committed
102
G_DEFINE_TYPE (GtkImage, gtk_image, GTK_TYPE_MISC)
Elliot Lee's avatar
Elliot Lee committed
103
104
105
106

static void
gtk_image_class_init (GtkImageClass *class)
{
Havoc Pennington's avatar
Havoc Pennington committed
107
  GObjectClass *gobject_class;
108
  GtkObjectClass *object_class;
Elliot Lee's avatar
Elliot Lee committed
109
110
  GtkWidgetClass *widget_class;

Havoc Pennington's avatar
Havoc Pennington committed
111
112
113
114
115
116
  gobject_class = G_OBJECT_CLASS (class);
  
  gobject_class->set_property = gtk_image_set_property;
  gobject_class->get_property = gtk_image_get_property;
  
  object_class = GTK_OBJECT_CLASS (class);
117
  
118
119
  object_class->destroy = gtk_image_destroy;

Havoc Pennington's avatar
Havoc Pennington committed
120
121
  widget_class = GTK_WIDGET_CLASS (class);
  
Elliot Lee's avatar
Elliot Lee committed
122
  widget_class->expose_event = gtk_image_expose;
123
  widget_class->size_request = gtk_image_size_request;
Havoc Pennington's avatar
Havoc Pennington committed
124
  widget_class->unmap = gtk_image_unmap;
125
  widget_class->unrealize = gtk_image_unrealize;
126
  widget_class->style_set = gtk_image_style_set;
127
  widget_class->screen_changed = gtk_image_screen_changed;
Havoc Pennington's avatar
Havoc Pennington committed
128
129
130
131
  
  g_object_class_install_property (gobject_class,
                                   PROP_PIXBUF,
                                   g_param_spec_object ("pixbuf",
132
133
                                                        P_("Pixbuf"),
                                                        P_("A GdkPixbuf to display"),
Havoc Pennington's avatar
Havoc Pennington committed
134
                                                        GDK_TYPE_PIXBUF,
135
                                                        GTK_PARAM_READWRITE));
Havoc Pennington's avatar
Havoc Pennington committed
136
137
138
139

  g_object_class_install_property (gobject_class,
                                   PROP_PIXMAP,
                                   g_param_spec_object ("pixmap",
140
141
                                                        P_("Pixmap"),
                                                        P_("A GdkPixmap to display"),
Havoc Pennington's avatar
Havoc Pennington committed
142
                                                        GDK_TYPE_PIXMAP,
143
                                                        GTK_PARAM_READWRITE));
Havoc Pennington's avatar
Havoc Pennington committed
144
145
146
147

  g_object_class_install_property (gobject_class,
                                   PROP_IMAGE,
                                   g_param_spec_object ("image",
148
149
                                                        P_("Image"),
                                                        P_("A GdkImage to display"),
Havoc Pennington's avatar
Havoc Pennington committed
150
                                                        GDK_TYPE_IMAGE,
151
                                                        GTK_PARAM_READWRITE));
Havoc Pennington's avatar
Havoc Pennington committed
152
153
154
155

  g_object_class_install_property (gobject_class,
                                   PROP_MASK,
                                   g_param_spec_object ("mask",
156
157
                                                        P_("Mask"),
                                                        P_("Mask bitmap to use with GdkImage or GdkPixmap"),
Havoc Pennington's avatar
Havoc Pennington committed
158
                                                        GDK_TYPE_PIXMAP,
159
                                                        GTK_PARAM_READWRITE));
Havoc Pennington's avatar
Havoc Pennington committed
160
161
162
163
  
  g_object_class_install_property (gobject_class,
                                   PROP_FILE,
                                   g_param_spec_string ("file",
164
165
                                                        P_("Filename"),
                                                        P_("Filename to load and display"),
Havoc Pennington's avatar
Havoc Pennington committed
166
                                                        NULL,
167
                                                        GTK_PARAM_READWRITE));
Havoc Pennington's avatar
Havoc Pennington committed
168
169
170
171
172
  

  g_object_class_install_property (gobject_class,
                                   PROP_STOCK,
                                   g_param_spec_string ("stock",
173
174
                                                        P_("Stock ID"),
                                                        P_("Stock ID for a stock image to display"),
Havoc Pennington's avatar
Havoc Pennington committed
175
                                                        NULL,
176
                                                        GTK_PARAM_READWRITE));
Havoc Pennington's avatar
Havoc Pennington committed
177
178
179
  
  g_object_class_install_property (gobject_class,
                                   PROP_ICON_SET,
180
                                   g_param_spec_boxed ("icon-set",
181
182
                                                       P_("Icon set"),
                                                       P_("Icon set to display"),
Havoc Pennington's avatar
Havoc Pennington committed
183
                                                       GTK_TYPE_ICON_SET,
184
                                                       GTK_PARAM_READWRITE));
Havoc Pennington's avatar
Havoc Pennington committed
185
186
187
  
  g_object_class_install_property (gobject_class,
                                   PROP_ICON_SIZE,
188
                                   g_param_spec_int ("icon-size",
189
                                                     P_("Icon size"),
190
                                                     P_("Symbolic size to use for stock icon, icon set or named icon"),
Havoc Pennington's avatar
Havoc Pennington committed
191
192
                                                     0, G_MAXINT,
                                                     DEFAULT_ICON_SIZE,
193
                                                     GTK_PARAM_READWRITE));
194
195
196
  /**
   * GtkImage:pixel-size:
   *
197
198
   * The "pixel-size" property can be used to specify a fixed size
   * overriding the #GtkImage:icon-size property for images of type 
199
200
201
202
203
204
   * %GTK_IMAGE_ICON_NAME. 
   *
   * Since: 2.6
   */
  g_object_class_install_property (gobject_class,
				   PROP_PIXEL_SIZE,
205
				   g_param_spec_int ("pixel-size",
206
207
208
209
						     P_("Pixel size"),
						     P_("Pixel size to use for named icon"),
						     -1, G_MAXINT,
						     -1,
210
						     GTK_PARAM_READWRITE));
211
  
Havoc Pennington's avatar
Havoc Pennington committed
212
213
  g_object_class_install_property (gobject_class,
                                   PROP_PIXBUF_ANIMATION,
214
                                   g_param_spec_object ("pixbuf-animation",
215
216
                                                        P_("Animation"),
                                                        P_("GdkPixbufAnimation to display"),
Havoc Pennington's avatar
Havoc Pennington committed
217
                                                        GDK_TYPE_PIXBUF_ANIMATION,
218
                                                        GTK_PARAM_READWRITE));
219
220
221
222

  /**
   * GtkImage:icon-name:
   *
223
   * The name of the icon in the icon theme. If the icon theme is
224
225
226
227
228
229
   * changed, the image will be updated automatically.
   *
   * Since: 2.6
   */
  g_object_class_install_property (gobject_class,
                                   PROP_ICON_NAME,
230
                                   g_param_spec_string ("icon-name",
231
232
233
                                                        P_("Icon Name"),
                                                        P_("The name of the icon from the icon theme"),
                                                        NULL,
234
                                                        GTK_PARAM_READWRITE));
Havoc Pennington's avatar
Havoc Pennington committed
235
  
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
  /**
   * GtkImage:gicon:
   *
   * The GIcon displayed in the GtkImage. For themed icons,
   * If the icon theme is changed, the image will be updated
   * automatically.
   *
   * Since: 2.14
   */
  g_object_class_install_property (gobject_class,
                                   PROP_GICON,
                                   g_param_spec_object ("gicon",
                                                        P_("Icon"),
                                                        P_("The GIcon being displayed"),
                                                        G_TYPE_ICON,
                                                        GTK_PARAM_READWRITE));
  
Havoc Pennington's avatar
Havoc Pennington committed
253
254
  g_object_class_install_property (gobject_class,
                                   PROP_STORAGE_TYPE,
Matthias Clasen's avatar
Matthias Clasen committed
255
                                   g_param_spec_enum ("storage-type",
256
257
                                                      P_("Storage type"),
                                                      P_("The representation being used for image data"),
Havoc Pennington's avatar
Havoc Pennington committed
258
259
                                                      GTK_TYPE_IMAGE_TYPE,
                                                      GTK_IMAGE_EMPTY,
260
                                                      GTK_PARAM_READABLE));
261
262

  g_type_class_add_private (object_class, sizeof (GtkImagePrivate));
Elliot Lee's avatar
Elliot Lee committed
263
264
265
266
267
}

static void
gtk_image_init (GtkImage *image)
{
268
269
  GtkImagePrivate *priv = GTK_IMAGE_GET_PRIVATE (image);

Elliot Lee's avatar
Elliot Lee committed
270
271
  GTK_WIDGET_SET_FLAGS (image, GTK_NO_WINDOW);

272
  image->storage_type = GTK_IMAGE_EMPTY;
Havoc Pennington's avatar
Havoc Pennington committed
273
274
  image->icon_size = DEFAULT_ICON_SIZE;
  image->mask = NULL;
275
276

  priv->pixel_size = -1;
277
278

  priv->filename = NULL;
Elliot Lee's avatar
Elliot Lee committed
279
280
}

281
282
283
284
285
static void
gtk_image_destroy (GtkObject *object)
{
  GtkImage *image = GTK_IMAGE (object);

286
  gtk_image_reset (image);
287
  
Matthias Clasen's avatar
Matthias Clasen committed
288
  GTK_OBJECT_CLASS (gtk_image_parent_class)->destroy (object);
289
290
}

Havoc Pennington's avatar
Havoc Pennington committed
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
327
328
329
330
331
332
static void 
gtk_image_set_property (GObject      *object,
			guint         prop_id,
			const GValue *value,
			GParamSpec   *pspec)
{
  GtkImage *image;

  image = GTK_IMAGE (object);
  
  switch (prop_id)
    {
    case PROP_PIXBUF:
      gtk_image_set_from_pixbuf (image,
                                 g_value_get_object (value));
      break;
    case PROP_PIXMAP:
      gtk_image_set_from_pixmap (image,
                                 g_value_get_object (value),
                                 image->mask);
      break;
    case PROP_IMAGE:
      gtk_image_set_from_image (image,
                                g_value_get_object (value),
                                image->mask);
      break;
    case PROP_MASK:
      if (image->storage_type == GTK_IMAGE_PIXMAP)
        gtk_image_set_from_pixmap (image,
                                   image->data.pixmap.pixmap,
                                   g_value_get_object (value));
      else if (image->storage_type == GTK_IMAGE_IMAGE)
        gtk_image_set_from_image (image,
                                  image->data.image.image,
                                  g_value_get_object (value));
      else
        {
          GdkBitmap *mask;

          mask = g_value_get_object (value);

          if (mask)
Manish Singh's avatar
Manish Singh committed
333
            g_object_ref (mask);
Havoc Pennington's avatar
Havoc Pennington committed
334
          
335
          gtk_image_clear (image);
Havoc Pennington's avatar
Havoc Pennington committed
336
337
338
339
340

          image->mask = mask;
        }
      break;
    case PROP_FILE:
341
      gtk_image_set_from_file (image, g_value_get_string (value));
Havoc Pennington's avatar
Havoc Pennington committed
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
      break;
    case PROP_STOCK:
      gtk_image_set_from_stock (image, g_value_get_string (value),
                                image->icon_size);
      break;
    case PROP_ICON_SET:
      gtk_image_set_from_icon_set (image, g_value_get_boxed (value),
                                   image->icon_size);
      break;
    case PROP_ICON_SIZE:
      if (image->storage_type == GTK_IMAGE_STOCK)
        gtk_image_set_from_stock (image,
                                  image->data.stock.stock_id,
                                  g_value_get_int (value));
      else if (image->storage_type == GTK_IMAGE_ICON_SET)
        gtk_image_set_from_icon_set (image,
                                     image->data.icon_set.icon_set,
                                     g_value_get_int (value));
360
361
362
363
      else if (image->storage_type == GTK_IMAGE_ICON_NAME)
        gtk_image_set_from_icon_name (image,
				      image->data.name.icon_name,
				      g_value_get_int (value));
364
365
366
367
      else if (image->storage_type == GTK_IMAGE_GICON)
        gtk_image_set_from_gicon (image,
                                  image->data.gicon.icon,
                                  g_value_get_int (value));
Havoc Pennington's avatar
Havoc Pennington committed
368
      else
369
        /* Save to be used when STOCK, ICON_SET, ICON_NAME or GICON property comes in */
Havoc Pennington's avatar
Havoc Pennington committed
370
371
        image->icon_size = g_value_get_int (value);
      break;
372
    case PROP_PIXEL_SIZE:
373
      gtk_image_set_pixel_size (image, g_value_get_int (value));
374
      break;
Havoc Pennington's avatar
Havoc Pennington committed
375
376
377
378
    case PROP_PIXBUF_ANIMATION:
      gtk_image_set_from_animation (image,
                                    g_value_get_object (value));
      break;
379
380
381
    case PROP_ICON_NAME:
      gtk_image_set_from_icon_name (image, g_value_get_string (value),
				    image->icon_size);
382
      break;
383
384
385
386
    case PROP_GICON:
      gtk_image_set_from_gicon (image, g_value_get_object (value),
				image->icon_size);
      break;
387

Havoc Pennington's avatar
Havoc Pennington committed
388
389
390
391
392
393
394
395
396
397
398
399
400
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void 
gtk_image_get_property (GObject     *object,
			guint        prop_id,
			GValue      *value,
			GParamSpec  *pspec)
{
  GtkImage *image;
401
  GtkImagePrivate *priv;
Havoc Pennington's avatar
Havoc Pennington committed
402
403

  image = GTK_IMAGE (object);
404
  priv = GTK_IMAGE_GET_PRIVATE (image);
Havoc Pennington's avatar
Havoc Pennington committed
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437

  /* The "getter" functions whine if you try to get the wrong
   * storage type. This function is instead robust against that,
   * so that GUI builders don't have to jump through hoops
   * to avoid g_warning
   */
  
  switch (prop_id)
    {
    case PROP_PIXBUF:
      if (image->storage_type != GTK_IMAGE_PIXBUF)
        g_value_set_object (value, NULL);
      else
        g_value_set_object (value,
                            gtk_image_get_pixbuf (image));
      break;
    case PROP_PIXMAP:
      if (image->storage_type != GTK_IMAGE_PIXMAP)
        g_value_set_object (value, NULL);
      else
        g_value_set_object (value,
                            image->data.pixmap.pixmap);
      break;
    case PROP_MASK:
      g_value_set_object (value, image->mask);
      break;
    case PROP_IMAGE:
      if (image->storage_type != GTK_IMAGE_IMAGE)
        g_value_set_object (value, NULL);
      else
        g_value_set_object (value,
                            image->data.image.image);
      break;
438
439
440
    case PROP_FILE:
      g_value_set_string (value, priv->filename);
      break;
Havoc Pennington's avatar
Havoc Pennington committed
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
    case PROP_STOCK:
      if (image->storage_type != GTK_IMAGE_STOCK)
        g_value_set_string (value, NULL);
      else
        g_value_set_string (value,
                            image->data.stock.stock_id);
      break;
    case PROP_ICON_SET:
      if (image->storage_type != GTK_IMAGE_ICON_SET)
        g_value_set_boxed (value, NULL);
      else
        g_value_set_boxed (value,
                           image->data.icon_set.icon_set);
      break;      
    case PROP_ICON_SIZE:
      g_value_set_int (value, image->icon_size);
      break;
458
459
460
    case PROP_PIXEL_SIZE:
      g_value_set_int (value, priv->pixel_size);
      break;
Havoc Pennington's avatar
Havoc Pennington committed
461
462
463
464
465
466
467
    case PROP_PIXBUF_ANIMATION:
      if (image->storage_type != GTK_IMAGE_ANIMATION)
        g_value_set_object (value, NULL);
      else
        g_value_set_object (value,
                            image->data.anim.anim);
      break;
468
469
    case PROP_ICON_NAME:
      if (image->storage_type != GTK_IMAGE_ICON_NAME)
470
	g_value_set_string (value, NULL);
471
472
473
474
      else
	g_value_set_string (value,
			    image->data.name.icon_name);
      break;
475
476
477
478
479
480
481
    case PROP_GICON:
      if (image->storage_type != GTK_IMAGE_GICON)
	g_value_set_object (value, NULL);
      else
	g_value_set_object (value,
			    image->data.gicon.icon);
      break;
Havoc Pennington's avatar
Havoc Pennington committed
482
483
484
485
486
487
488
489
490
491
    case PROP_STORAGE_TYPE:
      g_value_set_enum (value, image->storage_type);
      break;
      
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

492

493
494
495
496
497
498
/**
 * gtk_image_new_from_pixmap:
 * @pixmap: a #GdkPixmap, or %NULL
 * @mask: a #GdkBitmap, or %NULL
 * 
 * Creates a #GtkImage widget displaying @pixmap with a @mask.
Matthias Clasen's avatar
Matthias Clasen committed
499
 * A #GdkPixmap is a server-side image buffer in the pixel format of the
500
501
502
503
504
505
 * current display. The #GtkImage does not assume a reference to the
 * pixmap or mask; you still need to unref them if you own references.
 * #GtkImage will add its own reference rather than adopting yours.
 * 
 * Return value: a new #GtkImage
 **/
Elliot Lee's avatar
Elliot Lee committed
506
GtkWidget*
507
508
gtk_image_new_from_pixmap (GdkPixmap *pixmap,
                           GdkBitmap *mask)
Elliot Lee's avatar
Elliot Lee committed
509
510
511
{
  GtkImage *image;

Manish Singh's avatar
Manish Singh committed
512
  image = g_object_new (GTK_TYPE_IMAGE, NULL);
513
514
515
516
517
518

  gtk_image_set_from_pixmap (image, pixmap, mask);

  return GTK_WIDGET (image);
}

519
520
521
522
523
524
525
/**
 * gtk_image_new_from_image:
 * @image: a #GdkImage, or %NULL
 * @mask: a #GdkBitmap, or %NULL 
 * 
 * Creates a #GtkImage widget displaying a @image with a @mask.
 * A #GdkImage is a client-side image buffer in the pixel format of the
526
 * current display. The #GtkImage does not assume a reference to the
527
528
529
530
531
 * image or mask; you still need to unref them if you own references.
 * #GtkImage will add its own reference rather than adopting yours.
 * 
 * Return value: a new #GtkImage
 **/
532
533
534
535
536
GtkWidget*
gtk_image_new_from_image  (GdkImage  *gdk_image,
                           GdkBitmap *mask)
{
  GtkImage *image;
Elliot Lee's avatar
Elliot Lee committed
537

Manish Singh's avatar
Manish Singh committed
538
  image = g_object_new (GTK_TYPE_IMAGE, NULL);
Elliot Lee's avatar
Elliot Lee committed
539

540
541
542
543
544
  gtk_image_set_from_image (image, gdk_image, mask);

  return GTK_WIDGET (image);
}

545
546
547
548
/**
 * gtk_image_new_from_file:
 * @filename: a filename
 * 
Havoc Pennington's avatar
Havoc Pennington committed
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 * Creates a new #GtkImage displaying the file @filename. If the file
 * isn't found or can't be loaded, the resulting #GtkImage will
 * display a "broken image" icon. This function never returns %NULL,
 * it always returns a valid #GtkImage widget.
 *
 * If the file contains an animation, the image will contain an
 * animation.
 *
 * If you need to detect failures to load the file, use
 * gdk_pixbuf_new_from_file() to load the file yourself, then create
 * the #GtkImage from the pixbuf. (Or for animations, use
 * gdk_pixbuf_animation_new_from_file()).
 *
 * The storage type (gtk_image_get_storage_type()) of the returned
 * image is not defined, it will be whatever is appropriate for
 * displaying the file.
565
566
567
 * 
 * Return value: a new #GtkImage
 **/
568
569
570
571
572
GtkWidget*
gtk_image_new_from_file   (const gchar *filename)
{
  GtkImage *image;

Manish Singh's avatar
Manish Singh committed
573
  image = g_object_new (GTK_TYPE_IMAGE, NULL);
574
575
576
577
578
579

  gtk_image_set_from_file (image, filename);

  return GTK_WIDGET (image);
}

580
581
582
583
584
585
586
587
588
/**
 * gtk_image_new_from_pixbuf:
 * @pixbuf: a #GdkPixbuf, or %NULL
 * 
 * Creates a new #GtkImage displaying @pixbuf.
 * The #GtkImage does not assume a reference to the
 * pixbuf; you still need to unref it if you own references.
 * #GtkImage will add its own reference rather than adopting yours.
 * 
589
590
591
 * Note that this function just creates an #GtkImage from the pixbuf. The
 * #GtkImage created will not react to state changes. Should you want that, 
 * you should use gtk_image_new_from_icon_set().
592
 * 
593
594
 * Return value: a new #GtkImage
 **/
595
596
597
598
599
GtkWidget*
gtk_image_new_from_pixbuf (GdkPixbuf *pixbuf)
{
  GtkImage *image;

Manish Singh's avatar
Manish Singh committed
600
  image = g_object_new (GTK_TYPE_IMAGE, NULL);
601
602
603
604
605
606

  gtk_image_set_from_pixbuf (image, pixbuf);

  return GTK_WIDGET (image);  
}

607
608
609
610
611
612
/**
 * gtk_image_new_from_stock:
 * @stock_id: a stock icon name
 * @size: a stock icon size
 * 
 * Creates a #GtkImage displaying a stock icon. Sample stock icon
613
 * names are #GTK_STOCK_OPEN, #GTK_STOCK_QUIT. Sample stock sizes
614
 * are #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_SMALL_TOOLBAR. If the stock
Matthias Clasen's avatar
Matthias Clasen committed
615
 * icon name isn't known, the image will be empty.
Havoc Pennington's avatar
Havoc Pennington committed
616
617
 * You can register your own stock icon names, see
 * gtk_icon_factory_add_default() and gtk_icon_factory_add().
618
619
620
 * 
 * Return value: a new #GtkImage displaying the stock icon
 **/
621
622
GtkWidget*
gtk_image_new_from_stock (const gchar    *stock_id,
623
                          GtkIconSize     size)
624
625
626
{
  GtkImage *image;

Manish Singh's avatar
Manish Singh committed
627
  image = g_object_new (GTK_TYPE_IMAGE, NULL);
628
629
630
631
632
633

  gtk_image_set_from_stock (image, stock_id, size);

  return GTK_WIDGET (image);
}

634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
/**
 * gtk_image_new_from_icon_set:
 * @icon_set: a #GtkIconSet
 * @size: a stock icon size
 *
 * Creates a #GtkImage displaying an icon set. Sample stock sizes are
 * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_SMALL_TOOLBAR. Instead of using
 * this function, usually it's better to create a #GtkIconFactory, put
 * your icon sets in the icon factory, add the icon factory to the
 * list of default factories with gtk_icon_factory_add_default(), and
 * then use gtk_image_new_from_stock(). This will allow themes to
 * override the icon you ship with your application.
 *
 * The #GtkImage does not assume a reference to the
 * icon set; you still need to unref it if you own references.
 * #GtkImage will add its own reference rather than adopting yours.
 * 
 * Return value: a new #GtkImage
 **/
653
654
GtkWidget*
gtk_image_new_from_icon_set (GtkIconSet     *icon_set,
655
                             GtkIconSize     size)
656
657
658
{
  GtkImage *image;

Manish Singh's avatar
Manish Singh committed
659
  image = g_object_new (GTK_TYPE_IMAGE, NULL);
660
661

  gtk_image_set_from_icon_set (image, icon_set, size);
Elliot Lee's avatar
Elliot Lee committed
662
663
664
665

  return GTK_WIDGET (image);
}

Havoc Pennington's avatar
Havoc Pennington committed
666
667
668
669
670
671
672
673
/**
 * gtk_image_new_from_animation:
 * @animation: an animation
 * 
 * Creates a #GtkImage displaying the given animation.
 * The #GtkImage does not assume a reference to the
 * animation; you still need to unref it if you own references.
 * #GtkImage will add its own reference rather than adopting yours.
674
675
676
677
678
679
 *
 * Note that the animation frames are shown using a timeout with
 * #G_PRIORITY_DEFAULT. When using animations to indicate busyness,
 * keep in mind that the animation will only be shown if the main loop
 * is not busy with something that has a higher priority.
 *
Havoc Pennington's avatar
Havoc Pennington committed
680
681
682
683
684
685
686
687
688
 * Return value: a new #GtkImage widget
 **/
GtkWidget*
gtk_image_new_from_animation (GdkPixbufAnimation *animation)
{
  GtkImage *image;

  g_return_val_if_fail (GDK_IS_PIXBUF_ANIMATION (animation), NULL);
  
Manish Singh's avatar
Manish Singh committed
689
  image = g_object_new (GTK_TYPE_IMAGE, NULL);
Havoc Pennington's avatar
Havoc Pennington committed
690
691
692
693
694
695

  gtk_image_set_from_animation (image, animation);

  return GTK_WIDGET (image);
}

696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
/**
 * gtk_image_new_from_icon_name:
 * @icon_name: an icon name
 * @size: a stock icon size
 * 
 * Creates a #GtkImage displaying an icon from the current icon theme.
 * If the icon name isn't known, a "broken image" icon will be
 * displayed instead.  If the current icon theme is changed, the icon
 * will be updated appropriately.
 * 
 * Return value: a new #GtkImage displaying the themed icon
 *
 * Since: 2.6
 **/
GtkWidget*
gtk_image_new_from_icon_name (const gchar    *icon_name,
			      GtkIconSize     size)
{
  GtkImage *image;

  image = g_object_new (GTK_TYPE_IMAGE, NULL);

  gtk_image_set_from_icon_name (image, icon_name, size);

  return GTK_WIDGET (image);
}

723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
/**
 * gtk_image_new_from_gicon:
 * @icon: an icon
 * @size: a stock icon size
 * 
 * Creates a #GtkImage displaying an icon from the current icon theme.
 * If the icon name isn't known, a "broken image" icon will be
 * displayed instead.  If the current icon theme is changed, the icon
 * will be updated appropriately.
 * 
 * Return value: a new #GtkImage displaying the themed icon
 *
 * Since: 2.14
 **/
GtkWidget*
gtk_image_new_from_gicon (GIcon *icon,
			  GtkIconSize     size)
{
  GtkImage *image;

  image = g_object_new (GTK_TYPE_IMAGE, NULL);

  gtk_image_set_from_gicon (image, icon, size);

  return GTK_WIDGET (image);
}

750
751
752
753
754
755
756
757
/**
 * gtk_image_set_from_pixmap:
 * @image: a #GtkImage
 * @pixmap: a #GdkPixmap or %NULL
 * @mask: a #GdkBitmap or %NULL
 *
 * See gtk_image_new_from_pixmap() for details.
 **/
Elliot Lee's avatar
Elliot Lee committed
758
void
759
760
761
762
763
764
765
766
767
gtk_image_set_from_pixmap (GtkImage  *image,
                           GdkPixmap *pixmap,
                           GdkBitmap *mask)
{
  g_return_if_fail (GTK_IS_IMAGE (image));
  g_return_if_fail (pixmap == NULL ||
                    GDK_IS_PIXMAP (pixmap));
  g_return_if_fail (mask == NULL ||
                    GDK_IS_PIXMAP (mask));
Havoc Pennington's avatar
Havoc Pennington committed
768
769

  g_object_freeze_notify (G_OBJECT (image));
770
771
  
  if (pixmap)
Manish Singh's avatar
Manish Singh committed
772
    g_object_ref (pixmap);
773
774

  if (mask)
Manish Singh's avatar
Manish Singh committed
775
    g_object_ref (mask);
776

777
  gtk_image_clear (image);
778

Havoc Pennington's avatar
Havoc Pennington committed
779
780
  image->mask = mask;
  
781
782
783
784
785
786
787
788
789
790
791
792
793
  if (pixmap)
    {
      int width;
      int height;
      
      image->storage_type = GTK_IMAGE_PIXMAP;

      image->data.pixmap.pixmap = pixmap;

      gdk_drawable_get_size (GDK_DRAWABLE (pixmap), &width, &height);

      gtk_image_update_size (image, width, height);
    }
Havoc Pennington's avatar
Havoc Pennington committed
794
795
796
797
798

  g_object_notify (G_OBJECT (image), "pixmap");
  g_object_notify (G_OBJECT (image), "mask");
  
  g_object_thaw_notify (G_OBJECT (image));
799
800
}

801
802
803
804
805
806
807
808
/**
 * gtk_image_set_from_image:
 * @image: a #GtkImage
 * @gdk_image: a #GdkImage or %NULL
 * @mask: a #GdkBitmap or %NULL
 *
 * See gtk_image_new_from_image() for details.
 **/
809
810
811
812
void
gtk_image_set_from_image  (GtkImage  *image,
                           GdkImage  *gdk_image,
                           GdkBitmap *mask)
Elliot Lee's avatar
Elliot Lee committed
813
814
{
  g_return_if_fail (GTK_IS_IMAGE (image));
815
816
817
818
819
  g_return_if_fail (gdk_image == NULL ||
                    GDK_IS_IMAGE (gdk_image));
  g_return_if_fail (mask == NULL ||
                    GDK_IS_PIXMAP (mask));

Havoc Pennington's avatar
Havoc Pennington committed
820
  g_object_freeze_notify (G_OBJECT (image));
821
822
  
  if (gdk_image)
Manish Singh's avatar
Manish Singh committed
823
    g_object_ref (gdk_image);
824
825

  if (mask)
Manish Singh's avatar
Manish Singh committed
826
    g_object_ref (mask);
Elliot Lee's avatar
Elliot Lee committed
827

828
  gtk_image_clear (image);
Elliot Lee's avatar
Elliot Lee committed
829

830
  if (gdk_image)
Elliot Lee's avatar
Elliot Lee committed
831
    {
832
833
834
      image->storage_type = GTK_IMAGE_IMAGE;

      image->data.image.image = gdk_image;
Havoc Pennington's avatar
Havoc Pennington committed
835
      image->mask = mask;
836
837

      gtk_image_update_size (image, gdk_image->width, gdk_image->height);
Elliot Lee's avatar
Elliot Lee committed
838
839
840
    }
  else
    {
841
842
      /* Clean up the mask if gdk_image was NULL */
      if (mask)
Manish Singh's avatar
Manish Singh committed
843
        g_object_unref (mask);
Elliot Lee's avatar
Elliot Lee committed
844
    }
Havoc Pennington's avatar
Havoc Pennington committed
845
846
847
848
849

  g_object_notify (G_OBJECT (image), "image");
  g_object_notify (G_OBJECT (image), "mask");
  
  g_object_thaw_notify (G_OBJECT (image));
850
}
Elliot Lee's avatar
Elliot Lee committed
851

852
853
854
855
856
857
858
/**
 * gtk_image_set_from_file:
 * @image: a #GtkImage
 * @filename: a filename or %NULL
 *
 * See gtk_image_new_from_file() for details.
 **/
859
860
861
862
void
gtk_image_set_from_file   (GtkImage    *image,
                           const gchar *filename)
{
863
  GtkImagePrivate *priv = GTK_IMAGE_GET_PRIVATE (image);
Havoc Pennington's avatar
Havoc Pennington committed
864
  GdkPixbufAnimation *anim;
865
866
  
  g_return_if_fail (GTK_IS_IMAGE (image));
Havoc Pennington's avatar
Havoc Pennington committed
867
868

  g_object_freeze_notify (G_OBJECT (image));
869
  
870
  gtk_image_clear (image);
871
872

  if (filename == NULL)
Havoc Pennington's avatar
Havoc Pennington committed
873
    {
874
      priv->filename = NULL;
Havoc Pennington's avatar
Havoc Pennington committed
875
876
877
      g_object_thaw_notify (G_OBJECT (image));
      return;
    }
878

Havoc Pennington's avatar
Havoc Pennington committed
879
  anim = gdk_pixbuf_animation_new_from_file (filename, NULL);
880

Havoc Pennington's avatar
Havoc Pennington committed
881
  if (anim == NULL)
882
883
884
885
    {
      gtk_image_set_from_stock (image,
                                GTK_STOCK_MISSING_IMAGE,
                                GTK_ICON_SIZE_BUTTON);
Havoc Pennington's avatar
Havoc Pennington committed
886
      g_object_thaw_notify (G_OBJECT (image));
887
888
      return;
    }
889

Havoc Pennington's avatar
Havoc Pennington committed
890
891
892
893
  /* We could just unconditionally set_from_animation,
   * but it's nicer for memory if we toss the animation
   * if it's just a single pixbuf
   */
894

Havoc Pennington's avatar
Havoc Pennington committed
895
  if (gdk_pixbuf_animation_is_static_image (anim))
896
897
    gtk_image_set_from_pixbuf (image,
			       gdk_pixbuf_animation_get_static_image (anim));
Havoc Pennington's avatar
Havoc Pennington committed
898
  else
899
    gtk_image_set_from_animation (image, anim);
Havoc Pennington's avatar
Havoc Pennington committed
900

Manish Singh's avatar
Manish Singh committed
901
  g_object_unref (anim);
Havoc Pennington's avatar
Havoc Pennington committed
902

903
904
  priv->filename = g_strdup (filename);
  
Havoc Pennington's avatar
Havoc Pennington committed
905
  g_object_thaw_notify (G_OBJECT (image));
906
907
}

908
909
910
911
912
913
914
/**
 * gtk_image_set_from_pixbuf:
 * @image: a #GtkImage
 * @pixbuf: a #GdkPixbuf or %NULL
 *
 * See gtk_image_new_from_pixbuf() for details. 
 **/
915
916
917
918
919
920
921
void
gtk_image_set_from_pixbuf (GtkImage  *image,
                           GdkPixbuf *pixbuf)
{
  g_return_if_fail (GTK_IS_IMAGE (image));
  g_return_if_fail (pixbuf == NULL ||
                    GDK_IS_PIXBUF (pixbuf));
Havoc Pennington's avatar
Havoc Pennington committed
922
923

  g_object_freeze_notify (G_OBJECT (image));
924
925
  
  if (pixbuf)
Manish Singh's avatar
Manish Singh committed
926
    g_object_ref (pixbuf);
927

928
  gtk_image_clear (image);
929
930
931
932
933
934
935
936
937
938
939

  if (pixbuf != NULL)
    {
      image->storage_type = GTK_IMAGE_PIXBUF;

      image->data.pixbuf.pixbuf = pixbuf;

      gtk_image_update_size (image,
                             gdk_pixbuf_get_width (pixbuf),
                             gdk_pixbuf_get_height (pixbuf));
    }
Havoc Pennington's avatar
Havoc Pennington committed
940
941
942
943

  g_object_notify (G_OBJECT (image), "pixbuf");
  
  g_object_thaw_notify (G_OBJECT (image));
944
945
}

946
947
948
949
950
951
/**
 * gtk_image_set_from_stock:
 * @image: a #GtkImage
 * @stock_id: a stock icon name
 * @size: a stock icon size
 *
952
 * See gtk_image_new_from_stock() for details.
953
 **/
954
955
956
void
gtk_image_set_from_stock  (GtkImage       *image,
                           const gchar    *stock_id,
957
                           GtkIconSize     size)
958
{
Havoc Pennington's avatar
Havoc Pennington committed
959
960
  gchar *new_id;
  
961
  g_return_if_fail (GTK_IS_IMAGE (image));
Havoc Pennington's avatar
Havoc Pennington committed
962
963
964
965
966

  g_object_freeze_notify (G_OBJECT (image));

  /* in case stock_id == image->data.stock.stock_id */
  new_id = g_strdup (stock_id);
967
  
968
  gtk_image_clear (image);
969

Havoc Pennington's avatar
Havoc Pennington committed
970
971
  if (new_id)
    {
972
973
      image->storage_type = GTK_IMAGE_STOCK;
      
Havoc Pennington's avatar
Havoc Pennington committed
974
975
      image->data.stock.stock_id = new_id;
      image->icon_size = size;
976
977
978
979
980
981

      /* Size is demand-computed in size request method
       * if we're a stock image, since changing the
       * style impacts the size request
       */
    }
Havoc Pennington's avatar
Havoc Pennington committed
982
983

  g_object_notify (G_OBJECT (image), "stock");
984
  g_object_notify (G_OBJECT (image), "icon-size");
Havoc Pennington's avatar
Havoc Pennington committed
985
986
  
  g_object_thaw_notify (G_OBJECT (image));
987
988
}

989
990
991
992
993
994
995
996
/**
 * gtk_image_set_from_icon_set:
 * @image: a #GtkImage
 * @icon_set: a #GtkIconSet
 * @size: a stock icon size
 *
 * See gtk_image_new_from_icon_set() for details.
 **/
997
998
999
void
gtk_image_set_from_icon_set  (GtkImage       *image,
                              GtkIconSet     *icon_set,
1000
                              GtkIconSize     size)
1001
1002
1003
{
  g_return_if_fail (GTK_IS_IMAGE (image));

Havoc Pennington's avatar
Havoc Pennington committed
1004
1005
  g_object_freeze_notify (G_OBJECT (image));
  
1006
1007
1008
  if (icon_set)
    gtk_icon_set_ref (icon_set);
  
1009
  gtk_image_clear (image);
1010
1011
1012
1013
1014
1015

  if (icon_set)
    {      
      image->storage_type = GTK_IMAGE_ICON_SET;
      
      image->data.icon_set.icon_set = icon_set;
Havoc Pennington's avatar
Havoc Pennington committed
1016
      image->icon_size = size;
1017
1018
1019
1020
1021

      /* Size is demand-computed in size request method
       * if we're an icon set
       */
    }
Havoc Pennington's avatar
Havoc Pennington committed
1022
  
1023
1024
  g_object_notify (G_OBJECT (image), "icon-set");
  g_object_notify (G_OBJECT (image), "icon-size");
Havoc Pennington's avatar
Havoc Pennington committed
1025
1026
  
  g_object_thaw_notify (G_OBJECT (image));
1027
1028
}

Havoc Pennington's avatar
Havoc Pennington committed
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
/**
 * gtk_image_set_from_animation:
 * @image: a #GtkImage
 * @animation: the #GdkPixbufAnimation
 * 
 * Causes the #GtkImage to display the given animation (or display
 * nothing, if you set the animation to %NULL).
 **/
void
gtk_image_set_from_animation (GtkImage           *image,
                              GdkPixbufAnimation *animation)
{
  g_return_if_fail (GTK_IS_IMAGE (image));
  g_return_if_fail (animation == NULL ||
                    GDK_IS_PIXBUF_ANIMATION (animation));
Havoc Pennington's avatar
Havoc Pennington committed
1044
1045

  g_object_freeze_notify (G_OBJECT (image));
Havoc Pennington's avatar
Havoc Pennington committed
1046
1047
  
  if (animation)
Manish Singh's avatar
Manish Singh committed
1048
    g_object_ref (animation);
Havoc Pennington's avatar
Havoc Pennington committed
1049

1050
  gtk_image_clear (image);
Havoc Pennington's avatar
Havoc Pennington committed
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063

  if (animation != NULL)
    {
      image->storage_type = GTK_IMAGE_ANIMATION;

      image->data.anim.anim = animation;
      image->data.anim.frame_timeout = 0;
      image->data.anim.iter = NULL;
      
      gtk_image_update_size (image,
                             gdk_pixbuf_animation_get_width (animation),
                             gdk_pixbuf_animation_get_height (animation));
    }
Havoc Pennington's avatar
Havoc Pennington committed
1064

1065
  g_object_notify (G_OBJECT (image), "pixbuf-animation");
Havoc Pennington's avatar
Havoc Pennington committed
1066
1067
  
  g_object_thaw_notify (G_OBJECT (image));
Havoc Pennington's avatar
Havoc Pennington committed
1068
1069
}

1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
/**
 * gtk_image_set_from_icon_name:
 * @image: a #GtkImage
 * @icon_name: an icon name
 * @size: an icon size
 *
 * See gtk_image_new_from_icon_name() for details.
 * 
 * Since: 2.6
 **/
void
gtk_image_set_from_icon_name  (GtkImage       *image,
			       const gchar    *icon_name,
			       GtkIconSize     size)
{
  gchar *new_name;
  
  g_return_if_fail (GTK_IS_IMAGE (image));

  g_object_freeze_notify (G_OBJECT (image));

1091
  /* in case icon_name == image->data.name.icon_name */
1092
1093
  new_name = g_strdup (icon_name);
  
1094
  gtk_image_clear (image);
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108

  if (new_name)
    {
      image->storage_type = GTK_IMAGE_ICON_NAME;
      
      image->data.name.icon_name = new_name;
      image->icon_size = size;

      /* Size is demand-computed in size request method
       * if we're a icon theme image, since changing the
       * style impacts the size request
       */
    }

1109
1110
  g_object_notify (G_OBJECT (image), "icon-name");
  g_object_notify (G_OBJECT (image), "icon-size");
1111
1112
1113
1114
  
  g_object_thaw_notify (G_OBJECT (image));
}

1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
/**
 * gtk_image_set_from_gicon:
 * @image: a #GtkImage
 * @icon: an icon
 * @size: an icon size
 *
 * See gtk_image_new_from_gicon() for details.
 * 
 * Since: 2.14
 **/
void
gtk_image_set_from_gicon  (GtkImage       *image,
			   GIcon          *icon,
			   GtkIconSize     size)
{
  g_return_if_fail (GTK_IS_IMAGE (image));

  g_object_freeze_notify (G_OBJECT (image));

  /* in case icon == image->data.gicon.icon */
  if (icon)
    g_object_ref (icon);
  
  gtk_image_clear (image);

  if (icon)
    {
      image->storage_type = GTK_IMAGE_GICON;
      
      image->data.gicon.icon = icon;
      image->icon_size = size;

      /* Size is demand-computed in size request method
       * if we're a icon theme image, since changing the
       * style impacts the size request
       */
    }

  g_object_notify (G_OBJECT (image), "gicon");
  g_object_notify (G_OBJECT (image), "icon-size");
  
  g_object_thaw_notify (G_OBJECT (image));
}

1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
/**
 * gtk_image_get_storage_type:
 * @image: a #GtkImage
 * 
 * Gets the type of representation being used by the #GtkImage
 * to store image data. If the #GtkImage has no image data,
 * the return value will be %GTK_IMAGE_EMPTY.
 * 
 * Return value: image representation being used
 **/
1169
1170
1171
1172
1173
1174
1175
1176
GtkImageType
gtk_image_get_storage_type (GtkImage *image)
{
  g_return_val_if_fail (GTK_IS_IMAGE (image), GTK_IMAGE_EMPTY);

  return image->storage_type;
}

1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
/**
 * gtk_image_get_pixmap:
 * @image: a #GtkImage
 * @pixmap: location to store the pixmap, or %NULL
 * @mask: location to store the mask, or %NULL
 *
 * Gets the pixmap and mask being displayed by the #GtkImage.
 * The storage type of the image must be %GTK_IMAGE_EMPTY or
 * %GTK_IMAGE_PIXMAP (see gtk_image_get_storage_type()).
 * The caller of this function does not own a reference to the
 * returned pixmap and mask.
 **/
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
void
gtk_image_get_pixmap (GtkImage   *image,
                      GdkPixmap **pixmap,
                      GdkBitmap **mask)
{
  g_return_if_fail (GTK_IS_IMAGE (image)); 
  g_return_if_fail (image->storage_type == GTK_IMAGE_PIXMAP ||
                    image->storage_type == GTK_IMAGE_EMPTY);
  
  if (pixmap)
    *pixmap = image->data.pixmap.pixmap;
  
  if (mask)
Havoc Pennington's avatar
Havoc Pennington committed
1202
    *mask = image->mask;
1203
1204
}

1205
1206
1207
/**
 * gtk_image_get_image:
 * @image: a #GtkImage
Matthias Clasen's avatar
Matthias Clasen committed
1208
1209
 * @gdk_image: return location for a #GtkImage, or %NULL
 * @mask: return location for a #GdkBitmap, or %NULL
1210
1211
1212
1213
1214
1215
1216
 * 
 * Gets the #GdkImage and mask being displayed by the #GtkImage.
 * The storage type of the image must be %GTK_IMAGE_EMPTY or
 * %GTK_IMAGE_IMAGE (see gtk_image_get_storage_type()).
 * The caller of this function does not own a reference to the
 * returned image and mask.
 **/
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
void
gtk_image_get_image  (GtkImage   *image,
                      GdkImage  **gdk_image,
                      GdkBitmap **mask)
{
  g_return_if_fail (GTK_IS_IMAGE (image));
  g_return_if_fail (image->storage_type == GTK_IMAGE_IMAGE ||
                    image->storage_type == GTK_IMAGE_EMPTY);

  if (gdk_image)
    *gdk_image = image->data.image.image;
  
  if (mask)
Havoc Pennington's avatar
Havoc Pennington committed
1230
    *mask = image->mask;
1231
1232
}

1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
/**
 * gtk_image_get_pixbuf:
 * @image: a #GtkImage
 *
 * Gets the #GdkPixbuf being displayed by the #GtkImage.
 * The storage type of the image must be %GTK_IMAGE_EMPTY or
 * %GTK_IMAGE_PIXBUF (see gtk_image_get_storage_type()).
 * The caller of this function does not own a reference to the
 * returned pixbuf.
 * 
 * Return value: the displayed pixbuf, or %NULL if the image is empty
 **/
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
GdkPixbuf*
gtk_image_get_pixbuf (GtkImage *image)
{
  g_return_val_if_fail (GTK_IS_IMAGE (image), NULL);
  g_return_val_if_fail (image->storage_type == GTK_IMAGE_PIXBUF ||
                        image->storage_type == GTK_IMAGE_EMPTY, NULL);

  if (image->storage_type == GTK_IMAGE_EMPTY)
    image->data.pixbuf.pixbuf = NULL;
  
  return image->data.pixbuf.pixbuf;
}

1258
1259
1260
/**
 * gtk_image_get_stock:
 * @image: a #GtkImage
Matthias Clasen's avatar
Matthias Clasen committed
1261
1262
 * @stock_id: place to store a stock icon name, or %NULL
 * @size: place to store a stock icon size, or %NULL
1263
1264
1265
1266
 *
 * Gets the stock icon name and size being displayed by the #GtkImage.
 * The storage type of the image must be %GTK_IMAGE_EMPTY or
 * %GTK_IMAGE_STOCK (see gtk_image_get_storage_type()).
1267
 * The returned string is owned by the #GtkImage and should not
1268
1269
 * be freed.
 **/
1270
1271
1272
void
gtk_image_get_stock  (GtkImage        *image,
                      gchar          **stock_id,
1273
                      GtkIconSize     *size)
1274
1275
1276
1277
1278
1279
1280
1281
1282
{
  g_return_if_fail (GTK_IS_IMAGE (image));
  g_return_if_fail (image->storage_type == GTK_IMAGE_STOCK ||
                    image->storage_type == GTK_IMAGE_EMPTY);

  if (image->storage_type == GTK_IMAGE_EMPTY)
    image->data.stock.stock_id = NULL;
  
  if (stock_id)
1283
    *stock_id = image->data.stock.stock_id;
1284
1285

  if (size)
Havoc Pennington's avatar
Havoc Pennington committed
1286
    *size = image->icon_size;
1287
1288
}

1289
1290
1291
/**
 * gtk_image_get_icon_set:
 * @image: a #GtkImage
Matthias Clasen's avatar
Matthias Clasen committed
1292
1293
 * @icon_set: location to store a #GtkIconSet, or %NULL
 * @size: location to store a stock icon size, or %NULL
1294
1295
1296
1297
1298
 *
 * Gets the icon set and size being displayed by the #GtkImage.
 * The storage type of the image must be %GTK_IMAGE_EMPTY or
 * %GTK_IMAGE_ICON_SET (see gtk_image_get_storage_type()).
 **/
1299
1300
1301
void
gtk_image_get_icon_set  (GtkImage        *image,
                         GtkIconSet     **icon_set,
1302
                         GtkIconSize     *size)
1303
1304
1305
1306
1307
1308
1309
1310
1311
{
  g_return_if_fail (GTK_IS_IMAGE (image));
  g_return_if_fail (image->storage_type == GTK_IMAGE_ICON_SET ||
                    image->storage_type == GTK_IMAGE_EMPTY);
      
  if (icon_set)    
    *icon_set = image->data.icon_set.icon_set;

  if (size)
Havoc Pennington's avatar
Havoc Pennington committed
1312
    *size = image->icon_size;
1313
1314
}

Havoc Pennington's avatar
Havoc Pennington committed
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
/**
 * gtk_image_get_animation:
 * @image: a #GtkImage
 *
 * Gets the #GdkPixbufAnimation being displayed by the #GtkImage.
 * The storage type of the image must be %GTK_IMAGE_EMPTY or
 * %GTK_IMAGE_ANIMATION (see gtk_image_get_storage_type()).
 * The caller of this function does not own a reference to the
 * returned animation.
 * 
 * Return value: the displayed animation, or %NULL if the image is empty
 **/
GdkPixbufAnimation*
gtk_image_get_animation (GtkImage *image)
{
  g_return_val_if_fail (GTK_IS_IMAGE (image), NULL);
  g_return_val_if_fail (image->storage_type == GTK_IMAGE_ANIMATION ||
                        image->storage_type == GTK_IMAGE_EMPTY,
                        NULL);

  if (image->storage_type == GTK_IMAGE_EMPTY)
    image->data.anim.anim = NULL;
  
  return image->data.anim.anim;
}

1341
1342
1343
/**
 * gtk_image_get_icon_name:
 * @image: a #GtkImage
Matthias Clasen's avatar
Matthias Clasen committed
1344
1345
 * @icon_name: place to store an icon name, or %NULL
 * @size: place to store an icon size, or %NULL
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 *
 * Gets the icon name and size being displayed by the #GtkImage.
 * The storage type of the image must be %GTK_IMAGE_EMPTY or
 * %GTK_IMAGE_ICON_NAME (see gtk_image_get_storage_type()).
 * The returned string is owned by the #GtkImage and should not
 * be freed.
 * 
 * Since: 2.6
 **/
void
1356
1357
1358
gtk_image_get_icon_name  (GtkImage              *image,
			  G_CONST_RETURN gchar **icon_name,
			  GtkIconSize           *size)
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
{
  g_return_if_fail (GTK_IS_IMAGE (image));
  g_return_if_fail (image->storage_type == GTK_IMAGE_ICON_NAME ||
                    image->storage_type == GTK_IMAGE_EMPTY);

  if (image->storage_type == GTK_IMAGE_EMPTY)
    image->data.name.icon_name = NULL;
  
  if (icon_name)
    *icon_name = image->data.name.icon_name;

  if (size)
    *size = image->icon_size;
}