rpms/libgda
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2ceec0b677
libgda/libgda-5.0.4-missing-doc-files.patch

248 lines
12 KiB
Diff
Raw Blame History

diff -Nru libgda-5.0.4.orig/doc/C/data-model-writing.xml libgda-5.0.4/doc/C/data-model-writing.xml
--- libgda-5.0.4.orig/doc/C/data-model-writing.xml 1970-01-01 01:00:00.000000000 +0100
+++ libgda-5.0.4/doc/C/data-model-writing.xml 2013-07-18 02:34:39.868134274 +0200
@@ -0,0 +1,199 @@
+<?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"[
+<!ENTITY LIBGDA "<application>Libgda</application>">
+]>
+<sect1 id="gda-data-model-writing">
+ <title>Implementing your own data model</title>
+ <para>
+ You may need at some point to implement your own data model because the implementations in
+ &LIBGDA; don't suit your needs. This section is dedicated to explaining to you how this can be done.
+ </para>
+ <para>
+ Implementing a new <link linkend="GdaDataModel">GdaDataModel</link> is simply a matter of
+ creating a new GObject which implements the <link linkend="GdaDataModel">GdaDataModel</link>
+ interface, which is described below. Thos new class needs to inherit GObject, but needs not
+ be direct descendant of it. The way to subclass an object using GLib
+ is not covered in this documentation, for this matter reref to
+ <link linkend="howto-gobject-code">GObject's documentation</link>, or
+ <ulink url="http://developer.gnome.org/gobject/stable/howto-gobject.html">online</ulink>.
+ </para>
+
+ <sect2 id="gda-data-model-writing-virtual-methods">
+ <title>Virtual methods</title>
+ <para>
+ The interface's methods which can and/or need to be implemented are defined below.
+ </para>
+
+ <sect3 id="i_get_n_rows">
+ <title>i_get_n_rows() - optional</title>
+ <para>This method, if implemented, returns the total number of rows in the data model, or -1 if
+ unknown. If it's not implemented, then it is assumed that -1 is returned in all cases.</para>
+ </sect3>
+
+ <sect3 id="i_get_n_columns">
+ <title>i_get_n_columns() - required</title>
+ <para>This method, returns the total number of columns in the data model, or -1 if unknown.</para>
+ </sect3>
+
+ <sect3 id="i_describe_column">
+ <title>i_describe_column() - required</title>
+ <para>This method describes a column; it returns (without any ownership to the caller) a
+ <link linkend="GdaColumn">GdaColumn</link> for each existing column, or NULL otherwise.</para>
+ </sect3>
+
+ <sect3 id="i_get_access_flags">
+ <title>i_get_access_flags() - required</title>
+ <para>This method defines how the data model may be accessed (randomly, only using a cursor, ...)</para>
+ </sect3>
+
+ <sect3 id="i_get_value_at">
+ <title>i_get_value_at() - required for random access</title>
+ <para>This method is used to access the contents of a data model, specifically
+ a <link linkend="GValue">GValue</link> is returned for each (column,row) position.
+ It must return NULL if the data model experienced an error for the specific (column,row)
+ position. See <link linkend="gda-data-model-get-value-at">gda_data_model_get_value_at()</link>
+ for more information about the lifetime of the returned GValue.</para>
+ </sect3>
+
+ <sect3 id="i_get_attributes_at">
+ <title>i_get_attributes_at() - optional</title>
+ <para>This method returns, for a (column,row) position in the data model, the attributes
+ of the adressed "cell".</para>
+ </sect3>
+
+ <sect3 id="i_create_iter">
+ <title>i_create_iter() - optional</title>
+ <para>This method can be implemented to create specific
+ <link linkend="GdaDataModelIter">GdaDataModelIter</link> or to customize them.</para>
+ </sect3>
+
+ <sect3 id="i_iter_at_row">
+ <title>i_iter_at_row() - optional</title>
+ <para>This method can be implemented if a specific implementation allows an iterator
+ to be moved quickly to a specific row (faster than iterating from row to row to the
+ requested row).</para>
+ </sect3>
+
+ <sect3 id="i_iter_next">
+ <title>i_iter_next() - required for cursor based access</title>
+ <para>This method is called to move an iterator to the next row; it's not necessary to
+ implement it if the data models supports random access.</para>
+ </sect3>
+
+ <sect3 id="i_iter_prev">
+ <title>i_iter_prev() - optional for cursor based access</title>
+ <para>This method is called to move an iterator to the previous row. It is only necessary to
+ implement it if the data model does not support random access and supports moving the
+ cursor backward.</para>
+ </sect3>
+
+ <sect3 id="i_set_value_at">
+ <title>i_set_value_at() - optional</title>
+ <para>This method needs to be defined if the data model allows each value in a (column,row) position
+ to be modified individually.
+ </para>
+ </sect3>
+
+ <sect3 id="i_iter_set_value">
+ <title>i_iter_set_value() - optional</title>
+ <para>This method can be defined if a specific treatment is required when a modification made
+ to a <link linkend="GdaDataModelIter">GdaDataModelIter</link> is propagated to the data model.
+ It should seldom, if ever, be necessary to implement it.</para>
+ </sect3>
+
+ <sect3 id="i_set_values">
+ <title>i_set_values() - optional</title>
+ <para>This method needs to be defined if the data model allows modifications to be made for
+ one complete row at a time. See the
+ <link linkend="gda-data-model-set-values">gda_data_model_set_values()</link> method for
+ more information about the arguments</para>
+ </sect3>
+
+ <sect3 id="i_append_values">
+ <title>i_append_values() - optional</title>
+ <para>This method can be implemented if the data model needs to support adding a row and defining the
+ values to be added in the same operation.
+ See <link linkend="gda-data-model-append-values">gda_data_model_append_values()</link> for
+ more information.</para>
+ </sect3>
+
+ <sect3 id="i_append_row">
+ <title>i_append_row() - optional</title>
+ <para>This method needs to be defined if the data model needs to support adding an empty row (i.e.
+ without any value specified in the new row).</para>
+ </sect3>
+
+ <sect3 id="i_remove_row">
+ <title>i_remove_row() - optional</title>
+ <para>This method should be implemented if the data model needs to support row removal.</para>
+ </sect3>
+
+ <sect3 id="i_find_row">
+ <title>i_find_row() - optional</title>
+ <para>This method can be implemented if the data model implements an indexing scheme which
+ allows it to find rows from values quickly than by analysing each row after another to
+ find the requested values.</para>
+ </sect3>
+
+ <sect3 id="i_set_notify">
+ <title>i_set_notify() - optional</title>
+ <para>This method should be implemented if the data model needs to honor the
+ <link linkend="gda-data-model-freeze">gda_data_model_freeze()</link> and
+ <link linkend="gda-data-model-thaw">gda_data_model_thaw()</link> methods. If
+ this method is not implemented, then these two methods will have no effect.
+ </para>
+ </sect3>
+
+ <sect3 id="i_get_notify">
+ <title>i_get_notify() - optional</title>
+ <para>This method should be implemented if the data model needs to honor the
+ <link linkend="gda-data-model-freeze">gda_data_model_freeze()</link> and
+ <link linkend="gda-data-model-thaw">gda_data_model_thaw()</link> methods. If
+ this method is not implemented, then these two methods will have no effect.</para>
+ </sect3>
+
+ <sect3 id="i_send_hint">
+ <title>i_send_hint() - optional</title>
+ <para>This method should be implemented if the data model needs to be able to treat
+ hints, see <link linkend="gda-data-model-send-hint">gda_data_model_send_hint()</link> for
+ more information</para>
+ </sect3>
+
+ <sect3 id="i_get_exceptions">
+ <title>i_get_exceptions() - optional</title>
+ <para>This method needs to be implemented if the data model keeps exceptions about the errors
+ it has encountered and may "export" these exceptions using the
+ <link linkend="gda-data-model-get-exceptions">gda_data_model_get_exceptions()</link> method.</para>
+ </sect3>
+ </sect2>
+
+ <sect2 id="gda-data-model-writing-signalling">
+ <title>Signalling changes</title>
+ <para>
+ When the data model changes, it needs to signal its changes. However, only the changes from
+ the initial state need to be notified, in situations such as:
+ <itemizedlist>
+ <listitem><para>a row which has already been accessed is modified or removed</para></listitem>
+ <listitem><para>the total number of rows changes, and that number has already been obtained and
+ was known (i.e. different than -1)</para></listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ To signal changes, one of the following methods has to be used:
+ <itemizedlist>
+ <listitem><para><link linkend="gda-data-model-row-inserted">gda_data_model_row_inserted()</link>: to be called after a row has been inserted</para></listitem>
+ <listitem><para><link linkend="gda-data-model-row-updated">gda_data_model_row_updated()</link>: to be called after a row has been updated</para></listitem>
+ <listitem><para><link linkend="gda-data-model-row-removed">gda_data_model_row_removed()</link>: to be called after a row has been removed</para></listitem>
+ <listitem><para><link linkend="gda-data-model-reset">gda_data_model_reset()</link>: to be called
+ when the data model has changed in a way it's not possible or desirable to signal all the changes
+ using any combination of the above methods (for example when the whole contents has changed, or
+ when the number and/or types of columns has changed)</para></listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ Moreover, when the data model's access flags have changed, the implementation should signal it by
+ emitting the <link linkend="GdaDataModel-access-changed">"access-changed"</link> signal.
+ </para>
+ </sect2>
+</sect1>
diff -Nru libgda-5.0.4.orig/doc/C/migration3.xml libgda-5.0.4/doc/C/migration3.xml
--- libgda-5.0.4.orig/doc/C/migration3.xml 1970-01-01 01:00:00.000000000 +0100
+++ libgda-5.0.4/doc/C/migration3.xml 2013-07-18 02:34:28.803238296 +0200
@@ -0,0 +1,40 @@
+<?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"[
+<!ENTITY LIBGDA "<application>Libgda</application>">
+]>
+<chapter id="migration-3" xmlns:xi="http://www.w3.org/2003/XInclude">
+ <title>Migration from 4.X versions</title>
+ <sect1><title>Overview</title>
+ <para>Version 5.0 of &LIBGDA; is a small evolution to adapt to the GTK3 environment; as such it is API
+ compatible with versions 4.0.x or 4.2.x. However there are some few behavioural changes explicited
+ below.
+ </para>
+ </sect1>
+
+ <sect1><title>GDA_TYPE_NULL</title>
+ <para>
+ Previous versions of &LIBGDA; represented SQL NULL values as a <link linkend="GValue">GValue</link> completely filled
+ with zeros (i.e. of type G_TYPE_INVALID), and GDA_TYPE_NULL was thus equivalent to G_TYPE_INVALID.
+ </para>
+ <para>
+ This new version introduces a new specific type for the same GDA_TYPE_NULL (which means
+ GDA_TYPE_NULL no longer equals G_TYPE_INVALID). The most common sources of errors brought by this
+ change are:
+ <itemizedlist>
+ <listitem><para>if you used <link linkend="g-value-init">g_value_init()</link> on a
+ value of type GDA_TYPE_NULL, then you'll have to eight clear the value first, or replace
+ that call with a call to <link linkend="gda-value-reset-with-type">gda_value_reset_with_type()</link></para></listitem>
+ <listitem><para>the <link linkend="gda-g-type-from-string">gda_g_type_from_string()</link> function
+ now returns G_TYPE_INVALID if it does not know how to interpret the argument, so testing the return
+ value now also involves testing for the G_TYPE_INVALID value.</para></listitem>
+ <listitem><para>creating a GValue using <link linkend="g-new0">g_new0()</link> resulted
+ in a GDA_TYPE_NULL value, which is not longer the case; the value needs to be initialized
+ with a call to <link linkend="g-value-init">g_value_init()</link></para></listitem>
+ <listitem><para>testing for NULL values using G_IS_VALUE does not work anymore, you'll have to
+ replace them with <link linkend="GDA-VALUE-HOLDS-NULL:CAPS">GDA_VALUE_HOLDS_NULL()</link></para></listitem>
+ </itemizedlist>
+ </para>
+ </sect1>
+
+</chapter>
Reference in New Issue View Git Blame Copy Permalink