-<!--
+<!--
* t
****************************************************************************
- * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. *
+ * Copyright 2018-2019,2020 Thomas E. Dickey *
+ * Copyright 1998-2010,2015 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_opts.3x,v 1.11 2010/12/04 18:40:45 tom Exp @
+ * @Id: form_opts.3x,v 1.17 2020/10/18 00:03:49 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
-<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>form_opts 3x</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
+<TITLE>form_opts 3X</TITLE>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
-<H1 class="no-header">form_opts 3x</H1>
+<H1 class="no-header">form_opts 3X</H1>
<PRE>
-<STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG> <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
+<B><A HREF="form_opts.3X.html">form_opts(3X)</A></B> <B><A HREF="form_opts.3X.html">form_opts(3X)</A></B>
-</PRE>
-<H2><a name="h2-NAME">NAME</a></H2><PRE>
- <STRONG>form_opts</STRONG> - set and get form options
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+ <B>set_form_opts</B>, <B>form_opts_on</B>, <B>form_opts_off</B>, <B>form_opts</B> - set and get
+ form options
-</PRE>
-<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
- int set_form_opts(FORM *form, Field_Options opts);
- int form_opts_on(FORM *form, Field_Options opts);
- int form_opts_off(FORM *form, Field_Options opts);
- Field_Options form_opts(const FORM *form);
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
+ <B>#include</B> <B><form.h></B>
+ <B>int</B> <B>set_form_opts(FORM</B> <B>*</B><I>form</I><B>,</B> <B>Field_Options</B> <I>opts</I><B>);</B>
+ <B>Field_Options</B> <B>form_opts(const</B> <B>FORM</B> <B>*</B><I>form</I><B>);</B>
-</PRE>
-<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- The function <STRONG>set_form_opts</STRONG> sets all the given form's
- option bits (form option bits may be logically-OR'ed
- together).
+ <B>int</B> <B>form_opts_on(FORM</B> <B>*</B><I>form</I><B>,</B> <B>Field_Options</B> <I>opts</I><B>);</B>
+ <B>int</B> <B>form_opts_off(FORM</B> <B>*</B><I>form</I><B>,</B> <B>Field_Options</B> <I>opts</I><B>);</B>
+
+
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
+ The function <B>set_form_opts</B> sets all the given form's option bits (form
+ option bits may be logically-OR'ed together).
- The function <STRONG>form_opts_on</STRONG> turns on the given option bits,
- and leaves others alone.
+ The function <B>form_opts_on</B> turns on the given option bits, and leaves
+ others alone.
- The function <STRONG>form_opts_off</STRONG> turns off the given option
- bits, and leaves others alone.
+ The function <B>form_opts_off</B> turns off the given option bits, and leaves
+ others alone.
- The function <STRONG>form_opts</STRONG> returns the form's current option
- bits.
+ The function <B>form_opts</B> returns the form's current option bits.
The following options are defined (all are on by default):
O_NL_OVERLOAD
- Overload the <STRONG>REQ_NEW_LINE</STRONG> forms driver request so
- that calling it at the end of a field goes to the
- next field.
+ Overload the <B>REQ_NEW_LINE</B> forms driver request so that calling it
+ at the end of a field goes to the next field.
O_BS_OVERLOAD
- Overload the <STRONG>REQ_DEL_PREV</STRONG> forms driver request so
- that calling it at the beginning of a field goes to
- the previous field.
+ Overload the <B>REQ_DEL_PREV</B> forms driver request so that calling it
+ at the beginning of a field goes to the previous field.
-</PRE>
-<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- Except for <STRONG>form_opts</STRONG>, each routine returns one of the fol-
- lowing:
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+ Except for <B>form_opts</B>, each routine returns one of the following:
- <STRONG>E_OK</STRONG> The routine succeeded.
+ <B>E_OK</B> The routine succeeded.
- <STRONG>E_SYSTEM_ERROR</STRONG>
- System error occurred (see <STRONG>errno</STRONG>).
+ <B>E_SYSTEM_ERROR</B>
+ System error occurred (see <B>errno(3)</B>).
-</PRE>
-<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="form.3X.html">form(3X)</A></B>.
-</PRE>
-<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
- The header file <STRONG><form.h></STRONG> automatically includes the header
- file <STRONG><curses.h></STRONG>.
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+ The header file <B><form.h></B> automatically includes the header file
+ <B><curses.h></B>.
-</PRE>
-<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- These routines emulate the System V forms library. They
- were not supported on Version 7 or BSD versions.
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+ These routines emulate the System V forms library. They were not
+ supported on Version 7 or BSD versions.
-</PRE>
-<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
- Juergen Pfeifer. Manual pages and adaptation for new
- curses by Eric S. Raymond.
+</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
+ Raymond.
- <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
+ <B><A HREF="form_opts.3X.html">form_opts(3X)</A></B>
</PRE>
<div class="nav">
<ul>
projects / ncurses.git / blobdiff