X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_cursor.3x;h=7a364eb5aba0fea1fdd6e7dea5722e19c65b1948;hp=d2e5e2a3e8ba9f3aeeb74bc5ee2cb44f5d438fba;hb=a6eb34d7fec8170a8715f9e53ca2f96452dd30dd;hpb=3a9b6a3bf0269231bef7de74757a910dedd04e0c diff --git a/man/menu_cursor.3x b/man/menu_cursor.3x index d2e5e2a3..7a364eb5 100644 --- a/man/menu_cursor.3x +++ b/man/menu_cursor.3x @@ -1,29 +1,60 @@ '\" t +.\"*************************************************************************** +.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * +.\" * +.\" Permission is hereby granted, free of charge, to any person obtaining a * +.\" copy of this software and associated documentation files (the * +.\" "Software"), to deal in the Software without restriction, including * +.\" without limitation the rights to use, copy, modify, merge, publish, * +.\" distribute, distribute with modifications, sublicense, and/or sell * +.\" copies of the Software, and to permit persons to whom the Software is * +.\" furnished to do so, subject to the following conditions: * +.\" * +.\" The above copyright notice and this permission notice shall be included * +.\" in all copies or substantial portions of the Software. * +.\" * +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * +.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * +.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * +.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * +.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * +.\" * +.\" Except as contained in this notice, the name(s) of the above copyright * +.\" holders shall not be used in advertising or otherwise to promote the * +.\" sale, use or other dealings in this Software without prior written * +.\" authorization. * +.\"*************************************************************************** +.\" +.\" $Id: menu_cursor.3x,v 1.13 2020/10/17 23:41:31 tom Exp $ .TH menu_cursor 3X "" .SH NAME -\fBmenu_cursor\fR - position a menu's cursor +\fBpos_menu_cursor\fR \- position a menu's cursor .SH SYNOPSIS \fB#include \fR -.br -int pos_menu_cursor(const MENU *menu); +.sp +\fBint pos_menu_cursor(const MENU *\fP\fImenu\fP\fB);\fP .br .SH DESCRIPTION The function \fBpos_menu_cursor\fR restores the cursor to the current position -associated with the menu's selected item. This is useful after \fBcurses\fR +associated with the menu's selected item. +This is useful after \fBcurses\fR routines have been called to do screen-painting in response to a menu select. .SH RETURN VALUE This routine returns one of the following: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR(3)). .TP 5 -\fBE_BAD_ARGUMENT\fR +.B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. .TP 5 -\fBE_NOT_POSTED\fR +.B E_NOT_POSTED The menu has not been posted. .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X). @@ -31,14 +62,9 @@ The menu has not been posted. The header file \fB\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V menu library. They were not supported on +These routines emulate the System V menu library. +They were not supported on Version 7 or BSD versions. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.