X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmitem_current.3x;h=0464042023cc9bb8e6f1fcea6249ab2d615067f9;hb=3183ac61c6bf0a75ee65dc8cbebf54f7c143df46;hp=360f799728bb3385a7cd3b2eca5760e8d527553b;hpb=f44733b760290aa8f51c6c9e1e463254833bffcd;p=ncurses.git diff --git a/man/mitem_current.3x b/man/mitem_current.3x index 360f7997..04640420 100644 --- a/man/mitem_current.3x +++ b/man/mitem_current.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 2018-2021,2022 Thomas E. Dickey * .\" Copyright 1998-2006,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,47 +28,47 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_current.3x,v 1.18 2020/03/28 19:06:28 tom Exp $ +.\" $Id: mitem_current.3x,v 1.23 2022/02/12 20:02:20 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 *\fImenu\fB, ITEM *\fIitem\fB);\fR .br -int set_current_item(MENU *menu, ITEM *item); +\fBITEM *current_item(const MENU *\fImenu\fB);\fR +.sp +\fBint set_top_row(MENU *\fImenu\fB, int \fIrow\fB);\fR .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 *\fImenu\fB);\fR +.sp +\fBint item_index(const ITEM *\fIitem\fB);\fR .br .SH DESCRIPTION -The function \fBset_current_item\fR sets the current item (the item on which +The function \fBset_current_item\fP sets the current item (the item on which the menu cursor is positioned). -\fBcurrent_item\fR returns a pointer to the +\fBcurrent_item\fP 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 +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). +\fBO_ROWMAJOR\fP option is toggled). The item leftmost on the given row becomes current. -The function \fBtop_row\fR returns the number of the top menu +The function \fBtop_row\fP 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 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 a pointer (which may be \fBNULL\fR). +\fBcurrent_item\fP returns a pointer (which may be \fBNULL\fP). It does not set \fBerrno\fP. .PP -\fBtop_row\fR and \fBitem_index\fR return \fBERR\fR (the general \fBcurses\fR +\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\fR and \fBset_top_row\fR return one of the following: +\fBset_current_item\fP and \fBset_top_row\fP return one of the following: .TP 5 .B E_OK The routine succeeded. @@ -83,19 +83,19 @@ Routine was called from an initialization or termination function. No items are connected to the menu. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR(3)). +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 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). +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.