<refentry id="GnomeDEntryEdit" revision="20 Jun 2000">
<refmeta>
<refentrytitle>GnomeDEntryEdit</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GNOMEUI Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GnomeDEntryEdit</refname><refpurpose>Editing object for dentries (.desktop files)</refpurpose>
</refnamediv>

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

#include &lt;gnome.h&gt;


struct      <link linkend="GnomeDEntryEdit-struct">GnomeDEntryEdit</link>;
<link linkend="GtkObject">GtkObject</link>*  <link linkend="gnome-dentry-edit-new">gnome_dentry_edit_new</link>           (void);
#define     <link linkend="gnome-dentry-edit-child1">gnome_dentry_edit_child1</link>        (d)
#define     <link linkend="gnome-dentry-edit-child2">gnome_dentry_edit_child2</link>        (d)
<link linkend="GtkObject">GtkObject</link>*  <link linkend="gnome-dentry-edit-new-notebook">gnome_dentry_edit_new_notebook</link>  (<link linkend="GtkNotebook">GtkNotebook</link> *notebook);
void        <link linkend="gnome-dentry-edit-clear">gnome_dentry_edit_clear</link>         (<link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> *dee);
void        <link linkend="gnome-dentry-edit-load-file">gnome_dentry_edit_load_file</link>     (<link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> *dee,
                                             const <link linkend="gchar">gchar</link> *path);
void        <link linkend="gnome-dentry-edit-set-dentry">gnome_dentry_edit_set_dentry</link>    (<link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> *dee,
                                             <link linkend="GnomeDesktopEntry">GnomeDesktopEntry</link> *dentry);
<link linkend="GnomeDesktopEntry">GnomeDesktopEntry</link>* <link linkend="gnome-dentry-get-dentry">gnome_dentry_get_dentry</link>  (<link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> *dee);
<link linkend="gchar">gchar</link>*      <link linkend="gnome-dentry-edit-get-icon">gnome_dentry_edit_get_icon</link>      (<link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> *dee);
<link linkend="gchar">gchar</link>*      <link linkend="gnome-dentry-edit-get-name">gnome_dentry_edit_get_name</link>      (<link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> *dee);

</synopsis>
</refsynopsisdiv>

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

  <link linkend="GtkObject">GtkObject</link>
   +----GnomeDEntryEdit
</synopsis>

</refsect1>




<refsect1>
<title>Description</title>
<para>
  GnomeDEntryEdit is a simpleobject, not a widget.  It is used for adding
  pages to a property notebook for editing a .desktop entry (such
  as in the menu editor).  Since it is not a widget you don't add it to the
  notebook, but you use the <link linkend="gnome-dentry-edit-new-notebook">gnome_dentry_edit_new_notebook</link> method to make
  a new object and automatically add it as the last page to a notebook.
</para>
</refsect1>

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

</para></refsect2>
<refsect2>
<title><anchor id="gnome-dentry-edit-new">gnome_dentry_edit_new ()</title>
<programlisting><link linkend="GtkObject">GtkObject</link>*  gnome_dentry_edit_new           (void);</programlisting>
<para>
Creates a new <link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> object. The object is not
a widget, but just an object which creates some widgets which you have
to add to a notebook. Use the <link linkend="gnome-dentry-edit-new-notebook">gnome_dentry_edit_new_notebook</link> to add
pages to the notebook.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> Newly-created <link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> object.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-dentry-edit-child1">gnome_dentry_edit_child1()</title>
<programlisting>#define     gnome_dentry_edit_child1(d)</programlisting>
<para>
  Get the first child widget pointer (page 1, basic), if you want to
  add it to a notebook yourself.
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>d</parameter>&nbsp;:</entry>
<entry>the GnomeDEntryEdit object to work with


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-dentry-edit-child2">gnome_dentry_edit_child2()</title>
<programlisting>#define     gnome_dentry_edit_child2(d)</programlisting>
<para>
  Get the first child widget pointer (page 2, advanced), if you want to
  add it to a notebook yourself.
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>d</parameter>&nbsp;:</entry>
<entry>the GnomeDEntryEdit object to work with


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-dentry-edit-new-notebook">gnome_dentry_edit_new_notebook ()</title>
<programlisting><link linkend="GtkObject">GtkObject</link>*  gnome_dentry_edit_new_notebook  (<link linkend="GtkNotebook">GtkNotebook</link> *notebook);</programlisting>
<para>
Creates a new <link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> object and adds it's pages
to the <parameter>notebook</parameter> specified in the parameter.</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>notebook</parameter>&nbsp;:</entry>
<entry> notebook to add the pages to
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> Newly-created <link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> object.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-dentry-edit-clear">gnome_dentry_edit_clear ()</title>
<programlisting>void        gnome_dentry_edit_clear         (<link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> *dee);</programlisting>
<para>
Clear the editting areas.</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>dee</parameter>&nbsp;:</entry>
<entry> <link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> object to work with
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-dentry-edit-load-file">gnome_dentry_edit_load_file ()</title>
<programlisting>void        gnome_dentry_edit_load_file     (<link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> *dee,
                                             const <link linkend="gchar">gchar</link> *path);</programlisting>
<para>
Load a .desktop file and update the editting areas
of the object accordingly.</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>dee</parameter>&nbsp;:</entry>
<entry> <link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> object to work with
</entry></row>
<row><entry align="right"><parameter>path</parameter>&nbsp;:</entry>
<entry> file to load into the editting areas
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-dentry-edit-set-dentry">gnome_dentry_edit_set_dentry ()</title>
<programlisting>void        gnome_dentry_edit_set_dentry    (<link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> *dee,
                                             <link linkend="GnomeDesktopEntry">GnomeDesktopEntry</link> *dentry);</programlisting>
<para>
Destroy existing dentry and replace
it with this one, updating the <link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> to reflect it.</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>dee</parameter>&nbsp;:</entry>
<entry> <link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> object to work with
</entry></row>
<row><entry align="right"><parameter>dentry</parameter>&nbsp;:</entry>
<entry> <link linkend="GnomeDesktopEntry">GnomeDesktopEntry</link> to use
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-dentry-get-dentry">gnome_dentry_get_dentry ()</title>
<programlisting><link linkend="GnomeDesktopEntry">GnomeDesktopEntry</link>* gnome_dentry_get_dentry  (<link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> *dee);</programlisting>
<para>
This call is actually the <link linkend="gnome-dentry-edit-get-dentry">gnome_dentry_edit_get_dentry</link>,
it should not be used, it is left ONLY for compatibility reasons.</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>dee</parameter>&nbsp;:</entry>
<entry> <link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> object to work with
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> a newly allocated <link linkend="GnomeDesktopEntry">GnomeDesktopEntry</link> structure.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-dentry-edit-get-icon">gnome_dentry_edit_get_icon ()</title>
<programlisting><link linkend="gchar">gchar</link>*      gnome_dentry_edit_get_icon      (<link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> *dee);</programlisting>
<para>
Get the icon filename. The icon is entered into a
<link linkend="GnomeIconEntry">GnomeIconEntry</link>, so the semantics of this call are the same as
for <link linkend="gnome-icon-entry-get-filename">gnome_icon_entry_get_filename</link></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>dee</parameter>&nbsp;:</entry>
<entry> <link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> object to work with
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> a newly allocated string with the filename of the icon
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-dentry-edit-get-name">gnome_dentry_edit_get_name ()</title>
<programlisting><link linkend="gchar">gchar</link>*      gnome_dentry_edit_get_name      (<link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> *dee);</programlisting>
<para>
Get the Name field from the dentry.</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>dee</parameter>&nbsp;:</entry>
<entry> <link linkend="GnomeDEntryEdit">GnomeDEntryEdit</link> object to work with
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> a newly allocated string with the name of the dentry
</entry></row>
</tbody></tgroup></informaltable></refsect2>

</refsect1>




</refentry>
