<?xml version="1.0"?>
<!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="GnomeDItemEdit">
<refmeta>
<refentrytitle role="top_of_page" id="GnomeDItemEdit.top_of_page">GnomeDItemEdit</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GNOME-DESKTOP Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GnomeDItemEdit</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

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

<synopsis>

#include &lt;libgnome/gnome-ditem-edit.h&gt;

                    <link linkend="GnomeDItemEdit-struct">GnomeDItemEdit</link>;
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gnome-ditem-edit-new">gnome_ditem_edit_new</link>                (void);
<link linkend="void">void</link>                <link linkend="gnome-ditem-edit-clear">gnome_ditem_edit_clear</link>              (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee);
<link linkend="gboolean">gboolean</link>            <link linkend="gnome-ditem-edit-load-uri">gnome_ditem_edit_load_uri</link>           (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee,
                                                         const <link linkend="gchar">gchar</link> *uri,
                                                         <link linkend="GError">GError</link> **error);
<link linkend="void">void</link>                <link linkend="gnome-ditem-edit-set-ditem">gnome_ditem_edit_set_ditem</link>          (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee,
                                                         const <link linkend="GnomeDesktopItem">GnomeDesktopItem</link> *ditem);
<link linkend="GnomeDesktopItem">GnomeDesktopItem</link>*   <link linkend="gnome-ditem-edit-get-ditem">gnome_ditem_edit_get_ditem</link>          (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee);
<link linkend="gchar">gchar</link>*              <link linkend="gnome-ditem-edit-get-icon">gnome_ditem_edit_get_icon</link>           (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee);
<link linkend="gchar">gchar</link>*              <link linkend="gnome-ditem-edit-get-name">gnome_ditem_edit_get_name</link>           (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee);
<link linkend="void">void</link>                <link linkend="gnome-ditem-edit-set-entry-type">gnome_ditem_edit_set_entry_type</link>     (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee,
                                                         const <link linkend="char">char</link> *type);
<link linkend="void">void</link>                <link linkend="gnome-ditem-edit-set-directory-only">gnome_ditem_edit_set_directory_only</link> (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee,
                                                         <link linkend="gboolean">gboolean</link> directory_only);
<link linkend="void">void</link>                <link linkend="gnome-ditem-edit-grab-focus">gnome_ditem_edit_grab_focus</link>         (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee);
<link linkend="void">void</link>                <link linkend="gnome-ditem-edit-set-editable">gnome_ditem_edit_set_editable</link>       (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee,
                                                         <link linkend="gboolean">gboolean</link> editable);
</synopsis>
</refsynopsisdiv>

<refsect1 id="GnomeDItemEdit.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="GtkNotebook">GtkNotebook</link>
                                 +----GnomeDItemEdit
</synopsis>

</refsect1>



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

</refsect1>



<refsect1 id="GnomeDItemEdit.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="GnomeDItemEdit-changed">changed</link>&quot;                                        : Run Last
  &quot;<link linkend="GnomeDItemEdit-icon-changed">icon-changed</link>&quot;                                   : Run Last
  &quot;<link linkend="GnomeDItemEdit-name-changed">name-changed</link>&quot;                                   : Run Last
</synopsis>
</refsect1>


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

</para>
</refsect1>

<refsect1 id="GnomeDItemEdit.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GnomeDItemEdit-struct" role="struct">
<title>GnomeDItemEdit</title>
<indexterm zone="GnomeDItemEdit-struct" role="deprecated"><primary>GnomeDItemEdit</primary></indexterm><programlisting>typedef struct _GnomeDItemEdit GnomeDItemEdit;</programlisting>
<warning><para><literal>GnomeDItemEdit</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>

</para></refsect2>
<refsect2 id="gnome-ditem-edit-new" role="function" condition="deprecated:2.18:">
<title>gnome_ditem_edit_new ()</title>
<indexterm zone="gnome-ditem-edit-new" role="deprecated"><primary>gnome_ditem_edit_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gnome_ditem_edit_new                (void);</programlisting>
<warning><para><literal>gnome_ditem_edit_new</literal> has been deprecated since version 2.18 and should not be used in newly-written code. </para></warning>
<para>
Creates a new <link linkend="GnomeDItemEdit"><type>GnomeDItemEdit</type></link> widget.  A widget
for the purpose of editing <link linkend="GnomeDesktopItems"><type>GnomeDesktopItems</type></link></para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Newly-created <link linkend="GnomeDItemEdit"><type>GnomeDItemEdit</type></link> widget.

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-ditem-edit-clear" role="function" condition="deprecated:2.18:">
<title>gnome_ditem_edit_clear ()</title>
<indexterm zone="gnome-ditem-edit-clear" role="deprecated"><primary>gnome_ditem_edit_clear</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_ditem_edit_clear              (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee);</programlisting>
<warning><para><literal>gnome_ditem_edit_clear</literal> has been deprecated since version 2.18 and should not be used in newly-written code. </para></warning>
<para>
Clear the editting areas.  And unref any
stored <link linkend="GnomeDesktopItem"><type>GnomeDesktopItem</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>dee</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GnomeDItemEdit"><type>GnomeDItemEdit</type></link> object to work with
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-ditem-edit-load-uri" role="function" condition="deprecated:2.18:">
<title>gnome_ditem_edit_load_uri ()</title>
<indexterm zone="gnome-ditem-edit-load-uri" role="deprecated"><primary>gnome_ditem_edit_load_uri</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gnome_ditem_edit_load_uri           (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee,
                                                         const <link linkend="gchar">gchar</link> *uri,
                                                         <link linkend="GError">GError</link> **error);</programlisting>
<warning><para><literal>gnome_ditem_edit_load_uri</literal> has been deprecated since version 2.18 and should not be used in newly-written code. </para></warning>
<para>
Load a .desktop file and update the editting areas
of the object accordingly.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>dee</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GnomeDItemEdit"><type>GnomeDItemEdit</type></link> object to work with
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
<listitem><simpara> file to load into the editting areas
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara> location to store error, or NULL
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>  <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-ditem-edit-set-ditem" role="function" condition="deprecated:2.18:">
<title>gnome_ditem_edit_set_ditem ()</title>
<indexterm zone="gnome-ditem-edit-set-ditem" role="deprecated"><primary>gnome_ditem_edit_set_ditem</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_ditem_edit_set_ditem          (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee,
                                                         const <link linkend="GnomeDesktopItem">GnomeDesktopItem</link> *ditem);</programlisting>
<warning><para><literal>gnome_ditem_edit_set_ditem</literal> has been deprecated since version 2.18 and should not be used in newly-written code. </para></warning>
<para>
Set the ditem edit UI to this item.  This makes a copy
internally so do not worry about modifying this item later yourself.
Note that since the entire item is stored, any hidden fields will be
preserved when you later get it with <link linkend="gnome-ditem-edit-get-ditem"><type>gnome_ditem_edit_get_ditem</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>dee</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GnomeDItemEdit"><type>GnomeDItemEdit</type></link> object to work with
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ditem</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GnomeDesktopItem"><type>GnomeDesktopItem</type></link> to use
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-ditem-edit-get-ditem" role="function" condition="deprecated:2.18:">
<title>gnome_ditem_edit_get_ditem ()</title>
<indexterm zone="gnome-ditem-edit-get-ditem" role="deprecated"><primary>gnome_ditem_edit_get_ditem</primary></indexterm><programlisting><link linkend="GnomeDesktopItem">GnomeDesktopItem</link>*   gnome_ditem_edit_get_ditem          (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee);</programlisting>
<warning><para><literal>gnome_ditem_edit_get_ditem</literal> has been deprecated since version 2.18 and should not be used in newly-written code. </para></warning>
<para>
Get the current status of the editting areas
as a <link linkend="GnomeDesktopItem"><type>GnomeDesktopItem</type></link> structure.  It will give you a pointer
to the internal structure.  If you wish to modify it,
make a copy of it with <link linkend="gnome-desktop-item-copy"><type>gnome_desktop_item_copy</type></link></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>dee</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GnomeDItemEdit"><type>GnomeDItemEdit</type></link> object to work with
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a pointer to the internal <link linkend="GnomeDesktopItem"><type>GnomeDesktopItem</type></link> structure.

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-ditem-edit-get-icon" role="function" condition="deprecated:2.18:">
<title>gnome_ditem_edit_get_icon ()</title>
<indexterm zone="gnome-ditem-edit-get-icon" role="deprecated"><primary>gnome_ditem_edit_get_icon</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gnome_ditem_edit_get_icon           (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee);</programlisting>
<warning><para><literal>gnome_ditem_edit_get_icon</literal> has been deprecated since version 2.18 and should not be used in newly-written code. </para></warning>
<para>
Get the icon filename.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>dee</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GnomeDItemEdit"><type>GnomeDItemEdit</type></link> object to work with
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated string with the filename of the icon

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-ditem-edit-get-name" role="function" condition="deprecated:2.18:">
<title>gnome_ditem_edit_get_name ()</title>
<indexterm zone="gnome-ditem-edit-get-name" role="deprecated"><primary>gnome_ditem_edit_get_name</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gnome_ditem_edit_get_name           (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee);</programlisting>
<warning><para><literal>gnome_ditem_edit_get_name</literal> has been deprecated since version 2.18 and should not be used in newly-written code. </para></warning>
<para>
Get the Name field from the ditem for the current language.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>dee</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GnomeDItemEdit"><type>GnomeDItemEdit</type></link> object to work with
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated string with the name of the ditem

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-ditem-edit-set-entry-type" role="function" condition="deprecated:2.18:">
<title>gnome_ditem_edit_set_entry_type ()</title>
<indexterm zone="gnome-ditem-edit-set-entry-type" role="deprecated"><primary>gnome_ditem_edit_set_entry_type</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_ditem_edit_set_entry_type     (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee,
                                                         const <link linkend="char">char</link> *type);</programlisting>
<warning><para><literal>gnome_ditem_edit_set_entry_type</literal> has been deprecated since version 2.18 and should not be used in newly-written code. </para></warning>
<para>
Force directory only.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>dee</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GnomeDItemEdit"><type>GnomeDItemEdit</type></link> object to work with
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-ditem-edit-set-directory-only" role="function" condition="deprecated:">
<title>gnome_ditem_edit_set_directory_only ()</title>
<indexterm zone="gnome-ditem-edit-set-directory-only" role="deprecated"><primary>gnome_ditem_edit_set_directory_only</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_ditem_edit_set_directory_only (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee,
                                                         <link linkend="gboolean">gboolean</link> directory_only);</programlisting>
<warning><para><literal>gnome_ditem_edit_set_directory_only</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>dee</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>directory_only</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-ditem-edit-grab-focus" role="function" condition="deprecated:2.18:">
<title>gnome_ditem_edit_grab_focus ()</title>
<indexterm zone="gnome-ditem-edit-grab-focus" role="deprecated"><primary>gnome_ditem_edit_grab_focus</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_ditem_edit_grab_focus         (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee);</programlisting>
<warning><para><literal>gnome_ditem_edit_grab_focus</literal> has been deprecated since version 2.18 and should not be used in newly-written code. </para></warning>
<para>
Give the focus to the editor.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>dee</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GnomeDItemEdit"><type>GnomeDItemEdit</type></link> object to work with
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-ditem-edit-set-editable" role="function" condition="deprecated:2.18:">
<title>gnome_ditem_edit_set_editable ()</title>
<indexterm zone="gnome-ditem-edit-set-editable" role="deprecated"><primary>gnome_ditem_edit_set_editable</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_ditem_edit_set_editable       (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *dee,
                                                         <link linkend="gboolean">gboolean</link> editable);</programlisting>
<warning><para><literal>gnome_ditem_edit_set_editable</literal> has been deprecated since version 2.18 and should not be used in newly-written code. </para></warning>
<para>
Set the object editable.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>dee</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GnomeDItemEdit"><type>GnomeDItemEdit</type></link> object to work with
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>editable</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to set the object editable
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>

<refsect1 id="GnomeDItemEdit.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GnomeDItemEdit-changed"><title>The <literal>&quot;changed&quot;</literal> signal</title>
<indexterm zone="GnomeDItemEdit-changed"><primary>GnomeDItemEdit::changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *ditemedit,
                                                        <link linkend="gpointer">gpointer</link>        user_data)      : Run Last</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ditemedit</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GnomeDItemEdit-icon-changed"><title>The <literal>&quot;icon-changed&quot;</literal> signal</title>
<indexterm zone="GnomeDItemEdit-icon-changed"><primary>GnomeDItemEdit::icon-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *ditemedit,
                                                        <link linkend="gpointer">gpointer</link>        user_data)      : Run Last</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ditemedit</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GnomeDItemEdit-name-changed"><title>The <literal>&quot;name-changed&quot;</literal> signal</title>
<indexterm zone="GnomeDItemEdit-name-changed"><primary>GnomeDItemEdit::name-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GnomeDItemEdit">GnomeDItemEdit</link> *ditemedit,
                                                        <link linkend="gpointer">gpointer</link>        user_data)      : Run Last</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>ditemedit</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>



</refentry>
