X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_opts.3x;h=0caaae7c88370774d57cc6ae06957a1adbe43e49;hp=7921b3772563a47ad2d4707090e08a2505a1b663;hb=9fab8ab6b69130169a6880e63585d83efb1c1722;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce;ds=sidebyside diff --git a/man/form_opts.3x b/man/form_opts.3x index 7921b377..0caaae7c 100644 --- a/man/form_opts.3x +++ b/man/form_opts.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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,33 +27,33 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_opts.3x,v 1.6 1998/11/29 01:07:53 Rick.Ohnemus Exp $ +.\" $Id: form_opts.3x,v 1.9 2007/02/24 17:34:36 tom Exp $ .TH form_opts 3X "" .SH NAME \fBform_opts\fR - set and get form options .SH SYNOPSIS \fB#include \fR .br -int set_form_opts(FORM *form, OPTIONS opts); +int set_form_opts(FORM *form, Field_Options opts); .br -int form_opts_on(FORM *form, OPTIONS opts); +int form_opts_on(FORM *form, Field_Options opts); .br -int form_opts_off(FORM *form, OPTIONS opts); +int form_opts_off(FORM *form, Field_Options opts); .br -OPTIONS form_opts(const FORM *form); +Field_Options form_opts(const FORM *form); .br .SH DESCRIPTION The function \fBset_form_opts\fR sets all the given form's option bits (form option bits may be logically-OR'ed together). - +.PP The function \fBform_opts_on\fR turns on the given option bits, and leaves others alone. - +.PP The function \fBform_opts_off\fR turns off the given option bits, and leaves others alone. - +.PP The function \fBform_opts\fR returns the form's current option bits. - +.PP The following options are defined (all are on by default): .TP 5 O_NL_OVERLOAD @@ -66,10 +66,10 @@ beginning of a field goes to the previous field. .SH RETURN VALUE Except for \fBform_opts\fR, each routine returns one of the following: .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). .SH SEE ALSO \fBcurses\fR(3X), \fBform\fR(3X).