[libgda] Documented the GdauiDataProxy::proxy-changed signal



commit 3ee60cbcd5f70fbf436e46e1b05603f2ad41c363
Author: Vivien Malerba <malerba gnome-db org>
Date:   Fri Jun 17 20:55:43 2011 +0200

    Documented the GdauiDataProxy::proxy-changed signal

 libgda-ui/gdaui-data-proxy.c |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)
---
diff --git a/libgda-ui/gdaui-data-proxy.c b/libgda-ui/gdaui-data-proxy.c
index 24cebb3..4f602fd 100644
--- a/libgda-ui/gdaui-data-proxy.c
+++ b/libgda-ui/gdaui-data-proxy.c
@@ -68,6 +68,16 @@ gdaui_data_proxy_iface_init (G_GNUC_UNUSED gpointer g_class)
 	static gboolean initialized = FALSE;
 
 	if (! initialized) {
+		/**
+		 * GdauiDataProxy::proxy-changed:
+		 * @gdauidataproxy: the #GdauiDataProxy
+		 * @arg1: the GdaDataProxy which would be returned by gdaui_data_proxy_get_proxy()
+		 *
+		 * The ::proxy-changed signal is emitted each time the #GdaDataProxy which would be
+		 * returned by gdaui_data_proxy_get_proxy() changes. This is generally the result
+		 * of changes in the structure of the proxied data model (different number and/or type
+		 * of columns for example).
+		 */
 		gdaui_data_proxy_signals[PROXY_CHANGED] = 
 			g_signal_new ("proxy-changed",
                                       GDAUI_TYPE_DATA_PROXY,



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