<refentry id="GnomeDbEntryCombo">
<refmeta>
<refentrytitle>GnomeDbEntryCombo</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEDB-4.0 Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GnomeDbEntryCombo</refname><refpurpose>A combo box to choose a value from a <link linkend="GdaSet"><type>GdaSet</type></link></refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



struct      <link linkend="GnomeDbEntryCombo-struct">GnomeDbEntryCombo</link>;
struct      <link linkend="GnomeDbEntryComboClass">GnomeDbEntryComboClass</link>;
struct      <link linkend="GnomeDbEntryComboPriv">GnomeDbEntryComboPriv</link>;
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gnome-db-entry-combo-new">gnome_db_entry_combo_new</link>        (<link linkend="GdaSet">GdaSet</link> *paramlist,
                                             <link linkend="GdaSetSource">GdaSetSource</link> *source);
<link linkend="gboolean">gboolean</link>    <link linkend="gnome-db-entry-combo-set-values">gnome_db_entry_combo_set_values</link> (<link linkend="GnomeDbEntryCombo">GnomeDbEntryCombo</link> *combo,
                                             <link linkend="GSList">GSList</link> *values);
<link linkend="GSList">GSList</link>*     <link linkend="gnome-db-entry-combo-get-values">gnome_db_entry_combo_get_values</link> (<link linkend="GnomeDbEntryCombo">GnomeDbEntryCombo</link> *combo);
<link linkend="GSList">GSList</link>*     <link linkend="gnome-db-entry-combo-get-all-values">gnome_db_entry_combo_get_all_values</link>
                                            (<link linkend="GnomeDbEntryCombo">GnomeDbEntryCombo</link> *combo);
<link linkend="void">void</link>        <link linkend="gnome-db-entry-combo-set-values-orig">gnome_db_entry_combo_set_values_orig</link>
                                            (<link linkend="GnomeDbEntryCombo">GnomeDbEntryCombo</link> *combo,
                                             <link linkend="GSList">GSList</link> *values);
<link linkend="GSList">GSList</link>*     <link linkend="gnome-db-entry-combo-get-values-orig">gnome_db_entry_combo_get_values_orig</link>
                                            (<link linkend="GnomeDbEntryCombo">GnomeDbEntryCombo</link> *combo);
<link linkend="void">void</link>        <link linkend="gnome-db-entry-combo-set-values-default">gnome_db_entry_combo_set_values_default</link>
                                            (<link linkend="GnomeDbEntryCombo">GnomeDbEntryCombo</link> *combo,
                                             <link linkend="GSList">GSList</link> *values);

</synopsis>
</refsynopsisdiv>

<refsect1>
<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="GtkBin">GtkBin</link>
                                 +----<link linkend="GtkViewport">GtkViewport</link>
                                       +----<link linkend="GnomeDbEntryShell">GnomeDbEntryShell</link>
                                             +----GnomeDbEntryCombo
</synopsis>

</refsect1>



<refsect1>
<title>Implemented Interfaces</title>
<para>
GnomeDbEntryCombo implements
 <link linkend="GnomeDbDataEntry">GnomeDbDataEntry</link>,  <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>

</refsect1>


<refsect1>
<title>Properties</title>
<synopsis>

  &quot;<link linkend="GnomeDbEntryCombo--set-default-if-invalid">set-default-if-invalid</link>&quot; <link linkend="gboolean">gboolean</link>             : Read / Write
</synopsis>
</refsect1>



<refsect1>
<title>Description</title>
<para>
This widget allows the user to select a row from a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object, and set one or several values from that row.
Specifically, it uses a <link linkend="GdaSetNode"><type>GdaSetNode</type></link> (within a <link linkend="GdaSet"><type>GdaSet</type></link> object),
and synchonizes the values of the <link linkend="GdaHolder"><type>GdaHolder</type></link> objects in that <link linkend="GdaSetNode"><type>GdaSetNode</type></link>.
</para>
</refsect1>

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

</para></refsect2>
<refsect2>
<title><anchor id="GnomeDbEntryComboClass"/>struct GnomeDbEntryComboClass</title>
<indexterm><primary>GnomeDbEntryComboClass</primary></indexterm><programlisting>struct GnomeDbEntryComboClass {

	GnomeDbEntryShellClass   parent_class;
};
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GnomeDbEntryComboPriv"/>struct GnomeDbEntryComboPriv</title>
<indexterm><primary>GnomeDbEntryComboPriv</primary></indexterm><programlisting>struct GnomeDbEntryComboPriv;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="gnome-db-entry-combo-new"/>gnome_db_entry_combo_new ()</title>
<indexterm><primary>gnome_db_entry_combo_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gnome_db_entry_combo_new        (<link linkend="GdaSet">GdaSet</link> *paramlist,
                                             <link linkend="GdaSetSource">GdaSetSource</link> *source);</programlisting>
<para>
Creates a new <link linkend="GnomeDbEntryCombo"><type>GnomeDbEntryCombo</type></link> widget. The widget is a combo box which displays a
selectable list of items (the items come from the 'source->data_model' data model)
</para>
<para>
The widget allows the value setting of one or more <link linkend="GdaHolder"><type>GdaHolder</type></link> objects
(one for each 'source->nodes') while proposing potentially "more readable" choices.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>paramlist</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaSet"><type>GdaSet</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaSetSource"><type>GdaSetSource</type></link> structure, part of <parameter>paramlist</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new widget
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-entry-combo-set-values"/>gnome_db_entry_combo_set_values ()</title>
<indexterm><primary>gnome_db_entry_combo_set_values</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_db_entry_combo_set_values (<link linkend="GnomeDbEntryCombo">GnomeDbEntryCombo</link> *combo,
                                             <link linkend="GSList">GSList</link> *values);</programlisting>
<para>
Sets the values of <parameter>combo</parameter> to the specified ones. None of the
values provided in the list is modified.
</para>
<para>
<parameter>values</parameter> holds a list of <link linkend="GValue"><type>GValue</type></link> values, one for each parameter that is present in the <parameter>node</parameter> argument
of the <link linkend="gnome-db-entry-combo-new"><function>gnome_db_entry_combo_new()</function></link> function which created <parameter>combo</parameter>.
</para>
<para>
An error can occur when there is no corresponding value(s) to be displayed
for the provided values.
</para>
<para>
If <parameter>values</parameter> is <literal>NULL</literal>, then the entry itself is set to NULL;</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>combo</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEntryCombo"><type>GnomeDbEntryCombo</type></link> widet
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>values</parameter>&nbsp;:</term>
<listitem><simpara> a list of <link linkend="GValue"><type>GValue</type></link> values, or <literal>NULL</literal>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if no error occurred.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-entry-combo-get-values"/>gnome_db_entry_combo_get_values ()</title>
<indexterm><primary>gnome_db_entry_combo_get_values</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*     gnome_db_entry_combo_get_values (<link linkend="GnomeDbEntryCombo">GnomeDbEntryCombo</link> *combo);</programlisting>
<para>
Get the values stored within <parameter>combo</parameter>. The returned values are the ones
within <parameter>combo</parameter>, so they must not be freed afterwards, however the returned
list has to be freed afterwards.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>combo</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEntryCombo"><type>GnomeDbEntryCombo</type></link> widet
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new list of values
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-entry-combo-get-all-values"/>gnome_db_entry_combo_get_all_values ()</title>
<indexterm><primary>gnome_db_entry_combo_get_all_values</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*     gnome_db_entry_combo_get_all_values
                                            (<link linkend="GnomeDbEntryCombo">GnomeDbEntryCombo</link> *combo);</programlisting>
<para>
Get a list of all the values in <parameter>combo</parameter>'s data model's selected row. The list
must be freed by the caller.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>combo</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEntryCombo"><type>GnomeDbEntryCombo</type></link> widet
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new list of values
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-entry-combo-set-values-orig"/>gnome_db_entry_combo_set_values_orig ()</title>
<indexterm><primary>gnome_db_entry_combo_set_values_orig</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_db_entry_combo_set_values_orig
                                            (<link linkend="GnomeDbEntryCombo">GnomeDbEntryCombo</link> *combo,
                                             <link linkend="GSList">GSList</link> *values);</programlisting>
<para>
Sets the original values of <parameter>combo</parameter> to the specified ones. None of the
values provided in the list is modified.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>combo</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEntryCombo"><type>GnomeDbEntryCombo</type></link> widet
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>values</parameter>&nbsp;:</term>
<listitem><simpara> a list of <link linkend="GValue"><type>GValue</type></link> values
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-entry-combo-get-values-orig"/>gnome_db_entry_combo_get_values_orig ()</title>
<indexterm><primary>gnome_db_entry_combo_get_values_orig</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*     gnome_db_entry_combo_get_values_orig
                                            (<link linkend="GnomeDbEntryCombo">GnomeDbEntryCombo</link> *combo);</programlisting>
<para>
Get the original values stored within <parameter>combo</parameter>. The returned values are the ones
within <parameter>combo</parameter>, so they must not be freed afterwards; the list has to be freed afterwards.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>combo</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEntryCombo"><type>GnomeDbEntryCombo</type></link> widet
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new list of values
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-entry-combo-set-values-default"/>gnome_db_entry_combo_set_values_default ()</title>
<indexterm><primary>gnome_db_entry_combo_set_values_default</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_db_entry_combo_set_values_default
                                            (<link linkend="GnomeDbEntryCombo">GnomeDbEntryCombo</link> *combo,
                                             <link linkend="GSList">GSList</link> *values);</programlisting>
<para>
Sets the default values of <parameter>combo</parameter> to the specified ones. None of the
values provided in the list is modified.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>combo</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEntryCombo"><type>GnomeDbEntryCombo</type></link> widet
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>values</parameter>&nbsp;:</term>
<listitem><simpara> a list of <link linkend="GValue"><type>GValue</type></link> values
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1>
<title>Properties</title>
<variablelist>
<varlistentry><term><anchor id="GnomeDbEntryCombo--set-default-if-invalid"/>&quot;<literal>set-default-if-invalid</literal>&quot; (<link linkend="gboolean">gboolean</link> : Read / Write)</term>
<listitem>
<para></para>
</listitem></varlistentry>

</variablelist>
</refsect1>




</refentry>
