<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>gtkmm: Gtk::OffscreenWindow Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceGtk.html">Gtk</a>::<a class="el" href="classGtk_1_1OffscreenWindow.html">OffscreenWindow</a>
</div>
</div>
<div class="contents">
<h1>Gtk::OffscreenWindow Class Reference<br/>
<small>
[<a class="el" href="group__Containers.html">Container Widgets</a>, <a class="el" href="group__Widgets.html">Widgets</a>]</small>
</h1><!-- doxytag: class="Gtk::OffscreenWindow" --><!-- doxytag: inherits="Gtk::Window" -->
<p>A top-level container widget used to manage offscreen rendering of child widgets. <a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classGtk_1_1Window.html">Gtk::Window</a>.</p>
<div class="dynheader">
Collaboration diagram for Gtk::OffscreenWindow:</div>
<div class="dynsection">
<div class="center"><img src="classGtk_1_1OffscreenWindow__coll__graph.png" border="0" usemap="#Gtk_1_1OffscreenWindow_coll__map" alt="Collaboration graph"/></div>
<map name="Gtk_1_1OffscreenWindow_coll__map" id="Gtk_1_1OffscreenWindow_coll__map">
<area shape="rect" href="classGtk_1_1Window.html" title="Toplevel Window This represents all widgets which are physical windows controlled..." alt="" coords="143,597,239,627"/><area shape="rect" href="classGtk_1_1Bin.html" title="A container with just one child." alt="" coords="63,501,132,531"/><area shape="rect" href="classGtk_1_1Container.html" title="Abstract container class." alt="" coords="37,405,141,435"/><area shape="rect" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)." alt="" coords="44,325,135,355"/><area shape="rect" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non-widget objects such..." alt="" coords="5,245,93,275"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="8,165,99,195"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="64,85,184,115"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="123,165,227,195"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="71,5,177,35"/><area shape="rect" href="classAtk_1_1Implementor.html" title="Atk::Implementor" alt="" coords="117,245,237,275"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html" title="Glib::RefPtr\< AccelGroup \>" alt="" coords="167,501,348,531"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html" title="Glib::RefPtr\< T_CppObject \>" alt="" coords="165,405,355,435"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classGtk_1_1OffscreenWindow-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1OffscreenWindow.html#a1f70762a4e24eac6990e54d8d8c017ff">~OffscreenWindow</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkOffscreenWindow* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1OffscreenWindow.html#aae1b74de2df739a8e7450c4f822ead9c">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#aae1b74de2df739a8e7450c4f822ead9c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GtkOffscreenWindow* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1OffscreenWindow.html#a46ea5cc9e5d95d2ee74a42552cfd2f00">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a46ea5cc9e5d95d2ee74a42552cfd2f00"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1OffscreenWindow.html#a8f100949a57b02106a5c41d100b0740f">OffscreenWindow</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixmap.html">Gdk::Pixmap</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1OffscreenWindow.html#a4dadd651cc9368f20ebdfb6666d48085">get_pixmap</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a snapshot of the contained widget in the form of a <a class="el" href="classGdk_1_1Pixmap.html" title="Pixmaps are offscreen drawables.">Gdk::Pixmap</a>. <a href="#a4dadd651cc9368f20ebdfb6666d48085"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classGdk_1_1Pixmap.html">Gdk::Pixmap</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1OffscreenWindow.html#a24b07ccb461c6189e0f96099be94d5a5">get_pixmap</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a snapshot of the contained widget in the form of a <a class="el" href="classGdk_1_1Pixmap.html" title="Pixmaps are offscreen drawables.">Gdk::Pixmap</a>. <a href="#a24b07ccb461c6189e0f96099be94d5a5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1OffscreenWindow.html#a8ffeea999702a6e310b9b262a644f45b">get_pixbuf</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a snapshot of the contained widget in the form of a <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>. <a href="#a8ffeea999702a6e310b9b262a644f45b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1OffscreenWindow.html#aedcfd093d9278e4d6126692b1464c995">get_pixbuf</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a snapshot of the contained widget in the form of a <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>. <a href="#aedcfd093d9278e4d6126692b1464c995"></a><br/></td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1OffscreenWindow.html">Gtk::OffscreenWindow</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1OffscreenWindow.html#ab1e70e1cb4a9892111df0bfad10aa9d0">wrap</a> (GtkOffscreenWindow* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#ab1e70e1cb4a9892111df0bfad10aa9d0"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A top-level container widget used to manage offscreen rendering of child widgets. </p>
<p><a class="el" href="classGtk_1_1OffscreenWindow.html" title="A top-level container widget used to manage offscreen rendering of child widgets...">OffscreenWindow</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="el" href="classGtk_1_1Widget.html#ab8c1ee5d84fc7e4e40e5e1f27bc26686" title="Create a Gdk::Pixmap of the contents of the widget and its children.">Gtk::Widget::get_snapshot()</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="el" href="classGtk_1_1OffscreenWindow.html" title="A top-level container widget used to manage offscreen rendering of child widgets...">OffscreenWindow</a> is a top-level 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 an <a class="el" href="classGtk_1_1OffscreenWindow.html" title="A top-level container widget used to manage offscreen rendering of child widgets...">OffscreenWindow</a> and then retrieve the snapshot as a <a class="el" href="classGdk_1_1Pixmap.html" title="Pixmaps are offscreen drawables.">Gdk::Pixmap</a> or <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>.</p>
<p><a class="el" href="classGtk_1_1OffscreenWindow.html" title="A top-level container widget used to manage offscreen rendering of child widgets...">OffscreenWindow</a> derives from <a class="el" href="classGtk_1_1Window.html" title="Toplevel Window This represents all widgets which are physical windows controlled...">Window</a> only as an implementation detail. Applications should not use any API specific to GtkWindow to operate on this object. It should be treated as a <a class="el" href="classGtk_1_1Bin.html" title="A container with just one child.">Bin</a> that has no parent widget.</p>
<p>When contained offscreen widgets are redrawn, <a class="el" href="classGtk_1_1OffscreenWindow.html" title="A top-level container widget used to manage offscreen rendering of child widgets...">OffscreenWindow</a> will emit a "damage-event" signal.</p>
<dl class="since_2_20"><dt><b><a class="el" href="since_2_20.html#_since_2_20000012">Since gtkmm 2.20:</a></b></dt><dd></dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1f70762a4e24eac6990e54d8d8c017ff"></a><!-- doxytag: member="Gtk::OffscreenWindow::~OffscreenWindow" ref="a1f70762a4e24eac6990e54d8d8c017ff" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gtk::OffscreenWindow::~OffscreenWindow </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a8f100949a57b02106a5c41d100b0740f"></a><!-- doxytag: member="Gtk::OffscreenWindow::OffscreenWindow" ref="a8f100949a57b02106a5c41d100b0740f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::OffscreenWindow::OffscreenWindow </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aedcfd093d9278e4d6126692b1464c995"></a><!-- doxytag: member="Gtk::OffscreenWindow::get_pixbuf" ref="aedcfd093d9278e4d6126692b1464c995" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>> Gtk::OffscreenWindow::get_pixbuf </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves a snapshot of the contained widget in the form of a <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>. </p>
<p>This is a new pixbuf with a reference count of 1, and the application should unreference it once it is no longer needed.</p>
<dl class="since_2_20"><dt><b><a class="el" href="since_2_20.html#_since_2_20000016">Since gtkmm 2.20:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> pointer, or <code>0</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a8ffeea999702a6e310b9b262a644f45b"></a><!-- doxytag: member="Gtk::OffscreenWindow::get_pixbuf" ref="a8ffeea999702a6e310b9b262a644f45b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>> Gtk::OffscreenWindow::get_pixbuf </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves a snapshot of the contained widget in the form of a <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>. </p>
<p>This is a new pixbuf with a reference count of 1, and the application should unreference it once it is no longer needed.</p>
<dl class="since_2_20"><dt><b><a class="el" href="since_2_20.html#_since_2_20000015">Since gtkmm 2.20:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> pointer, or <code>0</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a24b07ccb461c6189e0f96099be94d5a5"></a><!-- doxytag: member="Gtk::OffscreenWindow::get_pixmap" ref="a24b07ccb461c6189e0f96099be94d5a5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGdk_1_1Pixmap.html">Gdk::Pixmap</a>> Gtk::OffscreenWindow::get_pixmap </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves a snapshot of the contained widget in the form of a <a class="el" href="classGdk_1_1Pixmap.html" title="Pixmaps are offscreen drawables.">Gdk::Pixmap</a>. </p>
<p>If you need to keep this around over window resizes then you should add a reference to it.</p>
<dl class="since_2_20"><dt><b><a class="el" href="since_2_20.html#_since_2_20000014">Since gtkmm 2.20:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGdk_1_1Pixmap.html" title="Pixmaps are offscreen drawables.">Gdk::Pixmap</a> pointer to the offscreen pixmap, or <code>0</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a4dadd651cc9368f20ebdfb6666d48085"></a><!-- doxytag: member="Gtk::OffscreenWindow::get_pixmap" ref="a4dadd651cc9368f20ebdfb6666d48085" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Pixmap.html">Gdk::Pixmap</a>> Gtk::OffscreenWindow::get_pixmap </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves a snapshot of the contained widget in the form of a <a class="el" href="classGdk_1_1Pixmap.html" title="Pixmaps are offscreen drawables.">Gdk::Pixmap</a>. </p>
<p>If you need to keep this around over window resizes then you should add a reference to it.</p>
<dl class="since_2_20"><dt><b><a class="el" href="since_2_20.html#_since_2_20000013">Since gtkmm 2.20:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGdk_1_1Pixmap.html" title="Pixmaps are offscreen drawables.">Gdk::Pixmap</a> pointer to the offscreen pixmap, or <code>0</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a46ea5cc9e5d95d2ee74a42552cfd2f00"></a><!-- doxytag: member="Gtk::OffscreenWindow::gobj" ref="a46ea5cc9e5d95d2ee74a42552cfd2f00" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GtkOffscreenWindow* Gtk::OffscreenWindow::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GtkObject. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1Window.html#afe314a1e65505be026688060dc98ad3a">Gtk::Window</a>.</p>
</div>
</div>
<a class="anchor" id="aae1b74de2df739a8e7450c4f822ead9c"></a><!-- doxytag: member="Gtk::OffscreenWindow::gobj" ref="aae1b74de2df739a8e7450c4f822ead9c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkOffscreenWindow* Gtk::OffscreenWindow::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GtkObject. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1Window.html#a467102527550b51eb4036390caeedb5c">Gtk::Window</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="ab1e70e1cb4a9892111df0bfad10aa9d0"></a><!-- doxytag: member="Gtk::OffscreenWindow::wrap" ref="ab1e70e1cb4a9892111df0bfad10aa9d0" args="(GtkOffscreenWindow *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1OffscreenWindow.html">Gtk::OffscreenWindow</a>* wrap </td>
<td>(</td>
<td class="paramtype">GtkOffscreenWindow * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>gtkmm/offscreenwindow.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:21:56 2010 for gtkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
22e237efd6851989a23adf3360bb53d0
>
files
>
520
