diff options
author | Rong-En Fan <rafan@FreeBSD.org> | 2007-01-20 07:32:02 +0000 |
---|---|---|
committer | Rong-En Fan <rafan@FreeBSD.org> | 2007-01-20 07:32:02 +0000 |
commit | 4a1a95108dd76c4259fe6c37c4471f7969b17983 (patch) | |
tree | 1c6c3b549401156e1dbd96b9a6b18521f63ffb58 /contrib/ncurses/man/mitem_current.3x | |
parent | 555c9cae3cf9146482732c28c06a73314b618149 (diff) | |
download | src-4a1a95108dd76c4259fe6c37c4471f7969b17983.tar.gz src-4a1a95108dd76c4259fe6c37c4471f7969b17983.zip |
Import ncurses 5.6-20061217 onto the vender branch
Approved by: delphij
Notes
Notes:
svn path=/vendor/ncurses/dist/; revision=166124
Diffstat (limited to 'contrib/ncurses/man/mitem_current.3x')
-rw-r--r-- | contrib/ncurses/man/mitem_current.3x | 33 |
1 files changed, 17 insertions, 16 deletions
diff --git a/contrib/ncurses/man/mitem_current.3x b/contrib/ncurses/man/mitem_current.3x index 179a23be3b2e..979f401341fe 100644 --- a/contrib/ncurses/man/mitem_current.3x +++ b/contrib/ncurses/man/mitem_current.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998,2006 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 * @@ -27,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_current.3x,v 1.9 1998/12/26 19:52:34 tom Exp $ +.\" $Id: mitem_current.3x,v 1.11 2006/11/04 18:18:19 tom Exp $ .TH mitem_current 3X "" .SH NAME \fBmitem_current\fR - set and get current_menu_item @@ -48,37 +48,38 @@ int item_index(const ITEM *item); The function \fBset_current_item\fR sets the current item (the item on which the menu cursor is positioned). \fBcurrent_item\fR returns a pointer to the current item in the given menu. - +.PP The function \fBset_top_row\fR sets the top row of the menu to show the given row (the top row is initially 0, and is reset to this value whenever the \fBO_ROWMAJOR\fR option is toggled). The item leftmost on the given row becomes current. The function \fBtop_row\fR returns the number of the top menu row being displayed. - +.PP The function \fBitem_index\fR returns the (zero-origin) index of \fIitem\fR in the menu's item pointer list. .SH RETURN VALUE -\fBcurrent_item\fR returns \fBNULL\fR on error. - +\fBcurrent_item\fR returns a pointer (which may be \fBNULL\fR). +It does not set errno. +.PP \fBtop_row\fR and \fBitem_index\fR return \fBERR\fR (the general \fBcurses\fR -error value) on error. - +error value) if their \fImenu\fP parameter is \fBNULL\fP. +.PP \fBset_current_item\fR and \fBset_top_row\fR return 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). -.TP 5 -\fBE_BAD_ARGUMENT\fR +.B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. .TP 5 -\fBE_BAD_STATE\fR +.B E_BAD_STATE Routine was called from an initialization or termination function. .TP 5 -\fBE_NOT_CONNECTED\fR +.B E_NOT_CONNECTED No items are connected to the menu. +.TP 5 +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR). .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X). .SH NOTES @@ -87,7 +88,7 @@ The header file \fB<menu.h>\fR automatically includes the header file .SH PORTABILITY These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions. - +.PP The SVr4 menu library documentation specifies the \fBtop_row\fR and \fBindex_item\fR error value as -1 (which is the value of \fBERR\fR). .SH AUTHORS |