Debian Codegraph @

upstream/debian-unstable/man3/cursor.3form

raw
1 '\" t
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 .\"
31 .\" $Id: form_cursor.3x,v 1.31 2024/03/16 15:35:01 tom Exp $
32 .TH cursor 3FORM 2024-03-16 "ncurses 6.6" "Library calls"
33 .SH NAME
34 \fBpos_form_cursor\fP \-
35 position a form window cursor
36 .SH SYNOPSIS
37 .nf
38 \fB#include <form.h>
39 .PP
40 \fBint pos_form_cursor(FORM *\fIform\fP);
41 .fi
42 .SH DESCRIPTION
43 The function \fBpos_form_cursor\fP restores the cursor to the position required
44 for the forms driver to continue processing requests.
45 This is useful after
46 \fBcurses\fP routines have been called to do screen-painting in response to a
47 form operation.
48 .SH RETURN VALUE
49 This routine returns one of the following:
50 .TP 5
51 .B E_OK
52 The routine succeeded.
53 .TP 5
54 .B E_BAD_ARGUMENT
55 Routine detected an incorrect or out-of-range argument.
56 .TP 5
57 .B E_NOT_POSTED
58 The form has not been posted.
59 .TP 5
60 .B E_SYSTEM_ERROR
61 System error occurred (see \fBerrno\fP(3)).
62 .SH PORTABILITY
63 These routines emulate the System V forms library.
64 They were not supported on
65 Version 7 or BSD versions.
66 .SH AUTHORS
67 Juergen Pfeifer.
68 Manual pages and adaptation for new curses by Eric S. Raymond.
69 .SH SEE ALSO
70 \fB\%ncurses\fP(3NCURSES),
71 \fB\%form\fP(3FORM)