summaryrefslogtreecommitdiff
path: root/docs/reference/pygobject-gboxed.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/pygobject-gboxed.xml')
-rw-r--r--docs/reference/pygobject-gboxed.xml68
1 files changed, 68 insertions, 0 deletions
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>