man/menu_cursor.3x

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