From 3bd20fd42ba96ab19ea217d7b224c766d00cc06a Mon Sep 17 00:00:00 2001
From: Johan Dahlin <johan@src.gnome.org>
Date: Wed, 12 Jul 2006 23:06:52 +0000
Subject: Import GObject part of John Finlay's PyGTK Reference Manual, copy
 over

    * Makefile.am:
    * configure.ac:
    * docs/.cvsignore:
    * docs/Makefile.am:
    * docs/common.xsl:
    * docs/devhelp.xsl:
    * docs/html.xsl:
    * docs/pdf-style.xsl:
    * docs/pdf.xsl:
    * docs/ref-html-style.xsl:
    * docs/reference/.cvsignore:
    * docs/reference/pygobject-classes.xml:
    * docs/reference/pygobject-constants.xml:
    * docs/reference/pygobject-functions.xml:
    * docs/reference/pygobject-gboxed.xml:
    * docs/reference/pygobject-ginterface.xml:
    * docs/reference/pygobject-gpointer.xml:
    * docs/reference/pygobject-maincontext.xml:
    * docs/reference/pygobject-mainloop.xml:
    * docs/reference/pygobject-ref.xml:
    * docs/reference/pygobject.xml:
    Import GObject part of John Finlay's PyGTK Reference Manual, copy
    over infrastructure from the pygtk-web module.
---
 docs/reference/pygobject-gboxed.xml | 68 +++++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 docs/reference/pygobject-gboxed.xml

(limited to 'docs/reference/pygobject-gboxed.xml')

diff --git a/docs/reference/pygobject-gboxed.xml b/docs/reference/pygobject-gboxed.xml
new file mode 100644
index 0000000..f7f2438
--- /dev/null
+++ b/docs/reference/pygobject-gboxed.xml
@@ -0,0 +1,68 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+
+<refentry id="class-gobjectgboxed">
+  <refnamediv>
+    <refname>gobject.GBoxed</refname>
+    <refpurpose>an object containing an opaque chunk of data</refpurpose>
+  </refnamediv>
+
+  <refsect1>
+    <title>Synopsis</title>
+
+<classsynopsis language="python">
+  <ooclass><classname>gobject.GBoxed</classname></ooclass>
+<methodsynopsis language="python">
+    <methodname><link linkend="method-gobjectgboxed--copy">copy</link></methodname>
+  </methodsynopsis>
+</classsynopsis>
+
+</refsect1>
+
+  <refsect1>
+    <title>Ancestry</title>
+
+<synopsis>+-- <link linkend="class-gobjectgboxed">gobject.GBoxed</link>
+</synopsis>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para><link
+linkend="class-gobjectgboxed"><classname>gobject.GBoxed</classname></link>
+is an abstract base class that encapsulates an opaque chunk of data to
+provide an object-oriented interface and a type that is registered with the
+<literal>GLIB</literal> type system. A boxed type is registered with
+functions that provide for the copying and freeing of the underlying data
+structure - this allows PyGTK to encapsulate these as Python objects.</para>
+
+  </refsect1>
+
+  <refsect1>
+    <title>Methods</title>
+
+    <refsect2 id="method-gobjectgboxed--copy">
+      <title>gobject.GBoxed.copy</title>
+
+      <programlisting><methodsynopsis language="python">
+	  <methodname>copy</methodname>
+	</methodsynopsis></programlisting>
+      <variablelist>
+	<varlistentry>
+	<term><emphasis>Returns</emphasis>&nbsp;:</term>
+	  <listitem><simpara>a copy of the <link
+	  linkend="class-gobjectgboxed"><classname>gobject.GBoxed</classname></link>
+	  object</simpara></listitem>
+	</varlistentry>
+      </variablelist>
+
+      <para>The <methodname>copy</methodname>() method makes and returns a copy of the boxed object.</para>
+
+    </refsect2>
+
+  </refsect1>
+
+</refentry>
-- 
cgit