[gtkmm-documentation] gmmproc: _WRAP_METHOD: Include docs on wrapping methods with slots.



commit c24b2839c6d21a652f5b95a26222e97ba69c90f5
Author: Josà Alburquerque <jaalburqu svn gnome org>
Date:   Mon Nov 19 12:35:28 2012 -0500

    gmmproc: _WRAP_METHOD: Include docs on wrapping methods with slots.
    
    	* docs/tutorial/C/gtkmm-tutorial-in.xml: Document the new
    	'slot_name', 'slot_callback' and 'no_slot_copy' options of
    	_WRAP_METHOD().
    
    	Bug #688587.

 ChangeLog                             |   10 ++++++++++
 docs/tutorial/C/gtkmm-tutorial-in.xml |   32 ++++++++++++++++++++++++++++++++
 2 files changed, 42 insertions(+), 0 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 99ba6d2..db1192a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2012-11-19  Josà Alburquerque  <jaalburquerque gmail com>
+
+	gmmproc: _WRAP_METHOD: Include docs on wrapping methods with slots.
+
+	* docs/tutorial/C/gtkmm-tutorial-in.xml: Document the new
+	'slot_name', 'slot_callback' and 'no_slot_copy' options of
+	_WRAP_METHOD().
+
+	Bug #688587.
+
 2012-11-11  Josà Alburquerque  <jaalburquerque gmail com>
 
 	_WRAP_CTOR: Document the new "errthrow" extra argument option.
diff --git a/docs/tutorial/C/gtkmm-tutorial-in.xml b/docs/tutorial/C/gtkmm-tutorial-in.xml
index b15dcf1..1964e54 100644
--- a/docs/tutorial/C/gtkmm-tutorial-in.xml
+++ b/docs/tutorial/C/gtkmm-tutorial-in.xml
@@ -9041,6 +9041,38 @@ _WRAP_METHOD(void set_text(const Glib::ustring&amp; text), gtk_entry_set_text)
             <para>Puts the generated code in #ifdef blocks.</para>
         </listitem>
     </varlistentry>
+    <varlistentry>
+        <term>slot_name</term>
+        <listitem>
+          <para>Tells <function>_WRAP_METHOD()</function> the name of the slot
+            parameter of the method, if it has one.  This enables gmmproc to
+            generate code to copy the slot and pass the copy on to the C
+            function in its final <literal>gpointer user_data</literal>
+            parameter.  The <literal>slot_callback</literal> option must also
+            be used to specify the name of the glue callback function to also
+            pass on to the C function.</para>
+        </listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>slot_callback</term>
+        <listitem>
+          <para>Used in conjunction with the <literal>slot_name</literal>
+            option to tell <function>_WRAP_METHOD()</function> the name of the
+            glue callback function that handles extracting the slot and then
+            calling it.  The address of this callback is also passed on to the
+            C function that the method wraps.</para>
+        </listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>no_slot_copy</term>
+        <listitem>
+          <para>Tells gmmproc not to pass a copy of the slot to the C function,
+            if the method has one.  Instead the slot itself is passed.  The
+            slot parameter name and the glue callback function must have been
+            specified with the <literal>slot_name</literal> and
+            <literal>slot_callbback</literal> options respectively.</para>
+        </listitem>
+    </varlistentry>
 </variablelist>
 </para>
 <para>



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