AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

[docs] Fix GtkOffscreenWindow documentation

Browse Source
This commit is contained in:
Javier Jardón 2010-01-28 03:10:09 +01:00 committed by Tristan Van Berkom
parent 4343bc8d0a
commit d8453e7826
3 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/reference/gtk/gtk-docs.sgml
View File

@ -150,6 +150,7 @@ that is, GUI components such as #GtkButton or #GtkTextView.
<xi:include href="xml/gtkwindowgroup.xml" /> <xi:include href="xml/gtkwindowgroup.xml" />
<xi:include href="xml/gtkaboutdialog.xml" /> <xi:include href="xml/gtkaboutdialog.xml" />
<xi:include href="xml/gtkassistant.xml" /> <xi:include href="xml/gtkassistant.xml" />
<xi:include href="xml/gtkoffscreenwindow.xml" />
</chapter> </chapter>
<chapter id="DisplayWidgets"> <chapter id="DisplayWidgets">

1
docs/reference/gtk/gtk.types
View File

@ -104,6 +104,7 @@ gtk_misc_get_type
gtk_mount_operation_get_type gtk_mount_operation_get_type
gtk_notebook_get_type gtk_notebook_get_type
gtk_object_get_type gtk_object_get_type
gtk_offscreen_window_get_type
gtk_old_editable_get_type gtk_old_editable_get_type
gtk_option_menu_get_type gtk_option_menu_get_type
gtk_orientable_get_type gtk_orientable_get_type

16
gtk/gtkoffscreenwindow.c
View File

@ -22,10 +22,10 @@
#include "gtkalias.h" #include "gtkalias.h"
/** /**
* SECTION:offscreen_windows * SECTION:gtkoffscreenwindow
* @short description: A toplevel container widget used to manage offscreen * @short_description: A toplevel container widget used to manage offscreen
* rendering of child widgets. * rendering of child widgets.
* @title: Offscreen windows * @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. * snapshots of widgets that are not part of a normal widget hierarchy.
@ -45,7 +45,7 @@
* has no parent widget. * has no parent widget.
* *
* When contained offscreen widgets are redrawn, #GtkOffscreenWindow * When contained offscreen widgets are redrawn, #GtkOffscreenWindow
* will emit a "damage-event" signal. * will emit a #GtkWidget::damage-event signal.
*/ */
G_DEFINE_TYPE (GtkOffscreenWindow, gtk_offscreen_window, GTK_TYPE_WINDOW); G_DEFINE_TYPE (GtkOffscreenWindow, gtk_offscreen_window, GTK_TYPE_WINDOW);
@ -249,7 +249,7 @@ gtk_offscreen_window_init (GtkOffscreenWindow *window)
* Return value: A pointer to a #GtkWidget * Return value: A pointer to a #GtkWidget
* *
* Since: 2.20 * Since: 2.20
**/ */
GtkWidget * GtkWidget *
gtk_offscreen_window_new (void) gtk_offscreen_window_new (void)
{ {
@ -258,6 +258,7 @@ gtk_offscreen_window_new (void)
/** /**
* gtk_offscreen_window_get_pixmap: * gtk_offscreen_window_get_pixmap:
* @offscreen: the #GtkOffscreenWindow contained widget.
* *
* Retrieves a snapshot of the contained widget in the form of * Retrieves a snapshot of the contained widget in the form of
* a #GdkPixmap. If you need to keep this around over window * a #GdkPixmap. If you need to keep this around over window
@ -266,7 +267,7 @@ gtk_offscreen_window_new (void)
* Returns: A #GdkPixmap pointer to the offscreen pixmap, or %NULL. * Returns: A #GdkPixmap pointer to the offscreen pixmap, or %NULL.
* *
* Since: 2.20 * Since: 2.20
**/ */
GdkPixmap * GdkPixmap *
gtk_offscreen_window_get_pixmap (GtkOffscreenWindow *offscreen) gtk_offscreen_window_get_pixmap (GtkOffscreenWindow *offscreen)
{ {
@ -277,6 +278,7 @@ gtk_offscreen_window_get_pixmap (GtkOffscreenWindow *offscreen)
/** /**
* gtk_offscreen_window_get_pixbuf: * gtk_offscreen_window_get_pixbuf:
* @offscreen: the #GtkOffscreenWindow contained widget.
* *
* Retrieves a snapshot of the contained widget in the form of * Retrieves a snapshot of the contained widget in the form of
* a #GdkPixbuf. This is a new pixbuf with a reference count of 1, * a #GdkPixbuf. This is a new pixbuf with a reference count of 1,
@ -286,7 +288,7 @@ gtk_offscreen_window_get_pixmap (GtkOffscreenWindow *offscreen)
* Returns: A #GdkPixbuf pointer, or %NULL. * Returns: A #GdkPixbuf pointer, or %NULL.
* *
* Since: 2.20 * Since: 2.20
**/ */
GdkPixbuf * GdkPixbuf *
gtk_offscreen_window_get_pixbuf (GtkOffscreenWindow *offscreen) gtk_offscreen_window_get_pixbuf (GtkOffscreenWindow *offscreen)
{ {