X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fform_win.3x;h=49c007fc212e0bd74e4c2a583882f948b6af5338;hb=4c9f63c460cb7134f142aa65f6866c175ed77605;hp=32af49b68040c4505d9aea0497c0a5ee0d8737df;hpb=96d6b16de0d487e5d3aed0302a179dbce11b5d96;p=ncurses.git diff --git a/man/form_win.3x b/man/form_win.3x index 32af49b6..49c007fc 100644 --- a/man/form_win.3x +++ b/man/form_win.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * +.\" Copyright 2018-2021,2022 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,46 +28,49 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_win.3x,v 1.13 2010/12/04 18:38:55 tom Exp $ +.\" $Id: form_win.3x,v 1.21 2022/02/12 20:03:40 tom Exp $ .TH form_win 3X "" .SH NAME -\fBform_win\fR \- make and break form window and subwindow associations +\fBform_win\fP \- make and break form window and subwindow associations .SH SYNOPSIS -\fB#include \fR +\fB#include \fP +.sp +\fBint set_form_win(FORM *\fIform\fB, WINDOW *\fIwin\fB);\fR .br -int set_form_win(FORM *form, WINDOW *win); +\fBWINDOW *form_win(const FORM *\fIform\fB);\fR +.sp +\fBint set_form_sub(FORM *\fIform\fB, WINDOW *\fIsub\fB);\fR .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 *\fIform\fB);\fR +.sp +\fBint scale_form(const FORM *\fIform\fB, int *\fIrows\fB, int *\fIcolumns\fB);\fR .br .SH DESCRIPTION -Every form has an associated pair of \fBcurses\fR windows. The form window +Every form has an associated pair of \fBcurses\fP 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. +The first four functions get and set those windows. +It is not necessary to set +either window; by default, the driver code uses \fBstdscr\fP 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 +In the \fBset_\fP functions, window argument of \fBNULL\fP is treated as though +it were \fBstsdcr\fP. A form argument of \fBNULL\fP 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. +The function \fBscale_form\fP returns the minimum size required for the +subwindow of \fIform\fP. .SH RETURN VALUE -Routines that return pointers return \fBNULL\fR on error. Routines that return +Routines that return pointers return \fBNULL\fP 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\fP(3)). .TP 5 .B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. @@ -77,15 +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), -\fBcurs_variables\fR(3X), -\fBform\fR(3X). +\fBcurses\fP(3X), +\fBcurs_variables\fP(3X), +\fBform\fP(3X). .SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The header file \fB\fP automatically includes the header file +\fB\fP. .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. +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.