X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmitem_current.3x;h=b7cfa25eada5125a13ebca73ea818b534dfc7690;hb=74433bcf4f6fe40862a28f3c00edaedcd5054b01;hp=179a23be3b2e91e8a1e6aa3bfba90629dd6853c3;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce;p=ncurses.git diff --git a/man/mitem_current.3x b/man/mitem_current.3x index 179a23be..b7cfa25e 100644 --- a/man/mitem_current.3x +++ b/man/mitem_current.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright 2018-2020,2021 Thomas E. Dickey * +.\" Copyright 1998-2006,2010 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,75 +28,74 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_current.3x,v 1.9 1998/12/26 19:52:34 tom Exp $ +.\" $Id: mitem_current.3x,v 1.22 2021/12/25 21:49:32 tom Exp $ .TH mitem_current 3X "" .SH NAME -\fBmitem_current\fR - set and get current_menu_item +\fBmitem_current\fP \- set and get current_menu_item .SH SYNOPSIS -\fB#include \fR +\fB#include \fP +.sp +\fBint set_current_item(MENU *\fP\fImenu\fP\fB, ITEM *\fP\fIitem\fP\fB);\fP .br -int set_current_item(MENU *menu, const ITEM *item); +\fBITEM *current_item(const MENU *\fP\fImenu\fP\fB);\fP +.sp +\fBint set_top_row(MENU *\fP\fImenu\fP\fB, int \fP\fIrow\fP\fB);\fP .br -ITEM *current_item(const MENU *menu); -.br -int set_top_row(MENU *menu, int row); -.br -int top_row(const MENU *menu); -.br -int item_index(const ITEM *item); +\fBint top_row(const MENU *\fP\fImenu\fP\fB);\fP +.sp +\fBint item_index(const ITEM *\fP\fIitem\fP\fB);\fP .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 function \fBset_current_item\fP sets the current item (the item on which +the menu cursor is positioned). +\fBcurrent_item\fP returns a pointer to the current item in the given menu. - -The function \fBset_top_row\fR sets the top row of the menu to show the given +.PP +The function \fBset_top_row\fP 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\fP option is toggled). +The item leftmost on the given row +becomes current. +The function \fBtop_row\fP returns the number of the top menu row being displayed. - -The function \fBitem_index\fR returns the (zero-origin) index of \fIitem\fR in +.PP +The function \fBitem_index\fP returns the (zero-origin) index of \fIitem\fP in the menu's item pointer list. .SH RETURN VALUE -\fBcurrent_item\fR returns \fBNULL\fR on error. - -\fBtop_row\fR and \fBitem_index\fR return \fBERR\fR (the general \fBcurses\fR -error value) on error. - -\fBset_current_item\fR and \fBset_top_row\fR return one of the following: +\fBcurrent_item\fP returns a pointer (which may be \fBNULL\fP). +It does not set \fBerrno\fP. +.PP +\fBtop_row\fP and \fBitem_index\fP return \fBERR\fP (the general \fBcurses\fP +error value) if their \fImenu\fP parameter is \fBNULL\fP. +.PP +\fBset_current_item\fP and \fBset_top_row\fP 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\fP(3)). .SH SEE ALSO -\fBcurses\fR(3X), \fBmenu\fR(3X). +\fBcurses\fP(3X), \fBmenu\fP(3X). .SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The header file \fB\fP automatically includes the header file +\fB\fP. .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. - -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). +.PP +The SVr4 menu library documentation specifies the \fBtop_row\fP and +\fBindex_item\fP error value as \-1 (which is the value of \fBERR\fP). .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.