Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / refs/heads/android-16 / . / man / menu_cursor.3x
blob: d92d8c3ad4e0a088e945edb6e755d256799eef29 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1.\"***************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]2.\" Copyright 2018-2023,2024 Thomas E. Dickey *
3.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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.\"
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]30.\" $Id: menu_cursor.3x,v 1.30 2024/03/16 15:35:01 tom Exp $
31.TH menu_cursor 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]32.SH NAME
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]33\fBpos_menu_cursor\fP \-
34position a menu's cursor
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]35.SH SYNOPSIS
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]36.nf
37\fB#include <menu.h>
38.PP
39\fBint pos_menu_cursor(const MENU *\fImenu\fP);
40.fi
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]41.SH DESCRIPTION
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]42The function \fBpos_menu_cursor\fP restores the cursor to the current position
43associated with the menu's selected item.
44This is useful after \fBcurses\fP
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]45routines have been called to do screen-painting in response to a menu select.
46.SH RETURN VALUE
47This routine returns one of the following:
48.TP 5
49.B E_OK
50The routine succeeded.
51.TP 5
52.B E_SYSTEM_ERROR
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]53System error occurred (see \fBerrno\fP(3)).
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]54.TP 5
55.B E_BAD_ARGUMENT
56Routine detected an incorrect or out-of-range argument.
57.TP 5
58.B E_NOT_POSTED
59The menu has not been posted.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]60.SH PORTABILITY
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]61These routines emulate the System V menu library.
62They were not supported on
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]63Version 7 or BSD versions.
64.SH AUTHORS
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]65Juergen Pfeifer.
66Manual pages and adaptation for new curses by Eric S. Raymond.
67.SH SEE ALSO
68\fB\%curses\fP(3X),
69\fB\%menu\fP(3X)