<refentry id="GtkPixmap">
<refmeta>
<refentrytitle>GtkPixmap</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GtkPixmap</refname><refpurpose>a widget displaying a graphical image or icon.</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>
<synopsis>

#include &lt;gtk/gtk.h&gt;


struct      <link linkend="GtkPixmap-struct">GtkPixmap</link>;
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gtk-pixmap-new">gtk_pixmap_new</link>                  (<link linkend="GdkPixmap">GdkPixmap</link> *pixmap,
                                             <link linkend="GdkBitmap">GdkBitmap</link> *mask);
void        <link linkend="gtk-pixmap-set">gtk_pixmap_set</link>                  (<link linkend="GtkPixmap">GtkPixmap</link> *pixmap,
                                             <link linkend="GdkPixmap">GdkPixmap</link> *val,
                                             <link linkend="GdkBitmap">GdkBitmap</link> *mask);
void        <link linkend="gtk-pixmap-get">gtk_pixmap_get</link>                  (<link linkend="GtkPixmap">GtkPixmap</link> *pixmap,
                                             <link linkend="GdkPixmap">GdkPixmap</link> **val,
                                             <link linkend="GdkBitmap">GdkBitmap</link> **mask);
void        <link linkend="gtk-pixmap-set-build-insensitive">gtk_pixmap_set_build_insensitive</link>
                                            (<link linkend="GtkPixmap">GtkPixmap</link> *pixmap,
                                             <link linkend="gboolean">gboolean</link> build);


</synopsis>
</refsynopsisdiv>

<refsect1>
<title>Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----<link linkend="GtkObject">GtkObject</link>
         +----<link linkend="GtkWidget">GtkWidget</link>
               +----<link linkend="GtkMisc">GtkMisc</link>
                     +----GtkPixmap
</synopsis>

</refsect1>




<refsect1>
<title>Description</title>
<para>
The <link linkend="GtkPixmap">GtkPixmap</link> widget displays a graphical image or icon.
The icon is typically created using <link linkend="gdk-pixmap-colormap-create-from-xpm">gdk_pixmap_colormap_create_from_xpm</link>()
or <link linkend="gdk-pixmap-colormap-create-from-xpm-d">gdk_pixmap_colormap_create_from_xpm_d</link>().
</para>
<para>
The pixels in a <link linkend="GtkPixmap">GtkPixmap</link> cannot be manipulated by the application after
creation, since under the X Window system the pixel data is stored on the
X server and so is not available to the client application.
If you want to create graphical images which can be manipulated by the
application, look at <link linkend="GtkImage">GtkImage</link> and <link linkend="GdkRGB">GdkRGB</link>.
</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GtkPixmap-struct">struct GtkPixmap</title>
<programlisting>struct GtkPixmap;</programlisting>
<warning>
<para>
<literal>GtkPixmap</literal> is deprecated and should not be used in newly-written code.
</para>
</warning>
<para>
The <link linkend="GtkPixmap-struct">GtkPixmap</link> struct contains private data only, and
should be accessed using the functions below.
</para></refsect2>
<refsect2>
<title><anchor id="gtk-pixmap-new">gtk_pixmap_new ()</title>
<programlisting><link linkend="GtkWidget">GtkWidget</link>*  gtk_pixmap_new                  (<link linkend="GdkPixmap">GdkPixmap</link> *pixmap,
                                             <link linkend="GdkBitmap">GdkBitmap</link> *mask);</programlisting>
<warning>
<para>
<literal>gtk_pixmap_new</literal> is deprecated and should not be used in newly-written code.
</para>
</warning>
<para>
Creates a new <link linkend="GtkPixmap">GtkPixmap</link>, using the given GDK pixmap and mask.
</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>pixmap</parameter>&nbsp;:</entry>
<entry>a <link linkend="GDKPixmap">GDKPixmap</link>.
</entry></row>
<row><entry align="right"><parameter>mask</parameter>&nbsp;:</entry>
<entry>a <link linkend="GDKBitmap">GDKBitmap</link> which indicates which parts of the <parameter>pixmap</parameter> should be
transparent.
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>a new <link linkend="GtkPixmap">GtkPixmap</link>.


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-pixmap-set">gtk_pixmap_set ()</title>
<programlisting>void        gtk_pixmap_set                  (<link linkend="GtkPixmap">GtkPixmap</link> *pixmap,
                                             <link linkend="GdkPixmap">GdkPixmap</link> *val,
                                             <link linkend="GdkBitmap">GdkBitmap</link> *mask);</programlisting>
<warning>
<para>
<literal>gtk_pixmap_set</literal> is deprecated and should not be used in newly-written code.
</para>
</warning>
<para>
Sets the <link linkend="GdkPixmap">GdkPixmap</link> and <link linkend="GdkBitmap">GdkBitmap</link> mask.
</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>pixmap</parameter>&nbsp;:</entry>
<entry>a <link linkend="GtkPixmap">GtkPixmap</link>.
</entry></row>
<row><entry align="right"><parameter>val</parameter>&nbsp;:</entry>
<entry>a <link linkend="GdkPixmap">GdkPixmap</link>.
</entry></row>
<row><entry align="right"><parameter>mask</parameter>&nbsp;:</entry>
<entry>a <link linkend="GdkBitmap">GdkBitmap</link>, which indicates which parts of the <parameter>pixmap</parameter> should be
transparent. This can be NULL, in which case none of the <parameter>pixmap</parameter> is
transparent.


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-pixmap-get">gtk_pixmap_get ()</title>
<programlisting>void        gtk_pixmap_get                  (<link linkend="GtkPixmap">GtkPixmap</link> *pixmap,
                                             <link linkend="GdkPixmap">GdkPixmap</link> **val,
                                             <link linkend="GdkBitmap">GdkBitmap</link> **mask);</programlisting>
<warning>
<para>
<literal>gtk_pixmap_get</literal> is deprecated and should not be used in newly-written code.
</para>
</warning>
<para>
Gets the current <link linkend="GdkPixmap">GdkPixmap</link> and <link linkend="GdkBitmap">GdkBitmap</link> mask.
</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>pixmap</parameter>&nbsp;:</entry>
<entry>a <link linkend="GtkPixmap">GtkPixmap</link>.
</entry></row>
<row><entry align="right"><parameter>val</parameter>&nbsp;:</entry>
<entry>returns the current <link linkend="GdkPixmap">GdkPixmap</link>.
</entry></row>
<row><entry align="right"><parameter>mask</parameter>&nbsp;:</entry>
<entry>returns the current <link linkend="GdkBitmap">GdkBitmap</link> mask.


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gtk-pixmap-set-build-insensitive">gtk_pixmap_set_build_insensitive ()</title>
<programlisting>void        gtk_pixmap_set_build_insensitive
                                            (<link linkend="GtkPixmap">GtkPixmap</link> *pixmap,
                                             <link linkend="gboolean">gboolean</link> build);</programlisting>
<warning>
<para>
<literal>gtk_pixmap_set_build_insensitive</literal> is deprecated and should not be used in newly-written code.
</para>
</warning>
<para>
Sets wether an extra pixmap should be automatically created and used
when the pixmap is insensitive. The default value is <literal>TRUE</literal>.
</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>pixmap</parameter>&nbsp;:</entry>
<entry>a <link linkend="GtkPixmap">GtkPixmap</link>.
</entry></row>
<row><entry align="right"><parameter>build</parameter>&nbsp;:</entry>
<entry>set to <literal>TRUE</literal> if an extra pixmap should be automatically created to use
when the pixmap is insensitive.


</entry></row>
</tbody></tgroup></informaltable></refsect2>

</refsect1>




</refentry>
