[gtk+] Add gtk-doc section for GtkOffscreenWindow
- From: Cody Russell <bratsche src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gtk+] Add gtk-doc section for GtkOffscreenWindow
- Date: Mon, 28 Dec 2009 15:35:19 +0000 (UTC)
commit 2158f5926329cf99dcb132ddd970a1d5f2943b99
Author: Cody Russell <crussell canonical com>
Date: Sat Dec 19 13:08:20 2009 +0100
Add gtk-doc section for GtkOffscreenWindow
docs/reference/gtk/tmpl/gtkoffscreenwindow.sgml | 49 -----------------------
gtk/gtkoffscreenwindow.c | 25 ++++++++++++
2 files changed, 25 insertions(+), 49 deletions(-)
---
diff --git a/gtk/gtkoffscreenwindow.c b/gtk/gtkoffscreenwindow.c
index 953a201..dd14159 100644
--- a/gtk/gtkoffscreenwindow.c
+++ b/gtk/gtkoffscreenwindow.c
@@ -21,6 +21,30 @@
#include "gtkoffscreenwindow.h"
#include "gtkalias.h"
+/**
+ * SECTION:offscreen_windows
+ * @short description: A toplevel container widget used to manage offscreen
+ * rendering of child widgets.
+ * @title: Offscreen windows
+ *
+ * #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
+ * 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 size and state of
+ * it, add it to a #GtkOffscreenWindow and then retrieve the snapshot
+ * as a #GdkPixmap or #GdkPixbuf.
+ *
+ * #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.
+ */
+
G_DEFINE_TYPE (GtkOffscreenWindow, gtk_offscreen_window, GTK_TYPE_WINDOW);
static void
@@ -210,6 +234,7 @@ gtk_offscreen_window_init (GtkOffscreenWindow *window)
{
}
+/* --- functions --- */
/**
* gtk_offscreen_window_new:
*
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]