<refentry id="GnomeIconEntry">
<refmeta>
<refentrytitle>GnomeIconEntry</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GNOMEUI Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GnomeIconEntry</refname><refpurpose>A widget to select an icon.</refpurpose>
</refnamediv>

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

#include &lt;gnome.h&gt;


struct      <link linkend="GnomeIconEntry-struct">GnomeIconEntry</link>;
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gnome-icon-entry-new">gnome_icon_entry_new</link>            (char *history_id,
                                             char *browse_dialog_title);
void        <link linkend="gnome-icon-entry-set-pixmap-subdir">gnome_icon_entry_set_pixmap_subdir</link>
                                            (<link linkend="GnomeIconEntry">GnomeIconEntry</link> *ientry,
                                             const char *subdir);
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gnome-icon-entry-gnome-file-entry">gnome_icon_entry_gnome_file_entry</link>
                                            (<link linkend="GnomeIconEntry">GnomeIconEntry</link> *ientry);
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gnome-icon-entry-gnome-entry">gnome_icon_entry_gnome_entry</link>    (<link linkend="GnomeIconEntry">GnomeIconEntry</link> *ientry);
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gnome-icon-entry-gtk-entry">gnome_icon_entry_gtk_entry</link>      (<link linkend="GnomeIconEntry">GnomeIconEntry</link> *ientry);
char*       <link linkend="gnome-icon-entry-get-filename">gnome_icon_entry_get_filename</link>   (<link linkend="GnomeIconEntry">GnomeIconEntry</link> *ientry);

</synopsis>
</refsynopsisdiv>

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

  <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>
                           +----GnomeIconEntry
</synopsis>

</refsect1>




<refsect1>
<title>Description</title>
<para>
   This widget provides the facilities to select an icon.  An icon is
   displayed inside a button, when the button is pressed, an Icon
   selector (a dialog with a <link linkend="GnomeIconSel">GnomeIconSel</link> widget) pops up to let the
   user choose an icon.  It also allows one to Drag and Drop the images
   to and from the preview button.
</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GnomeIconEntry-struct">struct GnomeIconEntry</title>
<programlisting>struct GnomeIconEntry;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="gnome-icon-entry-new">gnome_icon_entry_new ()</title>
<programlisting><link linkend="GtkWidget">GtkWidget</link>*  gnome_icon_entry_new            (char *history_id,
                                             char *browse_dialog_title);</programlisting>
<para>
Creates a new icon entry widget</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>history_id</parameter>&nbsp;:</entry>
<entry> the id given to <link linkend="gnome-entry-new">gnome_entry_new</link>
</entry></row>
<row><entry align="right"><parameter>browse_dialog_title</parameter>&nbsp;:</entry>
<entry> title of the browse dialog and icon selection dialog
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> Returns the new object
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-icon-entry-set-pixmap-subdir">gnome_icon_entry_set_pixmap_subdir ()</title>
<programlisting>void        gnome_icon_entry_set_pixmap_subdir
                                            (<link linkend="GnomeIconEntry">GnomeIconEntry</link> *ientry,
                                             const char *subdir);</programlisting>
<para>
Sets the subdirectory below gnome's default
pixmap directory to use as the default path for the file
entry.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>ientry</parameter>&nbsp;:</entry>
<entry> the GnomeIconEntry to work with
</entry></row>
<row><entry align="right"><parameter>subdir</parameter>&nbsp;:</entry>
<entry> subdirectory
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-icon-entry-gnome-file-entry">gnome_icon_entry_gnome_file_entry ()</title>
<programlisting><link linkend="GtkWidget">GtkWidget</link>*  gnome_icon_entry_gnome_file_entry
                                            (<link linkend="GnomeIconEntry">GnomeIconEntry</link> *ientry);</programlisting>
<para>
Get the GnomeFileEntry widget that's part of the entry</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>ientry</parameter>&nbsp;:</entry>
<entry> the GnomeIconEntry to work with
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> Returns GnomeFileEntry widget
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-icon-entry-gnome-entry">gnome_icon_entry_gnome_entry ()</title>
<programlisting><link linkend="GtkWidget">GtkWidget</link>*  gnome_icon_entry_gnome_entry    (<link linkend="GnomeIconEntry">GnomeIconEntry</link> *ientry);</programlisting>
<para>
Get the GnomeEntry widget that's part of the entry</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>ientry</parameter>&nbsp;:</entry>
<entry> the GnomeIconEntry to work with
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> Returns GnomeEntry widget
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-icon-entry-gtk-entry">gnome_icon_entry_gtk_entry ()</title>
<programlisting><link linkend="GtkWidget">GtkWidget</link>*  gnome_icon_entry_gtk_entry      (<link linkend="GnomeIconEntry">GnomeIconEntry</link> *ientry);</programlisting>
<para>
Get the GtkEntry widget that's part of the entry</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>ientry</parameter>&nbsp;:</entry>
<entry> the GnomeIconEntry to work with
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> Returns GtkEntry widget
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-icon-entry-get-filename">gnome_icon_entry_get_filename ()</title>
<programlisting>char*       gnome_icon_entry_get_filename   (<link linkend="GnomeIconEntry">GnomeIconEntry</link> *ientry);</programlisting>
<para>
Gets the file name of the image if it was possible
to load it into the preview. That is, it will only return a filename
if the image exists and it was possible to load it as an image.</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>ientry</parameter>&nbsp;:</entry>
<entry> the GnomeIconEntry to work with
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> a newly allocated string with the path or <literal>NULL</literal> if it
couldn't load the file
</entry></row>
</tbody></tgroup></informaltable></refsect2>

</refsect1>



<refsect1>
<title>See Also</title>
<para>
  <link linkend="GnomeEntry">GnomeEntry</link>, <link linkend="GnomeFileEntry">GnomeFileEntry</link>, <link linkend="GnomeNumberEntry">GnomeNumberEntry</link>, <link linkend="GnomePixmapEntry">GnomePixmapEntry</link>
</para>
</refsect1>

</refentry>
