/usr/share/gtk-doc/html/pygtk/class-gtkoffscreenwindow.html is in python-gtk2-doc 2.24.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.OffscreenWindow</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" 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-gtkobject.html" title="gtk.Object"><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.OffscreenWindow</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkobject.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" title="gtk.OffscreenWindow"><a name="class-gtkoffscreenwindow"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.OffscreenWindow</h2><p>gtk.OffscreenWindow — a toplevel container widget used to manage offscreen rendering of child widgets (new in PyGTK 2.22)</p></div><div class="refsect1" title="Synopsis"><a name="id3817321"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.OffscreenWindow</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkwindow.html" title="gtk.Window">gtk.Window</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><PYGTKDOCLINK HREF="constructor-gtkoffscreenwindow">gtk.OffscreenWindow</PYGTKDOCLINK></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkoffscreenwindow.html#method-gtkoffscreenwindow--get-pixmap" title="gtk.OffscreenWindow.get_pixmap">get_pixmap</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkoffscreenwindow.html#method-gtkoffscreenwindow--get-pixbuf" title="gtk.OffscreenWindow.get_pixbuf">get_pixbuf</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3817411"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">GObject</PYGTKDOCLINK>
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
+-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
+-- <a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
+-- <a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
+-- <a class="link" href="class-gtkwindow.html" title="gtk.Window">gtk.Window</a>
+-- <a class="link" href="class-gtkoffscreenwindow.html" title="gtk.OffscreenWindow">gtk.OffscreenWindow</a>
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3817469"></a><h2>Implemented Interfaces</h2><p>
<a class="link" href="class-gtkoffscreenwindow.html" title="gtk.OffscreenWindow"><code class="classname">gtk.OffscreenWindow</code></a>
implements
<a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
<a class="link" href="class-atkimplementor.html" title="atk.Implementor"><code class="classname">atk.ImplementorIFace</code></a>
</p></div><div class="refsect1" title="gtk.OffscreenWindow Properties"><a name="properties-gtkoffscreenwindow"></a><h2>gtk.OffscreenWindow Properties</h2><p><a class="link" href="class-gtkobject.html#properties-gtkobject" title="gtk.Object Properties">gtk.Object Properties</a></p><p><a class="link" href="class-gtkwidget.html#properties-gtkwidget" title="gtk.Widget Properties">gtk.Widget Properties</a></p><p><a class="link" href="class-gtkcontainer.html#properties-gtkcontainer" title="gtk.Container Properties">gtk.Container Properties</a></p><p><a class="link" href="class-gtkwindow.html#properties-gtkwindow" title="gtk.Window Properties">gtk.Window Properties</a></p></div><div class="refsect1" title="gtk.OffscreenWindow Style Properties"><a name="style-properties-gtkoffscreenwindow"></a><h2>gtk.OffscreenWindow 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" title="gtk.OffscreenWindow Signal Prototypes"><a name="signal-prototypes-gtkoffscreenwindow"></a><h2>gtk.OffscreenWindow 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><p><a class="link" href="class-gtkwindow.html#signal-prototypes-gtkwindow" title="gtk.Window Signal Prototypes">gtk.Window Signal Prototypes</a></p></div><div class="refsect1" title="Description"><a name="id3817616"></a><h2>Description</h2><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This widget is available in PyGTK 2.22 and above.</p></div><p><a class="link" href="class-gtkoffscreenwindow.html" title="gtk.OffscreenWindow"><code class="classname">gtk.OffscreenWindow</code></a> is strictly
intended to be used for obtaining snapshots of widgets that are not part of a normal widget hierarchy.
It differs from <a class="link" href="class-gtkwidget.html#method-gtkwidget--get-snapshot" title="gtk.Widget.get_snapshot"><code class="methodname">gtk.Widget.get_snapshot</code></a>()
in that the widget you want to get a snapshot of need not be displayed on the user's screen as a part
of a widget hierarchy. However, since <a class="link" href="class-gtkoffscreenwindow.html" title="gtk.OffscreenWindow"><code class="classname">gtk.OffscreenWindow</code></a>
is a toplevel widget you cannot obtain snapshots of a full window with it since you cannot pack a
toplevel widget in another toplevel.</p><p>The idea is to take a widget and manually set the state of it, add it to a
<a class="link" href="class-gtkoffscreenwindow.html" title="gtk.OffscreenWindow"><code class="classname">gtk.OffscreenWindow</code></a> and then retrieve
the snapshot as a <a class="link" href="class-gdkpixmap.html" title="gtk.gdk.Pixmap"><code class="classname">gtk.gdk.Pixmap</code></a> or
<a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>.</p><p><a class="link" href="class-gtkoffscreenwindow.html" title="gtk.OffscreenWindow"><code class="classname">gtk.OffscreenWindow</code></a> derives
from <a class="link" href="class-gtkwindow.html" title="gtk.Window"><code class="classname">gtk.Window</code></a> only as an implementation
detail. Applications should not use any API specific to <a class="link" href="class-gtkwindow.html" title="gtk.Window"><code class="classname">gtk.Window</code></a>
to operate on this object. It should be treated as a <a class="link" href="class-gtkbin.html" title="gtk.Bin"><code class="classname">gtk.Bin</code></a>
that has no parent widget.</p><p>When contained offscreen widgets are redrawn,
<a class="link" href="class-gtkoffscreenwindow.html" title="gtk.OffscreenWindow"><code class="classname">gtk.OffscreenWindow</code></a> will emit a
"<a class="link" href="class-gtkwidget.html#signal-gtkwidget--damage-event" title='The "damage-event" gtk.Widget Signal'>damage-event</a>" signal.</p></div><div class="refsect1" title="Constructor"><a name="id3817744"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname"><PYGTKDOCLINK HREF="constructor-gtkoffscreenwindow">gtk.OffscreenWindow</PYGTKDOCLINK></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 pointer to a <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a></td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.22 and above.</p></div><p>Creates a toplevel container widget that is used to retrieve
snapshots of widgets without showing them on the screen. For
widgets that are on the screen and part of a normal widget
hierarchy, <a class="link" href="class-gtkwidget.html#method-gtkwidget--get-snapshot" title="gtk.Widget.get_snapshot"><code class="methodname">gtk.Widget.get_snapshot</code></a> can be used instead.</p></div><div class="refsect1" title="Methods"><a name="id3817823"></a><h2>Methods</h2><div class="refsect2" title="gtk.OffscreenWindow.get_pixmap"><a name="method-gtkoffscreenwindow--get-pixmap"></a><h3>gtk.OffscreenWindow.get_pixmap</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_pixmap</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 <a class="link" href="class-gdkpixmap.html" title="gtk.gdk.Pixmap"><code class="classname">gtk.gdk.Pixmap</code></a>, or <code class="literal">None</code>.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.22 and above.</p></div><p>Retrieves a snapshot of the contained widget in the form of a
<a class="link" href="class-gdkpixmap.html" title="gtk.gdk.Pixmap"><code class="classname">gtk.gdk.Pixmap</code></a>.</p></div><div class="refsect2" title="gtk.OffscreenWindow.get_pixbuf"><a name="method-gtkoffscreenwindow--get-pixbuf"></a><h3>gtk.OffscreenWindow.get_pixbuf</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_pixbuf</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 <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>, or <code class="literal">None</code>.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.22 and above.</p></div><p>Retrieves a snapshot of the contained widget in the form of a
<a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtkobject.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gtkoptionmenu.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.Object </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.OptionMenu</td></tr></table></div></body></html>
|