<!--
* t
****************************************************************************
- * Copyright (c) 1998,2003 Free Software Foundation, Inc. *
+ * Copyright (c) 1998-2007,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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: form_field_opts.3x,v 1.8 2003/05/10 20:33:49 jmc Exp @
+ * @Id: form_field_opts.3x,v 1.16 2010/12/04 18:41:07 tom Exp @
-->
<HTML>
<HEAD>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
-<STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG> <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
+<STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
<STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
</PRE>
<H2>SYNOPSIS</H2><PRE>
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
- int set_field_opts(FIELD *field, OPTIONS opts);
- int field_opts_on(FIELD *field, OPTIONS opts);
- int field_opts_off(FIELD *field, OPTIONS opts);
- OPTIONS field_opts(const FIELD *field);
+ int set_field_opts(FIELD *field, Field_Options opts);
+ int field_opts_on(FIELD *field, Field_Options opts);
+ int field_opts_off(FIELD *field, Field_Options opts);
+ Field_Options field_opts(const FIELD *field);
</PRE>
The following options are defined (all are on by default):
O_VISIBLE
- The field is displayed. If this option is off, dis-
+ The field is displayed. If this option is off, dis-
play of the field is suppressed.
O_ACTIVE
- The field is visited during processing. If this
- option is off, the field will not be reachable by
- navigation keys. Please notice that an invisible
+ The field is visited during processing. If this
+ option is off, the field will not be reachable by
+ navigation keys. Please notice that an invisible
field appears to be inactive also.
O_PUBLIC
- The field contents are displayed as data is entered.
+ The field contents are displayed as data is entered.
O_EDIT
The field can be edited.
O_WRAP
- Words that don't fit on a line are wrapped to the
+ Words that do not fit on a line are wrapped to the
next line. Words are blank-separated.
O_BLANK
Allow a blank field.
O_STATIC
- Field buffers are fixed to field's original size.
+ Field buffers are fixed to field's original size.
+ Turn this option off to create a dynamic field.
O_PASSOK
Validate field only if modified by user.
</PRE>
<H2>RETURN VALUE</H2><PRE>
- Except for <STRONG>field_opts</STRONG>, each routine returns one of the
+ Except for <STRONG>field_opts</STRONG>, each routine returns one of the
following:
<STRONG>E_OK</STRONG> The routine succeeded.
- <STRONG>E_SYSTEM_ERROR</STRONG>
- System error occurred (see <STRONG>errno</STRONG>).
+ <STRONG>E_BAD_ARGUMENT</STRONG>
+ Routine detected an incorrect or out-of-range argu-
+ ment.
<STRONG>E_CURRENT</STRONG>
The field is the current field.
+ <STRONG>E_SYSTEM_ERROR</STRONG>
+ System error occurred (see <STRONG>errno</STRONG>).
+
</PRE>
<H2>SEE ALSO</H2><PRE>
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
- <STRONG>NOTES</STRONG> The header file <STRONG><form.h></STRONG> automatically includes the
- header file <STRONG><curses.h></STRONG>.
+</PRE>
+<H2>NOTES</H2><PRE>
+ The header file <STRONG><form.h></STRONG> automatically includes the header
+ file <STRONG><curses.h></STRONG>.
</PRE>
- <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
+
<STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
</PRE>
<HR>
<ADDRESS>
projects / ncurses.git / blobdiff