ncurses 6.1 - patch 20190121
[ncurses.git] / man / mitem_current.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2018,2019 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: mitem_current.3x,v 1.15 2019/01/20 20:32:23 tom Exp $
31 .TH mitem_current 3X ""
32 .SH NAME
33 \fBmitem_current\fR \- set and get current_menu_item
34 .SH SYNOPSIS
35 \fB#include <menu.h>\fR
36 .br
37 int set_current_item(MENU *menu, const ITEM *item);
38 .br
39 ITEM *current_item(const MENU *menu);
40 .br
41 int set_top_row(MENU *menu, int row);
42 .br
43 int top_row(const MENU *menu);
44 .br
45 int item_index(const ITEM *item);
46 .br
47 .SH DESCRIPTION
48 The function \fBset_current_item\fR sets the current item (the item on which
49 the menu cursor is positioned).
50 \fBcurrent_item\fR returns a pointer to the
51 current item in the given menu.
52 .PP
53 The function \fBset_top_row\fR 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\fR option is toggled).
56 The item leftmost on the given row
57 becomes current.
58 The function \fBtop_row\fR returns the number of the top menu
59 row being displayed.
60 .PP
61 The function \fBitem_index\fR returns the (zero-origin) index of \fIitem\fR in
62 the menu's item pointer list.
63 .SH RETURN VALUE
64 \fBcurrent_item\fR returns a pointer (which may be \fBNULL\fR).
65 It does not set errno.
66 .PP
67 \fBtop_row\fR and \fBitem_index\fR return \fBERR\fR (the general \fBcurses\fR
68 error value) if their \fImenu\fP parameter is \fBNULL\fP.
69 .PP
70 \fBset_current_item\fR and \fBset_top_row\fR return one of the following:
71 .TP 5
72 .B E_OK
73 The routine succeeded.
74 .TP 5
75 .B E_BAD_ARGUMENT
76 Routine detected an incorrect or out-of-range argument.
77 .TP 5
78 .B E_BAD_STATE
79 Routine was called from an initialization or termination function.
80 .TP 5
81 .B E_NOT_CONNECTED
82 No items are connected to the menu.
83 .TP 5
84 .B E_SYSTEM_ERROR
85 System error occurred (see \fBerrno\fR(3)).
86 .SH SEE ALSO
87 \fBcurses\fR(3X), \fBmenu\fR(3X).
88 .SH NOTES
89 The header file \fB<menu.h>\fR automatically includes the header file
90 \fB<curses.h>\fR.
91 .SH PORTABILITY
92 These routines emulate the System V menu library.
93 They were not supported on
94 Version 7 or BSD versions.
95 .PP
96 The SVr4 menu library documentation specifies the \fBtop_row\fR and
97 \fBindex_item\fR error value as \-1 (which is the value of \fBERR\fR).
98 .SH AUTHORS
99 Juergen Pfeifer.
100 Manual pages and adaptation for new curses by Eric S. Raymond.