File: gda-data-model.xml

package info (click to toggle)
libgda2 1.2.4-1.2
links: PTS
area: main
in suites: lenny
size: 13,724 kB
ctags: 6,979
sloc: ansic: 47,166; xml: 19,896; sh: 8,797; makefile: 863; yacc: 202; lex: 129; cpp: 73
file content (810 lines) | stat: -rw-r--r-- 56,120 bytes
<refentry id="libgda-GdaDataModel">
<refmeta>
<refentrytitle role="top_of_page" id="libgda-GdaDataModel.top_of_page">GdaDataModel</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGDA Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GdaDataModel</refname>
<refpurpose>Basic data model class</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="libgda-GdaDataModel.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="GdaDataModelPrivate">GdaDataModelPrivate</link>;
<link linkend="void">void</link>                <link linkend="gda-data-model-changed">gda_data_model_changed</link>              (<link linkend="GdaDataModel">GdaDataModel</link> *model);
<link linkend="void">void</link>                <link linkend="gda-data-model-row-inserted">gda_data_model_row_inserted</link>         (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> row);
<link linkend="void">void</link>                <link linkend="gda-data-model-row-updated">gda_data_model_row_updated</link>          (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> row);
<link linkend="void">void</link>                <link linkend="gda-data-model-row-removed">gda_data_model_row_removed</link>          (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> row);
<link linkend="void">void</link>                <link linkend="gda-data-model-column-inserted">gda_data_model_column_inserted</link>      (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col);
<link linkend="void">void</link>                <link linkend="gda-data-model-column-updated">gda_data_model_column_updated</link>       (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col);
<link linkend="void">void</link>                <link linkend="gda-data-model-column-removed">gda_data_model_column_removed</link>       (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col);
<link linkend="void">void</link>                <link linkend="gda-data-model-freeze">gda_data_model_freeze</link>               (<link linkend="GdaDataModel">GdaDataModel</link> *model);
<link linkend="void">void</link>                <link linkend="gda-data-model-thaw">gda_data_model_thaw</link>                 (<link linkend="GdaDataModel">GdaDataModel</link> *model);
<link linkend="gint">gint</link>                <link linkend="gda-data-model-get-n-rows">gda_data_model_get_n_rows</link>           (<link linkend="GdaDataModel">GdaDataModel</link> *model);
<link linkend="gint">gint</link>                <link linkend="gda-data-model-get-n-columns">gda_data_model_get_n_columns</link>        (<link linkend="GdaDataModel">GdaDataModel</link> *model);
<link linkend="GdaFieldAttributes">GdaFieldAttributes</link>* <link linkend="gda-data-model-describe-column">gda_data_model_describe_column</link>      (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col);
const <link linkend="gchar">gchar</link>*        <link linkend="gda-data-model-get-column-title">gda_data_model_get_column_title</link>     (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col);
<link linkend="void">void</link>                <link linkend="gda-data-model-set-column-title">gda_data_model_set_column_title</link>     (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col,
                                                         const <link linkend="gchar">gchar</link> *title);
<link linkend="gint">gint</link>                <link linkend="gda-data-model-get-column-position">gda_data_model_get_column_position</link>  (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         const <link linkend="gchar">gchar</link> *title);
const <link linkend="GdaRow">GdaRow</link>*       <link linkend="gda-data-model-get-row">gda_data_model_get_row</link>              (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> row);
const <link linkend="GdaValue">GdaValue</link>*     <link linkend="gda-data-model-get-value-at">gda_data_model_get_value_at</link>         (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col,
                                                         <link linkend="gint">gint</link> row);
<link linkend="gboolean">gboolean</link>            <link linkend="gda-data-model-is-updatable">gda_data_model_is_updatable</link>         (<link linkend="GdaDataModel">GdaDataModel</link> *model);
const <link linkend="GdaRow">GdaRow</link>*       <link linkend="gda-data-model-append-row">gda_data_model_append_row</link>           (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         const <link linkend="GList">GList</link> *values);
<link linkend="gboolean">gboolean</link>            <link linkend="gda-data-model-remove-row">gda_data_model_remove_row</link>           (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         const <link linkend="GdaRow">GdaRow</link> *row);
<link linkend="gboolean">gboolean</link>            <link linkend="gda-data-model-update-row">gda_data_model_update_row</link>           (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         const <link linkend="GdaRow">GdaRow</link> *row);
<link linkend="gboolean">gboolean</link>            <link linkend="gda-data-model-append-column">gda_data_model_append_column</link>        (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         const <link linkend="GdaFieldAttributes">GdaFieldAttributes</link> *attrs);
<link linkend="gboolean">gboolean</link>            <link linkend="gda-data-model-update-column">gda_data_model_update_column</link>        (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col,
                                                         const <link linkend="GdaFieldAttributes">GdaFieldAttributes</link> *attrs);
<link linkend="gboolean">gboolean</link>            <link linkend="gda-data-model-remove-column">gda_data_model_remove_column</link>        (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col);
<link linkend="gboolean">gboolean</link>            (<link linkend="GdaDataModelForeachFunc">*GdaDataModelForeachFunc</link>)          (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="GdaRow">GdaRow</link> *row,
                                                         <link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link>                <link linkend="gda-data-model-foreach">gda_data_model_foreach</link>              (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="GdaDataModelForeachFunc">GdaDataModelForeachFunc</link> func,
                                                         <link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link>            <link linkend="gda-data-model-has-changed">gda_data_model_has_changed</link>          (<link linkend="GdaDataModel">GdaDataModel</link> *model);
<link linkend="gboolean">gboolean</link>            <link linkend="gda-data-model-begin-update">gda_data_model_begin_update</link>         (<link linkend="GdaDataModel">GdaDataModel</link> *model);
<link linkend="gboolean">gboolean</link>            <link linkend="gda-data-model-cancel-update">gda_data_model_cancel_update</link>        (<link linkend="GdaDataModel">GdaDataModel</link> *model);
<link linkend="gboolean">gboolean</link>            <link linkend="gda-data-model-end-update">gda_data_model_end_update</link>           (<link linkend="GdaDataModel">GdaDataModel</link> *model);
<link linkend="gchar">gchar</link>*              <link linkend="gda-data-model-to-comma-separated">gda_data_model_to_comma_separated</link>   (<link linkend="GdaDataModel">GdaDataModel</link> *model);
<link linkend="gchar">gchar</link>*              <link linkend="gda-data-model-to-tab-separated">gda_data_model_to_tab_separated</link>     (<link linkend="GdaDataModel">GdaDataModel</link> *model);
<link linkend="gchar">gchar</link>*              <link linkend="gda-data-model-to-xml">gda_data_model_to_xml</link>               (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gboolean">gboolean</link> standalone);
<link linkend="xmlNodePtr">xmlNodePtr</link>          <link linkend="gda-data-model-to-xml-node">gda_data_model_to_xml_node</link>          (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         const <link linkend="gchar">gchar</link> *name);
<link linkend="gboolean">gboolean</link>            <link linkend="gda-data-model-add-data-from-xml-node">gda_data_model_add_data_from_xml_node</link>
                                                        (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="xmlNodePtr">xmlNodePtr</link> node);
const <link linkend="gchar">gchar</link>*        <link linkend="gda-data-model-get-command-text">gda_data_model_get_command_text</link>     (<link linkend="GdaDataModel">GdaDataModel</link> *model);
<link linkend="void">void</link>                <link linkend="gda-data-model-set-command-text">gda_data_model_set_command_text</link>     (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         const <link linkend="gchar">gchar</link> *txt);
<link linkend="GdaCommandType">GdaCommandType</link>      <link linkend="gda-data-model-get-command-type">gda_data_model_get_command_type</link>     (<link linkend="GdaDataModel">GdaDataModel</link> *model);
<link linkend="void">void</link>                <link linkend="gda-data-model-set-command-type">gda_data_model_set_command_type</link>     (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="GdaCommandType">GdaCommandType</link> type);
</synopsis>
</refsynopsisdiv>









<refsect1 id="libgda-GdaDataModel.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="libgda-GdaDataModel.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GdaDataModelPrivate" role="struct">
<title>GdaDataModelPrivate</title>
<indexterm zone="GdaDataModelPrivate"><primary>GdaDataModelPrivate</primary></indexterm><programlisting>typedef struct _GdaDataModelPrivate GdaDataModelPrivate;</programlisting>
<para>

</para></refsect2>
<refsect2 id="gda-data-model-changed" role="function">
<title>gda_data_model_changed ()</title>
<indexterm zone="gda-data-model-changed"><primary>gda_data_model_changed</primary></indexterm><programlisting><link linkend="void">void</link>                gda_data_model_changed              (<link linkend="GdaDataModel">GdaDataModel</link> *model);</programlisting>
<para>
Notifies listeners of the given data model object of changes
in the underlying data. Listeners usually will connect
themselves to the "changed" signal in the <link linkend="GdaDataModel"><type>GdaDataModel</type></link>
class, thus being notified of any new data being appended
or removed from the data model.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-row-inserted" role="function">
<title>gda_data_model_row_inserted ()</title>
<indexterm zone="gda-data-model-row-inserted"><primary>gda_data_model_row_inserted</primary></indexterm><programlisting><link linkend="void">void</link>                gda_data_model_row_inserted         (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> row);</programlisting>
<para>
Emits the 'row_inserted' and 'changed' signals on <parameter>model</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>row</parameter>&nbsp;:</term>
<listitem><simpara> row number.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-row-updated" role="function">
<title>gda_data_model_row_updated ()</title>
<indexterm zone="gda-data-model-row-updated"><primary>gda_data_model_row_updated</primary></indexterm><programlisting><link linkend="void">void</link>                gda_data_model_row_updated          (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> row);</programlisting>
<para>
Emits the 'row_updated' and 'changed' signals on <parameter>model</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>row</parameter>&nbsp;:</term>
<listitem><simpara> row number.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-row-removed" role="function">
<title>gda_data_model_row_removed ()</title>
<indexterm zone="gda-data-model-row-removed"><primary>gda_data_model_row_removed</primary></indexterm><programlisting><link linkend="void">void</link>                gda_data_model_row_removed          (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> row);</programlisting>
<para>
Emits the 'row_removed' and 'changed' signal on <parameter>model</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>row</parameter>&nbsp;:</term>
<listitem><simpara> row number.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-column-inserted" role="function">
<title>gda_data_model_column_inserted ()</title>
<indexterm zone="gda-data-model-column-inserted"><primary>gda_data_model_column_inserted</primary></indexterm><programlisting><link linkend="void">void</link>                gda_data_model_column_inserted      (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col);</programlisting>
<para>
Emits the 'column_inserted' and 'changed' signals on <parameter>model</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>col</parameter>&nbsp;:</term>
<listitem><simpara> column number.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-column-updated" role="function">
<title>gda_data_model_column_updated ()</title>
<indexterm zone="gda-data-model-column-updated"><primary>gda_data_model_column_updated</primary></indexterm><programlisting><link linkend="void">void</link>                gda_data_model_column_updated       (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col);</programlisting>
<para>
Emits the 'column_updated' and 'changed' signals on <parameter>model</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>col</parameter>&nbsp;:</term>
<listitem><simpara> column number.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-column-removed" role="function">
<title>gda_data_model_column_removed ()</title>
<indexterm zone="gda-data-model-column-removed"><primary>gda_data_model_column_removed</primary></indexterm><programlisting><link linkend="void">void</link>                gda_data_model_column_removed       (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col);</programlisting>
<para>
Emits the 'column_removed' and 'changed' signal on <parameter>model</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>col</parameter>&nbsp;:</term>
<listitem><simpara> column number.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-freeze" role="function">
<title>gda_data_model_freeze ()</title>
<indexterm zone="gda-data-model-freeze"><primary>gda_data_model_freeze</primary></indexterm><programlisting><link linkend="void">void</link>                gda_data_model_freeze               (<link linkend="GdaDataModel">GdaDataModel</link> *model);</programlisting>
<para>
Disables notifications of changes on the given data model. To
re-enable notifications again, you should call the
<link linkend="gda-data-model-thaw"><type>gda_data_model_thaw</type></link> function.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-thaw" role="function">
<title>gda_data_model_thaw ()</title>
<indexterm zone="gda-data-model-thaw"><primary>gda_data_model_thaw</primary></indexterm><programlisting><link linkend="void">void</link>                gda_data_model_thaw                 (<link linkend="GdaDataModel">GdaDataModel</link> *model);</programlisting>
<para>
Re-enables notifications of changes on the given data model.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-get-n-rows" role="function">
<title>gda_data_model_get_n_rows ()</title>
<indexterm zone="gda-data-model-get-n-rows"><primary>gda_data_model_get_n_rows</primary></indexterm><programlisting><link linkend="gint">gint</link>                gda_data_model_get_n_rows           (<link linkend="GdaDataModel">GdaDataModel</link> *model);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the number of rows in the given data model.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-get-n-columns" role="function">
<title>gda_data_model_get_n_columns ()</title>
<indexterm zone="gda-data-model-get-n-columns"><primary>gda_data_model_get_n_columns</primary></indexterm><programlisting><link linkend="gint">gint</link>                gda_data_model_get_n_columns        (<link linkend="GdaDataModel">GdaDataModel</link> *model);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the number of columns in the given data model.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-describe-column" role="function">
<title>gda_data_model_describe_column ()</title>
<indexterm zone="gda-data-model-describe-column"><primary>gda_data_model_describe_column</primary></indexterm><programlisting><link linkend="GdaFieldAttributes">GdaFieldAttributes</link>* gda_data_model_describe_column      (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col);</programlisting>
<para>
Queries the underlying data model implementation for a description
of a given column. That description is returned in the form of
a <link linkend="GdaFieldAttributes"><type>GdaFieldAttributes</type></link> structure, which contains all the information
about the given column in the data model.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>col</parameter>&nbsp;:</term>
<listitem><simpara> column number.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the description of the column.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-get-column-title" role="function">
<title>gda_data_model_get_column_title ()</title>
<indexterm zone="gda-data-model-get-column-title"><primary>gda_data_model_get_column_title</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gda_data_model_get_column_title     (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>col</parameter>&nbsp;:</term>
<listitem><simpara> column number.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the title for the given column in a data model object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-set-column-title" role="function">
<title>gda_data_model_set_column_title ()</title>
<indexterm zone="gda-data-model-set-column-title"><primary>gda_data_model_set_column_title</primary></indexterm><programlisting><link linkend="void">void</link>                gda_data_model_set_column_title     (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col,
                                                         const <link linkend="gchar">gchar</link> *title);</programlisting>
<para>
Sets the <parameter>title</parameter> of the given <parameter>col</parameter> in <parameter>model</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>col</parameter>&nbsp;:</term>
<listitem><simpara> column number
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
<listitem><simpara> title for the given column.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-get-column-position" role="function">
<title>gda_data_model_get_column_position ()</title>
<indexterm zone="gda-data-model-get-column-position"><primary>gda_data_model_get_column_position</primary></indexterm><programlisting><link linkend="gint">gint</link>                gda_data_model_get_column_position  (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         const <link linkend="gchar">gchar</link> *title);</programlisting>
<para>
Gets the position of a column on the data model, based on
the column's title.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
<listitem><simpara> column title.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the position of the column in the data model, or -1
if the column could not be found.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-get-row" role="function">
<title>gda_data_model_get_row ()</title>
<indexterm zone="gda-data-model-get-row"><primary>gda_data_model_get_row</primary></indexterm><programlisting>const <link linkend="GdaRow">GdaRow</link>*       gda_data_model_get_row              (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> row);</programlisting>
<para>
Retrieves a given row from a data model.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>row</parameter>&nbsp;:</term>
<listitem><simpara> row number.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GdaRow"><type>GdaRow</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-get-value-at" role="function">
<title>gda_data_model_get_value_at ()</title>
<indexterm zone="gda-data-model-get-value-at"><primary>gda_data_model_get_value_at</primary></indexterm><programlisting>const <link linkend="GdaValue">GdaValue</link>*     gda_data_model_get_value_at         (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col,
                                                         <link linkend="gint">gint</link> row);</programlisting>
<para>
Retrieves the data stored in the given position (identified by
the <parameter>col</parameter> and <parameter>row</parameter> parameters) on a data model.
</para>
<para>
This is the main function for accessing data in a model.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>col</parameter>&nbsp;:</term>
<listitem><simpara> column number.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>row</parameter>&nbsp;:</term>
<listitem><simpara> row number.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GdaValue"><type>GdaValue</type></link> containing the value stored in the given
position, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> on error (out-of-bound position, etc).
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-is-updatable" role="function">
<title>gda_data_model_is_updatable ()</title>
<indexterm zone="gda-data-model-is-updatable"><primary>gda_data_model_is_updatable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gda_data_model_is_updatable         (<link linkend="GdaDataModel">GdaDataModel</link> *model);</programlisting>
<para>
Checks whether the given data model can be updated or not.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if it can be updated, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if not.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-append-row" role="function">
<title>gda_data_model_append_row ()</title>
<indexterm zone="gda-data-model-append-row"><primary>gda_data_model_append_row</primary></indexterm><programlisting>const <link linkend="GdaRow">GdaRow</link>*       gda_data_model_append_row           (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         const <link linkend="GList">GList</link> *values);</programlisting>
<para>
Appends a row to the given data model.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>values</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GList"><type>GList</type></link> of <link linkend="GdaValue"><type>GdaValue</type></link>* representing the row to add.  The
         length must match model's column count.  These <link linkend="GdaValue"><type>GdaValue</type></link>
    are value-copied.  The user is still responsible for freeing them.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the added row.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-remove-row" role="function">
<title>gda_data_model_remove_row ()</title>
<indexterm zone="gda-data-model-remove-row"><primary>gda_data_model_remove_row</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gda_data_model_remove_row           (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         const <link linkend="GdaRow">GdaRow</link> *row);</programlisting>
<para>
Removes a row from the data model. This results in the underlying
database row being removed in the database.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>row</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="GdaRow"><type>GdaRow</type></link> to be removed.
</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="gda-data-model-update-row" role="function">
<title>gda_data_model_update_row ()</title>
<indexterm zone="gda-data-model-update-row"><primary>gda_data_model_update_row</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gda_data_model_update_row           (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         const <link linkend="GdaRow">GdaRow</link> *row);</programlisting>
<para>
Updates a row data model. This results in the underlying
database row's values being changed.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>row</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="GdaRow"><type>GdaRow</type></link> to be updated.
</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="gda-data-model-append-column" role="function">
<title>gda_data_model_append_column ()</title>
<indexterm zone="gda-data-model-append-column"><primary>gda_data_model_append_column</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gda_data_model_append_column        (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         const <link linkend="GdaFieldAttributes">GdaFieldAttributes</link> *attrs);</programlisting>
<para>
Appends a column to the given data model.  If successful, the position of
the new column in the data model is set on <parameter>col</parameter>, and you can grab it using
<parameter>gda_field_attributes_get_position</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attrs</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaFieldAttributes"><type>GdaFieldAttributes</type></link> describing the column to add.
</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="gda-data-model-update-column" role="function">
<title>gda_data_model_update_column ()</title>
<indexterm zone="gda-data-model-update-column"><primary>gda_data_model_update_column</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gda_data_model_update_column        (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col,
                                                         const <link linkend="GdaFieldAttributes">GdaFieldAttributes</link> *attrs);</programlisting>
<para>
Updates a column in the given data model. This results in the underlying
database row's values being changed.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>col</parameter>&nbsp;:</term>
<listitem><simpara> the column to be updated.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attrs</parameter>&nbsp;:</term>
<listitem><simpara> attributes for the column.
</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="gda-data-model-remove-column" role="function">
<title>gda_data_model_remove_column ()</title>
<indexterm zone="gda-data-model-remove-column"><primary>gda_data_model_remove_column</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gda_data_model_remove_column        (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gint">gint</link> col);</programlisting>
<para>
Removes a column from the data model. This means that all values attached to this
column in the data model will be destroyed in the underlying database.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>col</parameter>&nbsp;:</term>
<listitem><simpara> the column to be removed.
</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="GdaDataModelForeachFunc" role="function">
<title>GdaDataModelForeachFunc ()</title>
<indexterm zone="GdaDataModelForeachFunc"><primary>GdaDataModelForeachFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            (*GdaDataModelForeachFunc)          (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="GdaRow">GdaRow</link> *row,
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>row</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-foreach" role="function">
<title>gda_data_model_foreach ()</title>
<indexterm zone="gda-data-model-foreach"><primary>gda_data_model_foreach</primary></indexterm><programlisting><link linkend="void">void</link>                gda_data_model_foreach              (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="GdaDataModelForeachFunc">GdaDataModelForeachFunc</link> func,
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Calls the specified callback function for each row in the data model.
This will just traverse all rows, and call the given callback
function for each of them.
</para>
<para>
The callback function must have the following form:
</para>
<para>
     gboolean foreach_func (GdaDataModel *model, GdaRow *row, gpointer user_data)
</para>
<para>
where "row" would be the row being read, and "user_data" the parameter
specified in <parameter>user_data</parameter> in the call to gda_data_model_foreach.
This callback function can return <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> to stop the processing. If
it returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, processing will continue until no rows remain.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>func</parameter>&nbsp;:</term>
<listitem><simpara> callback function.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara> context data for the callback function.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-has-changed" role="function">
<title>gda_data_model_has_changed ()</title>
<indexterm zone="gda-data-model-has-changed"><primary>gda_data_model_has_changed</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gda_data_model_has_changed          (<link linkend="GdaDataModel">GdaDataModel</link> *model);</programlisting>
<para>
Checks whether this data model is in updating mode or not. Updating
mode is set to <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> when <parameter>gda_data_model_begin_update</parameter> has been
called successfully, and is not set back to <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> until either
<parameter>gda_data_model_cancel_update</parameter> or <parameter>gda_data_model_end_update</parameter> have
been called.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if updating mode, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-begin-update" role="function">
<title>gda_data_model_begin_update ()</title>
<indexterm zone="gda-data-model-begin-update"><primary>gda_data_model_begin_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gda_data_model_begin_update         (<link linkend="GdaDataModel">GdaDataModel</link> *model);</programlisting>
<para>
Starts update of this data model. This function should be the
first called when modifying the data model.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if there was an error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-cancel-update" role="function">
<title>gda_data_model_cancel_update ()</title>
<indexterm zone="gda-data-model-cancel-update"><primary>gda_data_model_cancel_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gda_data_model_cancel_update        (<link linkend="GdaDataModel">GdaDataModel</link> *model);</programlisting>
<para>
Cancels update of this data model. This means that all changes
will be discarded, and the old data put back in the model.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if there was an error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-end-update" role="function">
<title>gda_data_model_end_update ()</title>
<indexterm zone="gda-data-model-end-update"><primary>gda_data_model_end_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gda_data_model_end_update           (<link linkend="GdaDataModel">GdaDataModel</link> *model);</programlisting>
<para>
Approves all modifications and send them to the underlying
data source/store.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if there was an error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-to-comma-separated" role="function">
<title>gda_data_model_to_comma_separated ()</title>
<indexterm zone="gda-data-model-to-comma-separated"><primary>gda_data_model_to_comma_separated</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gda_data_model_to_comma_separated   (<link linkend="GdaDataModel">GdaDataModel</link> *model);</programlisting>
<para>
Converts the given model into a comma-separated series of rows.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the representation of the model. You should free this
string when you no longer need it.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-to-tab-separated" role="function">
<title>gda_data_model_to_tab_separated ()</title>
<indexterm zone="gda-data-model-to-tab-separated"><primary>gda_data_model_to_tab_separated</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gda_data_model_to_tab_separated     (<link linkend="GdaDataModel">GdaDataModel</link> *model);</programlisting>
<para>
Converts the given model into a tab-separated series of rows.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the representation of the model. You should free this
string when you no longer need it.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-to-xml" role="function">
<title>gda_data_model_to_xml ()</title>
<indexterm zone="gda-data-model-to-xml"><primary>gda_data_model_to_xml</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gda_data_model_to_xml               (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="gboolean">gboolean</link> standalone);</programlisting>
<para>
Converts the given model into a XML representation.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>standalone</parameter>&nbsp;:</term>
<listitem><simpara> whether ... 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the representation of the model. You should free this
string when you no longer need it.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-to-xml-node" role="function">
<title>gda_data_model_to_xml_node ()</title>
<indexterm zone="gda-data-model-to-xml-node"><primary>gda_data_model_to_xml_node</primary></indexterm><programlisting><link linkend="xmlNodePtr">xmlNodePtr</link>          gda_data_model_to_xml_node          (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Converts a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> into a xmlNodePtr (as used in libxml).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara> name to use for the XML resulting table.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a xmlNodePtr representing the whole data model.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-add-data-from-xml-node" role="function">
<title>gda_data_model_add_data_from_xml_node ()</title>
<indexterm zone="gda-data-model-add-data-from-xml-node"><primary>gda_data_model_add_data_from_xml_node</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gda_data_model_add_data_from_xml_node
                                                        (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="xmlNodePtr">xmlNodePtr</link> node);</programlisting>
<para>
Adds the data from a XML node to the given data model.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>node</parameter>&nbsp;:</term>
<listitem><simpara> a XML node representing a &amp;lt;data&amp;gt; XML node.
</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="gda-data-model-get-command-text" role="function">
<title>gda_data_model_get_command_text ()</title>
<indexterm zone="gda-data-model-get-command-text"><primary>gda_data_model_get_command_text</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gda_data_model_get_command_text     (<link linkend="GdaDataModel">GdaDataModel</link> *model);</programlisting>
<para>
Gets the text of command that generated this data model.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a string with the command issued.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-set-command-text" role="function">
<title>gda_data_model_set_command_text ()</title>
<indexterm zone="gda-data-model-set-command-text"><primary>gda_data_model_set_command_text</primary></indexterm><programlisting><link linkend="void">void</link>                gda_data_model_set_command_text     (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         const <link linkend="gchar">gchar</link> *txt);</programlisting>
<para>
Sets the command text of the given <parameter>model</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>txt</parameter>&nbsp;:</term>
<listitem><simpara> the command text.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-get-command-type" role="function">
<title>gda_data_model_get_command_type ()</title>
<indexterm zone="gda-data-model-get-command-type"><primary>gda_data_model_get_command_type</primary></indexterm><programlisting><link linkend="GdaCommandType">GdaCommandType</link>      gda_data_model_get_command_type     (<link linkend="GdaDataModel">GdaDataModel</link> *model);</programlisting>
<para>
Gets the type of command that generated this data model.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GdaCommandType"><type>GdaCommandType</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-data-model-set-command-type" role="function">
<title>gda_data_model_set_command_type ()</title>
<indexterm zone="gda-data-model-set-command-type"><primary>gda_data_model_set_command_type</primary></indexterm><programlisting><link linkend="void">void</link>                gda_data_model_set_command_type     (<link linkend="GdaDataModel">GdaDataModel</link> *model,
                                                         <link linkend="GdaCommandType">GdaCommandType</link> type);</programlisting>
<para>
Sets the type of command that generated this data model.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdaDataModel"><type>GdaDataModel</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> the type of the command (one of <link linkend="GdaCommandType"><type>GdaCommandType</type></link>)
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>