ncurses 6.2 - patch 20210911
[ncurses.git] / man / menu_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: menu_cursor.3x,v 1.13 2020/10/17 23:41:31 tom Exp $
32 .TH menu_cursor 3X ""
33 .SH NAME
34 \fBpos_menu_cursor\fR \- position a menu's cursor
35 .SH SYNOPSIS
36 \fB#include <menu.h>\fR
37 .sp
38 \fBint pos_menu_cursor(const MENU *\fP\fImenu\fP\fB);\fP
39 .br
40 .SH DESCRIPTION
41 The function \fBpos_menu_cursor\fR restores the cursor to the current position
42 associated with the menu's selected item.
43 This is useful after \fBcurses\fR
44 routines have been called to do screen-painting in response to a menu select.
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_SYSTEM_ERROR
52 System error occurred (see \fBerrno\fR(3)).
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 menu has not been posted.
59 .SH SEE ALSO
60 \fBcurses\fR(3X), \fBmenu\fR(3X).
61 .SH NOTES
62 The header file \fB<menu.h>\fR automatically includes the header file
63 \fB<curses.h>\fR.
64 .SH PORTABILITY
65 These routines emulate the System V menu library.
66 They were not supported on
67 Version 7 or BSD versions.
68 .SH AUTHORS
69 Juergen Pfeifer.
70 Manual pages and adaptation for new curses by Eric S. Raymond.