<refentry id="GnomePixmapEntry">
<refmeta>
<refentrytitle role="top_of_page" id="GnomePixmapEntry.top_of_page">GnomePixmapEntry</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GnomePixmapEntry</refname>
<refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv id="GnomePixmapEntry.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>

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

                    <link linkend="GnomePixmapEntry-struct">GnomePixmapEntry</link>;
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gnome-pixmap-entry-new">gnome_pixmap_entry_new</link>              (const <link linkend="gchar">gchar</link> *history_id,
                                                         const <link linkend="gchar">gchar</link> *browse_dialog_title,
                                                         <link linkend="gboolean">gboolean</link> do_preview);
<link linkend="void">void</link>                <link linkend="gnome-pixmap-entry-construct">gnome_pixmap_entry_construct</link>        (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry,
                                                         const <link linkend="gchar">gchar</link> *history_id,
                                                         const <link linkend="gchar">gchar</link> *browse_dialog_title,
                                                         <link linkend="gboolean">gboolean</link> do_preview);
<link linkend="void">void</link>                <link linkend="gnome-pixmap-entry-set-pixmap-subdir">gnome_pixmap_entry_set_pixmap_subdir</link>
                                                        (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry,
                                                         const <link linkend="gchar">gchar</link> *subdir);
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gnome-pixmap-entry-gnome-file-entry">gnome_pixmap_entry_gnome_file_entry</link> (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gnome-pixmap-entry-gnome-entry">gnome_pixmap_entry_gnome_entry</link>      (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gnome-pixmap-entry-gtk-entry">gnome_pixmap_entry_gtk_entry</link>        (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gnome-pixmap-entry-scrolled-window">gnome_pixmap_entry_scrolled_window</link>  (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gnome-pixmap-entry-preview-widget">gnome_pixmap_entry_preview_widget</link>   (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);
<link linkend="void">void</link>                <link linkend="gnome-pixmap-entry-set-preview">gnome_pixmap_entry_set_preview</link>      (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry,
                                                         <link linkend="gboolean">gboolean</link> do_preview);
<link linkend="void">void</link>                <link linkend="gnome-pixmap-entry-set-preview-size">gnome_pixmap_entry_set_preview_size</link> (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry,
                                                         <link linkend="gint">gint</link> preview_w,
                                                         <link linkend="gint">gint</link> preview_h);
<link linkend="gchar">gchar</link> *             <link linkend="gnome-pixmap-entry-get-filename">gnome_pixmap_entry_get_filename</link>     (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);
</synopsis>
</refsynopsisdiv>

<refsect1 id="GnomePixmapEntry.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="GtkContainer">GtkContainer</link>
                           +----<link linkend="GtkBox">GtkBox</link>
                                 +----<link linkend="GtkVBox">GtkVBox</link>
                                       +----<link linkend="GnomeFileEntry">GnomeFileEntry</link>
                                             +----GnomePixmapEntry
</synopsis>
</refsect1>



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


<refsect1 id="GnomePixmapEntry.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="GnomePixmapEntry--do-preview">do-preview</link>&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write
</synopsis>
</refsect1>



<refsect1 id="GnomePixmapEntry.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>

<refsect1 id="GnomePixmapEntry.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GnomePixmapEntry-struct" role="struct">
<title>GnomePixmapEntry</title>
<indexterm zone="GnomePixmapEntry-struct" role="deprecated"><primary sortas="GnomePixmapEntry">GnomePixmapEntry</primary></indexterm><programlisting>typedef struct _GnomePixmapEntry GnomePixmapEntry;</programlisting>
<warning><para><literal>GnomePixmapEntry</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para></refsect2>
<refsect2 id="gnome-pixmap-entry-new" role="function" condition="deprecated:">
<title>gnome_pixmap_entry_new ()</title>
<indexterm zone="gnome-pixmap-entry-new" role="deprecated"><primary sortas="gnome_pixmap_entry_new">gnome_pixmap_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gnome_pixmap_entry_new              (const <link linkend="gchar">gchar</link> *history_id,
                                                         const <link linkend="gchar">gchar</link> *browse_dialog_title,
                                                         <link linkend="gboolean">gboolean</link> do_preview);</programlisting>
<warning><para><literal>gnome_pixmap_entry_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Creates a new pixmap entry widget, if do_preview is false,
there is no preview, the files are not loaded and thus are not
checked to be real image files.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>history_id</parameter>&#160;:</term>
<listitem><simpara> The id given to <link linkend="gnome-entry-new"><type>gnome_entry_new</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>browse_dialog_title</parameter>&#160;:</term>
<listitem><simpara> Title of the browse dialog
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>do_preview</parameter>&#160;:</term>
<listitem><simpara> boolean
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> New GnomePixmapEntry object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-pixmap-entry-construct" role="function" condition="deprecated:">
<title>gnome_pixmap_entry_construct ()</title>
<indexterm zone="gnome-pixmap-entry-construct" role="deprecated"><primary sortas="gnome_pixmap_entry_construct">gnome_pixmap_entry_construct</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_pixmap_entry_construct        (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry,
                                                         const <link linkend="gchar">gchar</link> *history_id,
                                                         const <link linkend="gchar">gchar</link> *browse_dialog_title,
                                                         <link linkend="gboolean">gboolean</link> do_preview);</programlisting>
<warning><para><literal>gnome_pixmap_entry_construct</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Constructs the <parameter>pentry</parameter> object.  If do_preview is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>,
there is no preview, the files are not loaded and thus are not
checked to be real image files.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="GnomePixmapEntry"><type>GnomePixmapEntry</type></link> object to construct
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>history_id</parameter>&#160;:</term>
<listitem><simpara> The id given to <link linkend="gnome-entry-new"><type>gnome_entry_new</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>browse_dialog_title</parameter>&#160;:</term>
<listitem><simpara> Title of the browse dialog
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>do_preview</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if preview is desired, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if not.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-pixmap-entry-set-pixmap-subdir" role="function" condition="deprecated:">
<title>gnome_pixmap_entry_set_pixmap_subdir ()</title>
<indexterm zone="gnome-pixmap-entry-set-pixmap-subdir" role="deprecated"><primary sortas="gnome_pixmap_entry_set_pixmap_subdir">gnome_pixmap_entry_set_pixmap_subdir</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_pixmap_entry_set_pixmap_subdir
                                                        (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry,
                                                         const <link linkend="gchar">gchar</link> *subdir);</programlisting>
<warning><para><literal>gnome_pixmap_entry_set_pixmap_subdir</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets the default path for the file entry. The new
subdirectory should be specified relative to the default GNOME
pixmap directory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter>&#160;:</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>subdir</parameter>&#160;:</term>
<listitem><simpara> Subdirectory
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-pixmap-entry-gnome-file-entry" role="function" condition="deprecated:">
<title>gnome_pixmap_entry_gnome_file_entry ()</title>
<indexterm zone="gnome-pixmap-entry-gnome-file-entry" role="deprecated"><primary sortas="gnome_pixmap_entry_gnome_file_entry">gnome_pixmap_entry_gnome_file_entry</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gnome_pixmap_entry_gnome_file_entry (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);</programlisting>
<warning><para><literal>gnome_pixmap_entry_gnome_file_entry</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Get the <link linkend="GnomeFileEntry"><type>GnomeFileEntry</type></link> component of the
GnomePixmapEntry widget for lower-level manipulation.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter>&#160;:</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="GnomeFileEntry"><type>GnomeFileEntry</type></link> widget
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-pixmap-entry-gnome-entry" role="function" condition="deprecated:">
<title>gnome_pixmap_entry_gnome_entry ()</title>
<indexterm zone="gnome-pixmap-entry-gnome-entry" role="deprecated"><primary sortas="gnome_pixmap_entry_gnome_entry">gnome_pixmap_entry_gnome_entry</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gnome_pixmap_entry_gnome_entry      (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);</programlisting>
<warning><para><literal>gnome_pixmap_entry_gnome_entry</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Get the <link linkend="GnomeEntry"><type>GnomeEntry</type></link> component of the
GnomePixmapEntry widget for lower-level manipulation.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter>&#160;:</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="GnomeEntry"><type>GnomeEntry</type></link> widget
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-pixmap-entry-gtk-entry" role="function" condition="deprecated:">
<title>gnome_pixmap_entry_gtk_entry ()</title>
<indexterm zone="gnome-pixmap-entry-gtk-entry" role="deprecated"><primary sortas="gnome_pixmap_entry_gtk_entry">gnome_pixmap_entry_gtk_entry</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gnome_pixmap_entry_gtk_entry        (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);</programlisting>
<warning><para><literal>gnome_pixmap_entry_gtk_entry</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Get the <link linkend="GtkEntry"><type>GtkEntry</type></link> component of the
GnomePixmapEntry for Gtk+-level manipulation.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter>&#160;:</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="GtkEntry"><type>GtkEntry</type></link> widget
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-pixmap-entry-scrolled-window" role="function" condition="deprecated:">
<title>gnome_pixmap_entry_scrolled_window ()</title>
<indexterm zone="gnome-pixmap-entry-scrolled-window" role="deprecated"><primary sortas="gnome_pixmap_entry_scrolled_window">gnome_pixmap_entry_scrolled_window</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gnome_pixmap_entry_scrolled_window  (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);</programlisting>
<warning><para><literal>gnome_pixmap_entry_scrolled_window</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Get the <link linkend="GtkScrolledWindow"><type>GtkScrolledWindow</type></link> widget that the preview
is contained in.  Could be <link linkend="NULL--CAPS"><literal>NULL</literal></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter>&#160;:</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="GtkScrolledWindow"><type>GtkScrolledWindow</type></link> widget or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-pixmap-entry-preview-widget" role="function" condition="deprecated:">
<title>gnome_pixmap_entry_preview_widget ()</title>
<indexterm zone="gnome-pixmap-entry-preview-widget" role="deprecated"><primary sortas="gnome_pixmap_entry_preview_widget">gnome_pixmap_entry_preview_widget</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gnome_pixmap_entry_preview_widget   (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);</programlisting>
<warning><para><literal>gnome_pixmap_entry_preview_widget</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Get the widget that is the preview.  Don't assume any
type of widget.  Currently either <link linkend="GnomePixmap"><type>GnomePixmap</type></link> or <link linkend="GtkLabel"><type>GtkLabel</type></link>, but it
could change in the future. Could be <link linkend="NULL--CAPS"><literal>NULL</literal></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter>&#160;:</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the preview widget pointer or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-pixmap-entry-set-preview" role="function" condition="deprecated:">
<title>gnome_pixmap_entry_set_preview ()</title>
<indexterm zone="gnome-pixmap-entry-set-preview" role="deprecated"><primary sortas="gnome_pixmap_entry_set_preview">gnome_pixmap_entry_set_preview</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_pixmap_entry_set_preview      (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry,
                                                         <link linkend="gboolean">gboolean</link> do_preview);</programlisting>
<warning><para><literal>gnome_pixmap_entry_set_preview</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets whether or not the preview box is shown above
the entry.  If the preview is on, we also load the files and check
for them being real images.  If it is off, we don't check files
to be real image files.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter>&#160;:</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>do_preview</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to show previews, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> to not show them.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-pixmap-entry-set-preview-size" role="function" condition="deprecated:">
<title>gnome_pixmap_entry_set_preview_size ()</title>
<indexterm zone="gnome-pixmap-entry-set-preview-size" role="deprecated"><primary sortas="gnome_pixmap_entry_set_preview_size">gnome_pixmap_entry_set_preview_size</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_pixmap_entry_set_preview_size (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry,
                                                         <link linkend="gint">gint</link> preview_w,
                                                         <link linkend="gint">gint</link> preview_h);</programlisting>
<warning><para><literal>gnome_pixmap_entry_set_preview_size</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets the minimum size of the preview frame in pixels.
This works only if the preview is enabled.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter>&#160;:</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>preview_w</parameter>&#160;:</term>
<listitem><simpara> Preview width in pixels
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>preview_h</parameter>&#160;:</term>
<listitem><simpara> Preview height in pixels
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-pixmap-entry-get-filename" role="function" condition="deprecated:">
<title>gnome_pixmap_entry_get_filename ()</title>
<indexterm zone="gnome-pixmap-entry-get-filename" role="deprecated"><primary sortas="gnome_pixmap_entry_get_filename">gnome_pixmap_entry_get_filename</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             gnome_pixmap_entry_get_filename     (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);</programlisting>
<warning><para><literal>gnome_pixmap_entry_get_filename</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Gets the filename of the image if the preview
successfully loaded if preview is disabled.  If the preview is
disabled, the file is only checked if it exists or not.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter>&#160;:</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> Newly allocated string containing path, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> on error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="GnomePixmapEntry.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GnomePixmapEntry--do-preview" role="property"><title>The <literal>&quot;do-preview&quot;</literal> property</title>
<indexterm zone="GnomePixmapEntry--do-preview"><primary sortas="GnomePixmapEntry:do-preview">GnomePixmapEntry:do-preview</primary></indexterm><programlisting>  &quot;do-preview&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>Whether the pixmap entry should have a preview.</para><para>Default value: FALSE</para>
</refsect2>
</refsect1>




</refentry>
