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

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

Havoc Pennington's avatar
Havoc Pennington committed
72 73 74 75 76 77 78 79 80
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);

81 82
static void icon_theme_changed          (GtkImage         *image);

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

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

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

Havoc Pennington's avatar
Havoc Pennington committed
110 111 112 113 114 115
  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);
116
  
117 118
  object_class->destroy = gtk_image_destroy;

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

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

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

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

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

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

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

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

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

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

  priv->pixel_size = -1;
276 277

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

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

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

Havoc Pennington's avatar
Havoc Pennington committed
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
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
332
            g_object_ref (mask);
Havoc Pennington's avatar
Havoc Pennington committed
333
          
334
          gtk_image_clear (image);
Havoc Pennington's avatar
Havoc Pennington committed
335 336 337 338 339

          image->mask = mask;
        }
      break;
    case PROP_FILE:
340
      gtk_image_set_from_file (image, g_value_get_string (value));
Havoc Pennington's avatar
Havoc Pennington committed
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
      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));
359 360 361 362
      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
363 364 365 366
      else
        /* Save to be used when STOCK or ICON_SET property comes in */
        image->icon_size = g_value_get_int (value);
      break;
367
    case PROP_PIXEL_SIZE:
368
      gtk_image_set_pixel_size (image, g_value_get_int (value));
369
      break;
Havoc Pennington's avatar
Havoc Pennington committed
370 371 372 373
    case PROP_PIXBUF_ANIMATION:
      gtk_image_set_from_animation (image,
                                    g_value_get_object (value));
      break;
374 375 376
    case PROP_ICON_NAME:
      gtk_image_set_from_icon_name (image, g_value_get_string (value),
				    image->icon_size);
377
      break;
378 379 380 381
    case PROP_GICON:
      gtk_image_set_from_gicon (image, g_value_get_object (value),
				image->icon_size);
      break;
382

Havoc Pennington's avatar
Havoc Pennington committed
383 384 385 386 387 388 389 390 391 392 393 394 395
    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;
396
  GtkImagePrivate *priv;
Havoc Pennington's avatar
Havoc Pennington committed
397 398

  image = GTK_IMAGE (object);
399
  priv = GTK_IMAGE_GET_PRIVATE (image);
Havoc Pennington's avatar
Havoc Pennington committed
400 401 402 403 404 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

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

487

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

Manish Singh's avatar
Manish Singh committed
507
  image = g_object_new (GTK_TYPE_IMAGE, NULL);
508 509 510 511 512 513

  gtk_image_set_from_pixmap (image, pixmap, mask);

  return GTK_WIDGET (image);
}

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

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

535 536 537 538 539
  gtk_image_set_from_image (image, gdk_image, mask);

  return GTK_WIDGET (image);
}

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

Manish Singh's avatar
Manish Singh committed
568
  image = g_object_new (GTK_TYPE_IMAGE, NULL);
569 570 571 572 573 574

  gtk_image_set_from_file (image, filename);

  return GTK_WIDGET (image);
}

575 576 577 578 579 580 581 582 583
/**
 * 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.
 * 
584 585 586
 * 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().
587
 * 
588 589
 * Return value: a new #GtkImage
 **/
590 591 592 593 594
GtkWidget*
gtk_image_new_from_pixbuf (GdkPixbuf *pixbuf)
{
  GtkImage *image;

Manish Singh's avatar
Manish Singh committed
595
  image = g_object_new (GTK_TYPE_IMAGE, NULL);
596 597 598 599 600 601

  gtk_image_set_from_pixbuf (image, pixbuf);

  return GTK_WIDGET (image);  
}

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

Manish Singh's avatar
Manish Singh committed
622
  image = g_object_new (GTK_TYPE_IMAGE, NULL);
623 624 625 626 627 628

  gtk_image_set_from_stock (image, stock_id, size);

  return GTK_WIDGET (image);
}

629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
/**
 * 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
 **/
648 649
GtkWidget*
gtk_image_new_from_icon_set (GtkIconSet     *icon_set,
650
                             GtkIconSize     size)
651 652 653
{
  GtkImage *image;

Manish Singh's avatar
Manish Singh committed
654
  image = g_object_new (GTK_TYPE_IMAGE, NULL);
655 656

  gtk_image_set_from_icon_set (image, icon_set, size);
Elliot Lee's avatar
Elliot Lee committed
657 658 659 660

  return GTK_WIDGET (image);
}

Havoc Pennington's avatar
Havoc Pennington committed
661 662 663 664 665 666 667 668
/**
 * 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.
669 670 671 672 673 674
 *
 * 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
675 676 677 678 679 680 681 682 683
 * 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
684
  image = g_object_new (GTK_TYPE_IMAGE, NULL);
Havoc Pennington's avatar
Havoc Pennington committed
685 686 687 688 689 690

  gtk_image_set_from_animation (image, animation);

  return GTK_WIDGET (image);
}

691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
/**
 * 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);
}

718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
/**
 * 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);
}

745 746 747 748 749 750 751 752
/**
 * 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
753
void
754 755 756 757 758 759 760 761 762
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
763 764

  g_object_freeze_notify (G_OBJECT (image));
765 766
  
  if (pixmap)
Manish Singh's avatar
Manish Singh committed
767
    g_object_ref (pixmap);
768 769

  if (mask)
Manish Singh's avatar
Manish Singh committed
770
    g_object_ref (mask);
771

772
  gtk_image_clear (image);
773

Havoc Pennington's avatar
Havoc Pennington committed
774 775
  image->mask = mask;
  
776 777 778 779 780 781 782 783 784 785 786 787 788
  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
789 790 791 792 793

  g_object_notify (G_OBJECT (image), "pixmap");
  g_object_notify (G_OBJECT (image), "mask");
  
  g_object_thaw_notify (G_OBJECT (image));
794 795
}

796 797 798 799 800 801 802 803
/**
 * 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.
 **/
804 805 806 807
void
gtk_image_set_from_image  (GtkImage  *image,
                           GdkImage  *gdk_image,
                           GdkBitmap *mask)
Elliot Lee's avatar
Elliot Lee committed
808 809
{
  g_return_if_fail (GTK_IS_IMAGE (image));
810 811 812 813 814
  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
815
  g_object_freeze_notify (G_OBJECT (image));
816 817
  
  if (gdk_image)
Manish Singh's avatar
Manish Singh committed
818
    g_object_ref (gdk_image);
819 820

  if (mask)
Manish Singh's avatar
Manish Singh committed
821
    g_object_ref (mask);
Elliot Lee's avatar
Elliot Lee committed
822

823
  gtk_image_clear (image);
Elliot Lee's avatar
Elliot Lee committed
824

825
  if (gdk_image)
Elliot Lee's avatar
Elliot Lee committed
826
    {
827 828 829
      image->storage_type = GTK_IMAGE_IMAGE;

      image->data.image.image = gdk_image;
Havoc Pennington's avatar
Havoc Pennington committed
830
      image->mask = mask;
831 832

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

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

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

  g_object_freeze_notify (G_OBJECT (image));
864
  
865
  gtk_image_clear (image);
866 867

  if (filename == NULL)
Havoc Pennington's avatar
Havoc Pennington committed
868
    {
869
      priv->filename = NULL;
Havoc Pennington's avatar
Havoc Pennington committed
870 871 872
      g_object_thaw_notify (G_OBJECT (image));
      return;
    }
873

Havoc Pennington's avatar
Havoc Pennington committed
874
  anim = gdk_pixbuf_animation_new_from_file (filename, NULL);
875

Havoc Pennington's avatar
Havoc Pennington committed
876
  if (anim == NULL)
877 878 879 880
    {
      gtk_image_set_from_stock (image,
                                GTK_STOCK_MISSING_IMAGE,
                                GTK_ICON_SIZE_BUTTON);
Havoc Pennington's avatar
Havoc Pennington committed
881
      g_object_thaw_notify (G_OBJECT (image));
882 883
      return;
    }
884

Havoc Pennington's avatar
Havoc Pennington committed
885 886 887 888
  /* 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
   */
889

Havoc Pennington's avatar
Havoc Pennington committed
890
  if (gdk_pixbuf_animation_is_static_image (anim))
891 892
    gtk_image_set_from_pixbuf (image,
			       gdk_pixbuf_animation_get_static_image (anim));
Havoc Pennington's avatar
Havoc Pennington committed
893
  else
894
    gtk_image_set_from_animation (image, anim);
Havoc Pennington's avatar
Havoc Pennington committed
895

Manish Singh's avatar
Manish Singh committed
896
  g_object_unref (anim);
Havoc Pennington's avatar
Havoc Pennington committed
897

898 899
  priv->filename = g_strdup (filename);
  
Havoc Pennington's avatar
Havoc Pennington committed
900
  g_object_thaw_notify (G_OBJECT (image));
901 902
}

903 904 905 906 907 908 909
/**
 * gtk_image_set_from_pixbuf:
 * @image: a #GtkImage
 * @pixbuf: a #GdkPixbuf or %NULL
 *
 * See gtk_image_new_from_pixbuf() for details. 
 **/
910 911 912 913 914 915 916
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
917 918

  g_object_freeze_notify (G_OBJECT (image));
919 920
  
  if (pixbuf)
Manish Singh's avatar
Manish Singh committed
921
    g_object_ref (pixbuf);
922

923
  gtk_image_clear (image);
924 925 926 927 928 929 930 931 932 933 934

  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
935 936 937 938

  g_object_notify (G_OBJECT (image), "pixbuf");
  
  g_object_thaw_notify (G_OBJECT (image));
939 940
}

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

  g_object_freeze_notify (G_OBJECT (image));

  /* in case stock_id == image->data.stock.stock_id */
  new_id = g_strdup (stock_id);
962
  
963
  gtk_image_clear (image);
964

Havoc Pennington's avatar
Havoc Pennington committed
965 966
  if (new_id)
    {
967 968
      image->storage_type = GTK_IMAGE_STOCK;
      
Havoc Pennington's avatar
Havoc Pennington committed
969 970
      image->data.stock.stock_id = new_id;
      image->icon_size = size;
971 972 973 974 975 976

      /* 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
977 978

  g_object_notify (G_OBJECT (image), "stock");
979
  g_object_notify (G_OBJECT (image), "icon-size");
Havoc Pennington's avatar
Havoc Pennington committed
980 981
  
  g_object_thaw_notify (G_OBJECT (image));
982 983
}

984 985 986 987 988 989 990 991
/**
 * 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.
 **/
992 993 994
void
gtk_image_set_from_icon_set  (GtkImage       *image,
                              GtkIconSet     *icon_set,
995
                              GtkIconSize     size)
996 997 998
{
  g_return_if_fail (GTK_IS_IMAGE (image));

Havoc Pennington's avatar
Havoc Pennington committed
999 1000
  g_object_freeze_notify (G_OBJECT (image));
  
1001 1002 1003
  if (icon_set)
    gtk_icon_set_ref (icon_set);
  
1004
  gtk_image_clear (image);
1005 1006 1007 1008 1009 1010

  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
1011
      image->icon_size = size;
1012 1013 1014 1015 1016

      /* Size is demand-computed in size request method
       * if we're an icon set
       */
    }
Havoc Pennington's avatar
Havoc Pennington committed
1017
  
1018 1019
  g_object_notify (G_OBJECT (image), "icon-set");
  g_object_notify (G_OBJECT (image), "icon-size");
Havoc Pennington's avatar
Havoc Pennington committed
1020 1021
  
  g_object_thaw_notify (G_OBJECT (image));
1022 1023
}

Havoc Pennington's avatar
Havoc Pennington committed
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
/**
 * 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
1039 1040

  g_object_freeze_notify (G_OBJECT (image));
Havoc Pennington's avatar
Havoc Pennington committed
1041 1042
  
  if (animation)
Manish Singh's avatar
Manish Singh committed
1043
    g_object_ref (animation);
Havoc Pennington's avatar
Havoc Pennington committed
1044

1045
  gtk_image_clear (image);
Havoc Pennington's avatar
Havoc Pennington committed
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058

  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
1059

1060
  g_object_notify (G_OBJECT (image), "pixbuf-animation");
Havoc Pennington's avatar
Havoc Pennington committed
1061 1062
  
  g_object_thaw_notify (G_OBJECT (image));
Havoc Pennington's avatar
Havoc Pennington committed
1063 1064
}

1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
/**
 * 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));

1086
  /* in case icon_name == image->data.name.icon_name */
1087 1088
  new_name = g_strdup (icon_name);
  
1089
  gtk_image_clear (image);
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103

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

1104 1105
  g_object_notify (G_OBJECT (image), "icon-name");
  g_object_notify (G_OBJECT (image), "icon-size");
1106 1107 1108 1109
  
  g_object_thaw_notify (G_OBJECT (image));
}

1110 1111 1112 1113 1114 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
/**
 * 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));
}

1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
/**
 * 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
 **/
1164 1165 1166 1167 1168 1169 1170 1171
GtkImageType
gtk_image_get_storage_type (GtkImage *image)
{
  g_return_val_if_fail (GTK_IS_IMAGE (image), GTK_IMAGE_EMPTY);

  return image->storage_type;
}

1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
/**
 * 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.
 **/
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
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
1197
    *mask = image->mask;
1198 1199
}

1200 1201 1202
/**
 * gtk_image_get_image:
 * @image: a #GtkImage
Matthias Clasen's avatar
Matthias Clasen committed
1203 1204
 * @gdk_image: return location for a #GtkImage, or %NULL
 * @mask: return location for a #GdkBitmap, or %NULL
1205 1206 1207 1208 1209 1210 1211
 * 
 * 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.
 **/
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
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
1225
    *mask = image->mask;
1226 1227
}

1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
/**
 * 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
 **/
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
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;
}

1253 1254 1255
/**
 * gtk_image_get_stock:
 * @image: a #GtkImage
Matthias Clasen's avatar
Matthias Clasen committed
1256 1257
 * @stock_id: place to store a stock icon name, or %NULL
 * @size: place to store a stock icon size, or %NULL
1258 1259 1260 1261
 *
 * 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()).
1262
 * The returned string is owned by the #GtkImage and should not
1263 1264
 * be freed.
 **/
1265 1266 1267
void
gtk_image_get_stock  (GtkImage        *image,
                      gchar          **stock_id,
1268
                      GtkIconSize     *size)
1269 1270 1271 1272 1273 1274 1275 1276 1277
{
  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)
1278
    *stock_id = image->data.stock.stock_id;
1279 1280

  if (size)
Havoc Pennington's avatar
Havoc Pennington committed
1281
    *size = image->icon_size;
1282 1283
}

1284 1285 1286
/**
 * gtk_image_get_icon_set:
 * @image: a #GtkImage
Matthias Clasen's avatar
Matthias Clasen committed
1287 1288
 * @icon_set: location to store a #GtkIconSet, or %NULL
 * @size: location to store a stock icon size, or %NULL
1289 1290 1291 1292 1293
 *
 * 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()).
 **/
1294 1295 1296
void
gtk_image_get_icon_set  (GtkImage        *image,
                         GtkIconSet     **icon_set,
1297
                         GtkIconSize     *size)
1298 1299 1300 1301 1302 1303 1304 1305 1306
{
  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
1307
    *size = image->icon_size;
1308 1309
}

Havoc Pennington's avatar
Havoc Pennington committed
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335
/**
 * 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;
}

1336 1337 1338
/**
 * gtk_image_get_icon_name:
 * @image: a #GtkImage
Matthias Clasen's avatar
Matthias Clasen committed
1339 1340
 * @icon_name: place to store an icon name, or %NULL
 * @size: place to store an icon size, or %NULL
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350
 *
 * 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
1351 1352 1353
gtk_image_get_icon_name  (GtkImage              *image,
			  G_CONST_RETURN gchar **icon_name,
			  GtkIconSize           *size)
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
{
  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;
}

1369 1370 1371
/**
 * gtk_image_get_gicon:
 * @image: a #GtkImage
Matthias Clasen's avatar
Matthias Clasen committed
1372 1373
 * @gicon: place to store a #GIcon, or %NULL
 * @size: place to store an icon size, or %NULL
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
 *
 * Gets the #GIcon and size being displayed by the #GtkImage.
 * The storage type of the image must be %GTK_IMAGE_EMPTY or
 * %GTK_IMAGE_GICON (see gtk_image_get_storage_type()).
 * The caller of this function does not own a reference to the
 * returned #GIcon.
 * 
 * Since: 2.14
 **/
void
gtk_image_get_gicon (GtkImage     *image,
		     GIcon       **gicon,
		     GtkIconSize  *size)
{
  g_return_if_fail (GTK_IS_IMAGE (image));
  g_return_if_fail (image->storage_type == GTK_IMAGE_GICON ||
                    image->storage_type == GTK_IMAGE_EMPTY);

  if (image->storage_type == GTK_IMAGE_EMPTY)
    image->data.gicon.icon = NULL;
  
  if (gicon)
    *gicon = image->data.gicon.icon;

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

1402 1403 1404 1405 1406 1407 1408
/**
 * gtk_image_new:
 * 
 * Creates a new empty #GtkImage widget.
 * 
 * Return value: a newly created #GtkImage widget. 
 **/
1409
GtkWidget*
1410
gtk_image_new (void)
1411
{
1412
  return g_object_new (GTK_TYPE_IMAGE, NULL);
1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
}

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
1423 1424 1425 1426 1427 1428 1429 1430 1431
}

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

1432
  gtk_image_get_image (image, val, mask);
Elliot Lee's avatar
Elliot Lee committed
1433 1434
}

Havoc Pennington's avatar
Havoc Pennington committed
1435
static void
1436
gtk_image_reset_anim_iter (GtkImage *image)
Havoc Pennington's avatar
Havoc Pennington committed
1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449
{
  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
1450
          g_object_unref (image->data.anim.iter);
Havoc Pennington's avatar
Havoc Pennington committed
1451 1452 1453
          image->data.anim.iter = NULL;
        }
    }
1454 1455 1456 1457 1458 1459
}

static void
gtk_image_unmap (GtkWidget *widget)
{
  gtk_image_reset_anim_iter (GTK_IMAGE (widget));
Havoc Pennington's avatar
Havoc Pennington committed
1460

1461
  GTK_WIDGET_CLASS (gtk_image_parent_class)->unmap (widget);
Havoc Pennington's avatar
Havoc Pennington committed
1462 1463
}

1464 1465 1466 1467 1468
static void
gtk_image_unrealize (GtkWidget *widget)
{
  gtk_image_reset_anim_iter (GTK_IMAGE (widget));

1469
  GTK_WIDGET_CLASS (gtk_image_parent_class)->unrealize (widget);
1470 1471
}

Mark McLoughlin's avatar
Mark McLoughlin committed
1472
static gint
Havoc Pennington's avatar
Havoc Pennington committed
1473 1474 1475
animation_timeout (gpointer data)
{
  GtkImage *image;
1476
  int delay;
Havoc Pennington's avatar
Havoc Pennington committed
1477 1478 1479 1480 1481 1482 1483

  image = GTK_IMAGE (data);
  
  image->data.anim.frame_timeout = 0;

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

1484 1485 1486 1487 1488
  delay = gdk_pixbuf_animation_iter_get_delay_time (image->data.anim.iter);
  if (delay >= 0)
    {
      image->data.anim.frame_timeout =
        gdk_threads_add_timeout (delay, animation_timeout, image);
1489

1490
      gtk_widget_queue_draw (GTK_WIDGET (image));
Havoc Pennington's avatar
Havoc Pennington committed
1491

1492 1493 1494
      if (GTK_WIDGET_DRAWABLE (image))
        gdk_window_process_updates (GTK_WIDGET (image)->window, TRUE);
    }
1495

Havoc Pennington's avatar
Havoc Pennington committed
1496 1497
  return FALSE;
}
Elliot Lee's avatar
Elliot Lee committed
1498

1499
static void
1500
icon_theme_changed (GtkImage *image)
1501
{
1502 1503 1504 1505 1506
  if (image->storage_type == GTK_IMAGE_ICON_NAME) 
    {
      if (image->data.name.pixbuf)
	g_object_unref (image->data.name.pixbuf);
      image->data.name.pixbuf = NULL;
1507

1508 1509 1510 1511 1512 1513 1514 1515
      gtk_widget_queue_draw (GTK_WIDGET (image));
    }
  if (image->storage_type == GTK_IMAGE_GICON) 
    {
      if (image->data.gicon.pixbuf)
	g_object_unref (image->data.gicon.pixbuf);
      image->data.gicon.pixbuf = NULL;

1516 1517
      gtk_widget_queue_draw (GTK_WIDGET (image));
    }
1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
}

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;
1529
  GtkIconLookupFlags flags;
1530 1531 1532 1533 1534 1535 1536 1537
  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);
1538
  flags = GTK_ICON_LOOKUP_USE_BUILTIN;
1539 1540 1541 1542 1543
  if (image->data.name.pixbuf == NULL)
    {
      if (priv->pixel_size != -1)
	{
	  width = height = priv->pixel_size;
1544
          flags |= GTK_ICON_LOOKUP_FORCE_SIZE;
1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590
	}
      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,
1591
				  MIN (width, height), flags, &error);
1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
      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);
	}
    }
}

1604 1605 1606 1607 1608 1609 1610 1611 1612
static void
ensure_pixbuf_for_gicon (GtkImage *image)
{
  GtkImagePrivate *priv;
  GdkScreen *screen;
  GtkIconTheme *icon_theme;
  GtkSettings *settings;
  gint width, height;
  GtkIconInfo *info;
1613
  GtkIconLookupFlags flags;
1614 1615 1616 1617 1618 1619 1620

  g_return_if_fail (image->storage_type == GTK_IMAGE_GICON);

  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);
1621
  flags = GTK_ICON_LOOKUP_USE_BUILTIN;
1622 1623 1624 1625 1626
  if (image->data.gicon.pixbuf == NULL)
    {
      if (priv->pixel_size != -1)
	{
	  width = height = priv->pixel_size;
1627
          flags |= GTK_ICON_LOOKUP_FORCE_SIZE;
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643
	}
      else if (!gtk_icon_size_lookup_for_settings (settings,
						   image->icon_size,
						   &width, &height))
	{
	  if (image->icon_size == -1)
	    width = height = 48;
	  else
	    {
	      g_warning ("Invalid icon size %d\n", image->icon_size);
	      width = height = 24;
	    }
	}

      info = gtk_icon_theme_lookup_by_gicon (icon_theme,
					     image->data.gicon.icon,
1644
					     MIN (width, height), flags);
1645 1646 1647 1648 1649 1650
      if (info)
        {
          image->data.gicon.pixbuf = gtk_icon_info_load_icon (info, NULL);
          gtk_icon_info_free (info);
        }

1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662
      if (image->data.gicon.pixbuf == NULL)
	{
	  image->data.gicon.pixbuf =
	    gtk_widget_render_icon (GTK_WIDGET (image),
				    GTK_STOCK_MISSING_IMAGE,
				    image->icon_size,
				    NULL);
	}
    }
}


1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700
/*
 * 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
1701 1702 1703 1704 1705 1706
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);
1707
  
<