RubyGems - gio2 - Versions diffs - 0.90.3-x86-mingw32 - Mend

gio2 0.90.3-x86-mingw32

Files changed (856) hide show

data/vendor/local/share/gtk-doc/html/gobject/howto-interface-implement.html ADDED

@@ -0,0 +1,125 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>How To define implement an Interface?</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="index.html" title="GObject Reference Manual">
+<link rel="up" href="howto-interface.html" title="How to define and implement interfaces">
+<link rel="prev" href="howto-interface.html" title="How to define and implement interfaces">
+<link rel="next" href="ch06s03.html" title="Interface definition prerequisites">
+<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
+<td><a accesskey="p" href="howto-interface.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="howto-interface.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
+<th width="100%" align="center">GObject Reference Manual</th>
+<td><a accesskey="n" href="ch06s03.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="sect1">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="howto-interface-implement"></a>How To define implement an Interface?</h2></div></div></div>
+<p>
+      Once the interface is defined, implementing it is rather trivial.
+    </p>
+<p>
+      The first step is to define a normal GObject class, like:
+</p>
+<pre class="programlisting">
+#ifndef __MAMAN_BAZ_H__
+#define __MAMAN_BAZ_H__
+#include &lt;glib-object.h&gt;
+#define MAMAN_TYPE_BAZ             (maman_baz_get_type ())
+#define MAMAN_BAZ(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), MAMAN_TYPE_BAZ, Mamanbaz))
+#define MAMAN_IS_BAZ(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MAMAN_TYPE_BAZ))
+#define MAMAN_BAZ_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), MAMAN_TYPE_BAZ, MamanbazClass))
+#define MAMAN_IS_BAZ_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), MAMAN_TYPE_BAZ))
+#define MAMAN_BAZ_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), MAMAN_TYPE_BAZ, MamanbazClass))
+typedef struct _MamanBaz        MamanBaz;
+typedef struct _MamanBazClass   MamanBazClass;
+struct _MamanBaz
+{
+  GObject parent_instance;
+  int instance_member;
+};
+struct _MamanBazClass
+{
+  GObjectClass parent_class;
+};
+GType maman_baz_get_type (void);
+#endif /* __MAMAN_BAZ_H__ */
+</pre>
+<p>
+      There is clearly nothing specifically weird or scary about this header:
+      it does not define any weird API or derives from a weird type.
+    </p>
+<p>
+      The second step is to implement <span class="type">MamanBaz</span> by defining
+      its GType. Instead of using <code class="function">G_DEFINE_TYPE</code> we
+      use <code class="function">G_DEFINE_TYPE_WITH_CODE</code> and the
+      <code class="function">G_IMPLEMENT_INTERFACE</code> macros.
+</p>
+<pre class="programlisting">
+static void maman_ibaz_interface_init (MamanIbazInterface *iface);
+G_DEFINE_TYPE_WITH_CODE (MamanBar, maman_bar, G_TYPE_OBJECT,
+                         G_IMPLEMENT_INTERFACE (MAMAN_TYPE_IBAZ,
+                                                maman_ibaz_interface_init));
+</pre>
+<p>
+      This definition is very much like all the similar functions we looked
+      at previously. The only interface-specific code present here is the call
+      to <code class="function">G_IMPLEMENT_INTERFACE</code>.
+    </p>
+<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
+<h3 class="title">Note</h3>
+<p>Classes can implement multiple interfaces by using multiple
+    calls to <code class="function">G_IMPLEMENT_INTERFACE</code> inside the call
+    to <code class="function">G_DEFINE_TYPE_WITH_CODE</code>.</p>
+</div>
+<p>
+      <code class="function">maman_baz_interface_init</code>, the interface
+      initialization function: inside it every virtual method of the interface
+      must be assigned to its implementation:
+</p>
+<pre class="programlisting">
+static void
+maman_baz_do_action (MamanBaz *self)
+{
+  g_print ("Baz implementation of IBaz interface Action: 0x%x.\n",
+           self-&gt;instance_member);
+}
+static void
+maman_ibaz_interface_init (MamanIbazInterface *iface)
+{
+  iface-&gt;do_action = baz_do_action;
+}
+static void
+maman_baz_init (MamanBaz *self)
+{
+  MamanBaz *self = MAMAN_BAZ (instance);
+  self-&gt;instance_member = 0xdeadbeaf;
+}
+</pre>
+<p>
+    </p>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.15.1</div>
+</body>
+</html>

data/vendor/local/share/gtk-doc/html/gobject/howto-interface-properties.html ADDED

@@ -0,0 +1,167 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Interface Properties</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="index.html" title="GObject Reference Manual">
+<link rel="up" href="howto-interface.html" title="How to define and implement interfaces">
+<link rel="prev" href="ch06s03.html" title="Interface definition prerequisites">
+<link rel="next" href="howto-signals.html" title="How to create and use signals">
+<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
+<td><a accesskey="p" href="ch06s03.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="howto-interface.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
+<th width="100%" align="center">GObject Reference Manual</th>
+<td><a accesskey="n" href="howto-signals.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="sect1">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="howto-interface-properties"></a>Interface Properties</h2></div></div></div>
+<p>
+      Starting from version 2.4 of GLib, GObject interfaces can also have
+      properties. Declaration of the interface properties is similar to
+      declaring the properties of ordinary GObject types as explained in
+      <a class="xref" href="gobject-properties.html" title="Object properties">the section called “Object properties”</a>,
+      except that <code class="function"><a class="link" href="gobject-The-Base-Object-Type.html#g-object-interface-install-property" title="g_object_interface_install_property ()">g_object_interface_install_property</a></code> is used to
+      declare the properties instead of <code class="function"><a class="link" href="gobject-The-Base-Object-Type.html#g-object-class-install-property" title="g_object_class_install_property ()">g_object_class_install_property</a></code>.
+    </p>
+<p>
+      To include a property named 'name' of type <span class="type">string</span> in the
+      <span class="type">maman_ibaz</span> interface example code above, we only need to
+      add one
+      <sup>[<a name="id471707" href="#ftn.id471707" class="footnote">12</a>]</sup>
+      line in the <code class="function">maman_ibaz_base_init</code>
+      <sup>[<a name="id471720" href="#ftn.id471720" class="footnote">13</a>]</sup>
+      as shown below:
+</p>
+<pre class="programlisting">
+static void
+maman_ibaz_base_init (gpointer g_iface)
+{
+  static gboolean is_initialized = FALSE;
+  if (!is_initialized)
+    {
+      g_object_interface_install_property (g_iface,
+                                           g_param_spec_string ("name",
+                                                                "Name",
+                                                                "Name of the MamanIbaz",
+                                                                "maman",
+                                                                G_PARAM_READWRITE));
+      is_initialized = TRUE;
+    }
+}
+</pre>
+<p>
+    </p>
+<p>
+      One point worth noting is that the declared property wasn't assigned an
+      integer ID. The reason being that integer IDs of properties are used
+      only inside the get and set methods and since interfaces do not
+      implement properties, there is no need to assign integer IDs to
+      interface properties.
+    </p>
+<p>
+      An implementation shall declare and define it's properties in the usual
+      way as explained in <a class="xref" href="gobject-properties.html" title="Object properties">the section called “Object properties”</a>, except for one
+      small change: it must declare the properties of the interface it
+      implements using <code class="function"><a class="link" href="gobject-The-Base-Object-Type.html#g-object-class-override-property" title="g_object_class_override_property ()">g_object_class_override_property</a></code>
+      instead of <code class="function"><a class="link" href="gobject-The-Base-Object-Type.html#g-object-class-install-property" title="g_object_class_install_property ()">g_object_class_install_property</a></code>.
+      The following code snippet shows the modifications needed in the
+      <span class="type">MamanBaz</span> declaration and implementation above:
+</p>
+<pre class="programlisting">
+struct _MamanBaz
+{
+  GObject parent_instance;
+  gint instance_member;
+  gchar *name;
+};
+enum
+{
+  PROP_0,
+  PROP_NAME
+};
+static void
+maman_baz_set_property (GObject      *object,
+                        guint         property_id,
+                        const GValue *value,
+                        GParamSpec   *pspec)
+{
+  MamanBaz *baz = MAMAN_BAZ (object);
+  GObject *obj;
+  switch (prop_id)
+    {
+    case ARG_NAME:
+      g_free (baz-&gt;name);
+      baz-&gt;name = g_value_dup_string (value);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
+    }
+}
+static void
+maman_baz_get_property (GObject    *object,
+                        guint       prop_id,
+                        GValue     *value,
+                        GParamSpec *pspec)
+{
+  MamanBaz *baz = MAMAN_BAZ (object);
+  switch (prop_id)
+    {
+    case ARG_NAME:
+      g_value_set_string (value, baz-&gt;name);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
+    }
+}
+static void
+maman_baz_class_init (MamanBazClass *klass)
+{
+  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+  gobject_class-&gt;set_property = maman_baz_set_property;
+  gobject_class-&gt;get_property = maman_baz_get_property;
+  g_object_class_override_property (gobject_class, PROP_NAME, "name");
+}
+</pre>
+<p>
+    </p>
+<div class="footnotes">
+<br><hr width="100" align="left">
+<div class="footnote"><p><sup>[<a name="ftn.id471707" href="#id471707" class="para">12</a>] </sup>
+          That really is one line extended to six for the sake of clarity
+        </p></div>
+<div class="footnote"><p><sup>[<a name="ftn.id471720" href="#id471720" class="para">13</a>] </sup>
+          The <code class="function"><a class="link" href="gobject-The-Base-Object-Type.html#g-object-interface-install-property" title="g_object_interface_install_property ()">g_object_interface_install_property</a></code>
+          can also be called from <code class="function">class_init</code> but it must
+          not be called after that point.
+        </p></div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.15.1</div>
+</body>
+</html>

data/vendor/local/share/gtk-doc/html/gobject/howto-interface.html ADDED

@@ -0,0 +1,160 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>How to define and implement interfaces</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="index.html" title="GObject Reference Manual">
+<link rel="up" href="pt02.html" title="Part IV. Tutorial">
+<link rel="prev" href="howto-gobject-chainup.html" title="Chaining up">
+<link rel="next" href="howto-interface-implement.html" title="How To define implement an Interface?">
+<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
+<td><a accesskey="p" href="howto-gobject-chainup.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="pt02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
+<th width="100%" align="center">GObject Reference Manual</th>
+<td><a accesskey="n" href="howto-interface-implement.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="chapter">
+<div class="titlepage"><div><div><h2 class="title">
+<a name="howto-interface"></a>How to define and implement interfaces</h2></div></div></div>
+<div class="toc"><dl>
+<dt><span class="sect1"><a href="howto-interface.html#howto-interface-define">How to define interfaces</a></span></dt>
+<dt><span class="sect1"><a href="howto-interface-implement.html">How To define implement an Interface?</a></span></dt>
+<dt><span class="sect1"><a href="ch06s03.html">Interface definition prerequisites</a></span></dt>
+<dt><span class="sect1"><a href="howto-interface-properties.html">Interface Properties</a></span></dt>
+</dl></div>
+<div class="sect1">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="howto-interface-define"></a>How to define interfaces</h2></div></div></div>
+<p>
+    The bulk of interface definition has already been shown in <a class="xref" href="gtype-non-instantiable-classed.html" title="Non-instantiable classed types: interfaces">the section called “Non-instantiable classed types: interfaces”</a>
+    but I feel it is needed to show exactly how to create an interface.
+  </p>
+<p>
+    As above, the first step is to get the header right:
+</p>
+<pre class="programlisting">
+#ifndef __MAMAN_IBAZ_H__
+#define __MAMAN_IBAZ_H__
+#include &lt;glib-object.h&gt;
+#define MAMAN_TYPE_IBAZ                 (maman_ibaz_get_type ())
+#define MAMAN_IBAZ(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), MAMAN_TYPE_IBAZ, MamanIbaz))
+#define MAMAN_IS_IBAZ(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MAMAN_TYPE_IBAZ))
+#define MAMAN_IBAZ_GET_INTERFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), MAMAN_TYPE_IBAZ, MamanIbazInterface))
+typedef struct _MamanIbaz               MamanIbaz; /* dummy object */
+typedef struct _MamanIbazInterface      MamanIbazInterface;
+struct _MamanIbazInterface
+{
+  GTypeInterface parent_iface;
+  void (*do_action) (MamanIbaz *self);
+};
+GType maman_ibaz_get_type (void);
+void maman_ibaz_do_action (MamanIbaz *self);
+#endif /* __MAMAN_IBAZ_H__ */
+</pre>
+<p>
+    This code is the same as the code for a normal <span class="type"><a class="link" href="gobject-Type-Information.html#GType" title="GType">GType</a></span>
+    which derives from a <span class="type"><a class="link" href="gobject-The-Base-Object-Type.html#GObject">GObject</a></span> except for a few details:
+    </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem"><p>
+        The <code class="function">_GET_CLASS</code> macro is called <code class="function">_GET_INTERFACE</code>
+                  and not implemented with <code class="function">G_TYPE_INSTANCE_GET_CLASS</code>
+                  but with <code class="function">G_TYPE_INSTANCE_GET_INTERFACE</code>.
+      </p></li>
+<li class="listitem"><p>
+        The instance type, <span class="type">MamanIbaz</span> is not fully defined: it is
+        used merely as an abstract type which represents an instance of
+        whatever object which implements the interface.
+      </p></li>
+<li class="listitem"><p>
+        The parent of the <span class="type">MamanIbazInterface</span> is not
+        <span class="type">GObjectClass</span> but <span class="type">GTypeInterface</span>.
+      </p></li>
+</ul></div>
+<p>
+  </p>
+<p>
+    The implementation of the <span class="type">MamanIbaz</span> type itself is trivial:
+    </p>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem"><p><code class="function">maman_ibaz_get_type</code> registers the
+       type in the type system.
+       </p></li>
+<li class="listitem"><p><code class="function">maman_ibaz_base_init</code> is expected
+      to register the interface's signals if there are any (we will see a bit
+      (later how to use them). Make sure to use a static local boolean variable
+      to make sure not to run the initialization code twice (as described in
+      <a class="xref" href="gtype-non-instantiable-classed.html#gtype-non-instantiable-classed-init" title="Interface Initialization">the section called “Interface Initialization”</a>,
+      <code class="function">base_init</code> is run once for each interface implementation
+      instantiation)</p></li>
+<li class="listitem"><p><code class="function">maman_ibaz_do_action</code> dereferences
+      the class structure to access its associated class function and calls it.
+      </p></li>
+</ul></div>
+<p>
+</p>
+<pre class="programlisting">
+static void
+maman_ibaz_base_init (gpointer g_class)
+{
+  static gboolean is_initialized = FALSE;
+  if (!is_initialized)
+    {
+      /* add properties and signals to the interface here */
+      is_initialized = TRUE;
+    }
+}
+GType
+maman_ibaz_get_type (void)
+{
+  static GType iface_type = 0;
+  if (iface_type == 0)
+    {
+      static const GTypeInfo info = {
+        sizeof (MamanIbazInterface),
+        maman_ibaz_base_init,   /* base_init */
+        NULL,   /* base_finalize */
+      };
+      iface_type = g_type_register_static (G_TYPE_INTERFACE, "MamanIbaz",
+                                           &amp;info, 0);
+    }
+  return iface_type;
+}
+void
+maman_ibaz_do_action (MamanIbaz *self)
+{
+  g_return_if_fail (MAMAN_IS_IBAZ (self));
+  MAMAN_IBAZ_GET_INTERFACE (self)-&gt;do_action (self);
+}
+</pre>
+<p>
+    </p>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.15.1</div>
+</body>
+</html>