gtkimage.c 60.7 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* GTK - The GIMP Toolkit
 * 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 48 49 50
  gint pixel_size;
};

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


Havoc Pennington's avatar
Havoc Pennington committed
53 54
#define DEFAULT_ICON_SIZE GTK_ICON_SIZE_BUTTON

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

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

Havoc Pennington's avatar
Havoc Pennington committed
75 76 77 78 79 80 81 82 83
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);

84 85
static void icon_theme_changed          (GtkImage         *image);

86
static gpointer parent_class;
Elliot Lee's avatar
Elliot Lee committed
87

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

Manish Singh's avatar
Manish Singh committed
105
GType
106
gtk_image_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
107
{
Manish Singh's avatar
Manish Singh committed
108
  static GType image_type = 0;
Elliot Lee's avatar
Elliot Lee committed
109 110 111

  if (!image_type)
    {
Manish Singh's avatar
Manish Singh committed
112
      static const GTypeInfo image_info =
Elliot Lee's avatar
Elliot Lee committed
113 114
      {
	sizeof (GtkImageClass),
Manish Singh's avatar
Manish Singh committed
115 116 117 118 119 120 121 122
	NULL,		/* base_init */
	NULL,		/* base_finalize */
	(GClassInitFunc) gtk_image_class_init,
	NULL,		/* class_finalize */
	NULL,		/* class_data */
	sizeof (GtkImage),
	0,		/* n_preallocs */
	(GInstanceInitFunc) gtk_image_init,
Elliot Lee's avatar
Elliot Lee committed
123 124
      };

125
      image_type = g_type_register_static (GTK_TYPE_MISC, I_("GtkImage"),
Manish Singh's avatar
Manish Singh committed
126
					   &image_info, 0);
Elliot Lee's avatar
Elliot Lee committed
127 128 129 130 131 132 133 134
    }

  return image_type;
}

static void
gtk_image_class_init (GtkImageClass *class)
{
Havoc Pennington's avatar
Havoc Pennington committed
135
  GObjectClass *gobject_class;
136
  GtkObjectClass *object_class;
Elliot Lee's avatar
Elliot Lee committed
137 138
  GtkWidgetClass *widget_class;

139
  parent_class = g_type_class_peek_parent (class);
140

Havoc Pennington's avatar
Havoc Pennington committed
141 142 143 144 145 146
  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);
147
  
148 149
  object_class->destroy = gtk_image_destroy;

Havoc Pennington's avatar
Havoc Pennington committed
150 151
  widget_class = GTK_WIDGET_CLASS (class);
  
Elliot Lee's avatar
Elliot Lee committed
152
  widget_class->expose_event = gtk_image_expose;
153
  widget_class->size_request = gtk_image_size_request;
Havoc Pennington's avatar
Havoc Pennington committed
154
  widget_class->unmap = gtk_image_unmap;
155
  widget_class->unrealize = gtk_image_unrealize;
156
  widget_class->style_set = gtk_image_style_set;
157
  widget_class->screen_changed = gtk_image_screen_changed;
Havoc Pennington's avatar
Havoc Pennington committed
158 159 160 161
  
  g_object_class_install_property (gobject_class,
                                   PROP_PIXBUF,
                                   g_param_spec_object ("pixbuf",
162 163
                                                        P_("Pixbuf"),
                                                        P_("A GdkPixbuf to display"),
Havoc Pennington's avatar
Havoc Pennington committed
164
                                                        GDK_TYPE_PIXBUF,
165
                                                        GTK_PARAM_READWRITE));
Havoc Pennington's avatar
Havoc Pennington committed
166 167 168 169

  g_object_class_install_property (gobject_class,
                                   PROP_PIXMAP,
                                   g_param_spec_object ("pixmap",
170 171
                                                        P_("Pixmap"),
                                                        P_("A GdkPixmap to display"),
Havoc Pennington's avatar
Havoc Pennington committed
172
                                                        GDK_TYPE_PIXMAP,
173
                                                        GTK_PARAM_READWRITE));
Havoc Pennington's avatar
Havoc Pennington committed
174 175 176 177

  g_object_class_install_property (gobject_class,
                                   PROP_IMAGE,
                                   g_param_spec_object ("image",
178 179
                                                        P_("Image"),
                                                        P_("A GdkImage to display"),
Havoc Pennington's avatar
Havoc Pennington committed
180
                                                        GDK_TYPE_IMAGE,
181
                                                        GTK_PARAM_READWRITE));
Havoc Pennington's avatar
Havoc Pennington committed
182 183 184 185

  g_object_class_install_property (gobject_class,
                                   PROP_MASK,
                                   g_param_spec_object ("mask",
186 187
                                                        P_("Mask"),
                                                        P_("Mask bitmap to use with GdkImage or GdkPixmap"),
Havoc Pennington's avatar
Havoc Pennington committed
188
                                                        GDK_TYPE_PIXMAP,
189
                                                        GTK_PARAM_READWRITE));
Havoc Pennington's avatar
Havoc Pennington committed
190 191 192 193
  
  g_object_class_install_property (gobject_class,
                                   PROP_FILE,
                                   g_param_spec_string ("file",
194 195
                                                        P_("Filename"),
                                                        P_("Filename to load and display"),
Havoc Pennington's avatar
Havoc Pennington committed
196
                                                        NULL,
197
                                                        GTK_PARAM_READWRITE));
Havoc Pennington's avatar
Havoc Pennington committed
198 199 200 201 202
  

  g_object_class_install_property (gobject_class,
                                   PROP_STOCK,
                                   g_param_spec_string ("stock",
203 204
                                                        P_("Stock ID"),
                                                        P_("Stock ID for a stock image to display"),
Havoc Pennington's avatar
Havoc Pennington committed
205
                                                        NULL,
206
                                                        GTK_PARAM_READWRITE));
Havoc Pennington's avatar
Havoc Pennington committed
207 208 209
  
  g_object_class_install_property (gobject_class,
                                   PROP_ICON_SET,
210
                                   g_param_spec_boxed ("icon-set",
211 212
                                                       P_("Icon set"),
                                                       P_("Icon set to display"),
Havoc Pennington's avatar
Havoc Pennington committed
213
                                                       GTK_TYPE_ICON_SET,
214
                                                       GTK_PARAM_READWRITE));
Havoc Pennington's avatar
Havoc Pennington committed
215 216 217
  
  g_object_class_install_property (gobject_class,
                                   PROP_ICON_SIZE,
218
                                   g_param_spec_int ("icon-size",
219
                                                     P_("Icon size"),
220
                                                     P_("Symbolic size to use for stock icon, icon set or named icon"),
Havoc Pennington's avatar
Havoc Pennington committed
221 222
                                                     0, G_MAXINT,
                                                     DEFAULT_ICON_SIZE,
223
                                                     GTK_PARAM_READWRITE));
224 225 226 227 228 229 230 231 232 233 234
  /**
   * GtkImage:pixel-size:
   *
   * The :pixel-size property can be used to specify a fixed size
   * overriding the :icon-size property for images of type 
   * %GTK_IMAGE_ICON_NAME. 
   *
   * Since: 2.6
   */
  g_object_class_install_property (gobject_class,
				   PROP_PIXEL_SIZE,
235
				   g_param_spec_int ("pixel-size",
236 237 238 239
						     P_("Pixel size"),
						     P_("Pixel size to use for named icon"),
						     -1, G_MAXINT,
						     -1,
240
						     GTK_PARAM_READWRITE));
241
  
Havoc Pennington's avatar
Havoc Pennington committed
242 243
  g_object_class_install_property (gobject_class,
                                   PROP_PIXBUF_ANIMATION,
244
                                   g_param_spec_object ("pixbuf-animation",
245 246
                                                        P_("Animation"),
                                                        P_("GdkPixbufAnimation to display"),
Havoc Pennington's avatar
Havoc Pennington committed
247
                                                        GDK_TYPE_PIXBUF_ANIMATION,
248
                                                        GTK_PARAM_READWRITE));
249 250 251 252 253 254 255 256 257 258 259

  /**
   * GtkImage:icon-name:
   *
   * The name of the icon in the icon theme.  If the icon theme is
   * changed, the image will be updated automatically.
   *
   * Since: 2.6
   */
  g_object_class_install_property (gobject_class,
                                   PROP_ICON_NAME,
260
                                   g_param_spec_string ("icon-name",
261 262 263
                                                        P_("Icon Name"),
                                                        P_("The name of the icon from the icon theme"),
                                                        NULL,
264
                                                        GTK_PARAM_READWRITE));
Havoc Pennington's avatar
Havoc Pennington committed
265 266 267
  
  g_object_class_install_property (gobject_class,
                                   PROP_STORAGE_TYPE,
Matthias Clasen's avatar
Matthias Clasen committed
268
                                   g_param_spec_enum ("storage-type",
269 270
                                                      P_("Storage type"),
                                                      P_("The representation being used for image data"),
Havoc Pennington's avatar
Havoc Pennington committed
271 272
                                                      GTK_TYPE_IMAGE_TYPE,
                                                      GTK_IMAGE_EMPTY,
273
                                                      GTK_PARAM_READABLE));
274 275

  g_type_class_add_private (object_class, sizeof (GtkImagePrivate));
Elliot Lee's avatar
Elliot Lee committed
276 277 278 279 280
}

static void
gtk_image_init (GtkImage *image)
{
281 282
  GtkImagePrivate *priv = GTK_IMAGE_GET_PRIVATE (image);

Elliot Lee's avatar
Elliot Lee committed
283 284
  GTK_WIDGET_SET_FLAGS (image, GTK_NO_WINDOW);

285
  image->storage_type = GTK_IMAGE_EMPTY;
Havoc Pennington's avatar
Havoc Pennington committed
286 287
  image->icon_size = DEFAULT_ICON_SIZE;
  image->mask = NULL;
288 289

  priv->pixel_size = -1;
290 291

  priv->filename = NULL;
Elliot Lee's avatar
Elliot Lee committed
292 293
}

294 295 296 297 298
static void
gtk_image_destroy (GtkObject *object)
{
  GtkImage *image = GTK_IMAGE (object);

299
  gtk_image_reset (image);
300 301 302 303
  
  GTK_OBJECT_CLASS (parent_class)->destroy (object);
}

Havoc Pennington's avatar
Havoc Pennington committed
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 333 334 335 336 337 338 339 340 341 342 343 344 345
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
346
            g_object_ref (mask);
Havoc Pennington's avatar
Havoc Pennington committed
347
          
348
          gtk_image_clear (image);
Havoc Pennington's avatar
Havoc Pennington committed
349 350 351 352 353

          image->mask = mask;
        }
      break;
    case PROP_FILE:
354
      gtk_image_set_from_file (image, g_value_get_string (value));
Havoc Pennington's avatar
Havoc Pennington committed
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
      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));
373 374 375 376
      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));
Havoc Pennington's avatar
Havoc Pennington committed
377 378 379 380
      else
        /* Save to be used when STOCK or ICON_SET property comes in */
        image->icon_size = g_value_get_int (value);
      break;
381
    case PROP_PIXEL_SIZE:
382
      gtk_image_set_pixel_size (image, g_value_get_int (value));
383
      break;
Havoc Pennington's avatar
Havoc Pennington committed
384 385 386 387
    case PROP_PIXBUF_ANIMATION:
      gtk_image_set_from_animation (image,
                                    g_value_get_object (value));
      break;
388 389 390
    case PROP_ICON_NAME:
      gtk_image_set_from_icon_name (image, g_value_get_string (value),
				    image->icon_size);
391 392
      break;

Havoc Pennington's avatar
Havoc Pennington committed
393 394 395 396 397 398 399 400 401 402 403 404 405
    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;
406
  GtkImagePrivate *priv;
Havoc Pennington's avatar
Havoc Pennington committed
407 408

  image = GTK_IMAGE (object);
409
  priv = GTK_IMAGE_GET_PRIVATE (image);
Havoc Pennington's avatar
Havoc Pennington committed
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 438 439 440 441 442

  /* 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;
443 444 445
    case PROP_FILE:
      g_value_set_string (value, priv->filename);
      break;
Havoc Pennington's avatar
Havoc Pennington committed
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
    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;
463 464 465
    case PROP_PIXEL_SIZE:
      g_value_set_int (value, priv->pixel_size);
      break;
Havoc Pennington's avatar
Havoc Pennington committed
466 467 468 469 470 471 472
    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;
473 474
    case PROP_ICON_NAME:
      if (image->storage_type != GTK_IMAGE_ICON_NAME)
475
	g_value_set_string (value, NULL);
476 477 478 479
      else
	g_value_set_string (value,
			    image->data.name.icon_name);
      break;
Havoc Pennington's avatar
Havoc Pennington committed
480 481 482 483 484 485 486 487 488 489
    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;
    }
}

490

491 492 493 494 495 496
/**
 * 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
497
 * A #GdkPixmap is a server-side image buffer in the pixel format of the
498 499 500 501 502 503
 * 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
504
GtkWidget*
505 506
gtk_image_new_from_pixmap (GdkPixmap *pixmap,
                           GdkBitmap *mask)
Elliot Lee's avatar
Elliot Lee committed
507 508 509
{
  GtkImage *image;

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

  gtk_image_set_from_pixmap (image, pixmap, mask);

  return GTK_WIDGET (image);
}

517 518 519 520 521 522 523 524 525 526 527 528 529 530
/**
 * 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
 * current display.
 * The #GtkImage does not assume a reference to the
 * 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
 **/
531 532 533 534 535
GtkWidget*
gtk_image_new_from_image  (GdkImage  *gdk_image,
                           GdkBitmap *mask)
{
  GtkImage *image;
Elliot Lee's avatar
Elliot Lee committed
536

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

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

  return GTK_WIDGET (image);
}

544 545 546 547
/**
 * gtk_image_new_from_file:
 * @filename: a filename
 * 
Havoc Pennington's avatar
Havoc Pennington committed
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
 * 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.
564 565 566
 * 
 * Return value: a new #GtkImage
 **/
567 568 569 570 571
GtkWidget*
gtk_image_new_from_file   (const gchar *filename)
{
  GtkImage *image;

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

  gtk_image_set_from_file (image, filename);

  return GTK_WIDGET (image);
}

579 580 581 582 583 584 585 586 587
/**
 * 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.
 * 
588 589
 * 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
Havoc Pennington's avatar
Havoc Pennington committed
590
 * should use gtk_image_new_from_icon_set().
591
 * 
592 593
 * Return value: a new #GtkImage
 **/
594 595 596 597 598
GtkWidget*
gtk_image_new_from_pixbuf (GdkPixbuf *pixbuf)
{
  GtkImage *image;

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

  gtk_image_set_from_pixbuf (image, pixbuf);

  return GTK_WIDGET (image);  
}

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

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

  gtk_image_set_from_stock (image, stock_id, size);

  return GTK_WIDGET (image);
}

633 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
/**
 * 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
732
void
733 734 735 736 737 738 739 740 741
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
742 743

  g_object_freeze_notify (G_OBJECT (image));
744 745
  
  if (pixmap)
Manish Singh's avatar
Manish Singh committed
746
    g_object_ref (pixmap);
747 748

  if (mask)
Manish Singh's avatar
Manish Singh committed
749
    g_object_ref (mask);
750

751
  gtk_image_clear (image);
752

Havoc Pennington's avatar
Havoc Pennington committed
753 754
  image->mask = mask;
  
755 756 757 758 759 760 761 762 763 764 765 766 767
  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
768 769 770 771 772

  g_object_notify (G_OBJECT (image), "pixmap");
  g_object_notify (G_OBJECT (image), "mask");
  
  g_object_thaw_notify (G_OBJECT (image));
773 774
}

775 776 777 778 779 780 781 782 783
/**
 * 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.
 * 
 **/
784 785 786 787
void
gtk_image_set_from_image  (GtkImage  *image,
                           GdkImage  *gdk_image,
                           GdkBitmap *mask)
Elliot Lee's avatar
Elliot Lee committed
788 789
{
  g_return_if_fail (GTK_IS_IMAGE (image));
790 791 792 793 794
  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
795
  g_object_freeze_notify (G_OBJECT (image));
796 797
  
  if (gdk_image)
Manish Singh's avatar
Manish Singh committed
798
    g_object_ref (gdk_image);
799 800

  if (mask)
Manish Singh's avatar
Manish Singh committed
801
    g_object_ref (mask);
Elliot Lee's avatar
Elliot Lee committed
802

803
  gtk_image_clear (image);
Elliot Lee's avatar
Elliot Lee committed
804

805
  if (gdk_image)
Elliot Lee's avatar
Elliot Lee committed
806
    {
807 808 809
      image->storage_type = GTK_IMAGE_IMAGE;

      image->data.image.image = gdk_image;
Havoc Pennington's avatar
Havoc Pennington committed
810
      image->mask = mask;
811 812

      gtk_image_update_size (image, gdk_image->width, gdk_image->height);
Elliot Lee's avatar
Elliot Lee committed
813 814 815
    }
  else
    {
816 817
      /* Clean up the mask if gdk_image was NULL */
      if (mask)
Manish Singh's avatar
Manish Singh committed
818
        g_object_unref (mask);
Elliot Lee's avatar
Elliot Lee committed
819
    }
Havoc Pennington's avatar
Havoc Pennington committed
820 821 822 823 824

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

827 828 829 830 831 832 833 834
/**
 * gtk_image_set_from_file:
 * @image: a #GtkImage
 * @filename: a filename or %NULL
 *
 * See gtk_image_new_from_file() for details.
 * 
 **/
835 836 837 838
void
gtk_image_set_from_file   (GtkImage    *image,
                           const gchar *filename)
{
839
  GtkImagePrivate *priv = GTK_IMAGE_GET_PRIVATE (image);
Havoc Pennington's avatar
Havoc Pennington committed
840
  GdkPixbufAnimation *anim;
841 842
  
  g_return_if_fail (GTK_IS_IMAGE (image));
Havoc Pennington's avatar
Havoc Pennington committed
843 844

  g_object_freeze_notify (G_OBJECT (image));
845
  
846
  gtk_image_clear (image);
847 848

  if (filename == NULL)
Havoc Pennington's avatar
Havoc Pennington committed
849
    {
850
      priv->filename = NULL;
Havoc Pennington's avatar
Havoc Pennington committed
851 852 853
      g_object_thaw_notify (G_OBJECT (image));
      return;
    }
854

Havoc Pennington's avatar
Havoc Pennington committed
855
  anim = gdk_pixbuf_animation_new_from_file (filename, NULL);
856

Havoc Pennington's avatar
Havoc Pennington committed
857
  if (anim == NULL)
858 859 860 861
    {
      gtk_image_set_from_stock (image,
                                GTK_STOCK_MISSING_IMAGE,
                                GTK_ICON_SIZE_BUTTON);
Havoc Pennington's avatar
Havoc Pennington committed
862
      g_object_thaw_notify (G_OBJECT (image));
863 864
      return;
    }
865

Havoc Pennington's avatar
Havoc Pennington committed
866 867 868 869
  /* 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
   */
870

Havoc Pennington's avatar
Havoc Pennington committed
871
  if (gdk_pixbuf_animation_is_static_image (anim))
872 873
    gtk_image_set_from_pixbuf (image,
			       gdk_pixbuf_animation_get_static_image (anim));
Havoc Pennington's avatar
Havoc Pennington committed
874
  else
875
    gtk_image_set_from_animation (image, anim);
Havoc Pennington's avatar
Havoc Pennington committed
876

Manish Singh's avatar
Manish Singh committed
877
  g_object_unref (anim);
Havoc Pennington's avatar
Havoc Pennington committed
878

879 880
  priv->filename = g_strdup (filename);
  
Havoc Pennington's avatar
Havoc Pennington committed
881
  g_object_thaw_notify (G_OBJECT (image));
882 883
}

884 885 886 887 888 889 890 891
/**
 * gtk_image_set_from_pixbuf:
 * @image: a #GtkImage
 * @pixbuf: a #GdkPixbuf or %NULL
 *
 * See gtk_image_new_from_pixbuf() for details. 
 * 
 **/
892 893 894 895 896 897 898
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
899 900

  g_object_freeze_notify (G_OBJECT (image));
901 902
  
  if (pixbuf)
Manish Singh's avatar
Manish Singh committed
903
    g_object_ref (pixbuf);
904

905
  gtk_image_clear (image);
906 907 908 909 910 911 912 913 914 915 916

  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
917 918 919 920

  g_object_notify (G_OBJECT (image), "pixbuf");
  
  g_object_thaw_notify (G_OBJECT (image));
921 922
}

923 924 925 926 927 928
/**
 * gtk_image_set_from_stock:
 * @image: a #GtkImage
 * @stock_id: a stock icon name
 * @size: a stock icon size
 *
929
 * See gtk_image_new_from_stock() for details.
930 931
 * 
 **/
932 933 934
void
gtk_image_set_from_stock  (GtkImage       *image,
                           const gchar    *stock_id,
935
                           GtkIconSize     size)
936
{
Havoc Pennington's avatar
Havoc Pennington committed
937 938
  gchar *new_id;
  
939
  g_return_if_fail (GTK_IS_IMAGE (image));
Havoc Pennington's avatar
Havoc Pennington committed
940 941 942 943 944

  g_object_freeze_notify (G_OBJECT (image));

  /* in case stock_id == image->data.stock.stock_id */
  new_id = g_strdup (stock_id);
945
  
946
  gtk_image_clear (image);
947

Havoc Pennington's avatar
Havoc Pennington committed
948 949
  if (new_id)
    {
950 951
      image->storage_type = GTK_IMAGE_STOCK;
      
Havoc Pennington's avatar
Havoc Pennington committed
952 953
      image->data.stock.stock_id = new_id;
      image->icon_size = size;
954 955 956 957 958 959

      /* 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
960 961

  g_object_notify (G_OBJECT (image), "stock");
962
  g_object_notify (G_OBJECT (image), "icon-size");
Havoc Pennington's avatar
Havoc Pennington committed
963 964
  
  g_object_thaw_notify (G_OBJECT (image));
965 966
}

967 968 969 970 971 972 973 974 975
/**
 * 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.
 * 
 **/
976 977 978
void
gtk_image_set_from_icon_set  (GtkImage       *image,
                              GtkIconSet     *icon_set,
979
                              GtkIconSize     size)
980 981 982
{
  g_return_if_fail (GTK_IS_IMAGE (image));

Havoc Pennington's avatar
Havoc Pennington committed
983 984
  g_object_freeze_notify (G_OBJECT (image));
  
985 986 987
  if (icon_set)
    gtk_icon_set_ref (icon_set);
  
988
  gtk_image_clear (image);
989 990 991 992 993 994

  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
995
      image->icon_size = size;
996 997 998 999 1000

      /* Size is demand-computed in size request method
       * if we're an icon set
       */
    }
Havoc Pennington's avatar
Havoc Pennington committed
1001
  
1002 1003
  g_object_notify (G_OBJECT (image), "icon-set");
  g_object_notify (G_OBJECT (image), "icon-size");
Havoc Pennington's avatar
Havoc Pennington committed
1004 1005
  
  g_object_thaw_notify (G_OBJECT (image));
1006 1007
}

Havoc Pennington's avatar
Havoc Pennington committed
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
/**
 * 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
1023 1024

  g_object_freeze_notify (G_OBJECT (image));
Havoc Pennington's avatar
Havoc Pennington committed
1025 1026
  
  if (animation)
Manish Singh's avatar
Manish Singh committed
1027
    g_object_ref (animation);
Havoc Pennington's avatar
Havoc Pennington committed
1028

1029
  gtk_image_clear (image);
Havoc Pennington's avatar
Havoc Pennington committed
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042

  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
1043

1044
  g_object_notify (G_OBJECT (image), "pixbuf-animation");
Havoc Pennington's avatar
Havoc Pennington committed
1045 1046
  
  g_object_thaw_notify (G_OBJECT (image));
Havoc Pennington's avatar
Havoc Pennington committed
1047 1048
}

1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
/**
 * 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));

1070
  /* in case icon_name == image->data.name.icon_name */
1071 1072
  new_name = g_strdup (icon_name);
  
1073
  gtk_image_clear (image);
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087

  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
       */
    }

1088 1089
  g_object_notify (G_OBJECT (image), "icon-name");
  g_object_notify (G_OBJECT (image), "icon-size");
1090 1091 1092 1093
  
  g_object_thaw_notify (G_OBJECT (image));
}

1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
/**
 * 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
 **/
1104 1105 1106 1107 1108 1109 1110 1111
GtkImageType
gtk_image_get_storage_type (GtkImage *image)
{
  g_return_val_if_fail (GTK_IS_IMAGE (image), GTK_IMAGE_EMPTY);

  return image->storage_type;
}

1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
/**
 * 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.
 * 
 **/
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
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
1138
    *mask = image->mask;
1139 1140
}

1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152
/**
 * gtk_image_get_image:
 * @image: a #GtkImage
 * @gdk_image: return location for a #GtkImage
 * @mask: return location for a #GdkBitmap
 * 
 * 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.
 **/
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
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
1166
    *mask = image->mask;
1167 1168
}

1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
/**
 * 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
 **/
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194
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;
}

1195 1196 1197 1198 1199 1200 1201 1202 1203
/**
 * gtk_image_get_stock:
 * @image: a #GtkImage
 * @stock_id: place to store a stock icon name
 * @size: place to store a stock icon size
 *
 * 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()).
1204
 * The returned string is owned by the #GtkImage and should not
1205 1206 1207
 * be freed.
 * 
 **/
1208 1209 1210
void
gtk_image_get_stock  (GtkImage        *image,
                      gchar          **stock_id,
1211
                      GtkIconSize     *size)
1212 1213 1214 1215 1216 1217 1218 1219 1220
{
  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)
1221
    *stock_id = image->data.stock.stock_id;
1222 1223

  if (size)
Havoc Pennington's avatar
Havoc Pennington committed
1224
    *size = image->icon_size;
1225 1226
}

1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
/**
 * gtk_image_get_icon_set:
 * @image: a #GtkImage
 * @icon_set: location to store a #GtkIconSet
 * @size: location to store a stock icon size
 *
 * 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()).
 * 
 **/
1238 1239 1240
void
gtk_image_get_icon_set  (GtkImage        *image,
                         GtkIconSet     **icon_set,
1241
                         GtkIconSize     *size)
1242 1243 1244 1245 1246 1247 1248 1249 1250
{
  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
1251
    *size = image->icon_size;
1252 1253
}

Havoc Pennington's avatar
Havoc Pennington committed
1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
/**
 * 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;
}

1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295
/**
 * gtk_image_get_icon_name:
 * @image: a #GtkImage
 * @icon_name: place to store an icon name
 * @size: place to store an icon size
 *
 * 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
1296 1297 1298
gtk_image_get_icon_name  (GtkImage              *image,
			  G_CONST_RETURN gchar **icon_name,
			  GtkIconSize           *size)
1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
{
  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;
}

1314 1315 1316 1317 1318 1319 1320
/**
 * gtk_image_new:
 * 
 * Creates a new empty #GtkImage widget.
 * 
 * Return value: a newly created #GtkImage widget. 
 **/
1321
GtkWidget*
1322
gtk_image_new (void)
1323
{
1324
  return g_object_new (GTK_TYPE_IMAGE, NULL);
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334
}

void
gtk_image_set (GtkImage  *image,
	       GdkImage  *val,
	       GdkBitmap *mask)
{
  g_return_if_fail (GTK_IS_IMAGE (image));

  gtk_image_set_from_image (image, val, mask);
Elliot Lee's avatar
Elliot Lee committed
1335 1336 1337 1338 1339 1340 1341 1342 1343
}

void
gtk_image_get (GtkImage   *image,
	       GdkImage  **val,
	       GdkBitmap **mask)
{
  g_return_if_fail (GTK_IS_IMAGE (image));

1344
  gtk_image_get_image (image, val, mask);
Elliot Lee's avatar
Elliot Lee committed
1345 1346
}

Havoc Pennington's avatar
Havoc Pennington committed
1347
static void
1348
gtk_image_reset_anim_iter (GtkImage *image)
Havoc Pennington's avatar
Havoc Pennington committed
1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
{
  if (image->storage_type == GTK_IMAGE_ANIMATION)
    {
      /* Reset the animation */
      
      if (image->data.anim.frame_timeout)
        {
          g_source_remove (image->data.anim.frame_timeout);
          image->data.anim.frame_timeout = 0;
        }

      if (image->data.anim.iter)
        {
Manish Singh's avatar
Manish Singh committed
1362
          g_object_unref (image->data.anim.iter);
Havoc Pennington's avatar
Havoc Pennington committed
1363 1364 1365
          image->data.anim.iter = NULL;
        }
    }
1366 1367 1368 1369 1370 1371
}

static void
gtk_image_unmap (GtkWidget *widget)
{
  gtk_image_reset_anim_iter (GTK_IMAGE (widget));
Havoc Pennington's avatar
Havoc Pennington committed
1372 1373 1374 1375 1376

  if (GTK_WIDGET_CLASS (parent_class)->unmap)
    GTK_WIDGET_CLASS (parent_class)->unmap (widget);
}

1377 1378 1379 1380 1381 1382 1383 1384 1385
static void
gtk_image_unrealize (GtkWidget *widget)
{
  gtk_image_reset_anim_iter (GTK_IMAGE (widget));

  if (GTK_WIDGET_CLASS (parent_class)->unrealize)
    GTK_WIDGET_CLASS (parent_class)->unrealize (widget);
}

Mark McLoughlin's avatar
Mark McLoughlin committed
1386
static gint
Havoc Pennington's avatar
Havoc Pennington committed
1387 1388 1389 1390
animation_timeout (gpointer data)
{
  GtkImage *image;

1391 1392
  GDK_THREADS_ENTER ();

Havoc Pennington's avatar
Havoc Pennington committed
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403
  image = GTK_IMAGE (data);
  
  image->data.anim.frame_timeout = 0;

  gdk_pixbuf_animation_iter_advance (image->data.anim.iter, NULL);

  if (gdk_pixbuf_animation_iter_get_delay_time (image->data.anim.iter) >= 0)
    image->data.anim.frame_timeout =
      g_timeout_add (gdk_pixbuf_animation_iter_get_delay_time (image->data.anim.iter),
                     animation_timeout,
                     image);
1404

Havoc Pennington's avatar
Havoc Pennington committed
1405 1406
  gtk_widget_queue_draw (GTK_WIDGET (image));

1407 1408 1409
  if (GTK_WIDGET_DRAWABLE (image))
    gdk_window_process_updates (GTK_WIDGET (image)->window, TRUE);

1410 1411
  GDK_THREADS_LEAVE ();

Havoc Pennington's avatar
Havoc Pennington committed
1412 1413
  return FALSE;
}
Elliot Lee's avatar
Elliot Lee committed
1414

1415
static void
1416
icon_theme_changed (GtkImage *image)
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505
{
  if (image->data.name.pixbuf)
    g_object_unref (image->data.name.pixbuf);
  image->data.name.pixbuf = NULL;

  gtk_widget_queue_draw (GTK_WIDGET (image));
}

static void
ensure_pixbuf_for_icon_name (GtkImage *image)
{
  GtkImagePrivate *priv;
  GdkScreen *screen;
  GtkIconTheme *icon_theme;
  GtkSettings *settings;
  gint width, height;
  gint *sizes, *s, dist;
  GError *error = NULL;

  g_return_if_fail (image->storage_type == GTK_IMAGE_ICON_NAME);

  priv = GTK_IMAGE_GET_PRIVATE (image);
  screen = gtk_widget_get_screen (GTK_WIDGET (image));
  icon_theme = gtk_icon_theme_get_for_screen (screen);
  settings = gtk_settings_get_for_screen (screen);
  if (image->data.name.pixbuf == NULL)
    {
      if (priv->pixel_size != -1)
	{
	  width = height = priv->pixel_size;
	}
      else if (!gtk_icon_size_lookup_for_settings (settings,
						   image->icon_size,
						   &width, &height))
	{
	  if (image->icon_size == -1)
	    {
	      /* Find an available size close to 48 */
	      sizes = gtk_icon_theme_get_icon_sizes (icon_theme, image->data.name.icon_name);
	      dist = 100;
	      width = height = 48;
	      for (s = sizes; *s; s++)
		{
		  if (*s == -1)
		    {
		      width = height = 48;
		      break;
		    }
		  if (*s < 48)
		    {
		      if (48 - *s < dist)
			{
			  width = height = *s;
			  dist = 48 - *s;
			}
		    }
		  else
		    {
		      if (*s - 48 < dist)
			{
			  width = height = *s;
			  dist = *s - 48;
			}
		    }
		}
	      g_free (sizes);
	    }
	  else
	    {
	      g_warning ("Invalid icon size %d\n", image->icon_size);
	      width = height = 24;
	    }
	}
      image->data.name.pixbuf =
	gtk_icon_theme_load_icon (icon_theme,
				  image->data.name.icon_name,
				  MIN (width, height), 0, &error);
      if (image->data.name.pixbuf == NULL)
	{
	  g_error_free (error);
	  image->data.name.pixbuf =
	    gtk_widget_render_icon (GTK_WIDGET (image),
				    GTK_STOCK_MISSING_IMAGE,
				    image->icon_size,
				    NULL);
	}
    }
}

1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543
/*
 * Like gdk_rectangle_intersect (dest, src, dest), but make 
 * sure that the origin of dest is moved by an "even" offset. 
 * If necessary grow the intersection by one row or column 
 * to achieve this.
 *
 * This is necessary since we can't pass alignment information
 * for the pixelation pattern down to gdk_pixbuf_saturate_and_pixelate(), 
 * thus we have to makesure that the subimages are properly aligned.
 */
static gboolean
rectangle_intersect_even (GdkRectangle *src, 
			  GdkRectangle *dest)
{
  gboolean isect;
  gint x, y;

  x = dest->x;
  y = dest->y;
  isect = gdk_rectangle_intersect (dest, src, dest);

  if ((dest->x - x + dest->y - y) % 2 != 0)
    {
      if (dest->x > x)
	{
	  dest->x--;
	  dest->width++;
	}
      else
	{
	  dest->y--;
	  dest->height++;
	}
    }
  
  return isect;
}

Elliot Lee's avatar
Elliot Lee committed
1544 1545 1546 1547 1548 1549
static gint
gtk_image_expose (GtkWidget      *widget,
		  GdkEventExpose *event)
{
  g_return_val_if_fail (GTK_IS_IMAGE (widget), FALSE);
  g_return_val_if_fail (event != NULL, FALSE);
1550
  
1551
  if (GTK_WIDGET_MAPPED (widget) &&
1552
      GTK_IMAGE (widget)->storage_type != GTK_IMAGE_EMPTY)
Elliot Lee's avatar
Elliot Lee committed
1553
    {
1554 1555
      GtkImage *image;
      GtkMisc *misc;
1556
      GdkRectangle area, image_bound;
1557
      gfloat xalign;
1558
      gint x, y, mask_x, mask_y;
1559 1560 1561
      GdkBitmap *mask;
      GdkPixbuf *pixbuf;
      gboolean needs_state_transform;
1562

Elliot Lee's avatar
Elliot Lee committed
1563 1564 1565
      image = GTK_IMAGE (widget);
      misc = GTK_MISC (widget);

1566
      area = event->area;
1567 1568 1569 1570 1571 1572 1573 1574

      /* For stock items and icon sets, we lazily calculate
       * the size; we might get here between a queue_resize()
       * and size_request() if something explicitely forces
       * a redraw.
       */
      if (widget->requisition.width == 0 && widget->requisition.height == 0)
	gtk_image_calc_size (image);
1575 1576 1577 1578
      
      if (!gdk_rectangle_intersect (&area, &widget->allocation, &area))
	return FALSE;

1579 1580 1581 1582 1583 1584
      if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
	xalign = misc->xalign;
      else
	xalign = 1.0 - misc->xalign;
  
      x = floor (widget->allocation.x + misc->xpad
1585
		 + ((widget->allocation.width - widget->requisition.width) * xalign));
1586
      y = floor (widget->allocation.y + misc->ypad 
1587
		 + ((widget->allocation.height - widget->requisition.height) * misc->yalign));
1588 1589
      mask_x = x;
      mask_y = y;
1590
      
1591 1592
      image_bound.x = x;
      image_bound.y = y;      
1593 1594
      image_bound.width = 0;
      image_bound.height = 0;      
1595

1596 1597 1598 1599
      mask = NULL;
      pixbuf = NULL;
      needs_state_transform = GTK_WIDGET_STATE (widget) != GTK_STATE_NORMAL;
      
1600 1601 1602
      switch (image->storage_type)
        {
        case GTK_IMAGE_PIXMAP:
Havoc Pennington's avatar
Havoc Pennington committed
1603
          mask = image->mask;
1604 1605 1606
          gdk_drawable_get_size (image->data.pixmap.pixmap,
                                 &image_bound.width,
                                 &image_bound.height);
1607
	  if (rectangle_intersect_even (&area, &image_bound) &&
1608 1609 1610 1611 1612
	      needs_state_transform)
            {
              pixbuf = gdk_pixbuf_get_from_drawable (NULL,
                                                     image->data.pixmap.pixmap,
                                                     gtk_widget_get_colormap (widget),
1613
                                                     image_bound.x - x, image_bound.y - y,
1614 1615 1616 1617 1618 1619 1620 1621
						     0, 0,
                                                     image_bound.width,
                                                     image_bound.height);

	      x = image_bound.x;
	      y = image_bound.y;
            }
	  
1622 1623 1624
          break;

        case GTK_IMAGE_IMAGE:
Havoc Pennington's avatar
Havoc Pennington committed
1625
          mask = image->mask;
1626 1627
          image_bound.width = image->data.image.image->width;
          image_bound.height = image->data.image.image->height;
1628

1629
	  if (rectangle_intersect_even (&area, &image_bound) &&
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642
	      needs_state_transform)
            {
              pixbuf = gdk_pixbuf_get_from_image (NULL,
                                                  image->data.image.image,
                                                  gtk_widget_get_colormap (widget),
						  image_bound.x - x, image_bound.y - y,
                                                  0, 0,
                                                  image_bound.width,
                                                  image_bound.height);

	      x = image_bound.x;
	      y = image_bound.y;
            }
1643 1644 1645 1646
          break;

        case GTK_IMAGE_PIXBUF:
          image_bound.width = gdk_pixbuf_get_width (image->data.pixbuf.pixbuf);
1647
          image_bound.height = gdk_pixbuf_get_height (image->data.pixbuf.pixbuf);            
1648

1649
	  if (rectangle_intersect_even (&area, &image_bound) &&
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661
	      needs_state_transform)
	    {
	      pixbuf = gdk_pixbuf_new_subpixbuf (image->data.pixbuf.pixbuf,
						 image_bound.x - x, image_bound.y - y,
						 image_bound.width, image_bound.height);

	      x = image_bound.x;
	      y = image_bound.y;
	    }
	  else
	    {
	      pixbuf = image->data.pixbuf.pixbuf;
Manish Singh's avatar
Manish Singh committed
1662
	      g_object_ref (pixbuf);
1663
	    }
1664 1665 1666
          break;

        case GTK_IMAGE_STOCK:
1667
          pixbuf = gtk_widget_render_icon (widget,
Matthias Clasen's avatar
Matthias Clasen committed
1668
                                           image->data.stock.stock_id,
1669 1670 1671
                                           image->icon_size,
                                           NULL);
          if (pixbuf)
1672
            {              
1673 1674
              image_bound.width = gdk_pixbuf_get_width (pixbuf);
              image_bound.height = gdk_pixbuf_get_height (pixbuf);