1<!-- 2 **************************************************************************** 3 * Copyright 2018-2023,2024 Thomas E. Dickey * 4 * Copyright 1998-2014,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_field_opts.3x,v 1.44 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_field_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_field_opts 3x 2024-03-16 ncurses 6.5 Library calls</H1> 43<PRE> 44<STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG> Library calls <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG> 45 46 47 48 49</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> 50 <STRONG>set_field_opts</STRONG>, <STRONG>field_opts_on</STRONG>, <STRONG>field_opts_off</STRONG>, <STRONG>field_opts</STRONG> - set and get 51 field 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_field_opts(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>Field_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG> 58 <STRONG>Field_Options</STRONG> <STRONG>field_opts(const</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG> 59 60 <STRONG>int</STRONG> <STRONG>field_opts_on(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>Field_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG> 61 <STRONG>int</STRONG> <STRONG>field_opts_off(FIELD</STRONG> <STRONG>*</STRONG><EM>field</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_field_opts</STRONG> sets all the given field's option bits 66 (field option bits may be logically-OR'ed together). 67 68 The function <STRONG>field_opts_on</STRONG> turns on the given option bits, and leaves 69 others alone. 70 71 The function <STRONG>field_opts_off</STRONG> turns off the given option bits, and leaves 72 others alone. 73 74 The function <STRONG>field_opts</STRONG> returns the field's current option bits. 75 76 The following standard options are defined (all are on by default): 77 78 O_ACTIVE 79 The field is visited during processing. If this option is off, 80 the field will not be reachable by navigation keys. Please notice 81 that an invisible field appears to be inactive also. 82 83 O_AUTOSKIP 84 Skip to the next field when this one fills. 85 86 O_BLANK 87 The field is cleared whenever a character is entered at the first 88 position. 89 90 O_EDIT 91 The field can be edited. 92 93 O_NULLOK 94 Allow a blank field. 95 96 O_PASSOK 97 Validate field only if modified by user. 98 99 O_PUBLIC 100 The field contents are displayed as data is entered. 101 102 O_STATIC 103 Field buffers are fixed to field's original size. Turn this 104 option off to create a dynamic field. 105 106 O_VISIBLE 107 The field is displayed. If this option is off, display of the 108 field is suppressed. 109 110 O_WRAP 111 Words that do not fit on a line are wrapped to the next line. 112 Words are blank-separated. 113 114 These extension options are defined (extensions are off by default): 115 116 O_DYNAMIC_JUSTIFY 117 Permit dynamic fields to be justified, like static fields. 118 119 O_NO_LEFT_STRIP 120 Preserve leading whitespace in the field buffer, which is normally 121 discarded. 122 123 O_EDGE_INSERT_STAY 124 When inserting into a field up to the boundary position, 125 optionally delay the scrolling, so that the last inserted 126 character remains visible, but advance the cursor to reflect the 127 insertion. This allows the form library to display the inserted 128 character in one-character fields as well as allowing the library 129 to maintain consistent state. 130 131 O_INPUT_FIELD 132 The <STRONG>set_max_field</STRONG> function checks for this extension, which allows 133 a dynamic field to shrink if the new limit is smaller than the 134 current field size. 135 136 137</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> 138 Except for <STRONG>field_opts</STRONG>, each routine returns one of the following: 139 140 <STRONG>E_OK</STRONG> The routine succeeded. 141 142 <STRONG>E_BAD_ARGUMENT</STRONG> 143 Routine detected an incorrect or out-of-range argument. 144 145 <STRONG>E_CURRENT</STRONG> 146 The field is the current field. 147 148 <STRONG>E_SYSTEM_ERROR</STRONG> 149 System error occurred (see <STRONG>errno(3)</STRONG>). 150 151 152</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> 153 These routines emulate the System V forms library. They were not 154 supported on Version 7 or BSD versions. 155 156 157</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> 158 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. 159 Raymond. 160 161 162</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> 163 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>, <STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG> 164 165 166 167ncurses 6.5 2024-03-16 <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG> 168</PRE> 169<div class="nav"> 170<ul> 171<li><a href="#h2-NAME">NAME</a></li> 172<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> 173<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> 174<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> 175<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> 176<li><a href="#h2-AUTHORS">AUTHORS</a></li> 177<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> 178</ul> 179</div> 180</BODY> 181</HTML> 182