1 .\"***************************************************************************
2 .\" Copyright 2018-2022,2023 Thomas E. Dickey *
3 .\" Copyright 1998-2006,2010 Free Software Foundation, Inc. *
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: *
13 .\" The above copyright notice and this permission notice shall be included *
14 .\" in all copies or substantial portions of the Software. *
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. *
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 *
28 .\"***************************************************************************
30 .\" $Id: mitem_current.3x,v 1.33 2023/10/07 21:19:07 tom Exp $
31 .TH mitem_current 3X 2023-10-07 "ncurses 6.4" "Library calls"
33 \fBmitem_current\fP \-
34 set and get current_menu_item
39 \fBint set_current_item(MENU *\fImenu\fP, ITEM *\fIitem\fP);
40 \fBITEM *current_item(const MENU *\fImenu\fP);
42 \fBint set_top_row(MENU *\fImenu\fP, int \fIrow\fP);
43 \fBint top_row(const MENU *\fImenu\fP);
45 \fBint item_index(const ITEM *\fIitem\fP);
48 The function \fBset_current_item\fP sets the current item (the item on which
49 the menu cursor is positioned).
50 \fBcurrent_item\fP returns a pointer to the
51 current item in the given menu.
53 The function \fBset_top_row\fP sets the top row of the menu to show the given
54 row (the top row is initially 0, and is reset to this value whenever the
55 \fBO_ROWMAJOR\fP option is toggled).
56 The item leftmost on the given row
58 The function \fBtop_row\fP returns the number of the top menu
61 The function \fBitem_index\fP returns the (zero-origin) index of \fIitem\fP in
62 the menu's item pointer list.
64 \fBcurrent_item\fP returns a pointer (which may be \fBNULL\fP).
65 It does not set \fBerrno\fP.
67 \fBtop_row\fP and \fBitem_index\fP return \fBERR\fP (the general \fBcurses\fP
68 error value) if their \fImenu\fP parameter is \fBNULL\fP.
70 \fBset_current_item\fP and \fBset_top_row\fP return one of the following:
73 The routine succeeded.
76 Routine detected an incorrect or out-of-range argument.
79 Routine was called from an initialization or termination function.
82 No items are connected to the menu.
85 System error occurred (see \fBerrno\fP(3)).
87 The header file \fB<menu.h>\fP automatically includes the header file
90 These routines emulate the System V menu library.
91 They were not supported on
92 Version 7 or BSD versions.
94 The SVr4 menu library documentation specifies the \fBtop_row\fP and
95 \fBindex_item\fP error value as \-1 (which is the value of \fBERR\fP).
98 Manual pages and adaptation for new curses by Eric S. Raymond.