X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_win.3x;h=8d4a46da3559fd1473242e66511e6bce5e9e69e3;hp=c8f64f2e04adf5061d8adcb4dc412ed70b925153;hb=e5d1530ca229aef94a3c84ad33f8ae89f35c4045;hpb=027ae42953e3186daed8f3882da73de48291b606 diff --git a/man/form_win.3x b/man/form_win.3x index c8f64f2e..8d4a46da 100644 --- a/man/form_win.3x +++ b/man/form_win.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 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,29 +28,31 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_win.3x,v 1.10 2006/11/04 17:12:00 tom Exp $ +.\" $Id: form_win.3x,v 1.18 2020/10/18 00:00:32 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 +.sp +\fBint set_form_win(FORM *\fP\fIform\fP\fB, WINDOW *\fP\fIwin\fP\fB);\fP .br -int set_form_win(FORM *form, WINDOW *win); +\fBWINDOW *form_win(const FORM *\fP\fIform\fP\fB);\fP +.sp +\fBint set_form_sub(FORM *\fP\fIform\fP\fB, WINDOW *\fP\fIsub\fP\fB);\fP .br -WINDOW *form_win(const FORM *form); -.br -int set_form_sub(FORM *form, WINDOW *sub); -.br -WINDOW *form_sub(const FORM *form); -.br -int scale_form(const FORM *form, int *rows, int *columns); +\fBWINDOW *form_sub(const FORM *\fP\fIform\fP\fB);\fP +.sp +\fBint scale_form(const FORM *\fP\fIform\fP\fB, int *\fP\fIrows\fP\fB, int *\fP\fIcolumns\fP\fB);\fP .br .SH DESCRIPTION -Every form has an associated pair of \fBcurses\fR windows. The form window +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 +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 @@ -59,14 +62,15 @@ to change the system default form window or subwindow. 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 +Routines that return pointers return \fBNULL\fR on error. +Routines that return an integer return one of the following error codes: .TP 5 .B E_OK The routine succeeded. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR). +System error occurred (see \fBerrno\fR(3)). .TP 5 .B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. @@ -77,19 +81,16 @@ The form has already been posted. .B E_NOT_CONNECTED No items are connected to the form. .SH SEE ALSO -\fBcurses\fR(3X), \fBform\fR(3X). +\fBcurses\fR(3X), +\fBcurs_variables\fR(3X), +\fBform\fR(3X). .SH NOTES The header file \fB\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V forms library. They were not supported on +These routines emulate the System V forms library. +They were not supported on Version 7 or BSD versions. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.