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