Re: [gtk-list] Gtk manpages?

[Steffen Kern <alfi nuke tj>]

On Mon, 27 Jul 1998 tile@primenet.com wrote:

> Any plans to write Gtk/Gdk/Glib manpages similar to the manpages written for
> Xlib and libc?
> (i.e. man gtk_window_new)

something like the attached one?


bye
Steffen
.\" (c) 1998 by Steffen Kern <alfi@rocks.pn.org>
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\" 
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" 
.TH GTK_WINDOW 3  "22 July 1998" "GTK+" "GTK+ Programmer's Manual"
.SH NAME
gtk_window_new \- create a new window
.SH SYNOPSIS
.B #include <gtk/gtk.h>
.sp
.BI "GtkWidget *gtk_window_new( GtkWindowType " type " );"
.SH DESCRIPTION
\fBgtk_window_new\fP creates a new GtkWindow object (size 200x200).  The
\fItype\fP can be one of GTK_WINDOW_TOPLEVEL, GTK_WINDOW_DIALOG or,
GTK_WINDOW_POPUP.  The \fItype\fP value determines how this widget will
interact with the window manager.
.sp
\fBGTK_WINDOW_TOPLEVEL\fP is usually used for the main application window
that will remain for the entire application run.
.br
\fBGTK_WINDOW_DIALOG\fP is usually used for transient windows. These windows
will open up, gather some input or provide some application specific
updates, then close. The window manager is free not to provide all the
\'normal\' window functions to this window.
.br
\fBGTK_WINDOW_POPUP\fP is usually used for transient windows.  These windows
are typically used for when no user interaction is required, to notify
the user of some condition. Other uses for these types of windows
are for 'about windows', startup windows and the like.  Typically the
window manager will *not* provide the usual widgets that surround the
window. At the most all that will be provided is a border. Also note that
windows that set this type will not be in any window list of the window
manager. Though this window will *not* get the kill and close widgets of
the window manager they still can receive said events and should be taken
into account.
.br
.SH "RETURN VALUE"
The new widget is returned as a pointer to a GtkWidget object. `NULL' is
returned on failure.