GtkOffscreenWindow: shorten doc title

This commit is contained in:
Matthias Clasen 2010-09-24 22:13:42 -04:00
parent a98127fc12
commit 8b5bc9669b

View File

@ -26,28 +26,27 @@
/**
* SECTION:gtkoffscreenwindow
* @short_description: A toplevel container widget used to manage offscreen
* rendering of child widgets.
* @short_description: A toplevel to manage offscreen rendering of child widgets
* @title: GtkOffscreenWindow
*
* #GtkOffscreenWindow is strictly intended to be used for obtaining
* GtkOffscreenWindow 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 #GtkOffscreenWindow
* as a part of a widget hierarchy. However, since GtkOffscreenWindow
* is a toplevel 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 a #GtkOffscreenWindow and then retrieve the snapshot
* add it to a GtkOffscreenWindow and then retrieve the snapshot
* as a #GdkPixmap or #GdkPixbuf.
*
* #GtkOffscreenWindow derives from #GtkWindow only as an implementation
* GtkOffscreenWindow derives from #GtkWindow 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 #GtkBin that
* has no parent widget.
*
* When contained offscreen widgets are redrawn, #GtkOffscreenWindow
* When contained offscreen widgets are redrawn, GtkOffscreenWindow
* will emit a #GtkWidget::damage-event signal.
*/