GNOME.org
 

[libgda] Documentation: starting to document the UI extension

commit d620bf8d3154b5d6c90b0a504f9306722ad478e4
Author: Vivien Malerba <malerba gnome-db org>
Date:   Mon Jul 27 19:35:19 2009 +0200

    Documentation: starting to document the UI extension

 Makefile.am                                        |    1 -
 configure.in                                       |   19 ++-
 doc/C/.gitignore                                   |    4 +-
 doc/C/Makefile.am                                  |   12 +-
 doc/C/architecture.svg                             |    2 +-
 doc/C/libgda-4.0-docs.sgml                         |    9 +
 ...libgda-4.0-sections.txt => libgda-sections.txt} |    1 +
 doc/C/libgda-ui-sections.txt                       |   29 +++
 doc/C/libgda-ui.types                              |    2 +
 doc/C/{libgda-4.0.types.in => libgda.types.in}     |    0
 doc/C/tmpl/gdaui-basic-form.sgml                   |  232 ++++++++++++++++++++
 doc/C/vi-basic-form.png                            |  Bin 0 -> 6192 bytes
 doc/C/visual_index.xml                             |    5 +
 13 files changed, 310 insertions(+), 6 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index 5160393..98b15ee 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -73,7 +73,6 @@ example_files = \
 	samples/XSLT/data2.xml \
 	samples/XSLT/test.xsl \
 	samples/XSLT/transform.c \
-<<<<<<< HEAD:Makefile.am
 	samples/MetaStore/Makefile \
 	samples/MetaStore/README \
 	samples/MetaStore/background.c \
diff --git a/configure.in b/configure.in
index 2b8bc3e..95cc9f4 100644
--- a/configure.in
+++ b/configure.in
@@ -1739,12 +1739,29 @@ tests/meta-store/Makefile
 tests/multi-threading/Makefile
 doc/Makefile
 doc/C/Makefile
-doc/C/libgda-4.0.types
+doc/C/libgda.types
 doc/C/version.xml
 data/Makefile
 stamp.h
 ])
 
+
+dnl Dirty work to be able to build documentation
+chmod -R u+w ${srcdir}/doc/C
+cp doc/C/version.xml ${srcdir}/doc/C
+
+cp ${srcdir}/doc/C/libgda-sections.txt doc/C/libgda-4.0-sections.txt
+echo "" >> doc/C/libgda-4.0-sections.txt
+cat ${srcdir}/doc/C/libgda-ui-sections.txt >> doc/C/libgda-4.0-sections.txt
+
+cp doc/C/libgda.types doc/C/libgda-4.0.types
+if test x$have_ui != xno
+then
+	echo "" >> doc/C/libgda-4.0.types
+	cat ${srcdir}/doc/C/libgda-ui.types >> doc/C/libgda-4.0.types
+fi
+
+
 dnl Print configuration summary
 echo ""
 echo " Configuration summary for version $GDA_VERSION"
diff --git a/doc/C/.gitignore b/doc/C/.gitignore
index 5565cdf..ef4c737 100644
--- a/doc/C/.gitignore
+++ b/doc/C/.gitignore
@@ -19,6 +19,7 @@ libgda-4.0.prerequisites
 libgda-4.0-decl.txt.bak
 libgda-4.0.interfaces
 libgda-4.0-decl-list.txt.bak
+libgda.types
 libgda-4.0.types
 libgda-4.0-overrides.txt
 libgda-4.0-doc.pdf
@@ -26,4 +27,5 @@ pdf-build.stamp
 libgda-4.0-undeclared.txt
 libgda-4.0-unused.sgml
 version.xml
-*.bak
\ No newline at end of file
+*.bak
+libgda-4.0-sections.txt
diff --git a/doc/C/Makefile.am b/doc/C/Makefile.am
index 7c084e9..58dea0f 100644
--- a/doc/C/Makefile.am
+++ b/doc/C/Makefile.am
@@ -39,6 +39,12 @@ GTKDOC_LIBS =  $(top_builddir)/libgda/libgda-4.0.la \
 	$(top_builddir)/libgda-report/libgda-report-4.0.la \
 	$(LIBGDA_LIBS)
 
+if HAVE_UI
+GTKDOC_CFLAGS += $(GTK_CFLAGS)
+GTKDOC_LIBS += $(GTK_LIBS) \
+	$(top_builddir)/libgda-ui/libgda-ui-4.0.la
+endif
+
 # Extra options to supply to gtkdoc-mkdb
 MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files="parser.c binreloc.c libcsv.c md5c.c"
 
@@ -56,7 +62,8 @@ HTML_IMAGES = DataModels.png \
 	gda-sql-graph.png howto-exec.png \
 	parser_gen.png parser_prov.png \
 	tree-overview.png tree-overview2.png \
-	SqlIdentifiers.png
+	SqlIdentifiers.png \
+	vi-basic-form.png
 
 # Extra options to supply to gtkdoc-fixref
 FIXXREF_OPTIONS=
@@ -70,7 +77,8 @@ EXTRA_DIST += examples/full_example.c installation.xml limitations.xml migration
 	DataModels.svg \
 	architecture.svg parts.svg stmt-unknown.svg stmt-select.svg stmt-insert1.svg stmt-insert2.svg \
 	stmt-update.svg stmt-compound.svg information_schema.svg howto-exec.svg \
-	version.xml.in
+	version.xml.in \
+	visual_index.xml
 
 # Files not to distribute
 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
diff --git a/doc/C/architecture.svg b/doc/C/architecture.svg
index 9fcccb4..8a4a34a 100644
--- a/doc/C/architecture.svg
+++ b/doc/C/architecture.svg
@@ -14,7 +14,7 @@
    id="svg2"
    sodipodi:version="0.32"
    inkscape:version="0.45.1"
-   sodipodi:docbase="/home/vivien/Devel/SVN/trunk-new-parser/doc/C"
+   sodipodi:docbase="/doc/C"
    sodipodi:docname="architecture.svg"
    inkscape:output_extension="org.inkscape.output.svg.inkscape">
   <defs
diff --git a/doc/C/libgda-4.0-docs.sgml b/doc/C/libgda-4.0-docs.sgml
index 7984ac9..a35d356 100644
--- a/doc/C/libgda-4.0-docs.sgml
+++ b/doc/C/libgda-4.0-docs.sgml
@@ -128,6 +128,9 @@
 <!ENTITY libgda-GdaTreeMgrColumns SYSTEM "xml/gda-tree-mgr-columns.xml">
 <!ENTITY libgda-GdaSqlBuilder SYSTEM "xml/gda-sql-builder.xml">
 <!ENTITY libgda-GdaThreadWrapper SYSTEM "xml/gda-thread-wrapper.xml">
+
+<!ENTITY visual-index SYSTEM "visual_index.xml">
+<!ENTITY libgdaui-GdauiBasicForm SYSTEM "xml/gdaui-basic-form.xml">
 ]>
 
 <book id="index">
@@ -1192,6 +1195,12 @@ g_object_unref (store);
       &libgda-GdaServerOperationSequences;
     </chapter>
 
+    <chapter>
+      <title>User interface API reference</title>
+      &visual-index;
+      &libgdaui-GdauiBasicForm;
+    </chapter>
+
     <chapter id="multi-threading">
       <title>Multi threading</title>
       &libgda-GdaMutex;
diff --git a/doc/C/libgda-4.0-sections.txt b/doc/C/libgda-sections.txt
similarity index 99%
rename from doc/C/libgda-4.0-sections.txt
rename to doc/C/libgda-sections.txt
index 2b28b93..acd49b4 100644
--- a/doc/C/libgda-4.0-sections.txt
+++ b/doc/C/libgda-sections.txt
@@ -1723,3 +1723,4 @@ GDA_IS_REPETITIVE_STATEMENT
 GDA_TYPE_REPETITIVE_STATEMENT
 gda_repetitive_statement_get_type
 </SECTION>
+
diff --git a/doc/C/libgda-ui-sections.txt b/doc/C/libgda-ui-sections.txt
new file mode 100644
index 0000000..5d81454
--- /dev/null
+++ b/doc/C/libgda-ui-sections.txt
@@ -0,0 +1,29 @@
+<SECTION>
+<FILE>gdaui-basic-form</FILE>
+<TITLE>GdauiBasicForm</TITLE>
+GdauiBasicForm
+GdauiFormLayoutSpec
+gdaui_basic_form_new
+gdaui_basic_form_new_custom
+gdaui_basic_form_new_in_dialog
+gdaui_basic_form_get_data_set
+gdaui_basic_form_is_valid
+gdaui_basic_form_has_been_changed
+gdaui_basic_form_reset
+gdaui_basic_form_set_current_as_orig
+gdaui_basic_form_show_entry_actions
+gdaui_basic_form_entry_show
+gdaui_basic_form_entry_grab_focus
+gdaui_basic_form_entry_set_editable
+gdaui_basic_form_set_entries_auto_default
+gdaui_basic_form_set_entries_default
+gdaui_basic_form_get_entry_widget
+gdaui_basic_form_get_label_widget
+<SUBSECTION Standard>
+GDAUI_BASIC_FORM
+GDAUI_BASIC_FORM_CLASS
+GDAUI_IS_BASIC_FORM
+GDAUI_IS_BASIC_FORM_CLASS
+GDAUI_TYPE_BASIC_FORM
+gdaui_basic_form_get_type
+</SECTION>
diff --git a/doc/C/libgda-ui.types b/doc/C/libgda-ui.types
new file mode 100644
index 0000000..89cc653
--- /dev/null
+++ b/doc/C/libgda-ui.types
@@ -0,0 +1,2 @@
+#include <libgda-ui/libgda-ui.h>
+gdaui_basic_form_get_type
diff --git a/doc/C/libgda-4.0.types.in b/doc/C/libgda.types.in
similarity index 100%
rename from doc/C/libgda-4.0.types.in
rename to doc/C/libgda.types.in
diff --git a/doc/C/tmpl/gdaui-basic-form.sgml b/doc/C/tmpl/gdaui-basic-form.sgml
new file mode 100644
index 0000000..2abc54e
--- /dev/null
+++ b/doc/C/tmpl/gdaui-basic-form.sgml
@@ -0,0 +1,232 @@
+<!-- ##### SECTION Title ##### -->
+GdauiBasicForm
+
+<!-- ##### SECTION Short_Description ##### -->
+Form widget mapping the values contained in a #GdaSet
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT GdauiBasicForm ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SIGNAL GdauiBasicForm::activated ##### -->
+<para>
+
+</para>
+
+ gdauibasicform: the object which received the signal.
+
+<!-- ##### SIGNAL GdauiBasicForm::param-changed ##### -->
+<para>
+
+</para>
+
+ gdauibasicform: the object which received the signal.
+ arg1: 
+ arg2: 
+
+<!-- ##### ARG GdauiBasicForm:data-layout ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GdauiBasicForm:entries-auto-default ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GdauiBasicForm:headers-sensitive ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GdauiBasicForm:layout-spec ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GdauiBasicForm:paramlist ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GdauiBasicForm:show-actions ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT GdauiFormLayoutSpec ##### -->
+<para>
+
+</para>
+
+ xml_object: 
+ xml_file: 
+ root_element: 
+ form_prefix: 
+
+<!-- ##### FUNCTION gdaui_basic_form_new ##### -->
+<para>
+
+</para>
+
+ data_set: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_basic_form_new_custom ##### -->
+<para>
+
+</para>
+
+ data_set: 
+ glade_file: 
+ root_element: 
+ form_prefix: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_basic_form_new_in_dialog ##### -->
+<para>
+
+</para>
+
+ data_set: 
+ parent: 
+ title: 
+ header: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_basic_form_get_data_set ##### -->
+<para>
+
+</para>
+
+ form: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_basic_form_is_valid ##### -->
+<para>
+
+</para>
+
+ form: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_basic_form_has_been_changed ##### -->
+<para>
+
+</para>
+
+ form: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_basic_form_reset ##### -->
+<para>
+
+</para>
+
+ form: 
+
+
+<!-- ##### FUNCTION gdaui_basic_form_set_current_as_orig ##### -->
+<para>
+
+</para>
+
+ form: 
+
+
+<!-- ##### FUNCTION gdaui_basic_form_show_entry_actions ##### -->
+<para>
+
+</para>
+
+ form: 
+ show_actions: 
+
+
+<!-- ##### FUNCTION gdaui_basic_form_entry_show ##### -->
+<para>
+
+</para>
+
+ form: 
+ param: 
+ show: 
+
+
+<!-- ##### FUNCTION gdaui_basic_form_entry_grab_focus ##### -->
+<para>
+
+</para>
+
+ form: 
+ param: 
+
+
+<!-- ##### FUNCTION gdaui_basic_form_entry_set_editable ##### -->
+<para>
+
+</para>
+
+ form: 
+ param: 
+ editable: 
+
+
+<!-- ##### FUNCTION gdaui_basic_form_set_entries_auto_default ##### -->
+<para>
+
+</para>
+
+ form: 
+ auto_default: 
+
+
+<!-- ##### FUNCTION gdaui_basic_form_set_entries_default ##### -->
+<para>
+
+</para>
+
+ form: 
+
+
+<!-- ##### FUNCTION gdaui_basic_form_get_entry_widget ##### -->
+<para>
+
+</para>
+
+ form: 
+ param: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_basic_form_get_label_widget ##### -->
+<para>
+
+</para>
+
+ form: 
+ param: 
+ Returns: 
+
+
diff --git a/doc/C/vi-basic-form.png b/doc/C/vi-basic-form.png
new file mode 100644
index 0000000..a9e07d7
Binary files /dev/null and b/doc/C/vi-basic-form.png differ
diff --git a/doc/C/visual_index.xml b/doc/C/visual_index.xml
new file mode 100644
index 0000000..84a4881
--- /dev/null
+++ b/doc/C/visual_index.xml
@@ -0,0 +1,5 @@
+<para role="gallery">
+  <link linkend="GdauiBasicForm">
+    <inlinegraphic fileref="vi-basic-form.png" format="PNG"></inlinegraphic>
+  </link>
+</para>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]