## GnomePixmap

GnomePixmap

## Synopsis

    #include <libgnomeui/libgnomeui.h>

                        GnomePixmapPrivate;
                        GnomePixmap;
    GtkWidget *         gnome_pixmap_new_from_file          (const gchar *filename);
    GtkWidget *         gnome_pixmap_new_from_file_at_size  (const gchar *filename,
                                                             gint width,
                                                             gint height);
    GtkWidget *         gnome_pixmap_new_from_xpm_d         (const gchar **xpm_data);
    GtkWidget *         gnome_pixmap_new_from_xpm_d_at_size (const gchar **xpm_data,
                                                             gint width,
                                                             gint height);
    GtkWidget *         gnome_pixmap_new_from_gnome_pixmap  (GnomePixmap *gpixmap);
    void                gnome_pixmap_load_file              (GnomePixmap *gpixmap,
                                                             const char *filename);
    void                gnome_pixmap_load_file_at_size      (GnomePixmap *gpixmap,
                                                             const char *filename,
                                                             int width,
                                                             int height);
    void                gnome_pixmap_load_xpm_d             (GnomePixmap *gpixmap,
                                                             const char **xpm_data);
    void                gnome_pixmap_load_xpm_d_at_size     (GnomePixmap *gpixmap,
                                                             const char **xpm_data,
                                                             int width,
                                                             int height);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkMisc
                               +----GtkImage
                                     +----GnomePixmap

## Implemented Interfaces

GnomePixmap implements AtkImplementorIface and GtkBuildable.

## Description

## Details

### GnomePixmapPrivate

    typedef struct _GnomePixmapPrivate GnomePixmapPrivate;

### Warning

`GnomePixmapPrivate` is deprecated and should not be used in newly-written code.

### GnomePixmap

    typedef struct _GnomePixmap GnomePixmap;

### Warning

`GnomePixmap` is deprecated and should not be used in newly-written code.

### gnome_pixmap_new_from_file ()

    GtkWidget *         gnome_pixmap_new_from_file          (const gchar *filename);

### Warning

`gnome_pixmap_new_from_file` is deprecated and should not be used in newly-written code.

Note that the new_from_file functions give you no way to detect errors; if the file isn't found/loaded, you get an empty widget. to detect errors just do:

<programlisting> pixbuf = gdk_pixbuf_new_from_file (filename); if (pixbuf != NULL) { gpixmap = gtk_image_new_from_pixbuf (pixbuf); } else { // handle your error... } </programlisting>

`filename` : | The filename of the file to be loaded.
Returns : | A newly allocated `GnomePixmap` with the file at `filename` loaded.

### gnome_pixmap_new_from_file_at_size ()

    GtkWidget *         gnome_pixmap_new_from_file_at_size  (const gchar *filename,
                                                             gint width,
                                                             gint height);

### Warning

`gnome_pixmap_new_from_file_at_size` is deprecated and should not be used in newly-written code.

Loads a new `GnomePixmap` from a file, and scales it (if necessary) to the size indicated by `height` and `width`. If either are set to -1, then the "natural" dimension of the image is used in place. See `gnome_pixmap_new_from_file` for information on error handling.

`filename` : | The filename of the file to be loaded.
`width` : | The width to scale the image to.
`height` : | The height to scale the image to.
Returns : | value: A newly allocated `GnomePixmap` with the file at `filename` loaded.

### gnome_pixmap_new_from_xpm_d ()

    GtkWidget *         gnome_pixmap_new_from_xpm_d         (const gchar **xpm_data);

### Warning

`gnome_pixmap_new_from_xpm_d` is deprecated and should not be used in newly-written code.

Loads a new `GnomePixmap` from the `xpm_data`, and scales it (if necessary) to the size indicated by `height` and `width`. If either are set to -1, then the "natural" dimension of the image is used in place.

`xpm_data` : | The xpm data to be loaded.
Returns : | value: A newly allocated `GnomePixmap` with the image from `xpm_data` loaded.

### gnome_pixmap_new_from_xpm_d_at_size ()

    GtkWidget *         gnome_pixmap_new_from_xpm_d_at_size (const gchar **xpm_data,
                                                             gint width,
                                                             gint height);

### Warning

`gnome_pixmap_new_from_xpm_d_at_size` is deprecated and should not be used in newly-written code.

Loads a new `GnomePixmap` from the `xpm_data`, and scales it (if necessary) to the size indicated by `height` and `width`. If either are set to -1, then the "natural" dimension of the image is used in place.

`xpm_data` : | The xpm data to be loaded.
`width` : | The width to scale the image to.
`height` : | The height to scale the image to.
Returns : | value: A newly allocated `GnomePixmap` with the image from `xpm_data` loaded.

### gnome_pixmap_new_from_gnome_pixmap ()

    GtkWidget *         gnome_pixmap_new_from_gnome_pixmap  (GnomePixmap *gpixmap);

### Warning

`gnome_pixmap_new_from_gnome_pixmap` is deprecated and should not be used in newly-written code.

`gpixmap` : |
Returns : |

### gnome_pixmap_load_file ()

    void                gnome_pixmap_load_file              (GnomePixmap *gpixmap,
                                                             const char *filename);

### Warning

`gnome_pixmap_load_file` is deprecated and should not be used in newly-written code.

`gpixmap` : |
`filename` : |

### gnome_pixmap_load_file_at_size ()

    void                gnome_pixmap_load_file_at_size      (GnomePixmap *gpixmap,
                                                             const char *filename,
                                                             int width,
                                                             int height);

### Warning

`gnome_pixmap_load_file_at_size` is deprecated and should not be used in newly-written code.

`gpixmap` : |
`filename` : |
`width` : |
`height` : |

### gnome_pixmap_load_xpm_d ()

    void                gnome_pixmap_load_xpm_d             (GnomePixmap *gpixmap,
                                                             const char **xpm_data);

### Warning

`gnome_pixmap_load_xpm_d` is deprecated and should not be used in newly-written code.

`gpixmap` : |
`xpm_data` : |

### gnome_pixmap_load_xpm_d_at_size ()

    void                gnome_pixmap_load_xpm_d_at_size     (GnomePixmap *gpixmap,
                                                             const char **xpm_data,
                                                             int width,
                                                             int height);

### Warning

`gnome_pixmap_load_xpm_d_at_size` is deprecated and should not be used in newly-written code.

`gpixmap` : |
`xpm_data` : |
`width` : |
`height` : |