X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmitem_current.3x;h=4cd37b6033e276f6d2c06b16dd16bf5946aa4fba;hp=86c9b4775eaa52f956c66cf2090b252cdb20c527;hb=fae162795e065e5901068152e91f2962b6b247f3;hpb=96d6b16de0d487e5d3aed0302a179dbce11b5d96 diff --git a/man/mitem_current.3x b/man/mitem_current.3x index 86c9b477..4cd37b60 100644 --- a/man/mitem_current.3x +++ b/man/mitem_current.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 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,39 +28,42 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_current.3x,v 1.13 2010/12/04 18:40:45 tom Exp $ +.\" $Id: mitem_current.3x,v 1.20 2020/10/18 00:39:06 tom Exp $ .TH mitem_current 3X "" .SH NAME \fBmitem_current\fR \- set and get current_menu_item .SH SYNOPSIS \fB#include \fR +.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 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 a pointer (which may be \fBNULL\fR). -It does not set errno. +It does not set \fBerrno\fP. .PP \fBtop_row\fR and \fBitem_index\fR return \fBERR\fR (the general \fBcurses\fR error value) if their \fImenu\fP parameter is \fBNULL\fP. @@ -79,18 +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). +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). .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.