ncurses 6.0 - patch 20151205
[ncurses.git] / man / menu_cursor.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2010,2015 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: menu_cursor.3x,v 1.9 2015/12/05 23:42:45 tom Exp $
31 .TH menu_cursor 3X ""
32 .SH NAME
33 \fBpos_menu_cursor\fR \- position a menu's cursor
34 .SH SYNOPSIS
35 \fB#include <menu.h>\fR
36 .br
37 int pos_menu_cursor(const MENU *menu);
38 .br
39 .SH DESCRIPTION
40 The function \fBpos_menu_cursor\fR restores the cursor to the current position
41 associated with the menu's selected item.  This is useful after \fBcurses\fR
42 routines have been called to do screen-painting in response to a menu select.
43 .SH RETURN VALUE
44 This routine returns one of the following:
45 .TP 5
46 .B E_OK
47 The routine succeeded.
48 .TP 5
49 .B E_SYSTEM_ERROR
50 System error occurred (see \fBerrno\fR).
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 menu has not been posted.
57 .SH SEE ALSO
58 \fBcurses\fR(3X), \fBmenu\fR(3X).
59 .SH NOTES
60 The header file \fB<menu.h>\fR automatically includes the header file
61 \fB<curses.h>\fR.
62 .SH PORTABILITY
63 These routines emulate the System V menu library.  They were not supported on
64 Version 7 or BSD versions.
65 .SH AUTHORS
66 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
67 S. Raymond.