← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/html/class-gtkhandlebox.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:
docs/html/class-gtkhandlebox.html
1
 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.HandleBox</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-pygtkgenerictreemodel.html" title="gtk.GenericTreeModel"><link rel="next" href="class-gtkhbox.html" title="gtk.HBox"></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.HandleBox</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-pygtkgenerictreemodel.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkhbox.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkhandlebox"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.HandleBox</h2><p>gtk.HandleBox — a widget for detachable window portions.</p></div><div class="refsect1" lang="en"><a name="id3494627"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.HandleBox</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a></span></span>):
2
 
<code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gtkhandlebox.html#constructor-gtkhandlebox" title="Constructor">gtk.HandleBox</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkhandlebox.html#method-gtkhandlebox--set-shadow-type" title="gtk.HandleBox.set_shadow_type">set_shadow_type</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkhandlebox.html#method-gtkhandlebox--get-shadow-type" title="gtk.HandleBox.get_shadow_type">get_shadow_type</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkhandlebox.html#method-gtkhandlebox--set-handle-position" title="gtk.HandleBox.set_handle_position">set_handle_position</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>position</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkhandlebox.html#method-gtkhandlebox--get-handle-position" title="gtk.HandleBox.get_handle_position">get_handle_position</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkhandlebox.html#method-gtkhandlebox--set-snap-edge" title="gtk.HandleBox.set_snap_edge">set_snap_edge</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>edge</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkhandlebox.html#method-gtkhandlebox--get-snap-edge" title="gtk.HandleBox.get_snap_edge">get_snap_edge</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkhandlebox.html#method-gtkhandlebox--get-child-detached" title="gtk.HandleBox.get_child_detached">get_child_detached</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3494842"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
 
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.HandleBox</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-pygtkgenerictreemodel.html" title="gtk.GenericTreeModel"><link rel="next" href="class-gtkhbox.html" title="gtk.HBox"></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.HandleBox</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-pygtkgenerictreemodel.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkhbox.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkhandlebox"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.HandleBox</h2><p>gtk.HandleBox — a widget for detachable window portions.</p></div><div class="refsect1" lang="en"><a name="id3695433"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.HandleBox</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a></span></span>):
 
2
<code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gtkhandlebox.html#constructor-gtkhandlebox" title="Constructor">gtk.HandleBox</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkhandlebox.html#method-gtkhandlebox--set-shadow-type" title="gtk.HandleBox.set_shadow_type">set_shadow_type</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkhandlebox.html#method-gtkhandlebox--get-shadow-type" title="gtk.HandleBox.get_shadow_type">get_shadow_type</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkhandlebox.html#method-gtkhandlebox--set-handle-position" title="gtk.HandleBox.set_handle_position">set_handle_position</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>position</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkhandlebox.html#method-gtkhandlebox--get-handle-position" title="gtk.HandleBox.get_handle_position">get_handle_position</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkhandlebox.html#method-gtkhandlebox--set-snap-edge" title="gtk.HandleBox.set_snap_edge">set_snap_edge</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>edge</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkhandlebox.html#method-gtkhandlebox--get-snap-edge" title="gtk.HandleBox.get_snap_edge">get_snap_edge</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkhandlebox.html#method-gtkhandlebox--get-child-detached" title="gtk.HandleBox.get_child_detached">get_child_detached</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3695648"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
3
3
  +-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
4
4
    +-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
5
5
      +-- <a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
6
6
        +-- <a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
7
7
          +-- <a class="link" href="class-gtkhandlebox.html" title="gtk.HandleBox">gtk.HandleBox</a>
8
 
</pre></div><div class="refsect1" lang="en"><a name="id3494893"></a><h2>Implemented Interfaces</h2><p>
 
8
</pre></div><div class="refsect1" lang="en"><a name="id3695699"></a><h2>Implemented Interfaces</h2><p>
9
9
                        <a class="link" href="class-gtkhandlebox.html" title="gtk.HandleBox"><code class="classname">gtk.HandleBox</code></a>
10
10
                        implements 
11
11
                        <a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
13
13
              widget; one of the <a class="xref" href="gtk-constants.html#gtk-position-type-constants" title="GTK Position Type Constants">GTK Position Type Constants</a>.</td></tr><tr valign="top"><td valign="top">"shadow-type"</td><td valign="top">Read-Write</td><td valign="top">The type of shadow; one of the <a class="xref" href="gtk-constants.html#gtk-shadow-type-constants" title="GTK Shadow Type Constants">GTK Shadow Type Constants</a>.</td></tr><tr valign="top"><td valign="top">"snap-edge"</td><td valign="top">Read-Write</td><td valign="top">The side of the handlebox that's lined up with the
14
14
              docking point to dock the handlebox; one of the <a class="xref" href="gtk-constants.html#gtk-position-type-constants" title="GTK Position Type Constants">GTK Position Type Constants</a>.</td></tr><tr valign="top"><td valign="top">"snap-edge-set"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code>, use the value from
15
15
              "snap-edge"; otherwise, use a value derived from
16
 
              "handle-position".  Available in GTK+ 2.2 and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="style-properties-gtkhandlebox"></a><h2>gtk.HandleBox Style Properties</h2><p><a class="link" href="class-gtkwidget.html#style-properties-gtkwidget" title="gtk.Widget Style Properties">gtk.Widget Style Properties</a></p></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkhandlebox"></a><h2>gtk.HandleBox Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a class="link" href="class-gtkwidget.html#signal-prototypes-gtkwidget" title="gtk.Widget Signal Prototypes">gtk.Widget Signal Prototypes</a></p><p><a class="link" href="class-gtkcontainer.html#signal-prototypes-gtkcontainer" title="gtk.Container Signal Prototypes">gtk.Container Signal Prototypes</a></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-gtkhandlebox.html#signal-gtkhandlebox--child-attached" title='The "child-attached" gtk.HandleBox Signal'>child-attached</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>handlebox</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>widget</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><tr><td><p><span class="term">"<a class="link" href="class-gtkhandlebox.html#signal-gtkhandlebox--child-detached" title='The "child-detached" gtk.HandleBox Signal'>child-detached</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>handlebox</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>widget</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="id3495326"></a><h2>Description</h2><p>The <a class="link" href="class-gtkhandlebox.html" title="gtk.HandleBox"><code class="classname">gtk.HandleBox</code></a>
 
16
              "handle-position".  Available in GTK+ 2.2 and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="style-properties-gtkhandlebox"></a><h2>gtk.HandleBox Style Properties</h2><p><a class="link" href="class-gtkwidget.html#style-properties-gtkwidget" title="gtk.Widget Style Properties">gtk.Widget Style Properties</a></p></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkhandlebox"></a><h2>gtk.HandleBox Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a class="link" href="class-gtkwidget.html#signal-prototypes-gtkwidget" title="gtk.Widget Signal Prototypes">gtk.Widget Signal Prototypes</a></p><p><a class="link" href="class-gtkcontainer.html#signal-prototypes-gtkcontainer" title="gtk.Container Signal Prototypes">gtk.Container Signal Prototypes</a></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-gtkhandlebox.html#signal-gtkhandlebox--child-attached" title='The "child-attached" gtk.HandleBox Signal'>child-attached</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>handlebox</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>widget</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><tr><td><p><span class="term">"<a class="link" href="class-gtkhandlebox.html#signal-gtkhandlebox--child-detached" title='The "child-detached" gtk.HandleBox Signal'>child-detached</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>handlebox</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>widget</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="id3696132"></a><h2>Description</h2><p>The <a class="link" href="class-gtkhandlebox.html" title="gtk.HandleBox"><code class="classname">gtk.HandleBox</code></a>
17
17
widget allows a portion of a window to be "torn off". It is a bin widget
18
18
which displays its child and a handle that the user can drag to tear off
19
19
into a separate floating window containing the child widget. A thin ghost is
32
32
the handlebox is detached, the bottom edge of the handlebox's allocation
33
33
will remain fixed as the height of the handlebox shrinks, so the snap edge
34
34
should be set to <code class="literal">gtk.POS_BOTTOM</code>.</p></div><div class="refsect1" lang="en"><a name="constructor-gtkhandlebox"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.HandleBox</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>a new handlebox widget</td></tr></tbody></table><p>Creates a new <a class="link" href="class-gtkhandlebox.html" title="gtk.HandleBox"><code class="classname">gtk.HandleBox</code></a>
35
 
widget.</p></div><div class="refsect1" lang="en"><a name="id3495465"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkhandlebox--set-shadow-type"></a><h3>gtk.HandleBox.set_shadow_type</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_shadow_type</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</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>type</code></strong> :</span></p></td><td>the shadow type:
 
35
widget.</p></div><div class="refsect1" lang="en"><a name="id3696272"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkhandlebox--set-shadow-type"></a><h3>gtk.HandleBox.set_shadow_type</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_shadow_type</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</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>type</code></strong> :</span></p></td><td>the shadow type:
36
36
<code class="literal">gtk.SHADOW_NONE</code>, <code class="literal">gtk.SHADOW_IN</code>,
37
37
<code class="literal">gtk.SHADOW_OUT</code>, <code class="literal">gtk.SHADOW_ETCHED_IN</code>,
38
38
<code class="literal">gtk.SHADOW_ETCHED_OUT</code></td></tr></tbody></table><p>The <code class="methodname">set_shadow_type</code>() method sets the
81
81
          otherwise <code class="literal">False</code></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
82
82
        The <code class="methodname">get_child_detached</code>() method gets
83
83
        whether the handlebox's child is currently detached.
84
 
      </p></div></div><div class="refsect1" lang="en"><a name="id3496237"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkhandlebox--child-attached"></a><h3>The "child-attached" gtk.HandleBox Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>handlebox</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>widget</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>handlebox</code></em> :</span></p></td><td>the widget that received the
 
84
      </p></div></div><div class="refsect1" lang="en"><a name="id3697044"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkhandlebox--child-attached"></a><h3>The "child-attached" gtk.HandleBox Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>handlebox</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>widget</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>handlebox</code></em> :</span></p></td><td>the widget that received the
85
85
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td><td>the child widget</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
86
86
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
87
87
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if