]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - Ada95/html/man/form_field_opts.3x.html
ncurses 5.0
[ncurses.git] / Ada95 / html / man / form_field_opts.3x.html
diff --git a/Ada95/html/man/form_field_opts.3x.html b/Ada95/html/man/form_field_opts.3x.html
new file mode 100644 (file)
index 0000000..5eabb11
--- /dev/null
@@ -0,0 +1,122 @@
+<HTML>
+<BODY>
+<PRE>
+       <STRONG>form_field_opts</STRONG> - set and get field options
+
+
+</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);
+
+
+</PRE>
+<H2>DESCRIPTION</H2><PRE>
+       The  function  <STRONG>set_field_opts</STRONG>  sets  all the given field's
+       option bits (field  option  bits  may  be  logically-OR'ed
+       together).
+
+       The function <STRONG>field_opts_on</STRONG> turns on the given option bits,
+       and leaves others alone.
+
+       The function <STRONG>field_opts_off</STRONG> turns  off  the  given  option
+       bits, and leaves others alone.
+
+       The function <STRONG>field_opts</STRONG> returns the field's current option
+       bits.
+
+       The following options are defined (all are on by default):
+
+       O_VISIBLE
+            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
+            field appears to be inactive also.
+
+       O_PUBLIC
+            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
+            next line.  Words are blank-separated.
+
+       O_BLANK
+            The  field is cleared whenever a character is entered
+            at the first position.
+
+       O_AUTOSKIP
+            Skip to the next field when this one fills
+
+            Allow a blank field.
+
+       O_STATIC
+            Field buffers are fixed to field's original size.
+
+       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
+       following:
+
+       <STRONG>E_OK</STRONG> The routine succeeded.
+
+       <STRONG>E_SYSTEM_ERROR</STRONG>
+            System error occurred (see <STRONG>errno</STRONG>).
+
+       <STRONG>E_CURRENT</STRONG>
+            The field is the current field.
+
+
+</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>PORTABILITY</H2><PRE>
+       These routines emulate the System V forms  library.   They
+       were not supported on Version 7 or BSD versions.
+
+
+</PRE>
+<H2>AUTHORS</H2><PRE>
+       Juergen  Pfeifer.   Manual  pages  and  adaptation for new
+       curses by Eric S. Raymond.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</PRE>
+</BODY>
+</HTML>