jcs.org
jcs's openbsd hax
openbsd
1'\" t
2.\" $OpenBSD: form_cursor.3,v 1.9 2023/10/17 09:52:10 nicm Exp $
3.\"
4.\"***************************************************************************
5.\" Copyright 2018-2022,2023 Thomas E. Dickey *
6.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
7.\" *
8.\" Permission is hereby granted, free of charge, to any person obtaining a *
9.\" copy of this software and associated documentation files (the *
10.\" "Software"), to deal in the Software without restriction, including *
11.\" without limitation the rights to use, copy, modify, merge, publish, *
12.\" distribute, distribute with modifications, sublicense, and/or sell *
13.\" copies of the Software, and to permit persons to whom the Software is *
14.\" furnished to do so, subject to the following conditions: *
15.\" *
16.\" The above copyright notice and this permission notice shall be included *
17.\" in all copies or substantial portions of the Software. *
18.\" *
19.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
20.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
21.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
22.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
23.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
24.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
25.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
26.\" *
27.\" Except as contained in this notice, the name(s) of the above copyright *
28.\" holders shall not be used in advertising or otherwise to promote the *
29.\" sale, use or other dealings in this Software without prior written *
30.\" authorization. *
31.\"***************************************************************************
32.\"
33.\" $Id: form_cursor.3,v 1.9 2023/10/17 09:52:10 nicm Exp $
34.TH form_cursor 3 2023-07-01 "ncurses 6.4" "Library calls"
35.SH NAME
36\fBpos_form_cursor\fP \- position a form window cursor
37.SH SYNOPSIS
38\fB#include <form.h>\fP
39.sp
40\fBint pos_form_cursor(FORM *\fIform\fB);\fR
41.SH DESCRIPTION
42The function \fBpos_form_cursor\fP restores the cursor to the position required
43for the forms driver to continue processing requests.
44This is useful after
45\fBcurses\fP routines have been called to do screen-painting in response to a
46form operation.
47.SH RETURN VALUE
48This routine returns one of the following:
49.TP 5
50.B E_OK
51The routine succeeded.
52.TP 5
53.B E_BAD_ARGUMENT
54Routine detected an incorrect or out-of-range argument.
55.TP 5
56.B E_NOT_POSTED
57The form has not been posted.
58.TP 5
59.B E_SYSTEM_ERROR
60System error occurred (see \fBerrno\fP(3)).
61.
62.SH SEE ALSO
63\fBcurses\fP(3), \fBform\fP(3).
64.SH NOTES
65The header file \fB<form.h>\fP automatically includes the header file
66\fB<curses.h>\fP.
67.SH PORTABILITY
68These routines emulate the System V forms library.
69They were not supported on
70Version 7 or BSD versions.
71.SH AUTHORS
72Juergen Pfeifer.
73Manual pages and adaptation for new curses by Eric S. Raymond.