RubyGems - glib2 - Versions diffs - 3.0.7-x64-mingw32 → 3.0.8-x64-mingw32 - Mend

glib2 3.0.7-x64-mingw32 → 3.0.8-x64-mingw32

Files changed (1062) hide show

data/vendor/local/share/gtk-doc/html/gobject/gtype-non-instantiable.html CHANGED Viewed

@@ -3,12 +3,12 @@
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>Non-instantiable non-classed fundamental types: GObject Reference Manual</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
 <link rel="home" href="index.html" title="GObject Reference Manual">
 <link rel="up" href="chapter-gtype.html" title="The GLib Dynamic Type System">
 <link rel="prev" href="gtype-conventions.html" title="Conventions">
 <link rel="next" href="gtype-instantiable-classed.html" title="Instantiable classed types: objects">
-<meta name="generator" content="GTK-Doc V1.21.1 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -25,10 +25,11 @@
 <p>
           A lot of types are not instantiable by the type system and do not have
           a class. Most of these types are fundamental trivial types such as <span class="emphasis"><em>gchar</em></span>,
-          registered in <code class="function">_g_value_types_init</code> (in <code class="filename">gvaluetypes.c</code>).
+          and are already registered by GLib.
         </p>
 <p>
-          To register such a type in the type system, you just need to fill the
+          In the rare case of needing to register such a type in the type
+          system, fill a
           <a class="link" href="gobject-Type-Information.html#GTypeInfo" title="struct GTypeInfo"><span class="type">GTypeInfo</span></a> structure with zeros since these types are also most of the time
           fundamental:
           </p>
@@ -60,30 +61,30 @@
 22
 23
 24</pre></td>
-        <td class="listing_code"><pre class="programlisting"><span class="usertype">GTypeInfo</span><span class="normal"> info </span><span class="symbol">=</span><span class="normal"> </span><span class="cbracket">{</span>
-<span class="normal">  </span><span class="number">0</span><span class="symbol">,</span><span class="normal">                                </span><span class="comment">/* class_size */</span>
-<span class="normal">  <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal">                        </span><span class="comment">/* base_init */</span>
-<span class="normal">  <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal">                        </span><span class="comment">/* base_destroy */</span>
-<span class="normal">  <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal">                        </span><span class="comment">/* class_init */</span>
-<span class="normal">  <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal">                        </span><span class="comment">/* class_destroy */</span>
-<span class="normal">  <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal">                        </span><span class="comment">/* class_data */</span>
-<span class="normal">  </span><span class="number">0</span><span class="symbol">,</span><span class="normal">                                </span><span class="comment">/* instance_size */</span>
-<span class="normal">  </span><span class="number">0</span><span class="symbol">,</span><span class="normal">                                </span><span class="comment">/* n_preallocs */</span>
-<span class="normal">  <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal">                        </span><span class="comment">/* instance_init */</span>
-<span class="normal">  <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal">                        </span><span class="comment">/* value_table */</span>
-<span class="cbracket">}</span><span class="symbol">;</span>
-<span class="keyword">static</span><span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="usertype">GTypeValueTable</span><span class="normal"> value_table </span><span class="symbol">=</span><span class="normal"> </span><span class="cbracket">{</span>
-<span class="normal">  value_init_long0</span><span class="symbol">,</span><span class="normal">                </span><span class="comment">/* value_init */</span>
-<span class="normal">  <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal">                        </span><span class="comment">/* value_free */</span>
-<span class="normal">  value_copy_long0</span><span class="symbol">,</span><span class="normal">                </span><span class="comment">/* value_copy */</span>
-<span class="normal">  <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal">                        </span><span class="comment">/* value_peek_pointer */</span>
-<span class="normal">  </span><span class="string">"i"</span><span class="symbol">,</span><span class="normal">                        </span><span class="comment">/* collect_format */</span>
-<span class="normal">  value_collect_int</span><span class="symbol">,</span><span class="normal">        </span><span class="comment">/* collect_value */</span>
-<span class="normal">  </span><span class="string">"p"</span><span class="symbol">,</span><span class="normal">                        </span><span class="comment">/* lcopy_format */</span>
-<span class="normal">  value_lcopy_char</span><span class="symbol">,</span><span class="normal">                </span><span class="comment">/* lcopy_value */</span>
-<span class="cbracket">}</span><span class="symbol">;</span>
-<span class="normal">info</span><span class="symbol">.</span><span class="normal">value_table </span><span class="symbol">=</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">value_table</span><span class="symbol">;</span>
-<span class="normal">type </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="gobject-Type-Information.html#g-type-register-fundamental">g_type_register_fundamental</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="gobject-Type-Information.html#G-TYPE-CHAR:CAPS">G_TYPE_CHAR</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"gchar"</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">info</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">finfo</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">);</span></pre></td>
+        <td class="listing_code"><pre class="programlisting">GTypeInfo info <span class="gtkdoc opt">= {</span>
+  <span class="number">0</span><span class="gtkdoc opt">,</span>                                <span class="comment">/* class_size */</span>
+  NULL<span class="gtkdoc opt">,</span>                        <span class="comment">/* base_init */</span>
+  NULL<span class="gtkdoc opt">,</span>                        <span class="comment">/* base_destroy */</span>
+  NULL<span class="gtkdoc opt">,</span>                        <span class="comment">/* class_init */</span>
+  NULL<span class="gtkdoc opt">,</span>                        <span class="comment">/* class_destroy */</span>
+  NULL<span class="gtkdoc opt">,</span>                        <span class="comment">/* class_data */</span>
+  <span class="number">0</span><span class="gtkdoc opt">,</span>                                <span class="comment">/* instance_size */</span>
+  <span class="number">0</span><span class="gtkdoc opt">,</span>                                <span class="comment">/* n_preallocs */</span>
+  NULL<span class="gtkdoc opt">,</span>                        <span class="comment">/* instance_init */</span>
+  NULL<span class="gtkdoc opt">,</span>                        <span class="comment">/* value_table */</span>
+<span class="gtkdoc opt">};</span>
+<span class="gtkdoc kwb">static const</span> GTypeValueTable value_table <span class="gtkdoc opt">= {</span>
+  value_init_long0<span class="gtkdoc opt">,</span>                <span class="comment">/* value_init */</span>
+  NULL<span class="gtkdoc opt">,</span>                        <span class="comment">/* value_free */</span>
+  value_copy_long0<span class="gtkdoc opt">,</span>                <span class="comment">/* value_copy */</span>
+  NULL<span class="gtkdoc opt">,</span>                        <span class="comment">/* value_peek_pointer */</span>
+  <span class="string">&quot;i&quot;</span><span class="gtkdoc opt">,</span>                        <span class="comment">/* collect_format */</span>
+  value_collect_int<span class="gtkdoc opt">,</span>        <span class="comment">/* collect_value */</span>
+  <span class="string">&quot;p&quot;</span><span class="gtkdoc opt">,</span>                        <span class="comment">/* lcopy_format */</span>
+  value_lcopy_char<span class="gtkdoc opt">,</span>                <span class="comment">/* lcopy_value */</span>
+<span class="gtkdoc opt">};</span>
+info<span class="gtkdoc opt">.</span>value_table <span class="gtkdoc opt">= &amp;</span>value_table<span class="gtkdoc opt">;</span>
+type <span class="gtkdoc opt">=</span> <span class="function"><a href="gobject-Type-Information.html#g-type-register-fundamental">g_type_register_fundamental</a></span> <span class="gtkdoc opt">(</span>G_TYPE_CHAR<span class="gtkdoc opt">,</span> <span class="string">&quot;gchar&quot;</span><span class="gtkdoc opt">, &amp;</span>info<span class="gtkdoc opt">, &amp;</span>finfo<span class="gtkdoc opt">,</span> <span class="number">0</span><span class="gtkdoc opt">);</span></pre></td>
       </tr>
     </tbody>
   </table>
@@ -101,7 +102,6 @@
         </p>
 </div>
 <div class="footer">
-<hr>
-          Generated by GTK-Doc V1.21.1</div>
+<hr>Generated by GTK-Doc V1.24</div>
 </body>
 </html>

data/vendor/local/share/gtk-doc/html/gobject/howto-gobject-chainup.html CHANGED Viewed

@@ -3,12 +3,12 @@
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>Chaining up: GObject Reference Manual</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
 <link rel="home" href="index.html" title="GObject Reference Manual">
 <link rel="up" href="howto-gobject.html" title="How to define and implement a new GObject">
 <link rel="prev" href="howto-gobject-methods.html" title="Object methods">
 <link rel="next" href="howto-interface.html" title="How to define and implement interfaces">
-<meta name="generator" content="GTK-Doc V1.21.1 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -29,35 +29,35 @@
 <li class="listitem"><p>Parent class A defines a public virtual method named <code class="function">foo</code> and
         provides a default implementation.</p></li>
 <li class="listitem"><p>Child class B re-implements method <code class="function">foo</code>.</p></li>
-<li class="listitem"><p>In the method B::foo, the child class B calls its parent class method A::foo.</p></li>
+<li class="listitem"><p>B’s implementation of <code class="function">foo</code> calls (‘chains up to’) its parent class A’s implementation of <code class="function">foo</code>.</p></li>
 </ul></div>
 <p>
-      There are various uses to this idiom:
+      There are various uses of this idiom:
       </p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p>You need to extend the behaviour of a class without modifying its code. You create
           a subclass to inherit its implementation, re-implement a public virtual method to modify the behaviour
           and chain up to ensure that the previous behaviour is not really modified, just extended.
           </p></li>
-<li class="listitem"><p>You need to implement the Chain Of Responsibility pattern: each object of the inheritance
+<li class="listitem"><p>You need to implement the
+          <a class="ulink" href="http://en.wikipedia.org/wiki/Chain-of-responsibility_pattern" target="_top">Chain
+          Of Responsibility pattern</a>: each object of the inheritance
           tree chains up to its parent (typically, at the beginning or the end of the method) to ensure that
-          they each handler is run in turn.</p></li>
+          each handler is run in turn.</p></li>
 </ul></div>
 <p>
     </p>
 <p>
       To explicitly chain up to the implementation of the virtual method in the parent class,
       you first need a handle to the original parent class structure. This pointer can then be used to
-      access the original class function pointer and invoke it directly.
-      <a href="#ftn.id-1.6.3.8.3.1" class="footnote" name="id-1.6.3.8.3.1"><sup class="footnote">[10]</sup></a>
+      access the original virtual function pointer and invoke it directly.
+      <a href="#ftn.id-1.6.3.9.3.1" class="footnote" name="id-1.6.3.9.3.1"><sup class="footnote">[7]</sup></a>
     </p>
-<p>The function <code class="function"><a class="link" href="gobject-Type-Information.html#g-type-class-peek-parent" title="g_type_class_peek_parent ()">g_type_class_peek_parent</a></code>
-    is used to access the original parent class structure. Its input is a
-    pointer to the class of the derived object and it returns a pointer to
-    the original parent class structure. Instead of using this function
-    directly, though, you should use the <code class="function">parent_class</code>
-    pointer created and initialized for us by the G_DEFINE_TYPE_* family of
-    macros, for instance:
+<p>
+      Use the <code class="function">parent_class</code> pointer created and initialized
+      by the
+      <a class="link" href="gobject-Type-Information.html#G-DEFINE-TYPE:CAPS" title="G_DEFINE_TYPE()"><code class="function">G_DEFINE_TYPE</code></a>
+      family of macros, for instance:
 </p>
 <div class="informalexample">
   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
@@ -77,20 +77,20 @@
 12
 13
 14</pre></td>
-        <td class="listing_code"><pre class="programlisting"><span class="keyword">static</span><span class="normal"> </span><span class="type">void</span>
-<span class="function">b_method_to_call</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">B</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">obj</span><span class="symbol">,</span><span class="normal"> </span><span class="type">int</span><span class="normal"> a</span><span class="symbol">)</span>
-<span class="cbracket">{</span>
-<span class="normal">  </span><span class="comment">/* do stuff before chain up */</span>
+        <td class="listing_code"><pre class="programlisting"><span class="gtkdoc kwb">static void</span>
+<span class="function">b_method_to_call</span> <span class="gtkdoc opt">(</span>B <span class="gtkdoc opt">*</span>obj<span class="gtkdoc opt">,</span> gint some_param<span class="gtkdoc opt">)</span>
+<span class="gtkdoc opt">{</span>
+  <span class="comment">/* do stuff before chain up */</span>
-<span class="normal">  </span><span class="comment">/* call the method_to_call() virtual function on the</span>
+  <span class="comment">/* call the method_to_call() virtual function on the</span>
 <span class="comment">   * parent of BClass, AClass.</span>
 <span class="comment">   *</span>
 <span class="comment">   * remember the explicit cast to AClass*</span>
 <span class="comment">   */</span>
-<span class="normal">  </span><span class="function">A_CLASS</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">b_parent_class</span><span class="symbol">)-&gt;</span><span class="function">method_to_call</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">obj</span><span class="symbol">,</span><span class="normal"> a</span><span class="symbol">);</span>
+  <span class="function">A_CLASS</span> <span class="gtkdoc opt">(</span>b_parent_class<span class="gtkdoc opt">)-&gt;</span><span class="function">method_to_call</span> <span class="gtkdoc opt">(</span>obj<span class="gtkdoc opt">,</span> some_param<span class="gtkdoc opt">);</span>
-<span class="normal">  </span><span class="comment">/* do stuff after chain up */</span>
-<span class="cbracket">}</span></pre></td>
+  <span class="comment">/* do stuff after chain up */</span>
+<span class="gtkdoc opt">}</span></pre></td>
       </tr>
     </tbody>
   </table>
@@ -100,20 +100,19 @@
   </p>
 <div class="footnotes">
 <br><hr style="width:100; text-align:left;margin-left: 0">
-<div id="ftn.id-1.6.3.8.3.1" class="footnote"><p><a href="#id-1.6.3.8.3.1" class="para"><sup class="para">[10] </sup></a>
+<div id="ftn.id-1.6.3.9.3.1" class="footnote"><p><a href="#id-1.6.3.9.3.1" class="para"><sup class="para">[7] </sup></a>
           The <span class="emphasis"><em>original</em></span> adjective used in this sentence is not innocuous. To fully
-          understand its meaning, you need to recall how class structures are initialized: for each object type,
-          the class structure associated to this object is created by first copying the class structure of its
-          parent type (a simple <code class="function">memcpy</code>) and then by invoking the class_init callback on
-          the resulting class structure. Since the class_init callback is responsible for overwriting the class structure
-          with the user re-implementations of the class methods, we cannot merely use the modified copy of the parent class
-          structure stored in our derived instance. We want to get a copy of the class structure of an instance of the parent
-          class.
+          understand its meaning, recall how class structures are initialized: for each object type,
+          the class structure associated with this object is created by first copying the class structure of its
+          parent type (a simple <code class="function">memcpy</code>) and then by invoking the <code class="function">class_init</code> callback on
+          the resulting class structure. Since the <code class="function">class_init</code> callback is responsible for overwriting the class structure
+          with the user re-implementations of the class methods, the modified copy of the parent class
+          structure stored in the derived instance cannot be used. A copy of the class structure of an instance of the parent
+          class is needed.
         </p></div>
 </div>
 </div>
 <div class="footer">
-<hr>
-          Generated by GTK-Doc V1.21.1</div>
+<hr>Generated by GTK-Doc V1.24</div>
 </body>
 </html>

data/vendor/local/share/gtk-doc/html/gobject/howto-gobject-code.html CHANGED Viewed

@@ -3,12 +3,12 @@
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>Boilerplate code: GObject Reference Manual</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
 <link rel="home" href="index.html" title="GObject Reference Manual">
 <link rel="up" href="howto-gobject.html" title="How to define and implement a new GObject">
 <link rel="prev" href="howto-gobject.html" title="How to define and implement a new GObject">
-<link rel="next" href="howto-gobject-construction.html" title="Object Construction">
-<meta name="generator" content="GTK-Doc V1.21.1 (XML mode)">
+<link rel="next" href="howto-gobject-construction.html" title="Object construction">
+<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -23,10 +23,8 @@
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="howto-gobject-code"></a>Boilerplate code</h2></div></div></div>
 <p>
-      In your code, the first step is to #include the needed headers: depending
-      on your header include strategy, this can be as simple as
-      <code class="literal">#include "maman-bar.h"</code> or as complicated as tens
-      of #include lines ending with <code class="literal">#include "maman-bar.h"</code>:
+      In your code, the first step is to <code class="function">#include</code> the
+      needed headers:
 </p>
 <div class="informalexample">
   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
@@ -46,26 +44,18 @@
 12
 13
 14
-15
-16
-17
-18
-19</pre></td>
+15</pre></td>
         <td class="listing_code"><pre class="programlisting"><span class="comment">/*</span>
 <span class="comment"> * Copyright information</span>
 <span class="comment"> */</span>
-<span class="preproc">#include</span><span class="normal"> </span><span class="string">"maman-bar.h"</span>
+<span class="gtkdoc ppc">#include</span> <span class="gtkdoc pps">&quot;viewer-file.h&quot;</span><span class="gtkdoc ppc"></span>
-<span class="comment">/* If you use Pimpls, include the private structure </span>
-<span class="comment"> * definition here. Some people create a maman-bar-private.h header</span>
-<span class="comment"> * which is included by the maman-bar.c file and which contains the</span>
-<span class="comment"> * definition for this private structure.</span>
-<span class="comment"> */</span>
-<span class="keyword">struct</span><span class="normal"> </span><span class="classname">_MamanBarPrivate</span><span class="normal"> </span><span class="cbracket">{</span>
-<span class="normal">  </span><span class="type">int</span><span class="normal"> member_1</span><span class="symbol">;</span>
-<span class="normal">  </span><span class="comment">/* stuff */</span>
-<span class="cbracket">}</span><span class="symbol">;</span>
+<span class="comment">/* Private structure definition. */</span>
+<span class="gtkdoc kwc">typedef</span> <span class="gtkdoc kwb">struct</span> <span class="gtkdoc opt">{</span>
+  gchar <span class="gtkdoc opt">*</span>filename<span class="gtkdoc opt">;</span>
+  <span class="comment">/* stuff */</span>
+<span class="gtkdoc opt">}</span> ViewerFilePrivate<span class="gtkdoc opt">;</span>
 <span class="comment">/* </span>
 <span class="comment"> * forward definitions</span>
@@ -78,18 +68,65 @@
 <p>
     </p>
 <p>
-      Call the <code class="function">G_DEFINE_TYPE</code> macro using the name
+      If the class is being declared as final using
+      <code class="function">G_DECLARE_FINAL_TYPE</code>, its instance structure should
+      be defined in the C file:
+</p>
+<div class="informalexample">
+  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <td class="listing_lines" align="right"><pre>1
+2
+3
+4
+5
+6</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="gtkdoc kwb">struct</span> _ViewerFile
+<span class="gtkdoc opt">{</span>
+  GObject parent_instance<span class="gtkdoc opt">;</span>
+  <span class="comment">/* Other members, including private data. */</span>
+<span class="gtkdoc opt">}</span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+<p>
+    </p>
+<p>
+      Call the <code class="function">G_DEFINE_TYPE</code> macro (or
+      <code class="function">G_DEFINE_TYPE_WITH_PRIVATE</code> if your class needs
+      private data — final types do <span class="emphasis"><em>not</em></span> need private data)
+      using the name
       of the type, the prefix of the functions and the parent GType to
       reduce the amount of boilerplate needed. This macro will:
       </p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
-<li class="listitem">implement the <code class="function">maman_bar_get_type</code>
+<li class="listitem">implement the <code class="function">viewer_file_get_type</code>
         function</li>
 <li class="listitem">define a parent class pointer accessible from
         the whole .c file</li>
+<li class="listitem">add private instance data to the type (if using
+        <code class="function">G_DEFINE_TYPE_WITH_PRIVATE</code>)</li>
 </ul></div>
 <p>
+    </p>
+<p>
+      If the class has been declared as final using
+      <code class="function">G_DECLARE_FINAL_TYPE</code> (see
+      <a class="xref" href="howto-gobject.html#howto-gobject-header" title="Boilerplate header code">the section called “Boilerplate header code”</a>), private data should be placed in
+      the instance structure, <span class="type">ViewerFile</span>, and
+      <code class="function">G_DEFINE_TYPE</code> should be used instead of
+      <code class="function">G_DEFINE_TYPE_WITH_PRIVATE</code>. The instance structure
+      for a final class is not exposed publicly, and is not embedded in the
+      instance structures of any derived classes (because the class is final);
+      so its size can vary without causing incompatibilities for code which uses
+      the class. Conversely, private data for derivable classes
+      <span class="emphasis"><em>must</em></span> be included in a private structure, and
+      <code class="function">G_DEFINE_TYPE_WITH_PRIVATE</code> must be used.
 </p>
 <div class="informalexample">
@@ -97,7 +134,21 @@
     <tbody>
       <tr>
         <td class="listing_lines" align="right"><pre>1</pre></td>
-        <td class="listing_code"><pre class="programlisting"><span class="function"><a href="gobject-Type-Information.html#G-DEFINE-TYPE:CAPS">G_DEFINE_TYPE</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">MamanBar</span><span class="symbol">,</span><span class="normal"> maman_bar</span><span class="symbol">,</span><span class="normal"> <a href="gobject-Type-Information.html#G-TYPE-OBJECT:CAPS">G_TYPE_OBJECT</a></span><span class="symbol">)</span></pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="function"><a href="gobject-Type-Information.html#G-DEFINE-TYPE:CAPS">G_DEFINE_TYPE</a></span> <span class="gtkdoc opt">(</span>ViewerFile<span class="gtkdoc opt">,</span> viewer_file<span class="gtkdoc opt">,</span> G_TYPE_OBJECT<span class="gtkdoc opt">)</span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+<p>
+or
+</p>
+<div class="informalexample">
+  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <td class="listing_lines" align="right"><pre>1</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="function"><a href="gobject-Type-Information.html#G-DEFINE-TYPE-WITH-PRIVATE:CAPS">G_DEFINE_TYPE_WITH_PRIVATE</a></span> <span class="gtkdoc opt">(</span>ViewerFile<span class="gtkdoc opt">,</span> viewer_file<span class="gtkdoc opt">,</span> G_TYPE_OBJECT<span class="gtkdoc opt">)</span></pre></td>
       </tr>
     </tbody>
   </table>
@@ -108,15 +159,12 @@
 <p>
       It is also possible to use the
       <code class="function">G_DEFINE_TYPE_WITH_CODE</code> macro to control the
-      get_type function implementation - for instance, to add a call to
-      <code class="function">G_IMPLEMENT_INTERFACE</code> macro which will
-      call the <code class="function">g_type_implement_interface</code> function,
-      or call the <code class="function">G_ADD_PRIVATE</code> macro will add an
-      instance private data structure.
+      <code class="function">get_type</code> function implementation — for instance, to
+      add a call to the <code class="function">G_IMPLEMENT_INTERFACE</code> macro to
+      implement an interface.
     </p>
 </div>
 <div class="footer">
-<hr>
-          Generated by GTK-Doc V1.21.1</div>
+<hr>Generated by GTK-Doc V1.24</div>
 </body>
 </html>

data/vendor/local/share/gtk-doc/html/gobject/howto-gobject-construction.html CHANGED Viewed

@@ -2,13 +2,13 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Object Construction: GObject Reference Manual</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<title>Object construction: GObject Reference Manual</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
 <link rel="home" href="index.html" title="GObject Reference Manual">
 <link rel="up" href="howto-gobject.html" title="How to define and implement a new GObject">
 <link rel="prev" href="howto-gobject-code.html" title="Boilerplate code">
-<link rel="next" href="howto-gobject-destruction.html" title="Object Destruction">
-<meta name="generator" content="GTK-Doc V1.21.1 (XML mode)">
+<link rel="next" href="howto-gobject-destruction.html" title="Object destruction">
+<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -21,7 +21,7 @@
 </tr></table>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="howto-gobject-construction"></a>Object Construction</h2></div></div></div>
+<a name="howto-gobject-construction"></a>Object construction</h2></div></div></div>
 <p>
       People often get confused when trying to construct their GObjects because of the
       sheer number of different ways to hook into the objects's construction process: it is
@@ -31,23 +31,27 @@
       <a class="xref" href="chapter-gobject.html#gobject-construction-table" title="Table 4. g_object_new">Table 4, “g_object_new”</a> shows what user-provided functions
       are invoked during object instantiation and in which order they are invoked.
       A user looking for the equivalent of the simple C++ constructor function should use
-      the instance_init method. It will be invoked after all the parent's instance_init
+      the <code class="function">instance_init</code> method. It will be invoked after
+      all the parents’ <code class="function">instance_init</code>
       functions have been invoked. It cannot take arbitrary construction parameters
       (as in C++) but if your object needs arbitrary parameters to complete initialization,
       you can use construction properties.
     </p>
 <p>
-      Construction properties will be set only after all instance_init functions have run.
+      Construction properties will be set only after all
+      <code class="function">instance_init</code> functions have run.
       No object reference will be returned to the client of <code class="function"><a class="link" href="gobject-The-Base-Object-Type.html#g-object-new" title="g_object_new ()">g_object_new</a></code>
       until all the construction properties have been set.
     </p>
 <p>
       It is important to note that object construction cannot <span class="emphasis"><em>ever</em></span>
       fail. If you require a fallible GObject construction, you can use the
-      GInitable and GAsyncInitable interfaces provided by the GIO library
+      <a href="https://developer.gnome.org/gio/unstable/GInitable.html"><span class="type">GInitable</span></a> and
+      <a href="https://developer.gnome.org/gio/unstable/GAsyncInitable.html"><span class="type">GAsyncInitable</span></a>
+      interfaces provided by the GIO library.
     </p>
 <p>
-      As such, I would recommend writing the following code first:
+      You should write the following code first:
 </p>
 <div class="informalexample">
   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
@@ -68,21 +72,21 @@
 13
 14
 15</pre></td>
-        <td class="listing_code"><pre class="programlisting"><span class="function"><a href="gobject-Type-Information.html#G-DEFINE-TYPE-WITH-PRIVATE:CAPS">G_DEFINE_TYPE_WITH_PRIVATE</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">MamanBar</span><span class="symbol">,</span><span class="normal"> maman_bar</span><span class="symbol">,</span><span class="normal"> <a href="gobject-Type-Information.html#G-TYPE-OBJECT:CAPS">G_TYPE_OBJECT</a></span><span class="symbol">)</span>
+        <td class="listing_code"><pre class="programlisting"><span class="function"><a href="gobject-Type-Information.html#G-DEFINE-TYPE-WITH-PRIVATE:CAPS">G_DEFINE_TYPE_WITH_PRIVATE</a></span> <span class="gtkdoc opt">(</span>ViewerFile<span class="gtkdoc opt">,</span> viewer_file<span class="gtkdoc opt">,</span> G_TYPE_OBJECT<span class="gtkdoc opt">)</span>
-<span class="keyword">static</span><span class="normal"> </span><span class="type">void</span>
-<span class="function">maman_bar_class_init</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">MamanBarClass</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">klass</span><span class="symbol">)</span>
-<span class="cbracket">{</span>
-<span class="cbracket">}</span>
+<span class="gtkdoc kwb">static void</span>
+<span class="function">viewer_file_class_init</span> <span class="gtkdoc opt">(</span>ViewerFileClass <span class="gtkdoc opt">*</span>klass<span class="gtkdoc opt">)</span>
+<span class="gtkdoc opt">{</span>
+<span class="gtkdoc opt">}</span>
-<span class="keyword">static</span><span class="normal"> </span><span class="type">void</span>
-<span class="function">maman_bar_init</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">MamanBar</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">self</span><span class="symbol">)</span>
-<span class="cbracket">{</span>
-<span class="normal">  self</span><span class="symbol">-&gt;</span><span class="normal">priv </span><span class="symbol">=</span><span class="normal"> </span><span class="function">maman_bar_get_instance_private</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">self</span><span class="symbol">);</span>
+<span class="gtkdoc kwb">static void</span>
+<span class="function">viewer_file_init</span> <span class="gtkdoc opt">(</span>ViewerFile <span class="gtkdoc opt">*</span>self<span class="gtkdoc opt">)</span>
+<span class="gtkdoc opt">{</span>
+  ViewerFilePrivate <span class="gtkdoc opt">*</span>priv <span class="gtkdoc opt">=</span> <span class="function">viewer_file_get_instance_private</span> <span class="gtkdoc opt">(</span>self<span class="gtkdoc opt">);</span>
-<span class="normal">  </span><span class="comment">/* initialize all public and private members to reasonable default values.</span>
+  <span class="comment">/* initialize all public and private members to reasonable default values.</span>
 <span class="comment">   * They are all automatically initialized to 0 to begin with. */</span>
-<span class="cbracket">}</span></pre></td>
+<span class="gtkdoc opt">}</span></pre></td>
       </tr>
     </tbody>
   </table>
@@ -91,10 +95,16 @@
 <p>
     </p>
 <p>
-      If you need special construction properties, install the properties in
+      If you need special construction properties (with
+      <a class="link" href="gobject-GParamSpec.html#G-PARAM-CONSTRUCT-ONLY:CAPS"><code class="function">G_PARAM_CONSTRUCT_ONLY</code></a>
+      set), install the properties in
       the <code class="function">class_init()</code> function, override the <code class="function">set_property()</code>
       and <code class="function">get_property()</code> methods of the GObject class,
       and implement them as described by <a class="xref" href="gobject-properties.html" title="Object properties">the section called “Object properties”</a>.
+    </p>
+<p>
+      Property IDs must start from 1, as 0 is reserved for internal use by
+      GObject.
 </p>
 <div class="informalexample">
   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
@@ -131,39 +141,49 @@
 29
 30
 31
-32</pre></td>
-        <td class="listing_code"><pre class="programlisting"><span class="keyword">enum</span><span class="normal"> </span><span class="cbracket">{</span>
-<span class="normal">  PROP_0</span><span class="symbol">,</span>
-<span class="normal">  PROP_MAMAN</span><span class="symbol">,</span>
+32
+33
+34
+35
+36
+37</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="gtkdoc kwb">enum</span>
+<span class="gtkdoc opt">{</span>
+  PROP_FILENAME <span class="gtkdoc opt">=</span> <span class="number">1</span><span class="gtkdoc opt">,</span>
+  PROP_ZOOM_LEVEL<span class="gtkdoc opt">,</span>
+  N_PROPERTIES
+<span class="gtkdoc opt">};</span>
-<span class="normal">  N_PROPERTIES</span>
-<span class="cbracket">}</span><span class="symbol">;</span>
+<span class="gtkdoc kwb">static</span> GParamSpec <span class="gtkdoc opt">*</span>obj_properties<span class="gtkdoc opt">[</span>N_PROPERTIES<span class="gtkdoc opt">] = {</span> NULL<span class="gtkdoc opt">, };</span>
-<span class="comment">/* Keep a pointer to the properties definition */</span>
-<span class="keyword">static</span><span class="normal"> </span><span class="usertype">GParamSpec</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">obj_properties</span><span class="symbol">[</span><span class="normal">N_PROPERTIES</span><span class="symbol">]</span><span class="normal"> </span><span class="symbol">=</span><span class="normal"> </span><span class="cbracket">{</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="cbracket">}</span><span class="symbol">;</span>
+<span class="gtkdoc kwb">static void</span>
+<span class="function">viewer_file_class_init</span> <span class="gtkdoc opt">(</span>ViewerFileClass <span class="gtkdoc opt">*</span>klass<span class="gtkdoc opt">)</span>
+<span class="gtkdoc opt">{</span>
+  GObjectClass <span class="gtkdoc opt">*</span>object_class <span class="gtkdoc opt">=</span> <span class="function"><a href="gobject-The-Base-Object-Type.html#G-OBJECT-CLASS:CAPS">G_OBJECT_CLASS</a></span> <span class="gtkdoc opt">(</span>klass<span class="gtkdoc opt">);</span>
-<span class="keyword">static</span><span class="normal"> </span><span class="type">void</span>
-<span class="function">bar_class_init</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">MamanBarClass</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">klass</span><span class="symbol">)</span>
-<span class="cbracket">{</span>
-<span class="normal">  </span><span class="usertype">GObjectClass</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">gobject_class </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="gobject-The-Base-Object-Type.html#G-OBJECT-CLASS:CAPS">G_OBJECT_CLASS</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">klass</span><span class="symbol">);</span>
+  object_class<span class="gtkdoc opt">-&gt;</span>set_property <span class="gtkdoc opt">=</span> viewer_file_set_property<span class="gtkdoc opt">;</span>
+  object_class<span class="gtkdoc opt">-&gt;</span>get_property <span class="gtkdoc opt">=</span> viewer_file_get_property<span class="gtkdoc opt">;</span>
-<span class="normal">  gobject_class</span><span class="symbol">-&gt;</span><span class="normal">set_property </span><span class="symbol">=</span><span class="normal"> bar_set_property</span><span class="symbol">;</span>
-<span class="normal">  gobject_class</span><span class="symbol">-&gt;</span><span class="normal">get_property </span><span class="symbol">=</span><span class="normal"> bar_get_property</span><span class="symbol">;</span>
+  obj_properties<span class="gtkdoc opt">[</span>PROP_FILENAME<span class="gtkdoc opt">] =</span>
+    <span class="function"><a href="gobject-Standard-Parameter-and-Value-Types.html#g-param-spec-string">g_param_spec_string</a></span> <span class="gtkdoc opt">(</span><span class="string">&quot;filename&quot;</span><span class="gtkdoc opt">,</span>
+                         <span class="string">&quot;Filename&quot;</span><span class="gtkdoc opt">,</span>
+                         <span class="string">&quot;Name of the file to load and display from.&quot;</span><span class="gtkdoc opt">,</span>
+                         NULL  <span class="comment">/* default value */</span><span class="gtkdoc opt">,</span>
+                         G_PARAM_CONSTRUCT_ONLY <span class="gtkdoc opt">|</span> G_PARAM_READWRITE<span class="gtkdoc opt">));</span>
-<span class="normal">  obj_properties</span><span class="symbol">[</span><span class="normal">PROP_MAMAN</span><span class="symbol">]</span><span class="normal"> </span><span class="symbol">=</span>
-<span class="normal">    </span><span class="function"><a href="gobject-Standard-Parameter-and-Value-Types.html#g-param-spec-string">g_param_spec_string</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"maman"</span><span class="symbol">,</span>
-<span class="normal">                         </span><span class="string">"Maman construct prop"</span><span class="symbol">,</span>
-<span class="normal">                         </span><span class="string">"Set maman's name"</span><span class="symbol">,</span>
-<span class="normal">                         </span><span class="string">"no-name-set"</span><span class="normal"> </span><span class="comment">/* default value */</span><span class="symbol">,</span>
-<span class="normal">                         <a href="gobject-GParamSpec.html#G-PARAM-CONSTRUCT-ONLY:CAPS">G_PARAM_CONSTRUCT_ONLY</a> </span><span class="symbol">|</span>
-<span class="normal">                         <a href="gobject-GParamSpec.html#G-PARAM-READWRITE:CAPS">G_PARAM_READWRITE</a> </span><span class="symbol">|</span>
-<span class="normal">                         <a href="gobject-GParamSpec.html#G-PARAM-STATIC-STRINGS:CAPS">G_PARAM_STATIC_STRINGS</a></span><span class="symbol">);</span>
+  obj_properties<span class="gtkdoc opt">[</span>PROP_ZOOM_LEVEL<span class="gtkdoc opt">] =</span>
+    <span class="function"><a href="gobject-Standard-Parameter-and-Value-Types.html#g-param-spec-uint">g_param_spec_uint</a></span> <span class="gtkdoc opt">(</span><span class="string">&quot;zoom-level&quot;</span><span class="gtkdoc opt">,</span>
+                       <span class="string">&quot;Zoom level&quot;</span><span class="gtkdoc opt">,</span>
+                       <span class="string">&quot;Zoom level to view the file at.&quot;</span><span class="gtkdoc opt">,</span>
+                       <span class="number">0</span>  <span class="comment">/* minimum value */</span><span class="gtkdoc opt">,</span>
+                       <span class="number">10</span> <span class="comment">/* maximum value */</span><span class="gtkdoc opt">,</span>
+                       <span class="number">2</span>  <span class="comment">/* default value */</span><span class="gtkdoc opt">,</span>
+                       G_PARAM_READWRITE<span class="gtkdoc opt">));</span>
-<span class="normal">  </span><span class="function"><a href="gobject-The-Base-Object-Type.html#g-object-class-install-properties">g_object_class_install_properties</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">gobject_class</span><span class="symbol">,</span>
-<span class="normal">                                     N_PROPERTIES</span><span class="symbol">,</span>
-<span class="normal">                                     obj_properties</span><span class="symbol">);</span>
-<span class="cbracket">}</span></pre></td>
+  <span class="function"><a href="gobject-The-Base-Object-Type.html#g-object-class-install-properties">g_object_class_install_properties</a></span> <span class="gtkdoc opt">(</span>object_class<span class="gtkdoc opt">,</span>
+                                     N_PROPERTIES<span class="gtkdoc opt">,</span>
+                                     obj_properties<span class="gtkdoc opt">);</span>
+<span class="gtkdoc opt">}</span></pre></td>
       </tr>
     </tbody>
   </table>
@@ -179,16 +199,16 @@
       of a type only after the properties passed to the constructors have been
       set. This is possible through the use of the <code class="function">constructor()</code>
       class method as described in <a class="xref" href="chapter-gobject.html#gobject-instantiation" title="Object instantiation">the section called “Object instantiation”</a> or,
-      more simply, using the <code class="function">constructed()</code> class method
-      available since GLib 2.12. Note that the <code class="function">constructed()</code>
+      more simply, using the <code class="function">constructed()</code> class method.
+      Note that the <code class="function">constructed()</code>
       virtual function will only be invoked after the properties marked as
-      G_PARAM_CONSTRUCT_ONLY or G_PARAM_CONSTRUCT have been consumed, but
+      <code class="function">G_PARAM_CONSTRUCT_ONLY</code> or
+      <code class="function">G_PARAM_CONSTRUCT</code> have been consumed, but
       before the regular properties passed to <code class="function">g_object_new()</code>
       have been set.
     </p>
 </div>
 <div class="footer">
-<hr>
-          Generated by GTK-Doc V1.21.1</div>
+<hr>Generated by GTK-Doc V1.24</div>
 </body>
 </html>