xref: /netbsd-src/lib/libmenu/menu_cursor.3 (revision 4472dbe5e3bd91ef2540bada7a7ca7384627ff9b)
1.\"	$NetBSD: menu_cursor.3,v 1.2 1999/11/24 12:43:16 kleink Exp $
2.\"
3.\" Copyright (c) 1999
4.\"	Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
5.\"
6.\" This code is donated to The NetBSD Foundation by the author.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. The name of the Author may not be used to endorse or promote
17.\"    products derived from this software without specific prior written
18.\"    permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.Dd September, 1999
33.Dt MENU_CURSOR 3
34.Os BSD 4
35.Sh NAME
36.Nm pos_menu_cursor
37.Nd menu library
38.Sh LIBRARY
39.Lb libmenu
40.Sh SYNOPSIS
41.Fd #include <menu.h>
42.Ft int
43.Fn pos_menu_cursor "MENU *menu"
44.Sh DESCRIPTION
45The
46.Fn pos_menu_cursor
47function positions the cursor in the menu window.  This function can
48be called after other curses calls to restore the cursor to it's
49correct position in the menu.
50.Sh RETURN VALUES
51The functions return one of the following error values:
52.Pp
53.ta 20
54.nf
55E_OK			The function was successful
56E_SYSTEM_ERROR		There was a system error during the call.
57E_BAD_ARGUMENT		One or more of the arguments passed to the function
58			was incorrect.
59E_POSTED		The menu is already posted.
60E_CONNECTED		An item was already connected to a menu.
61E_BAD_STATE		The function was called from within an initialisation
62			or termination routine.
63E_NO_ROOM		The menu does not fit within the subwindow.
64E_NOT_POSTED		The menu is not posted
65E_UNKNOWN_COMMAND	The menu driver does not recognise the request
66			passed to it.
67E_NO_MATCH		The character search failed to find a match.
68E_NOT_SELECTABLE	The item could not be selected.
69E_NOT_CONNECTED		The item is not connected to a menu.
70E_REQUEST_DENIED	The menu driver could not process the request.
71.fi
72.ft 1
73.br
74.ne 8
75.Sh SEE ALSO
76.Xr curses 3 ,
77.Xr menus 3
78.Sh NOTES
79The header
80.Xr <menus.h>
81automatically includes both
82.Xr <curses.h>
83and
84.Xr <eti.h>
85
86