1<!-- 2 **************************************************************************** 3 * Copyright 2018-2023,2024 Thomas E. Dickey * 4 * Copyright 1998-2010,2015 Free Software Foundation, Inc. * 5 * * 6 * Permission is hereby granted, free of charge, to any person obtaining a * 7 * copy of this software and associated documentation files (the * 8 * "Software"), to deal in the Software without restriction, including * 9 * without limitation the rights to use, copy, modify, merge, publish, * 10 * distribute, distribute with modifications, sublicense, and/or sell * 11 * copies of the Software, and to permit persons to whom the Software is * 12 * furnished to do so, subject to the following conditions: * 13 * * 14 * The above copyright notice and this permission notice shall be included * 15 * in all copies or substantial portions of the Software. * 16 * * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * 18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * 19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * 20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * 21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * 22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * 23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * 24 * * 25 * Except as contained in this notice, the name(s) of the above copyright * 26 * holders shall not be used in advertising or otherwise to promote the * 27 * sale, use or other dealings in this Software without prior written * 28 * authorization. * 29 **************************************************************************** 30 * @Id: form_opts.3x,v 1.34 2024/03/16 15:35:01 tom Exp @ 31--> 32<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> 33<HTML> 34<HEAD> 35<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> 36<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> 37<TITLE>form_opts 3x 2024-03-16 ncurses 6.5 Library calls</TITLE> 38<link rel="author" href="mailto:bug-ncurses@gnu.org"> 39 40</HEAD> 41<BODY> 42<H1 class="no-header">form_opts 3x 2024-03-16 ncurses 6.5 Library calls</H1> 43<PRE> 44<STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG> Library calls <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG> 45 46 47 48 49</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> 50 <STRONG>set_form_opts</STRONG>, <STRONG>form_opts_on</STRONG>, <STRONG>form_opts_off</STRONG>, <STRONG>form_opts</STRONG> - set and get 51 form options 52 53 54</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> 55 <STRONG>#include</STRONG> <STRONG><form.h></STRONG> 56 57 <STRONG>int</STRONG> <STRONG>set_form_opts(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>Field_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG> 58 <STRONG>Field_Options</STRONG> <STRONG>form_opts(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG> 59 60 <STRONG>int</STRONG> <STRONG>form_opts_on(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>Field_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG> 61 <STRONG>int</STRONG> <STRONG>form_opts_off(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>Field_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG> 62 63 64</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> 65 The function <STRONG>set_form_opts</STRONG> sets all the given form's option bits (form 66 option bits may be logically-OR'ed together). 67 68 The function <STRONG>form_opts_on</STRONG> turns on the given option bits, and leaves 69 others alone. 70 71 The function <STRONG>form_opts_off</STRONG> turns off the given option bits, and leaves 72 others alone. 73 74 The function <STRONG>form_opts</STRONG> returns the form's current option bits. 75 76 The following options are defined (all are on by default): 77 78 O_NL_OVERLOAD 79 Overload the <STRONG>REQ_NEW_LINE</STRONG> forms driver request so that calling it 80 at the end of a field goes to the next field. 81 82 O_BS_OVERLOAD 83 Overload the <STRONG>REQ_DEL_PREV</STRONG> forms driver request so that calling it 84 at the beginning of a field goes to the previous field. 85 86 87</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> 88 Except for <STRONG>form_opts</STRONG>, each routine returns one of the following: 89 90 <STRONG>E_OK</STRONG> The routine succeeded. 91 92 <STRONG>E_SYSTEM_ERROR</STRONG> 93 System error occurred (see <STRONG>errno(3)</STRONG>). 94 95 96</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> 97 These routines emulate the System V forms library. They were not 98 supported on Version 7 or BSD versions. 99 100 101</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> 102 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. 103 Raymond. 104 105 106</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> 107 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG> 108 109 110 111ncurses 6.5 2024-03-16 <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG> 112</PRE> 113<div class="nav"> 114<ul> 115<li><a href="#h2-NAME">NAME</a></li> 116<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> 117<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> 118<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> 119<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> 120<li><a href="#h2-AUTHORS">AUTHORS</a></li> 121<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> 122</ul> 123</div> 124</BODY> 125</HTML> 126