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