[gtkmm-documentation] Appendix G: _WRAP_VFUNC(): Include slot options documentation.
- From: José Alburquerque <jaalburqu src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtkmm-documentation] Appendix G: _WRAP_VFUNC(): Include slot options documentation.
- Date: Sun, 30 Jun 2013 22:06:10 +0000 (UTC)
commit 2b7687e6285d6f781e0a1561d9ede8284b19ed5a
Author: José Alburquerque <jaalburquerque gmail com>
Date: Sun Jun 30 17:26:30 2013 -0400
Appendix G: _WRAP_VFUNC(): Include slot options documentation.
* docs/tutorial/C/gtkmm-tutorial-in.xml: Include documentation in the
wrapping appendix for the 'slot_name', 'slot_callback' and
'no_slot_copy' options that _WRAP_VFUNC() handles just like
_WRAP_METHOD() does. Edit the corresponding _WRAP_METHOD() options
and copy them to avoid retyping the same thing twice. This should
have been done some time ago but I had not been able to get to it.
docs/tutorial/C/gtkmm-tutorial-in.xml | 62 +++++++++++++++++++++++++--------
1 files changed, 47 insertions(+), 15 deletions(-)
---
diff --git a/docs/tutorial/C/gtkmm-tutorial-in.xml b/docs/tutorial/C/gtkmm-tutorial-in.xml
index 511531b..53ccc9e 100644
--- a/docs/tutorial/C/gtkmm-tutorial-in.xml
+++ b/docs/tutorial/C/gtkmm-tutorial-in.xml
@@ -9300,32 +9300,32 @@ _WRAP_METHOD(void set_text(const Glib::ustring& text), gtk_entry_set_text)
<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>
+ <para>Specifies the name of the slot parameter of the method, if it
+ has one. This enables <command>gmmproc</command> 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>
+ option to specify 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
+ <para>Tells <command>gmmproc</command> 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>
@@ -9533,6 +9533,38 @@ _WRAP_VFUNC(SizeRequestMode get_request_mode() const, get_request_mode)
<para>Puts the generated code in #ifdef blocks.</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>slot_name</term>
+ <listitem>
+ <para>Specifies the name of the slot parameter of the method, if it
+ has one. This enables <command>gmmproc</command> 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 specify 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 <command>gmmproc</command> 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>A rule to which there may be exceptions: If the virtual C function returns
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]