Sync usage with man page.
[netbsd-mini2440.git] / lib / libmenu / menu_item_current.3
blob511dd300d0f3a00d5b1d3bcf5894bad7b8b7d9c6
1 .\"     $NetBSD: menu_item_current.3,v 1.8 2002/10/01 19:26:59 wiz Exp $
2 .\"
3 .\" Copyright (c) 1999
4 .\"     Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
5 .\"
6 .\" This code is donated to The NetBSD Foundation by the author.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\"    notice, this list of conditions and the following disclaimer in the
15 .\"    documentation and/or other materials provided with the distribution.
16 .\" 3. The name of the Author may not be used to endorse or promote
17 .\"    products derived from this software without specific prior written
18 .\"    permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .Dd September 10, 1999
33 .Dt MENU_ITEM_CURRENT 3
34 .Os
35 .Sh NAME
36 .Nm current_item ,
37 .Nm item_index ,
38 .Nm set_current_item ,
39 .Nm set_top_row
40 .Nm top_row
41 .Nd get or set item pointers or top row
42 .Sh LIBRARY
43 .Lb libmenu
44 .Sh SYNOPSIS
45 .In menu.h
46 .Ft ITEM *
47 .Fn current_item "MENU *menu"
48 .Ft int
49 .Fn item_index "ITEM *item"
50 .Ft int
51 .Fn set_current_item "MENU *menu" "ITEM *item"
52 .Ft int
53 .Fn set_top_row "MENU *menu" "int row"
54 .Ft int
55 .Fn top_row "MENU *menu"
56 .Sh DESCRIPTION
57 The
58 .Fn current_item
59 returns a pointer to the current menu item.
60 The
61 .Fn set_current_item
62 can be used to set this to the item give.
63 The
64 .Fn item_index
65 function returns the index number in the array of items for the item
66 pointed to by the
67 .Fa item
68 parameter.
69 The
70 .Fn set_top_row
71 function sets the top row of the menu displayed to be the row given.
72 The current item becomes the leftmost item of the top row.
73 The
74 .Fn top_row
75 call returns the row number that is currently at the top of the
76 displayed menu.
77 .Sh RETURN VALUES
78 .Fn current_item
79 returns NULL if no items are attached to the menu.
80 .Pp
81 .Bl -tag -width E_NOT_CONNECTED -compact
82 .It Er E_OK
83 The function was successful.
84 .It Er E_BAD_ARGUMENT
85 One or more of the arguments passed to the function was incorrect.
86 .It Er E_BAD_STATE
87 The function was called from within an initialization or termination
88 routine.
89 .It Er E_NOT_CONNECTED
90 The item is not connected to a menu.
91 .El
92 .Sh SEE ALSO
93 .Xr curses 3 ,
94 .Xr menus 3
95 .Sh NOTES
96 The header
97 .Pa \*[Lt]menu.h\*[Gt]
98 automatically includes both
99 .Pa \*[Lt]curses.h\*[Gt]
101 .Pa \*[Lt]eti.h\*[Gt] .