~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed

« back to all changes in this revision

Viewing changes to docs/html/class-gtkobject.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-06-22 16:49:42 UTC
  • mfrom: (1.2.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20090622164942-19zeltp4z0u5iw72
Tags: 2.15.2-0ubuntu1
* New upstream version:
  - Rename gtk.Statusbar.remove() to gtk.Statusbar.remove_message
  - Allow pango.Context creation 
  - Make gtk.gdk.Pixbuf.add_alpha accept integers, retaining backward
    compatibility accepting also chars 
  - Protect window obj from GC in gtk.window_get_toplevels 
  - Plug huge number of memory leaks in Pango wrappers 
  - Add gtk.gdk.WINDOWING constant 
  - Wrap gdk_pixbuf_apply_embedded_orientation 
  - Modernize constructors of seven more types 
  - Don't free a string we don't own 
  - Some docs tweaking 
* debian/control.in:
  - set vcs location
* debian/patches/02_fix_get_application_info_crash.patch:
  - the change is in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Object</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtknotebook.html" title="gtk.Notebook"><link rel="next" href="class-gtkoptionmenu.html" title="gtk.OptionMenu"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.Object</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtknotebook.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkoptionmenu.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkobject"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Object</h2><p>gtk.Object — the base class of the PyGTK type hierarchy.</p></div><div class="refsect1" lang="en"><a name="id3577294"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Object</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
 
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Object</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtknotebook.html" title="gtk.Notebook"><link rel="next" href="class-gtkoptionmenu.html" title="gtk.OptionMenu"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.Object</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtknotebook.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkoptionmenu.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkobject"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Object</h2><p>gtk.Object — the base class of the PyGTK type hierarchy.</p></div><div class="refsect1" lang="en"><a name="id3778099"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Object</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
2
2
<code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkobject.html#method-gtkobject--flags" title="gtk.Object.flags">flags</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkobject.html#method-gtkobject--set-flags" title="gtk.Object.set_flags">set_flags</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>flags</code></em></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkobject.html#method-gtkobject--unset-flags" title="gtk.Object.unset_flags">unset_flags</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>flags</code></em></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkobject.html#method-gtkobject--destroy" title="gtk.Object.destroy">destroy</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table><pre class="programlisting">
3
3
<span class="bold"><strong>Functions</strong></span>
4
4
 
5
 
<code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkobject.html#function-gtk--bindings-activate" title="gtk.bindings_activate">gtk.bindings_activate</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>object</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>modifiers</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkobject.html#function-gtk--bindings-activate-event" title="gtk.bindings_activate_event">gtk.bindings_activate_event</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>object</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>event</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkobject.html#function-gtk--binding-entry-add-signal" title="gtk.binding_entry_add_signal">gtk.binding_entry_add_signal</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>object</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>keyval</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>modifiers</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>signal_name</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkobject.html#function-gtk--binding-entry-remove" title="gtk.binding_entry_remove">gtk.binding_entry_remove</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>class_type</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>modifiers</code></strong></span></span>)</code></pre></div><div class="refsect1" lang="en"><a name="id3577644"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
 
5
<code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkobject.html#function-gtk--bindings-activate" title="gtk.bindings_activate">gtk.bindings_activate</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>object</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>modifiers</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkobject.html#function-gtk--bindings-activate-event" title="gtk.bindings_activate_event">gtk.bindings_activate_event</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>object</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>event</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkobject.html#function-gtk--binding-entry-add-signal" title="gtk.binding_entry_add_signal">gtk.binding_entry_add_signal</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>object</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>keyval</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>modifiers</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>signal_name</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkobject.html#function-gtk--binding-entry-remove" title="gtk.binding_entry_remove">gtk.binding_entry_remove</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>class_type</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>modifiers</code></strong></span></span>)</code></pre></div><div class="refsect1" lang="en"><a name="id3778449"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
6
6
  +-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
7
 
</pre></div><div class="refsect1" lang="en"><a name="properties-gtkobject"></a><h2>gtk.Object Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"user-data"</td><td valign="top">Read-Write</td><td valign="top">Anonymous User Data Pointer</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkobject"></a><h2>gtk.Object Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkobject.html#signal-gtkobject--destroy" title='The "destroy" gtk.Object Signal'>destroy</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>object</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3577832"></a><h2>Description</h2><p><a class="link" href="class-gtkobject.html" title="gtk.Object"><code class="classname">gtk.Object</code></a> is the
 
7
</pre></div><div class="refsect1" lang="en"><a name="properties-gtkobject"></a><h2>gtk.Object Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"user-data"</td><td valign="top">Read-Write</td><td valign="top">Anonymous User Data Pointer</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkobject"></a><h2>gtk.Object Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkobject.html#signal-gtkobject--destroy" title='The "destroy" gtk.Object Signal'>destroy</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>object</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3778638"></a><h2>Description</h2><p><a class="link" href="class-gtkobject.html" title="gtk.Object"><code class="classname">gtk.Object</code></a> is the
8
8
base class for all widgets, and for a few non-widget objects such as <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>.
9
9
<a class="link" href="class-gtkobject.html" title="gtk.Object"><code class="classname">gtk.Object</code></a>
10
10
predates <PYGTKDOCLINK HREF="class-gobject"><code class="classname">GObject</code></PYGTKDOCLINK>; non-widgets
33
33
destroyed using the <a class="link" href="class-gtkobject.html#method-gtkobject--destroy" title="gtk.Object.destroy"><code class="methodname">destroy</code>()</a> 
34
34
method, it will be removed from its container and unmapped and unrealized
35
35
but it will not be finalized because the Python wrapper object will still
36
 
exist and hold a reference.</p></div><div class="refsect1" lang="en"><a name="id3578001"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkobject--flags"></a><h3>gtk.Object.flags</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">flags</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the flags set for the
 
36
exist and hold a reference.</p></div><div class="refsect1" lang="en"><a name="id3778806"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkobject--flags"></a><h3>gtk.Object.flags</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">flags</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the flags set for the
37
37
object</td></tr></tbody></table><p>The <code class="methodname">flags</code>() method returns the value of
38
38
the flags for the object. The flags returned will include both the <a class="link" href="class-gtkobject.html" title="gtk.Object"><code class="classname">gtk.Object</code></a> flags and
39
39
the <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a>
70
70
for a description of the <a class="link" href="class-gtkobject.html" title="gtk.Object"><code class="classname">gtk.Object</code></a> and <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a> flags
71
71
that can be unset.</p></div><div class="refsect2" lang="en"><a name="method-gtkobject--destroy"></a><h3>gtk.Object.destroy</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">destroy</span>(<span class="methodparam"></span>)</code></pre><p>The <code class="methodname">destroy</code>() method emits the
72
72
"destroy" signal notifying all reference holders that they should release
73
 
the <a class="link" href="class-gtkobject.html" title="gtk.Object"><code class="classname">gtk.Object</code></a>.</p></div></div><div class="refsect1" lang="en"><a name="id3578884"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gtk--bindings-activate"></a><h3>gtk.bindings_activate</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.bindings_activate</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>object</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>modifiers</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>object</code></strong> :</span></p></td><td>the <a class="link" href="class-gtkobject.html" title="gtk.Object"><code class="classname">gtk.Object</code></a> to
 
73
the <a class="link" href="class-gtkobject.html" title="gtk.Object"><code class="classname">gtk.Object</code></a>.</p></div></div><div class="refsect1" lang="en"><a name="id3779690"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gtk--bindings-activate"></a><h3>gtk.bindings_activate</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.bindings_activate</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>object</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>keyval</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>modifiers</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>object</code></strong> :</span></p></td><td>the <a class="link" href="class-gtkobject.html" title="gtk.Object"><code class="classname">gtk.Object</code></a> to
74
74
activate the bindings on</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>keyval</code></strong> :</span></p></td><td>a key value</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>modifiers</code></strong> :</span></p></td><td>a modifier mask</td></tr><tr><td><p><span class="term"><strong class="parameter"><code></code></strong> :</span></p></td><td></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the binding could be
75
75
activated</td></tr></tbody></table><p>The <code class="function">gtk.bindings_activate</code>() function
76
76
activates the bindings associated with the <a class="link" href="class-gtkobject.html" title="gtk.Object"><code class="classname">gtk.Object</code></a> specified
94
94
class the binding entry will be removed from</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>keyval</code></strong> :</span></p></td><td>the key value</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>modifiers</code></strong> :</span></p></td><td>the modifier mask</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.2 and above.</p></div><p>The <code class="function">gtk.binding_entry_remove</code>() function
95
95
removes the binding (specified by <em class="parameter"><code>keyval</code></em> and
96
96
<em class="parameter"><code>modifiers</code></em>) from the binding set of the object class
97
 
specified by <em class="parameter"><code>class_type</code></em>.</p></div></div><div class="refsect1" lang="en"><a name="id3579657"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkobject--destroy"></a><h3>The "destroy" gtk.Object Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>object</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td><td>the object that received the
 
97
specified by <em class="parameter"><code>class_type</code></em>.</p></div></div><div class="refsect1" lang="en"><a name="id3780462"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkobject--destroy"></a><h3>The "destroy" gtk.Object Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>object</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td><td>the object that received the
98
98
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
99
99
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
100
100
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if