<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<!--ENTITY index-Objects-Grouped SYSTEM "objects_grouped.sgml"-->
<refentry id="GtkPixmap">
<refmeta>
<refentrytitle role="top_of_page" id="GtkPixmap.top_of_page">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 id="GtkPixmap.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>

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

                    <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);
<link linkend="void">void</link>                <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);
<link linkend="void">void</link>                <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);
<link linkend="void">void</link>                <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 id="GtkPixmap.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkMisc">GtkMisc</link>
                           +----GtkPixmap
</synopsis>
</refsect1>



<refsect1 id="GtkPixmap.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GtkPixmap implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>





<refsect1 id="GtkPixmap.description" role="desc">
<title role="desc.title">Description</title>
<para>
The <link linkend="GtkPixmap"><type>GtkPixmap</type></link> widget displays a graphical image or icon.
The icon is typically created using <link linkend="gdk-pixmap-colormap-create-from-xpm"><function>gdk_pixmap_colormap_create_from_xpm()</function></link>
or <link linkend="gdk-pixmap-colormap-create-from-xpm-d"><function>gdk_pixmap_colormap_create_from_xpm_d()</function></link>.
</para>
<para>
The pixels in a <link linkend="GtkPixmap"><type>GtkPixmap</type></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"><type>GtkImage</type></link> and <link linkend="GdkRGB"><type>GdkRGB</type></link>.
</para>
<para>
GtkPixmap has been deprecated since GTK+ 2.0 and should not be used
in newly written code. Use <link linkend="GtkImage"><type>GtkImage</type></link> instead.
</para>
</refsect1>

<refsect1 id="GtkPixmap.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GtkPixmap-struct" role="struct">
<title>GtkPixmap</title>
<indexterm zone="GtkPixmap-struct" role="deprecated"><primary sortas="Pixmap">GtkPixmap</primary></indexterm><programlisting>typedef struct _GtkPixmap 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"><type>GtkPixmap</type></link> struct contains private data only, and
should be accessed using the functions below.
</para></refsect2>
<refsect2 id="gtk-pixmap-new" role="function" condition="deprecated:">
<title>gtk_pixmap_new ()</title>
<indexterm zone="gtk-pixmap-new" role="deprecated"><primary sortas="pixmap_new">gtk_pixmap_new</primary></indexterm><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"><type>GtkPixmap</type></link>, using the given GDK pixmap and mask.
</para><variablelist role="params">
<varlistentry><term><parameter>pixmap</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="GDKPixmap"><type>GDKPixmap</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="GDKBitmap"><type>GDKBitmap</type></link> which indicates which parts of the <parameter>pixmap</parameter> should be
transparent.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>a new <link linkend="GtkPixmap"><type>GtkPixmap</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-pixmap-set" role="function" condition="deprecated:">
<title>gtk_pixmap_set ()</title>
<indexterm zone="gtk-pixmap-set" role="deprecated"><primary sortas="pixmap_set">gtk_pixmap_set</primary></indexterm><programlisting><link linkend="void">void</link>                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"><type>GdkPixmap</type></link> and <link linkend="GdkBitmap"><type>GdkBitmap</type></link> mask.
</para><variablelist role="params">
<varlistentry><term><parameter>pixmap</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="GtkPixmap"><type>GtkPixmap</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="GdkPixmap"><type>GdkPixmap</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="GdkBitmap"><type>GdkBitmap</type></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.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-pixmap-get" role="function" condition="deprecated:">
<title>gtk_pixmap_get ()</title>
<indexterm zone="gtk-pixmap-get" role="deprecated"><primary sortas="pixmap_get">gtk_pixmap_get</primary></indexterm><programlisting><link linkend="void">void</link>                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"><type>GdkPixmap</type></link> and <link linkend="GdkBitmap"><type>GdkBitmap</type></link> mask.
</para><variablelist role="params">
<varlistentry><term><parameter>pixmap</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="GtkPixmap"><type>GtkPixmap</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val</parameter>&#160;:</term>
<listitem><simpara>returns the current <link linkend="GdkPixmap"><type>GdkPixmap</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask</parameter>&#160;:</term>
<listitem><simpara>returns the current <link linkend="GdkBitmap"><type>GdkBitmap</type></link> mask.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-pixmap-set-build-insensitive" role="function" condition="deprecated:">
<title>gtk_pixmap_set_build_insensitive ()</title>
<indexterm zone="gtk-pixmap-set-build-insensitive" role="deprecated"><primary sortas="pixmap_set_build_insensitive">gtk_pixmap_set_build_insensitive</primary></indexterm><programlisting><link linkend="void">void</link>                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 <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>.
</para><variablelist role="params">
<varlistentry><term><parameter>pixmap</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="GtkPixmap"><type>GtkPixmap</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>build</parameter>&#160;:</term>
<listitem><simpara>set to <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if an extra pixmap should be automatically created to use
when the pixmap is insensitive.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
