| Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 1 | '\" t |
| 2 | .\"*************************************************************************** |
| 3 | .\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * |
| 4 | .\" * |
| 5 | .\" Permission is hereby granted, free of charge, to any person obtaining a * |
| 6 | .\" copy of this software and associated documentation files (the * |
| 7 | .\" "Software"), to deal in the Software without restriction, including * |
| 8 | .\" without limitation the rights to use, copy, modify, merge, publish, * |
| 9 | .\" distribute, distribute with modifications, sublicense, and/or sell * |
| 10 | .\" copies of the Software, and to permit persons to whom the Software is * |
| 11 | .\" furnished to do so, subject to the following conditions: * |
| 12 | .\" * |
| 13 | .\" The above copyright notice and this permission notice shall be included * |
| 14 | .\" in all copies or substantial portions of the Software. * |
| 15 | .\" * |
| 16 | .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * |
| 17 | .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * |
| 18 | .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * |
| 19 | .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * |
| 20 | .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * |
| 21 | .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * |
| 22 | .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * |
| 23 | .\" * |
| 24 | .\" Except as contained in this notice, the name(s) of the above copyright * |
| 25 | .\" holders shall not be used in advertising or otherwise to promote the * |
| 26 | .\" sale, use or other dealings in this Software without prior written * |
| 27 | .\" authorization. * |
| 28 | .\"*************************************************************************** |
| 29 | .\" |
| 30 | .\" $Id: mitem_current.3x,v 1.11 2006/11/04 18:18:19 tom Exp $ |
| 31 | .TH mitem_current 3X "" |
| 32 | .SH NAME |
| 33 | \fBmitem_current\fR - set and get current_menu_item |
| 34 | .SH SYNOPSIS |
| 35 | \fB#include <menu.h>\fR |
| 36 | .br |
| 37 | int set_current_item(MENU *menu, const ITEM *item); |
| 38 | .br |
| 39 | ITEM *current_item(const MENU *menu); |
| 40 | .br |
| 41 | int set_top_row(MENU *menu, int row); |
| 42 | .br |
| 43 | int top_row(const MENU *menu); |
| 44 | .br |
| 45 | int item_index(const ITEM *item); |
| 46 | .br |
| 47 | .SH DESCRIPTION |
| 48 | The function \fBset_current_item\fR sets the current item (the item on which |
| 49 | the menu cursor is positioned). \fBcurrent_item\fR returns a pointer to the |
| 50 | current item in the given menu. |
| 51 | .PP |
| 52 | The function \fBset_top_row\fR sets the top row of the menu to show the given |
| 53 | row (the top row is initially 0, and is reset to this value whenever the |
| 54 | \fBO_ROWMAJOR\fR option is toggled). The item leftmost on the given row |
| 55 | becomes current. The function \fBtop_row\fR returns the number of the top menu |
| 56 | row being displayed. |
| 57 | .PP |
| 58 | The function \fBitem_index\fR returns the (zero-origin) index of \fIitem\fR in |
| 59 | the menu's item pointer list. |
| 60 | .SH RETURN VALUE |
| 61 | \fBcurrent_item\fR returns a pointer (which may be \fBNULL\fR). |
| 62 | It does not set errno. |
| 63 | .PP |
| 64 | \fBtop_row\fR and \fBitem_index\fR return \fBERR\fR (the general \fBcurses\fR |
| 65 | error value) if their \fImenu\fP parameter is \fBNULL\fP. |
| 66 | .PP |
| 67 | \fBset_current_item\fR and \fBset_top_row\fR return one of the following: |
| 68 | .TP 5 |
| 69 | .B E_OK |
| 70 | The routine succeeded. |
| 71 | .TP 5 |
| 72 | .B E_BAD_ARGUMENT |
| 73 | Routine detected an incorrect or out-of-range argument. |
| 74 | .TP 5 |
| 75 | .B E_BAD_STATE |
| 76 | Routine was called from an initialization or termination function. |
| 77 | .TP 5 |
| 78 | .B E_NOT_CONNECTED |
| 79 | No items are connected to the menu. |
| 80 | .TP 5 |
| 81 | .B E_SYSTEM_ERROR |
| 82 | System error occurred (see \fBerrno\fR). |
| 83 | .SH SEE ALSO |
| 84 | \fBcurses\fR(3X), \fBmenu\fR(3X). |
| 85 | .SH NOTES |
| 86 | The header file \fB<menu.h>\fR automatically includes the header file |
| 87 | \fB<curses.h>\fR. |
| 88 | .SH PORTABILITY |
| 89 | These routines emulate the System V menu library. They were not supported on |
| 90 | Version 7 or BSD versions. |
| 91 | .PP |
| 92 | The SVr4 menu library documentation specifies the \fBtop_row\fR and |
| 93 | \fBindex_item\fR error value as -1 (which is the value of \fBERR\fR). |
| 94 | .SH AUTHORS |
| 95 | Juergen Pfeifer. Manual pages and adaptation for new curses by Eric |
| 96 | S. Raymond. |
| 97 | .\"# |
| 98 | .\"# The following sets edit modes for GNU EMACS |
| 99 | .\"# Local Variables: |
| 100 | .\"# mode:nroff |
| 101 | .\"# fill-column:79 |
| 102 | .\"# End: |