GNOME.org
 

[libgda] GdaBrowser: updated the hacking documentation

commit 8040f1725b369b13ac940ebff8ed2e9dc6aa9258
Author: Vivien Malerba <malerba gnome-db org>
Date:   Wed Jan 19 21:27:16 2011 +0100

    GdaBrowser: updated the hacking documentation

 tools/browser/browser-connection.c                 |    2 +-
 tools/browser/doc/Makefile.am                      |   14 +++-
 tools/browser/doc/gda-browser-docs.sgml            |   34 +++++++-
 tools/browser/doc/gda-browser-sections.txt         |   89 ++++++++++++++++++++
 tools/browser/doc/gda-browser.types                |   16 ++++
 tools/browser/doc/tmpl/browser-connection.sgml     |    4 +-
 tools/browser/doc/tmpl/browser-favorites.sgml      |   38 ++++++++
 .../browser/doc/tmpl/data-manager-perspective.sgml |    4 +-
 8 files changed, 191 insertions(+), 10 deletions(-)
---
diff --git a/tools/browser/browser-connection.c b/tools/browser/browser-connection.c
index becd1bb..f161732 100644
--- a/tools/browser/browser-connection.c
+++ b/tools/browser/browser-connection.c
@@ -241,7 +241,7 @@ browser_connection_class_init (BrowserConnectionClass *klass)
 	g_object_class_install_property (object_class, PROP_GDA_CNC,
                                          g_param_spec_object ("gda-connection", NULL, "Connection to use",
                                                               GDA_TYPE_CONNECTION,
-                                                              G_PARAM_READABLE | G_PARAM_WRITABLE |
+                                                              G_PARAM_WRITABLE |
 							      G_PARAM_CONSTRUCT_ONLY));
 
 	object_class->dispose = browser_connection_dispose;
diff --git a/tools/browser/doc/Makefile.am b/tools/browser/doc/Makefile.am
index c0faf2d..d4b470f 100644
--- a/tools/browser/doc/Makefile.am
+++ b/tools/browser/doc/Makefile.am
@@ -22,7 +22,7 @@ HFILE_GLOB=
 CFILE_GLOB=
 
 # Header files to ignore when scanning
-IGNORE_HFILES= marshal.h canvas dummy-perspective schema-browser query-exec
+IGNORE_HFILES= marshal.h canvas dummy-perspective
 
 # CFLAGS and LDFLAGS for compiling scan program. Only needed
 # if $(DOC_MODULE).types is non-empty.
@@ -33,13 +33,23 @@ GTKDOC_CFLAGS = -I$(top_srcdir) \
 	-I$(top_srcdir)/libgda-report \
 	-I$(top_srcdir)/libgda \
 	-I$(top_srcdir)/tools/browser \
+	-I$(top_srcdir)/tools/browser/common \
         $(LIBGDA_CFLAGS) \
 	$(LIBGDA_WFLAGS) \
         $(GTK_CFLAGS) \
 	$(GTKSOURCEVIEW_CFLAGS) \
 	-DGETTEXT_PACKAGE=\""$(GETTEXT_PACKAGE)"\"
 
-GTKDOC_LIBS = $(top_builddir)/tools/browser/data-manager/libperspective.la \
+ADDLIBS=
+if HAVE_GOOCANVAS
+ADDLIBS+=$(top_builddir)/tools/browser/canvas/libcanvas.la
+endif
+
+GTKDOC_LIBS = \
+	$(top_builddir)/tools/browser/data-manager/libperspective.la \
+	$(top_builddir)/tools/browser/schema-browser/libperspective.la \
+	$(ADDLIBS) \
+	$(top_builddir)/tools/browser/query-exec/libperspective.la \
 	$(top_builddir)/tools/browser/libbrowser.la \
 	$(top_builddir)/libgda-ui/internal/libgda-ui-internal.la \
 	$(top_builddir)/tools/browser/common/libcommon.la \
diff --git a/tools/browser/doc/gda-browser-docs.sgml b/tools/browser/doc/gda-browser-docs.sgml
index 7a13e12..d969a87 100644
--- a/tools/browser/doc/gda-browser-docs.sgml
+++ b/tools/browser/doc/gda-browser-docs.sgml
@@ -12,8 +12,13 @@
 <!ENTITY BrowserPage SYSTEM "xml/browser-page.xml">
 <!ENTITY BrowserPerspective SYSTEM "xml/browser-perspective.xml">
 <!ENTITY DataManagerPerspective SYSTEM "xml/data-manager-perspective.xml">
+<!ENTITY SchemaBrowserPerspective SYSTEM "xml/schema-browser-perspective.xml">
+<!ENTITY QueryExecPerspective SYSTEM "xml/query-exec-perspective.xml">
 <!ENTITY CCGrayBar SYSTEM "xml/cc-gray-bar.xml">
 <!ENTITY PopupContainer SYSTEM "xml/popup-container.xml">
+<!ENTITY UIFomrGrid SYSTEM "xml/ui-formgrid.xml">
+<!ENTITY MgrFavorites SYSTEM "xml/mgr-favorites.xml">
+<!ENTITY Support SYSTEM "xml/support.xml">
 ]>
 
 <book id="index">
@@ -30,14 +35,16 @@
         </contrib>
       </author>
     </authorgroup>
-    <date>August 2009</date>
+    <date>Jan. 2011</date>
     <copyright>
-      <year>2009</year>
+      <year>2009 - 2011</year>
       <holder>The GNOME Foundation</holder>
     </copyright>
     <abstract>
       <para>
-	Abstract blah.
+	Documentation to help improve and extend the GdaBrowser tool. All the objects and
+	widgets used by GdaBrowser are not included in this documentation, in order to
+	make it easier to understand; if you need them, go and look in the code.
       </para>
     </abstract>
     <legalnotice id="legalnotice">
@@ -91,7 +98,21 @@
     <chapter id="code_orga">
       <title>Code organization</title>
       <para>
-	TODO.
+	GdaBrowser's code is organized as follows,
+	assuming <filename class="directory">$(top_srcdir)</filename> is Libgda's
+	top source directory:
+	<itemizedlist>
+	  <listitem><para>All the code is in
+	      <filename class="directory">$(top_srcdir)/tools/browser</filename></para></listitem>
+	  <listitem><para>Some objects and functions are shared with LibgdaUi's own code which
+	      is located in <filename class="directory">$(top_srcdir)/libgda-ui/internal</filename></para></listitem>
+	  <listitem><para>All the main objects' code is in <filename class="directory">$(top_srcdir)/tools/browser</filename></para></listitem>
+	  <listitem><para>the <filename class="directory">$(top_srcdir)/tools/browser/common</filename> directory holds some objects and widgets which are used throught GdaBrowser's code</para></listitem>
+	  <listitem><para>the <filename class="directory">$(top_srcdir)/tools/browser/data</filename> directory contains all the small icons used inside GdaBrowser (at various sizes), while some more application oriented icons are in <filename class="directory">$(top_srcdir)/tools/browser</filename> </para></listitem>
+	  <listitem><para>the help files are stored in the <filename class="directory">$(top_srcdir)/tools/browser/help</filename> directory (each sub directory corresponds to a translation, except for the <filename class="directory">C</filename> which is the english and reference one)</para></listitem>
+	  <listitem>Each perspective's code is in the <filename class="directory">$(top_srcdir)/tools/browser/&lt;perspective name&gt;</filename> directory, with the <filename class="directory">$(top_srcdir)/tools/browser/dummy-perspective</filename> an example to implement a new perspective<para></para></listitem>
+	  <listitem><para>The <filename class="directory">$(top_srcdir)/tools/browser/canvas</filename> directory contains widgets to do some drawings, compiled only if the GooCanvas library has been detected at configure time.</para></listitem>
+	</itemizedlist>
       </para>
     </chapter>
   </part>  
@@ -108,6 +129,7 @@
       &BrowserCore;
       &BrowserConnection;
       &BrowserFavorites;
+      &Support;
     </chapter>
 
     <chapter id="windows">
@@ -139,6 +161,7 @@
 	This section is a reference to all the extra widgets used in the Gda browser,
 	which can be used in any extension.
       </para>
+      &UIFomrGrid;
       &CCGrayBar;
       &PopupContainer;
     </chapter>
@@ -149,7 +172,10 @@
 	This section is a reference to some of the existing perspectives and the associated
 	widgets.
       </para>
+      &MgrFavorites;
+      &SchemaBrowserPerspective;
       &DataManagerPerspective;
+      &QueryExecPerspective;
     </chapter>
   </part>
 
diff --git a/tools/browser/doc/gda-browser-sections.txt b/tools/browser/doc/gda-browser-sections.txt
index 6e81b2d..6eac4cb 100644
--- a/tools/browser/doc/gda-browser-sections.txt
+++ b/tools/browser/doc/gda-browser-sections.txt
@@ -133,6 +133,11 @@ browser_favorites_free_list
 browser_favorites_reset_attributes
 browser_favorites_find
 browser_favorites_get
+<SUBSECTION>
+BrowserFavoriteAction
+browser_favorites_get_actions
+browser_favorites_free_action
+browser_favorites_free_actions_list
 <SUBSECTION Standard>
 BROWSER_FAVORITES
 BROWSER_IS_FAVORITES
@@ -196,3 +201,87 @@ DataManagerPerspective
 data_manager_perspective_get_type
 data_manager_perspective_new_tab
 </SECTION>
+
+<SECTION>
+<FILE>schema-browser-perspective</FILE>
+SCHEMA_BROWSER_PERSPECTIVE_TYPE
+SCHEMA_BROWSER_PERSPECTIVE
+IS_SCHEMA_BROWSER_PERSPECTIVE
+SCHEMA_BROWSER_PERSPECTIVE_GET_CLASS
+SchemaBrowserPerspective
+schema_browser_perspective_display_table_info
+schema_browser_perspective_display_diagram
+</SECTION>
+
+<SECTION>
+<FILE>query-exec-perspective</FILE>
+QUERY_EXEC_PERSPECTIVE_TYPE
+QUERY_EXEC_PERSPECTIVE
+IS_QUERY_EXEC_PERSPECTIVE
+QUERY_EXEC_PERSPECTIVE_GET_CLASS
+QueryExecPerspective
+</SECTION>
+
+
+<SECTION>
+<FILE>support</FILE>
+<TITLE>Support functions</TITLE>
+browser_connection_open
+browser_connection_close
+<SUBSECTION>
+browser_show_error
+browser_show_message
+browser_show_help
+<SUBSECTION>
+browser_make_tab_label_with_stock
+browser_make_tab_label_with_pixbuf
+browser_make_small_button
+browser_make_tree_view
+<SUBSECTION>
+browser_find_parent_widget
+<SUBSECTION>
+BrowserIconType
+browser_get_pixbuf_icon
+<SUBSECTION>
+browser_get_connections_list
+</SECTION>
+
+<SECTION>
+<FILE>ui-formgrid</FILE>
+UiFormGridPrivate
+<TITLE>UiFormGrid</TITLE>
+UiFormGrid
+ui_formgrid_new
+ui_formgrid_handle_user_prefs
+ui_formgrid_get_selection
+ui_formgrid_get_form_data_set
+ui_formgrid_get_grid_data_set
+ui_formgrid_set_sample_size
+ui_formgrid_get_grid_widget
+ui_formgrid_set_connection
+<SUBSECTION Standard>
+UI_FORMGRID
+UI_IS_FORMGRID
+UI_TYPE_FORMGRID
+ui_formgrid_get_type
+UI_FORMGRID_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>mgr-favorites</FILE>
+MgrFavoritesPrivate
+<TITLE>MgrFavorites</TITLE>
+MgrFavorites
+MGR_FAVORITES_NAME_ATT_NAME
+MGR_FAVORITES_CONTENTS_ATT_NAME
+MGR_FAVORITES_ID_ATT_NAME
+MGR_FAVORITES_TYPE_ATT_NAME
+MGR_FAVORITES_POSITION_ATT_NAME
+mgr_favorites_new
+<SUBSECTION Standard>
+MGR_FAVORITES
+MGR_IS_FAVORITES
+MGR_TYPE_FAVORITES
+mgr_favorites_get_type
+MGR_FAVORITES_CLASS
+</SECTION>
diff --git a/tools/browser/doc/gda-browser.types b/tools/browser/doc/gda-browser.types
index 16012c4..aafc8f2 100644
--- a/tools/browser/doc/gda-browser.types
+++ b/tools/browser/doc/gda-browser.types
@@ -1,3 +1,15 @@
+#include <browser-core.h>
+#include <browser-connection.h>
+#include <browser-favorites.h>
+#include <browser-window.h>
+#include <browser-page.h>
+#include <cc-gray-bar.h>
+#include <libgda-ui/internal/popup-container.h>
+#include <data-manager/data-manager-perspective.h>
+#include <schema-browser/schema-browser-perspective.h>
+#include <query-exec/query-exec-perspective.h>
+#include <common/ui-formgrid.h>
+#include <mgr-favorites.h>
 browser_core_get_type
 browser_connection_get_type
 browser_favorites_get_type
@@ -7,3 +19,7 @@ browser_page_get_type
 cc_gray_bar_get_type
 popup_container_get_type
 data_manager_perspective_get_type
+schema_browser_perspective_get_type
+query_exec_perspective_get_type
+ui_formgrid_get_type
+mgr_favorites_get_type
diff --git a/tools/browser/doc/tmpl/browser-connection.sgml b/tools/browser/doc/tmpl/browser-connection.sgml
index 08a98ac..22495c0 100644
--- a/tools/browser/doc/tmpl/browser-connection.sgml
+++ b/tools/browser/doc/tmpl/browser-connection.sgml
@@ -7,7 +7,9 @@ An opened connection
 <!-- ##### SECTION Long_Description ##### -->
 <para>
   The #BrowserConnection object wraps a #GdaConnection with some
-  additionnal features.
+  additionnal features. The wrapped #GdaConnection is only accessible from within
+  the #BrowserConnection object, so to use a connection, you have to use the
+  #BrowserConnection's methods.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
diff --git a/tools/browser/doc/tmpl/browser-favorites.sgml b/tools/browser/doc/tmpl/browser-favorites.sgml
index 28c29b5..b588221 100644
--- a/tools/browser/doc/tmpl/browser-favorites.sgml
+++ b/tools/browser/doc/tmpl/browser-favorites.sgml
@@ -160,3 +160,41 @@ Favorites management
 @Returns: 
 
 
+<!-- ##### STRUCT BrowserFavoriteAction ##### -->
+<para>
+
+</para>
+
+ id: 
+ name: 
+ stmt: 
+ params: 
+ nb_bound: 
+
+<!-- ##### FUNCTION browser_favorites_get_actions ##### -->
+<para>
+
+</para>
+
+ bfav: 
+ bcnc: 
+ set: 
+ Returns: 
+
+
+<!-- ##### FUNCTION browser_favorites_free_action ##### -->
+<para>
+
+</para>
+
+ action: 
+
+
+<!-- ##### FUNCTION browser_favorites_free_actions_list ##### -->
+<para>
+
+</para>
+
+ actions_list: 
+
+
diff --git a/tools/browser/doc/tmpl/data-manager-perspective.sgml b/tools/browser/doc/tmpl/data-manager-perspective.sgml
index 99ba937..2f353a1 100644
--- a/tools/browser/doc/tmpl/data-manager-perspective.sgml
+++ b/tools/browser/doc/tmpl/data-manager-perspective.sgml
@@ -1,8 +1,8 @@
 <!-- ##### SECTION Title ##### -->
-data-manager-perspective
+Data Manager perspective
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Perspective to manipulate data contained in the database
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]