[gtkmm] Widget: Document get_style_property_value() and get_style_property()



commit d61e78c3fa44b11372314a580c33192093727a4a
Author: Mark Vender <markv743 yahoo co uk>
Date:   Wed May 2 13:08:14 2012 +0000

    Widget: Document get_style_property_value() and get_style_property()
    
    * widget.hg: Add documentation for get_style_property() and
    get_style_property_value(). Emphasize that get_style_property() is preferable,
    as it doesn't use GValue directly.
    
    Bug #673303.

 ChangeLog         |   10 ++++++++++
 gtk/src/widget.hg |    9 +++++++++
 2 files changed, 19 insertions(+), 0 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 0697bc3..d625c0a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,15 @@
 2012-05-28  Mark Vender <markv743 yahoo co uk>
 
+	Widget: Document get_style_property_value() and get_style_property()
+
+	* widget.hg: Add documentation for get_style_property() and
+	get_style_property_value(). Emphasize that get_style_property() is 
+	preferable, as it doesn't use GValue directly.
+    
+	Bug #673303.
+
+2012-05-28  Mark Vender <markv743 yahoo co uk>
+
 	StyleContext: Wrap gtk_style_context_get_style_property() and friends
     
 	* gtk/src/stylecontext.hg: Add get_style_property() and
diff --git a/gtk/src/widget.hg b/gtk/src/widget.hg
index 83c7b6e..34031f1 100644
--- a/gtk/src/widget.hg
+++ b/gtk/src/widget.hg
@@ -408,6 +408,10 @@ public:
   _WRAP_METHOD(void reset_style(), gtk_widget_reset_style)
 
   //The parameter name is "the_property_name" to avoid a warning because there is a method with the "property_name" name.
+  /** Gets the value of a style property of @a widget.
+   * @param the_property_name The name of a style property.
+   * @param value Location to return the property value.
+   */
   template <class PropertyType>
   void get_style_property(const Glib::ustring& the_property_name, PropertyType& value) const;
 
@@ -819,6 +823,11 @@ protected:
   _IGNORE(gtk_widget_get_child_requisition) //deprecated.
 
   //The parameter name is "the_property_name" to avoid a warning because there is a method with the "property_name" name.
+  /** Gets the value of a style property of @a widget. Most of the time, you want
+   * to use get_style_property().
+   * @param the_property_name The name of a style property.
+   * @param value Location to return the property value.
+   */
   _WRAP_METHOD(void get_style_property_value(
                    const Glib::ustring& the_property_name, Glib::ValueBase& value) const,
                gtk_widget_style_get_property)



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