X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_win.3x;h=cdb55adb0e788b403f3dba6d5ae8df8e742a287b;hp=e56597028868e340fce1cf7b9316e6f6c4dbc9ce;hb=0ac2306dd3aaab1338d8b1458c15a7e476cfc3ff;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce diff --git a/man/form_win.3x b/man/form_win.3x index e5659702..cdb55adb 100644 --- a/man/form_win.3x +++ b/man/form_win.3x @@ -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 * @@ -27,10 +27,10 @@ .\" 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 \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).