X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmitem_current.3x;h=00a876ab71ccdc24c8dd8964a304d97e638c3367;hp=69219ba94cba1f4b83ecec2015b952a4574fe385;hb=6b99a559185b3b8fad80b56bc2070b08101c33d1;hpb=71c0306f0824ef2b10c4c5813fb003db48f3012e diff --git a/man/mitem_current.3x b/man/mitem_current.3x index 69219ba9..00a876ab 100644 --- a/man/mitem_current.3x +++ b/man/mitem_current.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 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,14 +27,14 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_current.3x,v 1.12 2010/07/31 16:08:48 tom Exp $ +.\" $Id: mitem_current.3x,v 1.16 2019/03/23 21:47:36 tom Exp $ .TH mitem_current 3X "" .SH NAME \fBmitem_current\fR \- set and get current_menu_item .SH SYNOPSIS \fB#include \fR .br -int set_current_item(MENU *menu, const ITEM *item); +int set_current_item(MENU *menu, ITEM *item); .br ITEM *current_item(const MENU *menu); .br @@ -46,13 +46,16 @@ 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 @@ -79,24 +82,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. -.\"# -.\"# 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.