[rhythmbox] property-view: document property-selected vs properties-selected signals



commit 7128d738995b6cc2305dbfe897b01411eea12908
Author: Jonathan Matthew <jonathan d14n org>
Date:   Sat Sep 25 17:18:08 2010 +1000

    property-view: document property-selected vs properties-selected signals
    
    This isn't particularly nice, but maybe people will be able to figure it
    out without asking me now..

 widgets/rb-property-view.c |    8 ++++++--
 1 files changed, 6 insertions(+), 2 deletions(-)
---
diff --git a/widgets/rb-property-view.c b/widgets/rb-property-view.c
index 553828b..dbf8565 100644
--- a/widgets/rb-property-view.c
+++ b/widgets/rb-property-view.c
@@ -230,7 +230,9 @@ rb_property_view_class_init (RBPropertyViewClass *klass)
 	 * @view: the #RBPropertyView
 	 * @name: the property value that has been selected
 	 *
-	 * Emitted when an individual property value becomes selected.
+	 * Emitted when an individual property value becomes selected.  This is only
+	 * emitted for single-selection property views.  For multiple-selection views,
+	 * use the properties-selected signal.
 	 */
 	rb_property_view_signals[PROPERTY_SELECTED] =
 		g_signal_new ("property-selected",
@@ -248,7 +250,9 @@ rb_property_view_class_init (RBPropertyViewClass *klass)
 	 * @view: the #RBPropertyView
 	 * @properties: a list containing the selected property values
 	 *
-	 * Emitted when the set of selected property values changes.
+	 * Emitted when the set of selected property values changes.  This is only
+	 * emitted for multiple selection property views.  For single-selection views,
+	 * use the property-selected signal.
 	 */
 	rb_property_view_signals[PROPERTIES_SELECTED] =
 		g_signal_new ("properties-selected",



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