Gtk::OffscreenWindow Class Reference
[Container Widgets, Widgets]
A top-level container widget used to manage offscreen rendering of child widgets. More...
Inherits Gtk::Window.
Public Member Functions | |
| virtual | ~OffscreenWindow () |
| GtkOffscreenWindow* | gobj () |
| Provides access to the underlying C GtkObject. | |
| const GtkOffscreenWindow* | gobj () const |
| Provides access to the underlying C GtkObject. | |
| OffscreenWindow () | |
| Glib::RefPtr< Gdk::Pixmap > | get_pixmap () |
| Retrieves a snapshot of the contained widget in the form of a Gdk::Pixmap. | |
| Glib::RefPtr< const Gdk::Pixmap > | get_pixmap () const |
| Retrieves a snapshot of the contained widget in the form of a Gdk::Pixmap. | |
| Glib::RefPtr< Gdk::Pixbuf > | get_pixbuf () |
| Retrieves a snapshot of the contained widget in the form of a Gdk::Pixbuf. | |
| Glib::RefPtr< const Gdk::Pixbuf > | get_pixbuf () const |
| Retrieves a snapshot of the contained widget in the form of a Gdk::Pixbuf. | |
Related Functions | |
(Note that these are not member functions.) | |
| Gtk::OffscreenWindow* | wrap (GtkOffscreenWindow* object, bool take_copy=false) |
| A Glib::wrap() method for this object. | |
Detailed Description
A top-level container widget used to manage offscreen rendering of child widgets.
OffscreenWindow is strictly intended to be used for obtaining snapshots of widgets that are not part of a normal widget hierarchy. It differs from Gtk::Widget::get_snapshot() 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 OffscreenWindow 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.
The idea is to take a widget and manually set the state of it, add it to an OffscreenWindow and then retrieve the snapshot as a Gdk::Pixmap or Gdk::Pixbuf.
OffscreenWindow derives from Window 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 Bin that has no parent widget.
When contained offscreen widgets are redrawn, OffscreenWindow will emit a "damage-event" signal.
Constructor & Destructor Documentation
| virtual Gtk::OffscreenWindow::~OffscreenWindow | ( | ) | [virtual] |
| Gtk::OffscreenWindow::OffscreenWindow | ( | ) |
Member Function Documentation
| Glib::RefPtr<const Gdk::Pixbuf> Gtk::OffscreenWindow::get_pixbuf | ( | ) | const |
Retrieves a snapshot of the contained widget in the form of a Gdk::Pixbuf.
This is a new pixbuf with a reference count of 1, and the application should unreference it once it is no longer needed.
- Returns:
- A Gdk::Pixbuf pointer, or
0.
| Glib::RefPtr<Gdk::Pixbuf> Gtk::OffscreenWindow::get_pixbuf | ( | ) |
Retrieves a snapshot of the contained widget in the form of a Gdk::Pixbuf.
This is a new pixbuf with a reference count of 1, and the application should unreference it once it is no longer needed.
- Returns:
- A Gdk::Pixbuf pointer, or
0.
| Glib::RefPtr<const Gdk::Pixmap> Gtk::OffscreenWindow::get_pixmap | ( | ) | const |
Retrieves a snapshot of the contained widget in the form of a Gdk::Pixmap.
If you need to keep this around over window resizes then you should add a reference to it.
- Returns:
- A Gdk::Pixmap pointer to the offscreen pixmap, or
0.
| Glib::RefPtr<Gdk::Pixmap> Gtk::OffscreenWindow::get_pixmap | ( | ) |
Retrieves a snapshot of the contained widget in the form of a Gdk::Pixmap.
If you need to keep this around over window resizes then you should add a reference to it.
- Returns:
- A Gdk::Pixmap pointer to the offscreen pixmap, or
0.
| const GtkOffscreenWindow* Gtk::OffscreenWindow::gobj | ( | ) | const [inline] |
Provides access to the underlying C GtkObject.
Reimplemented from Gtk::Window.
| GtkOffscreenWindow* Gtk::OffscreenWindow::gobj | ( | ) | [inline] |
Provides access to the underlying C GtkObject.
Reimplemented from Gtk::Window.
Friends And Related Function Documentation
| Gtk::OffscreenWindow* wrap | ( | GtkOffscreenWindow * | object, | |
| bool | take_copy = false | |||
| ) | [related] |
A Glib::wrap() method for this object.
- Parameters:
-
object The C instance. take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
- Returns:
- A C++ instance that wraps this C instance.
The documentation for this class was generated from the following file:
- gtkmm/offscreenwindow.h
