ncurses 5.7 - patch 20100918
[ncurses.git] / man / form_win.3x
index e56597028868e340fce1cf7b9316e6f6c4dbc9ce..cdb55adb0e788b403f3dba6d5ae8df8e742a287b 100644 (file)
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: form_win.3x,v 1.8 1999/04/10 23:36:08 tom Exp $
+.\" $Id: form_win.3x,v 1.11 2010/07/31 16:08:48 tom Exp $
 .TH form_win 3X ""
 .SH NAME
-\fBform_win\fR - make and break form window and subwindow associations
+\fBform_win\fR \- make and break form window and subwindow associations
 .SH SYNOPSIS
 \fB#include <form.h>\fR
 .br
@@ -48,33 +48,33 @@ int scale_form(const FORM *form, int *rows, int *columns);
 Every form has an associated pair of \fBcurses\fR windows.  The form window
 displays any title and border associated with the window; the form subwindow
 displays the items of the form that are currently available for selection.
-
+.PP
 The first four functions get and set those windows.  It is not necessary to set
 either window; by default, the driver code uses \fBstdscr\fR for both.
-
+.PP
 In the \fBset_\fR functions, window argument of \fBNULL\fR is treated as though
 it were \fBstsdcr\fR.  A form argument of \fBNULL\fR is treated as a request
 to change the system default form window or subwindow.
-
+.PP
 The function \fBscale_form\fR returns the minimum size required for the
 subwindow of \fIform\fR.
 .SH RETURN VALUE
 Routines that return pointers return \fBNULL\fR on error.  Routines that return
 an integer return one of the following error codes:
 .TP 5
-\fBE_OK\fR
+.B E_OK
 The routine succeeded.
 .TP 5
-\fBE_SYSTEM_ERROR\fR
+.B E_SYSTEM_ERROR
 System error occurred (see \fBerrno\fR).
 .TP 5
-\fBE_BAD_ARGUMENT\fR
+.B E_BAD_ARGUMENT
 Routine detected an incorrect or out-of-range argument.
 .TP 5
-\fBE_POSTED\fR
+.B E_POSTED
 The form has already been posted.
 .TP 5
-\fBE_NOT_CONNECTED\fR
+.B E_NOT_CONNECTED
 No items are connected to the form.
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBform\fR(3X).