[gtkmm-documentation] Add description of the detail_name parameter in _WRAP_SIGNAL



commit 0177730bddc41837392778aa3a73dca761e3d8de
Author: Kjell Ahlstedt <kjell ahlstedt bredband net>
Date:   Sat May 23 09:19:17 2015 +0200

    Add description of the detail_name parameter in _WRAP_SIGNAL
    
    * docs/tutorial/C/index-in.docbook: "The .hg and .ccg files" section:
    Add description of the detail_name and two_signal_methods parameters in
    _WRAP_SIGNAL. Bug #749034.

 docs/tutorial/C/index-in.docbook |   21 +++++++++++++++++++++
 1 files changed, 21 insertions(+), 0 deletions(-)
---
diff --git a/docs/tutorial/C/index-in.docbook b/docs/tutorial/C/index-in.docbook
index b86c63c..78c1ada 100644
--- a/docs/tutorial/C/index-in.docbook
+++ b/docs/tutorial/C/index-in.docbook
@@ -9615,6 +9615,27 @@ _WRAP_SIGNAL(void clicked(),"clicked")
                    caught by default handler.</para>
              </listitem>
     </varlistentry>
+    <varlistentry>
+        <term>detail_name &lt;parameter_name&gt;</term>
+             <listitem>
+               <para>Adds a <type>const Glib::ustring&amp;</type> parameter to the
+                   <methodname>signal_something()</methodname> method. Use it, if the signal
+                   accepts a detailed signal name, i.e. if the underlying C code registers
+                   the signal with the <literal>G_SIGNAL_DETAILED</literal> flag.</para>
+             </listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>two_signal_methods</term>
+             <listitem>
+               <para>Used in conjunction with the <literal>detail_name</literal>
+              option to generate two <methodname>signal_something()</methodname>
+              methods, one without a parameter and one with a parameter without
+              a default value. With only the <literal>detail_name</literal> option
+              one method is generated, with a parameter with default value.
+              Use the <literal>two_signal_methods</literal> option, if it's
+              necessary in order to preserve ABI.</para>
+             </listitem>
+    </varlistentry>
 </variablelist>
 </para>
 </sect3>


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