GNOME.org
 

[libgda] More documentation for the UI extension

commit cbb0a71b02d27849cbd1504f177f9b08c326c3ca
Author: Vivien Malerba <malerba gnome-db org>
Date:   Tue Jul 28 18:38:44 2009 +0200

    More documentation for the UI extension

 doc/C/Makefile.am                |    2 +-
 doc/C/libgda-4.0-docs.sgml       |    8 ++
 doc/C/libgda-ui-sections.txt     |   78 +++++++++++++++
 doc/C/libgda-ui.types            |    3 +
 doc/C/tmpl/gdaui-combo.sgml      |  128 +++++++++++++++++++++++++
 doc/C/tmpl/gdaui-data-entry.sgml |  194 ++++++++++++++++++++++++++++++++++++++
 doc/C/tmpl/gdaui-data-store.sgml |  122 ++++++++++++++++++++++++
 doc/C/tmpl/gdaui-easy.sgml       |   39 ++++++++
 doc/C/vi-combo.png               |  Bin 0 -> 2747 bytes
 doc/C/vi-data-entry.png          |  Bin 0 -> 2435 bytes
 doc/C/visual_index.xml           |    6 +
 11 files changed, 579 insertions(+), 1 deletions(-)
---
diff --git a/doc/C/Makefile.am b/doc/C/Makefile.am
index 58dea0f..f8eafa5 100644
--- a/doc/C/Makefile.am
+++ b/doc/C/Makefile.am
@@ -63,7 +63,7 @@ HTML_IMAGES = DataModels.png \
 	parser_gen.png parser_prov.png \
 	tree-overview.png tree-overview2.png \
 	SqlIdentifiers.png \
-	vi-basic-form.png
+	vi-basic-form.png vi-combo.png vi-data-entry.png
 
 # Extra options to supply to gtkdoc-fixref
 FIXXREF_OPTIONS=
diff --git a/doc/C/libgda-4.0-docs.sgml b/doc/C/libgda-4.0-docs.sgml
index a35d356..173f3dd 100644
--- a/doc/C/libgda-4.0-docs.sgml
+++ b/doc/C/libgda-4.0-docs.sgml
@@ -131,6 +131,10 @@
 
 <!ENTITY visual-index SYSTEM "visual_index.xml">
 <!ENTITY libgdaui-GdauiBasicForm SYSTEM "xml/gdaui-basic-form.xml">
+<!ENTITY libgdaui-GdauiCombo SYSTEM "xml/gdaui-combo.xml">
+<!ENTITY libgdaui-GdauiDataEntry SYSTEM "xml/gdaui-data-entry.xml">
+<!ENTITY libgdaui-gdaui-easy SYSTEM "xml/gdaui-easy.xml">
+<!ENTITY libgdaui-GdauiDataStore SYSTEM "xml/gdaui-data-store.xml">
 ]>
 
 <book id="index">
@@ -1198,7 +1202,11 @@ g_object_unref (store);
     <chapter>
       <title>User interface API reference</title>
       &visual-index;
+      &libgdaui-gdaui-easy;
       &libgdaui-GdauiBasicForm;
+      &libgdaui-GdauiCombo;
+      &libgdaui-GdauiDataEntry;
+      &libgdaui-GdauiDataStore;
     </chapter>
 
     <chapter id="multi-threading">
diff --git a/doc/C/libgda-ui-sections.txt b/doc/C/libgda-ui-sections.txt
index 5d81454..eb3ffbb 100644
--- a/doc/C/libgda-ui-sections.txt
+++ b/doc/C/libgda-ui-sections.txt
@@ -1,4 +1,11 @@
 <SECTION>
+<FILE>gdaui-easy</FILE>
+<TITLE>UI Utility functions</TITLE>
+gdaui_new_data_entry
+gdaui_new_cell_renderer
+</SECTION>
+
+<SECTION>
 <FILE>gdaui-basic-form</FILE>
 <TITLE>GdauiBasicForm</TITLE>
 GdauiBasicForm
@@ -27,3 +34,74 @@ GDAUI_IS_BASIC_FORM_CLASS
 GDAUI_TYPE_BASIC_FORM
 gdaui_basic_form_get_type
 </SECTION>
+
+<SECTION>
+<FILE>gdaui-combo</FILE>
+<TITLE>GdauiCombo</TITLE>
+GdauiCombo
+gdaui_combo_new
+gdaui_combo_new_with_model
+gdaui_combo_set_model
+gdaui_combo_get_model
+gdaui_combo_add_undef_choice
+gdaui_combo_set_values
+gdaui_combo_get_values
+gdaui_combo_undef_selected
+gdaui_combo_set_values_ext
+gdaui_combo_get_values_ext
+<SUBSECTION Standard>
+GDAUI_COMBO
+GDAUI_COMBO_CLASS
+GDAUI_IS_COMBO
+GDAUI_IS_COMBO_CLASS
+GDAUI_TYPE_COMBO
+gdaui_combo_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gdaui-data-entry</FILE>
+<TITLE>GdauiDataEntry</TITLE>
+GdauiDataEntry
+gdaui_data_entry_set_value_type
+gdaui_data_entry_get_value_type
+gdaui_data_entry_set_value
+gdaui_data_entry_get_value
+gdaui_data_entry_content_is_valid
+gdaui_data_entry_set_original_value
+gdaui_data_entry_get_original_value
+gdaui_data_entry_reset
+gdaui_data_entry_set_value_default
+gdaui_data_entry_set_attributes
+gdaui_data_entry_get_attributes
+gdaui_data_entry_get_handler
+gdaui_data_entry_expand_in_layout
+gdaui_data_entry_set_editable
+gdaui_data_entry_grab_focus
+<SUBSECTION Standard>
+GDAUI_DATA_ENTRY
+GDAUI_IS_DATA_ENTRY
+GDAUI_DATA_ENTRY_GET_IFACE
+GDAUI_TYPE_DATA_ENTRY
+gdaui_data_entry_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gdaui-data-store</FILE>
+<TITLE>GdauiDataStore</TITLE>
+GdauiDataStore
+gdaui_data_store_new
+gdaui_data_store_get_proxy
+gdaui_data_store_get_row_from_iter
+gdaui_data_store_get_iter_from_values
+<SUBSECTION>
+gdaui_data_store_set_value
+gdaui_data_store_delete
+gdaui_data_store_undelete
+gdaui_data_store_append
+<SUBSECTION Standard>
+GDAUI_DATA_STORE
+GDAUI_IS_DATA_STORE
+GDAUI_DATA_STORE_CLASS
+GDAUI_TYPE_DATA_STORE
+gdaui_data_store_get_type
+</SECTION>
diff --git a/doc/C/libgda-ui.types b/doc/C/libgda-ui.types
index 89cc653..85c459f 100644
--- a/doc/C/libgda-ui.types
+++ b/doc/C/libgda-ui.types
@@ -1,2 +1,5 @@
 #include <libgda-ui/libgda-ui.h>
 gdaui_basic_form_get_type
+gdaui_combo_get_type
+gdaui_data_entry_get_type
+gdaui_data_store_get_type
diff --git a/doc/C/tmpl/gdaui-combo.sgml b/doc/C/tmpl/gdaui-combo.sgml
new file mode 100644
index 0000000..dd4f48a
--- /dev/null
+++ b/doc/C/tmpl/gdaui-combo.sgml
@@ -0,0 +1,128 @@
+<!-- ##### SECTION Title ##### -->
+GdauiCombo
+
+<!-- ##### SECTION Short_Description ##### -->
+Combo box to choose from the contents of a #GdaDataModel
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT GdauiCombo ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG GdauiCombo:model ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION gdaui_combo_new ##### -->
+<para>
+
+</para>
+
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_combo_new_with_model ##### -->
+<para>
+
+</para>
+
+ model: 
+ n_cols: 
+ cols_index: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_combo_set_model ##### -->
+<para>
+
+</para>
+
+ combo: 
+ model: 
+ n_cols: 
+ cols_index: 
+
+
+<!-- ##### FUNCTION gdaui_combo_get_model ##### -->
+<para>
+
+</para>
+
+ combo: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_combo_add_undef_choice ##### -->
+<para>
+
+</para>
+
+ combo: 
+ add_undef_choice: 
+
+
+<!-- ##### FUNCTION gdaui_combo_set_values ##### -->
+<para>
+
+</para>
+
+ combo: 
+ values: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_combo_get_values ##### -->
+<para>
+
+</para>
+
+ combo: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_combo_undef_selected ##### -->
+<para>
+
+</para>
+
+ combo: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_combo_set_values_ext ##### -->
+<para>
+
+</para>
+
+ combo: 
+ values: 
+ cols_index: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_combo_get_values_ext ##### -->
+<para>
+
+</para>
+
+ combo: 
+ n_cols: 
+ cols_index: 
+ Returns: 
+
+
diff --git a/doc/C/tmpl/gdaui-data-entry.sgml b/doc/C/tmpl/gdaui-data-entry.sgml
new file mode 100644
index 0000000..8949f90
--- /dev/null
+++ b/doc/C/tmpl/gdaui-data-entry.sgml
@@ -0,0 +1,194 @@
+<!-- ##### SECTION Title ##### -->
+GdauiDataEntry
+
+<!-- ##### SECTION Short_Description ##### -->
+Data entry widget
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+  The #GdaUiDataEntry is an interface for widgets (simple or complex)
+  which lets the user view and/or modify a #GValue.
+</para>
+<para>
+  #GdaUiDataEntry widgets are normally created using the gdaui_new_data_entry() function.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT GdauiDataEntry ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SIGNAL GdauiDataEntry::contents-activated ##### -->
+<para>
+
+</para>
+
+ gdauidataentry: the object which received the signal.
+
+<!-- ##### SIGNAL GdauiDataEntry::contents-modified ##### -->
+<para>
+
+</para>
+
+ gdauidataentry: the object which received the signal.
+
+<!-- ##### SIGNAL GdauiDataEntry::contents-valid ##### -->
+<para>
+
+</para>
+
+ gdauidataentry: the object which received the signal.
+ arg1: 
+ Returns: 
+
+<!-- ##### SIGNAL GdauiDataEntry::status-changed ##### -->
+<para>
+
+</para>
+
+ gdauidataentry: the object which received the signal.
+
+<!-- ##### FUNCTION gdaui_data_entry_set_value_type ##### -->
+<para>
+
+</para>
+
+ de: 
+ type: 
+
+
+<!-- ##### FUNCTION gdaui_data_entry_get_value_type ##### -->
+<para>
+
+</para>
+
+ de: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_data_entry_set_value ##### -->
+<para>
+
+</para>
+
+ de: 
+ value: 
+
+
+<!-- ##### FUNCTION gdaui_data_entry_get_value ##### -->
+<para>
+
+</para>
+
+ de: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_data_entry_content_is_valid ##### -->
+<para>
+
+</para>
+
+ de: 
+ error: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_data_entry_set_original_value ##### -->
+<para>
+
+</para>
+
+ de: 
+ value: 
+
+
+<!-- ##### FUNCTION gdaui_data_entry_get_original_value ##### -->
+<para>
+
+</para>
+
+ de: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_data_entry_reset ##### -->
+<para>
+
+</para>
+
+ de: 
+
+
+<!-- ##### FUNCTION gdaui_data_entry_set_value_default ##### -->
+<para>
+
+</para>
+
+ de: 
+ value: 
+
+
+<!-- ##### FUNCTION gdaui_data_entry_set_attributes ##### -->
+<para>
+
+</para>
+
+ de: 
+ attrs: 
+ mask: 
+
+
+<!-- ##### FUNCTION gdaui_data_entry_get_attributes ##### -->
+<para>
+
+</para>
+
+ de: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_data_entry_get_handler ##### -->
+<para>
+
+</para>
+
+ de: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_data_entry_expand_in_layout ##### -->
+<para>
+
+</para>
+
+ de: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_data_entry_set_editable ##### -->
+<para>
+
+</para>
+
+ de: 
+ editable: 
+
+
+<!-- ##### FUNCTION gdaui_data_entry_grab_focus ##### -->
+<para>
+
+</para>
+
+ de: 
+
+
diff --git a/doc/C/tmpl/gdaui-data-store.sgml b/doc/C/tmpl/gdaui-data-store.sgml
new file mode 100644
index 0000000..1655062
--- /dev/null
+++ b/doc/C/tmpl/gdaui-data-store.sgml
@@ -0,0 +1,122 @@
+<!-- ##### SECTION Title ##### -->
+GdauiDataStore
+
+<!-- ##### SECTION Short_Description ##### -->
+Bridge between a #GdaDataModel and a #GtkTreeModel
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+  The #GdauiDataStore object implements the #GtkTreeModel interface
+  on top of a #GdaDataModel to be able to display its contents
+  in a #GtkTreeView.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT GdauiDataStore ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG GdauiDataStore:model ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GdauiDataStore:prepend-null-entry ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GdauiDataStore:proxy ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION gdaui_data_store_new ##### -->
+<para>
+
+</para>
+
+ model: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_data_store_get_proxy ##### -->
+<para>
+
+</para>
+
+ store: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_data_store_get_row_from_iter ##### -->
+<para>
+
+</para>
+
+ store: 
+ iter: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_data_store_get_iter_from_values ##### -->
+<para>
+
+</para>
+
+ store: 
+ iter: 
+ values: 
+ cols_index: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_data_store_set_value ##### -->
+<para>
+
+</para>
+
+ store: 
+ iter: 
+ col: 
+ value: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_data_store_delete ##### -->
+<para>
+
+</para>
+
+ store: 
+ iter: 
+
+
+<!-- ##### FUNCTION gdaui_data_store_undelete ##### -->
+<para>
+
+</para>
+
+ store: 
+ iter: 
+
+
+<!-- ##### FUNCTION gdaui_data_store_append ##### -->
+<para>
+
+</para>
+
+ store: 
+ iter: 
+ Returns: 
+
+
diff --git a/doc/C/tmpl/gdaui-easy.sgml b/doc/C/tmpl/gdaui-easy.sgml
new file mode 100644
index 0000000..28fb9b3
--- /dev/null
+++ b/doc/C/tmpl/gdaui-easy.sgml
@@ -0,0 +1,39 @@
+<!-- ##### SECTION Title ##### -->
+UI Utility functions
+
+<!-- ##### SECTION Short_Description ##### -->
+Set of UI related functions
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION gdaui_new_data_entry ##### -->
+<para>
+
+</para>
+
+ type: 
+ plugin_name: 
+ Returns: 
+
+
+<!-- ##### FUNCTION gdaui_new_cell_renderer ##### -->
+<para>
+
+</para>
+
+ type: 
+ plugin_name: 
+ Returns: 
+
+
diff --git a/doc/C/vi-combo.png b/doc/C/vi-combo.png
new file mode 100644
index 0000000..6ab42f6
Binary files /dev/null and b/doc/C/vi-combo.png differ
diff --git a/doc/C/vi-data-entry.png b/doc/C/vi-data-entry.png
new file mode 100644
index 0000000..a45d74a
Binary files /dev/null and b/doc/C/vi-data-entry.png differ
diff --git a/doc/C/visual_index.xml b/doc/C/visual_index.xml
index 84a4881..ddf7c07 100644
--- a/doc/C/visual_index.xml
+++ b/doc/C/visual_index.xml
@@ -2,4 +2,10 @@
   <link linkend="GdauiBasicForm">
     <inlinegraphic fileref="vi-basic-form.png" format="PNG"></inlinegraphic>
   </link>
+  <link linkend="GdauiCombo">
+    <inlinegraphic fileref="vi-combo.png" format="PNG"></inlinegraphic>
+  </link>
+  <link linkend="GdauiDataEntry">
+    <inlinegraphic fileref="vi-data-entry.png" format="PNG"></inlinegraphic>
+  </link>
 </para>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]