man/form_cursor.3x

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