[libgda-uimm] DataSelector, Login: Add class description from C docs.



commit 455ae4e7481b33a6a714dce99b3d0b983a990f30
Author: José Alburquerque <jaalburqu svn gnome org>
Date:   Tue Feb 23 17:58:20 2010 -0500

    	DataSelector, Login: Add class description from C docs.
    
    	* libgda-ui/src/dataselector.hg:
    	* libgda-ui/src/login.hg: Add description from the C docs to the class
    	docs header.

 ChangeLog                     |    8 ++++++++
 libgda-ui/src/dataselector.hg |    9 +++++++++
 libgda-ui/src/login.hg        |    7 +++++++
 3 files changed, 24 insertions(+), 0 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 74a4bdf..7fd8a76 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,13 @@
 2010-02-23  José Alburquerque  <jaalburqu svn gnome org>
 
+	DataSelector, Login: Add class description from C docs.
+
+	* libgda-ui/src/dataselector.hg:
+	* libgda-ui/src/login.hg: Add description from the C docs to the class
+	docs header.
+
+2010-02-23  José Alburquerque  <jaalburqu svn gnome org>
+
 	Login: Wrapped properties and signals.
 
 	* libgda-ui/src/login.hg: Wrapped signals and properties.
diff --git a/libgda-ui/src/dataselector.hg b/libgda-ui/src/dataselector.hg
index ce71b2f..7eaa88b 100644
--- a/libgda-ui/src/dataselector.hg
+++ b/libgda-ui/src/dataselector.hg
@@ -38,6 +38,15 @@ namespace GdaUI
 {
 
 /** DataSelector - Selecting data in a Gnome::Gda::DataModel.
+ * The DataSelector  interface is implemented by widgets which allow the user
+ * to select some data from a Gnome::Gda::DataModel. Depending on the actual
+ * widget, the selection can be a single row or more than one row.
+ *
+ * This interface allows one to set and get the Gnome::Gda::DataModel from
+ * which data is to be selected and offers a few other common behaviours.
+ *
+ * Please note that any row number in this interface is in reference to the
+ * Gnome::Gda::DataModel returned by the get_model() method.
  */
 class DataSelector :
   public Glib::Interface
diff --git a/libgda-ui/src/login.hg b/libgda-ui/src/login.hg
index c9c5ec0..99c4a70 100644
--- a/libgda-ui/src/login.hg
+++ b/libgda-ui/src/login.hg
@@ -33,6 +33,13 @@ namespace GdaUI
 _WRAP_ENUM(LoginMode, GdauiLoginMode, s#UI_##)
 
 /** Login - Connection opening dialog.
+ * The Login  widget can be used when the user needs to enter data to open a
+ * connection. It can be customized in several ways:
+ *
+ *   - Data source (DSN) selection can be shown or hidden.
+ *   - The button to launch the control center to declare new data sources can
+ *   be shown or hidden.
+ *   - The form to open a connection not using a DSN can be shown or hidden.
  */
 class Login :
   public Gtk::VBox



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]