[libgda] GdaBrowser: added missing file to hacking manual

[Vivien Malerba <vivien src gnome org>]

commit 2d6387b06eb16728cb81bb265246bff89f722237
Author: Vivien Malerba <malerba gnome-db org>
Date:   Thu Jan 20 22:34:46 2011 +0100

    GdaBrowser: added missing file to hacking manual

 tools/browser/doc/tmpl/mgr-favorites.sgml          |   79 +++++++++
 tools/browser/doc/tmpl/query-exec-perspective.sgml |   44 +++++
 .../doc/tmpl/schema-browser-perspective.sgml       |   64 ++++++++
 tools/browser/doc/tmpl/support.sgml                |  166 ++++++++++++++++++++
 tools/browser/doc/tmpl/ui-formgrid.sgml            |  117 ++++++++++++++
 5 files changed, 470 insertions(+), 0 deletions(-)
---
diff --git a/tools/browser/doc/tmpl/mgr-favorites.sgml b/tools/browser/doc/tmpl/mgr-favorites.sgml
new file mode 100644
index 0000000..9077a52
--- /dev/null
+++ b/tools/browser/doc/tmpl/mgr-favorites.sgml
@@ -0,0 +1,79 @@
+<!-- ##### SECTION Title ##### -->
+MgrFavorites
+
+<!-- ##### SECTION Short_Description ##### -->
+A #GdaTreeManager for the stored favorites
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
+<!-- ##### STRUCT MgrFavorites ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG MgrFavorites:browser-connection ##### -->
+<para>
+
+</para>
+
+<!-- ##### MACRO MGR_FAVORITES_NAME_ATT_NAME ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO MGR_FAVORITES_CONTENTS_ATT_NAME ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO MGR_FAVORITES_ID_ATT_NAME ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO MGR_FAVORITES_TYPE_ATT_NAME ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO MGR_FAVORITES_POSITION_ATT_NAME ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION mgr_favorites_new ##### -->
+<para>
+
+</para>
+
+ bcnc: 
+ type: 
+ order_key: 
+ Returns: 
+
+
diff --git a/tools/browser/doc/tmpl/query-exec-perspective.sgml b/tools/browser/doc/tmpl/query-exec-perspective.sgml
new file mode 100644
index 0000000..b4afa95
--- /dev/null
+++ b/tools/browser/doc/tmpl/query-exec-perspective.sgml
@@ -0,0 +1,44 @@
+<!-- ##### SECTION Title ##### -->
+Query Exec perspective
+
+<!-- ##### SECTION Short_Description ##### -->
+Perspective to execute SQL commands
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
+<!-- ##### MACRO QUERY_EXEC_PERSPECTIVE ##### -->
+<para>
+
+</para>
+
+ obj: 
+
+
+<!-- ##### MACRO IS_QUERY_EXEC_PERSPECTIVE ##### -->
+<para>
+
+</para>
+
+ obj: 
+
+
+<!-- ##### STRUCT QueryExecPerspective ##### -->
+<para>
+
+</para>
+
+
diff --git a/tools/browser/doc/tmpl/schema-browser-perspective.sgml b/tools/browser/doc/tmpl/schema-browser-perspective.sgml
new file mode 100644
index 0000000..db19add
--- /dev/null
+++ b/tools/browser/doc/tmpl/schema-browser-perspective.sgml
@@ -0,0 +1,64 @@
+<!-- ##### SECTION Title ##### -->
+Schema Browser perspective
+
+<!-- ##### SECTION Short_Description ##### -->
+Perspective to analyse the database's schema
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
+<!-- ##### MACRO SCHEMA_BROWSER_PERSPECTIVE ##### -->
+<para>
+
+</para>
+
+ obj: 
+
+
+<!-- ##### MACRO IS_SCHEMA_BROWSER_PERSPECTIVE ##### -->
+<para>
+
+</para>
+
+ obj: 
+
+
+<!-- ##### STRUCT SchemaBrowserPerspective ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION schema_browser_perspective_display_table_info ##### -->
+<para>
+
+</para>
+
+ bpers: 
+ table_schema: 
+ table_name: 
+ table_short_name: 
+
+
+<!-- ##### FUNCTION schema_browser_perspective_display_diagram ##### -->
+<para>
+
+</para>
+
+ bpers: 
+ fav_id: 
+
+
diff --git a/tools/browser/doc/tmpl/support.sgml b/tools/browser/doc/tmpl/support.sgml
new file mode 100644
index 0000000..9050768
--- /dev/null
+++ b/tools/browser/doc/tmpl/support.sgml
@@ -0,0 +1,166 @@
+<!-- ##### SECTION Title ##### -->
+Support functions
+
+<!-- ##### SECTION Short_Description ##### -->
+Misc. functions for various situations
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
+<!-- ##### FUNCTION browser_connection_open ##### -->
+<para>
+
+</para>
+
+ error: 
+ Returns: 
+
+
+<!-- ##### FUNCTION browser_connection_close ##### -->
+<para>
+
+</para>
+
+ parent: 
+ bcnc: 
+ Returns: 
+
+
+<!-- ##### FUNCTION browser_show_error ##### -->
+<para>
+
+</para>
+
+ parent: 
+ format: 
+ Varargs: 
+
+
+<!-- ##### FUNCTION browser_show_message ##### -->
+<para>
+
+</para>
+
+ parent: 
+ format: 
+ Varargs: 
+
+
+<!-- ##### FUNCTION browser_show_help ##### -->
+<para>
+
+</para>
+
+ parent: 
+ topic: 
+
+
+<!-- ##### FUNCTION browser_make_tab_label_with_stock ##### -->
+<para>
+
+</para>
+
+ label: 
+ stock_id: 
+ with_close: 
+ out_close_button: 
+ Returns: 
+
+
+<!-- ##### FUNCTION browser_make_tab_label_with_pixbuf ##### -->
+<para>
+
+</para>
+
+ label: 
+ pixbuf: 
+ with_close: 
+ out_close_button: 
+ Returns: 
+
+
+<!-- ##### FUNCTION browser_make_small_button ##### -->
+<para>
+
+</para>
+
+ is_toggle: 
+ with_arrow: 
+ label: 
+ stock_id: 
+ tooltip: 
+ Returns: 
+
+
+<!-- ##### FUNCTION browser_make_tree_view ##### -->
+<para>
+
+</para>
+
+ model: 
+ Returns: 
+
+
+<!-- ##### FUNCTION browser_find_parent_widget ##### -->
+<para>
+
+</para>
+
+ current: 
+ requested_type: 
+ Returns: 
+
+
+<!-- ##### ENUM BrowserIconType ##### -->
+<para>
+
+</para>
+
+ BROWSER_ICON_BOOKMARK: 
+ BROWSER_ICON_SCHEMA: 
+ BROWSER_ICON_TABLE: 
+ BROWSER_ICON_COLUMN: 
+ BROWSER_ICON_COLUMN_PK: 
+ BROWSER_ICON_COLUMN_FK: 
+ BROWSER_ICON_COLUMN_FK_NN: 
+ BROWSER_ICON_COLUMN_NN: 
+ BROWSER_ICON_REFERENCE: 
+ BROWSER_ICON_DIAGRAM: 
+ BROWSER_ICON_QUERY: 
+ BROWSER_ICON_ACTION: 
+ BROWSER_ICON_GRID: 
+ BROWSER_ICON_FORM: 
+ BROWSER_ICON_MENU_INDICATOR: 
+ BROWSER_ICON_LAST: 
+
+<!-- ##### FUNCTION browser_get_pixbuf_icon ##### -->
+<para>
+
+</para>
+
+ type: 
+ Returns: 
+
+
+<!-- ##### FUNCTION browser_get_connections_list ##### -->
+<para>
+
+</para>
+
+ void: 
+ Returns: 
+
+
diff --git a/tools/browser/doc/tmpl/ui-formgrid.sgml b/tools/browser/doc/tmpl/ui-formgrid.sgml
new file mode 100644
index 0000000..cc213be
--- /dev/null
+++ b/tools/browser/doc/tmpl/ui-formgrid.sgml
@@ -0,0 +1,117 @@
+<!-- ##### SECTION Title ##### -->
+UiFormgrid
+
+<!-- ##### SECTION Short_Description ##### -->
+Widget embedding both a form and a grid to display a #GdaDataModel's contents
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
+<!-- ##### STRUCT UiFormGrid ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG UiFormGrid:raw-form ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG UiFormGrid:raw-grid ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG UiFormGrid:widget-info ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION ui_formgrid_new ##### -->
+<para>
+
+</para>
+
+ model: 
+ flags: 
+ Returns: 
+
+
+<!-- ##### FUNCTION ui_formgrid_handle_user_prefs ##### -->
+<para>
+
+</para>
+
+ formgrid: 
+ bcnc: 
+ stmt: 
+
+
+<!-- ##### FUNCTION ui_formgrid_get_selection ##### -->
+<para>
+
+</para>
+
+ formgrid: 
+ Returns: 
+
+
+<!-- ##### FUNCTION ui_formgrid_get_form_data_set ##### -->
+<para>
+
+</para>
+
+ formgrid: 
+ Returns: 
+
+
+<!-- ##### FUNCTION ui_formgrid_get_grid_data_set ##### -->
+<para>
+
+</para>
+
+ formgrid: 
+ Returns: 
+
+
+<!-- ##### FUNCTION ui_formgrid_set_sample_size ##### -->
+<para>
+
+</para>
+
+ formgrid: 
+ sample_size: 
+
+
+<!-- ##### FUNCTION ui_formgrid_get_grid_widget ##### -->
+<para>
+
+</para>
+
+ formgrid: 
+ Returns: 
+
+
+<!-- ##### FUNCTION ui_formgrid_set_connection ##### -->
+<para>
+
+</para>
+
+ formgrid: 
+ bcnc: 
+
+