doc/html/man/form_opts.3x.html

   1 <HTML>
   2 <BODY>
   3 <PRE>
   4 <!-- Manpage converted by man2html 3.0.1 -->
   5
   6 </PRE>
   7 <H2>NAME</H2><PRE>
   8        <B>form_opts</B> - set and get form options
   9
  10
  11 </PRE>
  12 <H2>SYNOPSIS</H2><PRE>
  13        <B>#include</B> <B>&lt;form.h&gt;</B>
  14        int set_form_opts(FORM *form, OPTIONS opts);
  15        int form_opts_on(FORM *form, OPTIONS opts);
  16        int form_opts_off(FORM *form, OPTIONS opts);
  17        OPTIONS form_opts(const FORM *form);
  18
  19
  20 </PRE>
  21 <H2>DESCRIPTION</H2><PRE>
  22        The  function  <B>set_form_opts</B>  sets  all  the  given form's
  23        option bits  (form  option  bits  may  be  logically-OR'ed
  24        together).
  25
  26        The  function <B>form_opts_on</B> turns on the given option bits,
  27        and leaves others alone.
  28
  29        The function <B>form_opts_off</B>  turns  off  the  given  option
  30        bits, and leaves others alone.
  31
  32        The  function  <B>form_opts</B> returns the form's current option
  33        bits.
  34
  35        The following options are defined (all are on by default):
  36
  37        O_NL_OVERLOAD
  38             Overload  the  <B>REQ_NEW_LINE</B>  forms  driver request so
  39             that calling it at the end of a  field  goes  to  the
  40             next field.
  41
  42        O_BS_OVERLOAD
  43             Overload  the  <B>REQ_DEL_PREV</B>  forms  driver request so
  44             that calling it at the beginning of a field  goes  to
  45             the previous field.
  46
  47
  48 </PRE>
  49 <H2>RETURN VALUE</H2><PRE>
  50        Except for <B>form_opts</B>, each routine returns one of the fol-
  51        lowing:
  52
  53        <B>E_OK</B> The routine succeeded.
  54
  55        <B>E_SYSTEM_ERROR</B>
  56             System error occurred (see <B>errno</B>).
  57
  58
  59 </PRE>
  60 <H2>SEE ALSO</H2><PRE>
  61        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>.
  62
  63
  64 </PRE>
  65 <H2>NOTES</H2><PRE>
  66        The header file <B>&lt;form.h&gt;</B> automatically includes the header
  67        file <B>&lt;curses.h&gt;</B>.
  68
  69
  70 </PRE>
  71 <H2>PORTABILITY</H2><PRE>
  72        These  routines  emulate the System V forms library.  They
  73        were not supported on Version 7 or BSD versions.
  74
  75
  76 </PRE>
  77 <H2>AUTHORS</H2><PRE>
  78        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
  79        curses by Eric S. Raymond.
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129 </PRE>
 130 <HR>
 131 <ADDRESS>
 132 Man(1) output converted with
 133 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 134 </ADDRESS>
 135 </BODY>
 136 </HTML>