<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-gdkpixmap">
  <refnamediv>
    <refname>gtk.gdk.Pixmap</refname>
    <refpurpose>An offscreen <link
linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link></refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.gdk.Pixmap</classname></ooclass>
      <ooclass><classname><link
linkend="class-gdkdrawable">gtk.gdk.Drawable</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link linkend="constructor-gdkpixmap">gtk.gdk.Pixmap</link></methodname>
	<methodparam><parameter
		       role="keyword">drawable</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">width</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">height</parameter></methodparam>
	<methodparam><parameter role="keyword">depth</parameter>
	  <initializer>-1</initializer></methodparam>
      </constructorsynopsis>

</classsynopsis>

    <programlisting>
<emphasis role="bold">Functions</emphasis>

<methodsynopsis language="python">
	<methodname><link
linkend="function-gdk--bitmap-create-from-data">gtk.gdk.bitmap_create_from_data</link></methodname>
	<methodparam><parameter
		       role="keyword">drawable</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">data</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">width</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">height</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
	<methodname><link
linkend="function-gdk--pixmap-create-from-data">gtk.gdk.pixmap_create_from_data</link></methodname>
	<methodparam><parameter
		       role="keyword">drawable</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">data</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">width</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">height</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">depth</parameter></methodparam>
	<methodparam><parameter role="keyword">fg</parameter></methodparam>
	<methodparam><parameter role="keyword">bg</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
	<methodname><link
linkend="function-gdk--pixmap-create-from-xpm">gtk.gdk.pixmap_create_from_xpm</link></methodname>
	<methodparam><parameter
		       role="keyword">window</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">transparent_color</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">filename</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
	<methodname><link
linkend="function-gdk--pixmap-colormap-create-from-xpm">gtk.gdk.pixmap_colormap_create_from_xpm</link></methodname>
	<methodparam><parameter
		       role="keyword">window</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">colormap</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">transparent_color</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">filename</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
	<methodname><link
linkend="function-gdk--pixmap-create-from-xpm-d">gtk.gdk.pixmap_create_from_xpm_d</link></methodname>
	<methodparam><parameter
		       role="keyword">window</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">transparent_color</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">data</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
	<methodname><link
linkend="function-gdk--pixmap-colormap-create-from-xpm-d">gtk.gdk.pixmap_colormap_create_from_xpm_d</link></methodname>
	<methodparam><parameter
		       role="keyword">window</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">colormap</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">transparent_color</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">data</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
	<methodname><link
linkend="function-gdk--pixmap-foreign-new">gtk.gdk.pixmap_foreign_new</link></methodname>
	<methodparam><parameter
		       role="keyword">anid</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
	<methodname><link
linkend="function-gdk--pixmap-lookup">gtk.gdk.pixmap_lookup</link></methodname>
	<methodparam><parameter
		       role="keyword">anid</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
	<methodname><link
linkend="function-gdk--pixmap-foreign-new-for-display">gtk.gdk.pixmap_foreign_new_for_display</link></methodname>
	<methodparam><parameter
		       role="keyword">display</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">anid</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
	<methodname><link
linkend="function-gdk--pixmap-lookup-for-display">gtk.gdk.pixmap_lookup_for_display</link></methodname>
	<methodparam><parameter
		       role="keyword">display</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">anid</parameter></methodparam>
      </methodsynopsis></programlisting>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gdkdrawable">gtk.gdk.Drawable</link>
    +-- <link linkend="class-gdkpixmap">gtk.gdk.Pixmap</link>
</synopsis>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>A <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> is an
offscreen <link
linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>.
It can be drawn upon with the standard <link
linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
drawing primitives, then copied to another <link
linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
(such as a <link
linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>) with
the <link
linkend="method-gdkdrawable--draw-drawable"><methodname>draw_drawable</methodname>()</link> 
method. The depth of a pixmap is the number of bits per pixels. A bitmaps
are simply a <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> with
a depth of 1. (That is, they are monochrome pixmaps - each pixel can be
either on or off).</para>

  </refsect1>

  <refsect1 id="constructor-gdkpixmap">
    <title>Constructor</title>

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.gdk.Pixmap</methodname>
	<methodparam><parameter
		       role="keyword">drawable</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">width</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">height</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">depth</parameter><initializer>-1</initializer></methodparam>
      </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><parameter role="keyword">drawable</parameter>&nbsp;:</term>
	<listitem><simpara>a <link
linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link> used
to determine default values for the new pixmap or <literal>None</literal> if
<parameter>depth</parameter> is specified.</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter role="keyword">width</parameter>&nbsp;:</term>
	<listitem><simpara>the width of the new pixmap in
pixels.</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter role="keyword">height</parameter>&nbsp;:</term>
	<listitem><simpara>the height of the new pixmap in
pixels.</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter role="keyword">depth</parameter>&nbsp;:</term>
	<listitem><simpara>the depth (number of bits per pixel) of the new
pixmap or -1 to use the depth of
<parameter>drawable</parameter>.</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>a new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
object</simpara></listitem>
      </varlistentry>
    </variablelist>

    <para>Creates a new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> with
the size specified by <parameter>width</parameter> and
<parameter>height</parameter> and the number of bits per pixel specified by
<parameter>depth</parameter>.</para>

  </refsect1>

  <refsect1>
    <title>Functions</title>

    <refsect2 id="function-gdk--bitmap-create-from-data">
      <title>gtk.gdk.bitmap_create_from_data</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.gdk.bitmap_create_from_data</methodname>
	  <methodparam><parameter
			 role="keyword">drawable</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">data</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">width</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">height</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">drawable</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link> used
to determine default values for the new pixmap or <literal>None</literal>
to use the root window.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">data</parameter>&nbsp;:</term>
	  <listitem><simpara>a string containing the XBM
data</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">width</parameter>&nbsp;:</term>
	  <listitem><simpara>the width of the new bitmap in
pixels.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">height</parameter>&nbsp;:</term>
	  <listitem><simpara>the height of the new bitmap in
pixels.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a new bitmap (<link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>)
object</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <function>gtk.gdk.bitmap_create_from_data</function>()
function returns a new bitmap of the size specified by
<parameter>width</parameter> and <parameter>height</parameter> from the
<literal>XBM</literal> format string specified by
<parameter>data</parameter>.</para>

    </refsect2>

    <refsect2 id="function-gdk--pixmap-create-from-data">
      <title>gtk.gdk.pixmap_create_from_data</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.gdk.pixmap_create_from_data</methodname>
	  <methodparam><parameter
			 role="keyword">drawable</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">data</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">width</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">height</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">depth</parameter></methodparam>
	  <methodparam><parameter role="keyword">fg</parameter></methodparam>
	  <methodparam><parameter role="keyword">bg</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">drawable</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link> used
to determine default values for the new pixmap or <literal>None</literal> if
<parameter>depth</parameter> is specified.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">data</parameter>&nbsp;:</term>
	  <listitem><simpara>the string containing the pixmap
data.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">width</parameter>&nbsp;:</term>
	  <listitem><simpara>the width of the new pixmap in
pixels.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">height</parameter>&nbsp;:</term>
	  <listitem><simpara>the height of the new pixmap in
pixels.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">depth</parameter>&nbsp;:</term>
	  <listitem><simpara>the depth (number of bits per pixel) of the new
pixmap or -1 to use the depth of
<parameter>drawable</parameter>.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">fg</parameter>&nbsp;:</term>
	  <listitem><simpara>the foreground color.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">bg</parameter>&nbsp;:</term>
	  <listitem><simpara>he background color. </simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
object</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <function>gtk.gdk.pixmap_create_from_data</function>()
function creates a two-color <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> of
the size specified by <parameter>width</parameter> and
<parameter>height</parameter> from the <literal>XBM</literal> format string
specified by <parameter>data</parameter>. The foreground and background
colors of the pixmap are specified by <parameter>fg</parameter> and
<parameter>bg</parameter> respectively. If <parameter>depth</parameter> is
-1 <parameter>drawable</parameter> is used to determine the bits per pixels
otherwise the value of <parameter>depth</parameter> is used.</para>

    </refsect2>

    <refsect2 id="function-gdk--pixmap-create-from-xpm">
      <title>gtk.gdk.pixmap_create_from_xpm</title>
      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.gdk.pixmap_create_from_xpm</methodname>
	  <methodparam><parameter
			 role="keyword">window</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">transparent_color</parameter></methodparam> 
	  
	  
	  <methodparam><parameter
			 role="keyword">filename</parameter></methodparam> 
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">window</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
	  linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>,
	  used to determine default values for the new <link
	  linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">transparent_color</parameter>&nbsp;:</term>
	  <listitem><simpara>the color to be used for the pixels that are
transparent in the input file or <literal>None</literal> to use a default
color.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
	  <listitem><simpara>the name of a file containing
<literal>XPM</literal> data.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a tuple containing a new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
object and a bitmap that is the transparency mask.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <function>gtk.gdk.pixmap_create_from_xpm</function>()
function returns a tuple containing a <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> and a
bitmap transparency mask created from the <literal>XPM</literal> data in the
file specified by <parameter>filename</parameter>.
<parameter>transparent_color</parameter> (if not <literal>None</literal>)
specifies the <link
linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to by
used for the transparent pixels.</para>

    </refsect2>

    <refsect2 id="function-gdk--pixmap-colormap-create-from-xpm">
      <title>gtk.gdk.pixmap_colormap_create_from_xpm</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.gdk.pixmap_colormap_create_from_xpm</methodname>
	  <methodparam><parameter
			 role="keyword">window</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">colormap</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">transparent_color</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">filename</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">window</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>,
used to determine default values for the new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> or
<literal>None</literal> if a <link
linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
is specified.</simpara></listitem> 
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">colormap</parameter>&nbsp;:</term>
	  <listitem><simpara>the <link
linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
that the new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> will
be use or <literal>None</literal> to use the colormap of
<parameter>window</parameter>.</simpara></listitem> 
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">transparent_color</parameter>&nbsp;:</term>
	  <listitem><simpara>the color to be used for the pixels that are
transparent in the input file or <literal>None</literal> to use a default
color.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
	  <listitem><simpara>the name of a file containing
<literal>XPM</literal> data.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a tuple containing a new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
object and a bitmap that is the transparency mask.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The
<function>gtk.gdk.pixmap_colormap_create_from_xpm</function>() function
returns a tuple containing a <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> and a
bitmap transparency mask created from the <literal>XPM</literal> data in the
file specified by <parameter>filename</parameter>.
<parameter>transparent_color</parameter> (if not <literal>None</literal>)
specifies the <link
linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to by
used for the transparent pixels. If <parameter>colormap</parameter> is not
<literal>None</literal> it must specify a <link
linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
that the new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> will
use. If <parameter>colormap</parameter> is <literal>None</literal> the new
<link linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
will use the colormap of <parameter>window</parameter>.</para>

    </refsect2>

    <refsect2 id="function-gdk--pixmap-create-from-xpm-d">
      <title>gtk.gdk.pixmap_create_from_xpm_d</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.gdk.pixmap_create_from_xpm_d</methodname>
	  <methodparam><parameter
			 role="keyword">window</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">transparent_color</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">data</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">window</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>,
used to determine default values for the new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">transparent_color</parameter>&nbsp;:</term>
	  <listitem><simpara>the color to be used for the pixels that are
transparent in the input file or <literal>None</literal> to use a default
color.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">data</parameter>&nbsp;:</term>
	  <listitem><simpara>a list of strings containing the
<literal>XPM</literal> data.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a tuple containing a new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
object and a bitmap that is the transparency mask.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <function>gtk.gdk.pixmap_create_from_xpm_d</function>()
function returns a tuple containing a new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> and a
bitmap transparency mask created from the <literal>XPM</literal> data
contained in <parameter>data</parameter>.
<parameter>transparent_color</parameter> (if not <literal>None</literal>)
specifies the <link
linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to by
used for the transparent pixels.</para>

    </refsect2>

    <refsect2 id="function-gdk--pixmap-colormap-create-from-xpm-d">
      <title>gtk.gdk.pixmap_colormap_create_from_xpm_d</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.gdk.pixmap_colormap_create_from_xpm_d</methodname>
	  <methodparam><parameter
			 role="keyword">window</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">colormap</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">transparent_color</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">data</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">window</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>,
used to determine default values for the new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">colormap</parameter>&nbsp;:</term>
	  <listitem><simpara>the <link
linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
that the new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> will
be use or <literal>None</literal> to use the colormap of
<parameter>window</parameter>.</simpara></listitem> 
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">transparent_color</parameter>&nbsp;:</term>
	  <listitem><simpara>the color to be used for the pixels that are
transparent in the input file or <literal>None</literal> to use a default
color.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">data</parameter>&nbsp;:</term>
	  <listitem><simpara>a list of strings containing the
<literal>XPM</literal> data.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a tuple containing a new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
object and a bitmap that is the transparency mask.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The
<function>gtk.gdk.pixmap_colormap_create_from_xpm_d</function>() function
returns a tuple containing a new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> and a
bitmap transparency mask created from the <literal>XPM</literal> data
contained in <parameter>data</parameter>.
<parameter>transparent_color</parameter> (if not <literal>None</literal>)
specifies the <link
linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to by
used for the transparent pixels. If <parameter>colormap</parameter> is not
<literal>None</literal> it must specify a <link
linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
that the new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> will
use. If <parameter>colormap</parameter> is <literal>None</literal> the new
<link linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
will use the colormap of <parameter>window</parameter>.</para>

    </refsect2>

    <refsect2 id="function-gdk--pixmap-foreign-new">
      <title>gtk.gdk.pixmap_foreign_new</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.gdk.pixmap_foreign_new</methodname>
	  <methodparam><parameter
			 role="keyword">anid</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">anid</parameter>&nbsp;:</term>
	  <listitem><simpara> a native window system pixmap
handle.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara> the new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
wrapper for the native pixmap or <literal>None</literal> if the pixmap has
been destroyed.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <function>gtk.gdk.pixmap_foreign_new</function>() function
returns a <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> that
wraps the native window specified by <parameter>anid</parameter> for the
default display. If the pixmap has been destroyed this function returns
<literal>None</literal>. In the X backend, <parameter>anid</parameter> must
specify an Xlib XID that is a native pixmap handle.</para>

    </refsect2>

    <refsect2 id="function-gdk--pixmap-lookup">
      <title>gtk.gdk.pixmap_lookup</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.gdk.pixmap_lookup</methodname>
	  <methodparam><parameter
			 role="keyword">anid</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">anid</parameter>&nbsp;:</term>
	  <listitem><simpara> a native window system pixmap
handle.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara> the new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
wrapper for the native pixmap or <literal>None</literal> if the pixmap has
been destroyed.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <function>gtk.gdk.pixmap_lookup</function>() function
returns looks up and returns the <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> that
wraps the native pixmap handle specified by <parameter>anid</parameter>.
This method returns <literal>None</literal> if no <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> wraps
<parameter>anid</parameter>. In the X backend, <parameter>anid</parameter>
must specify an Xlib XID that is a native pixmap handle.</para>

    </refsect2>

    <refsect2 id="function-gdk--pixmap-foreign-new-for-display">
      <title>gtk.gdk.pixmap_foreign_new_for_display</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.gdk.pixmap_foreign_new_for_display</methodname>
	  <methodparam><parameter
			 role="keyword">display</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">anid</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">display</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
	  linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
	  object</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">anid</parameter>&nbsp;:</term>
	  <listitem><simpara> a native window system pixmap
handle.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara> the new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
wrapper for the native pixmap or <literal>None</literal> if the pixmap has
been destroyed.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This function is available in PyGTK2.2 and above.</para>
      </note>

      <para>The
<function>gtk.gdk.pixmap_foreign_new_for_display</function>() function
returns a <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> that
wraps the native window specified by <parameter>anid</parameter> for the
<link
linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
specified by <parameter>display</parameter>. If the pixmap has been
destroyed this function returns <literal>None</literal>. In the X backend,
<parameter>anid</parameter> must specify an Xlib XID that is a native pixmap
handle.</para>

    </refsect2>

    <refsect2 id="function-gdk--pixmap-lookup-for-display">
      <title>gtk.gdk.pixmap_lookup_for_display</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.gdk.pixmap_lookup_for_display</methodname>
	  <methodparam><parameter
			 role="keyword">display</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">anid</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">display</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
	  linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
	  object</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">anid</parameter>&nbsp;:</term>
	  <listitem><simpara> a native window system pixmap
handle.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara> the new <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
wrapper for the native pixmap or <literal>None</literal> if the pixmap has
been destroyed.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This function is available in PyGTK2.2 and above.</para>
      </note>

      <para>The <function>gtk.gdk.pixmap_lookup_for_display</function>()
function returns looks up and returns the <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> that
wraps the native pixmap handle specified by <parameter>anid</parameter> for
the <link
linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
specified by <parameter>display</parameter>.  This method returns
<literal>None</literal> if no <link
linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> wraps
<parameter>anid</parameter>. In the X backend, <parameter>anid</parameter>
must specify an Xlib XID that is a native pixmap handle.</para>

    </refsect2>

  </refsect1>

</refentry>
