lib/libncurses/man/form_cursor.3

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright (c) 1998 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.4 1998/11/29 01:05:43 Rick.Ohnemus Exp $
  31 .\" $DragonFly: src/lib/libncurses/man/form_cursor.3,v 1.1 2005/03/12 19:13:54 eirikn Exp $
  32 .TH form_cursor 3X ""
  33 .SH NAME
  34 \fBform_cursor\fR - position a form window cursor
  35 .SH SYNOPSIS
  36 \fB#include <form.h>\fR
  37 .br
  38 int pos_form_cursor(FORM *form);
  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.  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 \fBE_OK\fR
  49 The routine succeeded.
  50 .TP 5
  51 \fBE_SYSTEM_ERROR\fR
  52 System error occurred (see \fBerrno\fR).
  53 .TP 5
  54 \fBE_BAD_ARGUMENT\fR
  55 Routine detected an incorrect or out-of-range argument.
  56 .TP 5
  57 \fBE_NOT_POSTED\fR
  58 The form has not been posted.
  59 .SH SEE ALSO
  60 \fBcurses\fR(3X), \fBform\fR(3X).
  61 .SH NOTES
  62 The header file \fB<form.h>\fR automatically includes the header file
  63 \fB<curses.h>\fR.
  64 .SH PORTABILITY
  65 These routines emulate the System V forms library.  They were not supported on
  66 Version 7 or BSD versions.
  67 .SH AUTHORS
  68 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
  69 S. Raymond.
  70 .\"#
  71 .\"# The following sets edit modes for GNU EMACS
  72 .\"# Local Variables:
  73 .\"# mode:nroff
  74 .\"# fill-column:79
  75 .\"# End: