X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmitem_current.3x;h=a231cabe9976cee4c7478a9e64eb63be457458c2;hp=179a23be3b2e91e8a1e6aa3bfba90629dd6853c3;hb=eccca377f55c70b12e3e92621d94d1e1c1fcfb7d;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce diff --git a/man/mitem_current.3x b/man/mitem_current.3x index 179a23be..a231cabe 100644 --- a/man/mitem_current.3x +++ b/man/mitem_current.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2018,2019 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_current.3x,v 1.9 1998/12/26 19:52:34 tom Exp $ +.\" $Id: mitem_current.3x,v 1.15 2019/01/20 20:32:23 tom Exp $ .TH mitem_current 3X "" .SH NAME -\fBmitem_current\fR - set and get current_menu_item +\fBmitem_current\fR \- set and get current_menu_item .SH SYNOPSIS \fB#include \fR .br @@ -46,56 +46,55 @@ int item_index(const ITEM *item); .br .SH DESCRIPTION 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 +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 +\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(3)). .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X). .SH NOTES The header file \fB\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V menu library. They were not supported on +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). +\fBindex_item\fR error value as \-1 (which is the value of \fBERR\fR). .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.