X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_field_opts.3x;h=d505279ceb201d7dd890c36033d8d44abc971f2b;hp=8f5e2def4315aa01d92c2c35f40bbc22600f7e02;hb=7b2974498fac39a3ffde257c92f572234d529239;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce;ds=sidebyside diff --git a/man/form_field_opts.3x b/man/form_field_opts.3x index 8f5e2def..d505279c 100644 --- a/man/form_field_opts.3x +++ b/man/form_field_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,38 +27,38 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_opts.3x,v 1.7 1998/11/29 01:06:54 Rick.Ohnemus Exp $ +.\" $Id: form_field_opts.3x,v 1.13 2007/02/24 17:34:27 tom Exp $ .TH form_field_opts 3X "" .SH NAME \fBform_field_opts\fR - set and get field options .SH SYNOPSIS \fB#include \fR .br -int set_field_opts(FIELD *field, OPTIONS opts); +int set_field_opts(FIELD *field, Field_Options opts); .br -int field_opts_on(FIELD *field, OPTIONS opts); +int field_opts_on(FIELD *field, Field_Options opts); .br -int field_opts_off(FIELD *field, OPTIONS opts); +int field_opts_off(FIELD *field, Field_Options opts); .br -OPTIONS field_opts(const FIELD *field); +Field_Options field_opts(const FIELD *field); .br .SH DESCRIPTION The function \fBset_field_opts\fR sets all the given field's option bits (field option bits may be logically-OR'ed together). - +.PP The function \fBfield_opts_on\fR turns on the given option bits, and leaves others alone. - +.PP The function \fBfield_opts_off\fR turns off the given option bits, and leaves others alone. - +.PP The function \fBfield_opts\fR returns the field's current option bits. - +.PP The following options are defined (all are on by default): .TP 5 O_VISIBLE The field is displayed. If this option is off, display of the field is -suppressed, +suppressed. .TP 5 O_ACTIVE The field is visited during processing. If this option is off, the field will @@ -72,34 +72,38 @@ O_EDIT The field can be edited. .TP 5 O_WRAP -Words that don't fit on a line are wrapped to the next line. Words are +Words that do not fit on a line are wrapped to the next line. Words are blank-separated. .TP 5 O_BLANK The field is cleared whenever a character is entered at the first position. .TP 5 O_AUTOSKIP -Skip to the next field when this one fills +Skip to the next field when this one fills. .TP 5 O_NULLOK Allow a blank field. .TP 5 O_STATIC Field buffers are fixed to field's original size. +Turn this option off to create a dynamic field. .TP 5 O_PASSOK Validate field only if modified by user. .SH RETURN VALUE Except for \fBfield_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 -System error occurred (see \fBerrno\fR). +.B E_BAD_ARGUMENT +Routine detected an incorrect or out-of-range argument. .TP 5 -\fBE_CURRENT\fR +.B E_CURRENT The field is the current field. +.TP 5 +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR). .SH SEE ALSO \fBcurses\fR(3X), \fBform\fR(3X). .TP 5