/usr/include/libgda-5.0/libgda/gda-data-proxy.h is in libgda-5.0-dev 5.2.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 | /*
* Copyright (C) 2006 - 2007 Murray Cumming <murrayc@murrayc.com>
* Copyright (C) 2006 - 2012 Vivien Malerba <malerba@gnome-db.org>
* Copyright (C) 2012 Daniel Espinosa <despinosa@src.gnome.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GDA_DATA_PROXY_H_
#define __GDA_DATA_PROXY_H_
#include "gda-decl.h"
#include <glib-object.h>
#include <libgda/gda-value.h>
#include <libgda/gda-enums.h>
G_BEGIN_DECLS
#define GDA_TYPE_DATA_PROXY (gda_data_proxy_get_type())
#define GDA_DATA_PROXY(obj) G_TYPE_CHECK_INSTANCE_CAST (obj, gda_data_proxy_get_type(), GdaDataProxy)
#define GDA_DATA_PROXY_CLASS(klass) G_TYPE_CHECK_CLASS_CAST (klass, gda_data_proxy_get_type (), GdaDataProxyClass)
#define GDA_IS_DATA_PROXY(obj) G_TYPE_CHECK_INSTANCE_TYPE (obj, gda_data_proxy_get_type ())
/* error reporting */
extern GQuark gda_data_proxy_error_quark (void);
#define GDA_DATA_PROXY_ERROR gda_data_proxy_error_quark ()
typedef enum {
GDA_DATA_PROXY_COMMIT_ERROR,
GDA_DATA_PROXY_COMMIT_CANCELLED,
GDA_DATA_PROXY_READ_ONLY_VALUE,
GDA_DATA_PROXY_READ_ONLY_ROW,
GDA_DATA_PROXY_FILTER_ERROR
} GdaDataProxyError;
/* struct for the object's data */
struct _GdaDataProxy
{
GObject object;
GdaDataProxyPrivate *priv;
};
/* struct for the object's class */
struct _GdaDataProxyClass
{
GObjectClass parent_class;
void (* row_delete_changed) (GdaDataProxy *proxy, gint row, gboolean to_be_deleted);
void (* sample_size_changed) (GdaDataProxy *proxy, gint sample_size);
void (* sample_changed) (GdaDataProxy *proxy, gint sample_start, gint sample_end);
GError *(* validate_row_changes) (GdaDataProxy *proxy, gint row, gint proxied_row);
void (* row_changes_applied) (GdaDataProxy *proxy, gint row, gint proxied_row);
void (* filter_changed) (GdaDataProxy *proxy);
/*< private >*/
/* Padding for future expansion */
void (*_gda_reserved1) (void);
void (*_gda_reserved2) (void);
void (*_gda_reserved3) (void);
void (*_gda_reserved4) (void);
};
/**
* SECTION:gda-data-proxy
* @short_description: Proxy to hold modifications for any #GdaDataModel, providing the #GdaDataModel interface itself
* @title: GdaDataProxy
* @stability: Stable
* @see_also: #GdaDataModel
*
* This object stores modifications to be made to a #GdaDataModel object which is proxied until the modifications are actually
* written to the #GdaDataModel, it can also filter the proxied data model to show only a subset (a defined number of continuous
* rows or by a filter to apply).
*
* Specifically, for a proxied data model having <varname>nb_cols</varname> columns and <varname>nb_rows</varname> rows,
* the #GdaDataProxy object has the following attributes:
* <itemizedlist>
* <listitem>
* <para><varname>2 * nb_cols</varname> columns:
* <itemizedlist>
* <listitem><para>the first (>= 0) <varname>nb_cols</varname> columns are the current values stored in the
* proxy (which correspond to the values of the proxied data model if the considered row has not been
* changed). The associated values are writable.</para></listitem>
* <listitem><para>the last <varname>nb_cols</varname> columns are the values stored in the proxied data model,
* at column <varname>col - nb_cols</varname></para></listitem>
* </itemizedlist>
* </para>
* </listitem>
* <listitem><para>a variable number of rows depending on the following attributes:
* <itemizedlist>
* <listitem><para>if the proxy is configured to have an empty row as the first row</para></listitem>
* <listitem><para>if the proxy only displays parts of the proxied data model</para></listitem>
* <listitem><para>if new rows have been added to the proxy</para></listitem>
* </itemizedlist>
* </para></listitem>
* <listitem><para>Any #GdaDataModelIter iterator created will only make appear the colmuns as present in the proxied
* data model, not any of the other columns</para></listitem>
* </itemizedlist>
* This situation is illustrated in the following schema, where there is a direct mapping between the proxy's
* rows and the proxied data model's rows:
* <mediaobject>
* <imageobject role="html">
* <imagedata fileref="data_proxy1.png" format="PNG" contentwidth="170mm"/>
* </imageobject>
* <textobject>
* <phrase>GdaDataProxy's values mapping regarding the proxied data model</phrase>
* </textobject>
* </mediaobject>
*
* Note that unless explicitly mentioned, the columns are read-only.
*
* The following figures illustrate row mappings between the data proxy and the proxied data model in
* several situations (which can be combined, but are shown alone for simplicity):
* <itemizedlist>
* <listitem><para>situation where rows 1 and 5 have been marked as deleted from the data proxy, using
* <link linkend="gda-data-proxy-delete">gda_data_proxy_delete()</link> method, the data
* proxy has 2 rows less than the proxied data model:
* <mediaobject>
* <imageobject role="html">
* <imagedata fileref="data_proxy2.png" format="PNG" contentwidth="100mm"/>
* </imageobject>
* <textobject>
* <phrase>GdaDataProxy with 2 rows marked as deleted</phrase>
* </textobject>
* </mediaobject>
* </para></listitem>
* <listitem><para>situation where the data proxy only shows a sample of the proxied data model
* at any given time, using the
* <link linkend="gda-data-proxy-set-sample-size">gda_data_proxy_set_sample_size()</link> method
* (the sample here is 4 rows wide, and starts at row 3):
* <mediaobject>
* <imageobject role="html">
* <imagedata fileref="data_proxy3.png" format="PNG" contentwidth="100mm"/>
* </imageobject>
* <textobject>
* <phrase>GdaDataProxy with a sample size of 4</phrase>
* </textobject>
* </mediaobject>
* </para></listitem>
* <listitem><para>situation where the data proxy shows a row of NULL values, using the
* <link linkend="GdaDataproxy-prepend-null-entry">"prepend-null-entry"</link> property:
* <mediaobject>
* <imageobject role="html">
* <imagedata fileref="data_proxy4.png" format="PNG" contentwidth="100mm"/>
* </imageobject>
* <textobject>
* <phrase>GdaDataProxy with an extra row of NULL values</phrase>
* </textobject>
* </mediaobject>
* </para></listitem>
* <listitem><para>situation where a row has been added to the data proxy, using for example the
* <link linkend="gda-data-model-append-row">gda_data_model_append_row()</link> method:
* <mediaobject>
* <imageobject role="html">
* <imagedata fileref="data_proxy5.png" format="PNG" contentwidth="100mm"/>
* </imageobject>
* <textobject>
* <phrase>GdaDataProxy where a row has been added</phrase>
* </textobject>
* </mediaobject>
* </para></listitem>
* </itemizedlist>
*
* The #GdaDataProxy objects are thread safe, which means any proxy object can be used from
* any thread at the same time as they implement their own locking mechanisms.
*/
GType gda_data_proxy_get_type (void) G_GNUC_CONST;
GObject *gda_data_proxy_new (GdaDataModel *model);
GdaDataProxy *gda_data_proxy_new_with_data_model (GdaDataModel *model);
GdaDataModel *gda_data_proxy_get_proxied_model (GdaDataProxy *proxy);
gint gda_data_proxy_get_proxied_model_n_cols (GdaDataProxy *proxy);
gint gda_data_proxy_get_proxied_model_n_rows (GdaDataProxy *proxy);
gboolean gda_data_proxy_is_read_only (GdaDataProxy *proxy);
GSList *gda_data_proxy_get_values (GdaDataProxy *proxy, gint proxy_row,
gint *cols_index, gint n_cols);
GdaValueAttribute gda_data_proxy_get_value_attributes (GdaDataProxy *proxy, gint proxy_row, gint col);
void gda_data_proxy_alter_value_attributes (GdaDataProxy *proxy, gint proxy_row, gint col, GdaValueAttribute alter_flags);
gint gda_data_proxy_get_proxied_model_row (GdaDataProxy *proxy, gint proxy_row);
void gda_data_proxy_delete (GdaDataProxy *proxy, gint proxy_row);
void gda_data_proxy_undelete (GdaDataProxy *proxy, gint proxy_row);
gboolean gda_data_proxy_row_is_deleted (GdaDataProxy *proxy, gint proxy_row);
gboolean gda_data_proxy_row_is_inserted (GdaDataProxy *proxy, gint proxy_row);
gboolean gda_data_proxy_row_has_changed (GdaDataProxy *proxy, gint proxy_row);
gboolean gda_data_proxy_has_changed (GdaDataProxy *proxy);
gint gda_data_proxy_get_n_new_rows (GdaDataProxy *proxy);
gint gda_data_proxy_get_n_modified_rows (GdaDataProxy *proxy);
gboolean gda_data_proxy_apply_row_changes (GdaDataProxy *proxy, gint proxy_row, GError **error);
void gda_data_proxy_cancel_row_changes (GdaDataProxy *proxy, gint proxy_row, gint col);
gboolean gda_data_proxy_apply_all_changes (GdaDataProxy *proxy, GError **error);
gboolean gda_data_proxy_cancel_all_changes (GdaDataProxy *proxy);
void gda_data_proxy_set_sample_size (GdaDataProxy *proxy, gint sample_size);
gint gda_data_proxy_get_sample_size (GdaDataProxy *proxy);
void gda_data_proxy_set_sample_start (GdaDataProxy *proxy, gint sample_start);
gint gda_data_proxy_get_sample_start (GdaDataProxy *proxy);
gint gda_data_proxy_get_sample_end (GdaDataProxy *proxy);
gboolean gda_data_proxy_set_filter_expr (GdaDataProxy *proxy, const gchar *filter_expr, GError **error);
const gchar *gda_data_proxy_get_filter_expr (GdaDataProxy *proxy);
gboolean gda_data_proxy_set_ordering_column (GdaDataProxy *proxy, gint col, GError **error);
gint gda_data_proxy_get_filtered_n_rows (GdaDataProxy *proxy);
G_END_DECLS
#endif
|