1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 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> :</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>
|