'\" t .\" $OpenBSD: menu_mark.3,v 1.5 1998/09/17 04:14:45 millert Exp $ .\" .\"*************************************************************************** .\" Copyright (c) 1998 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 * .\" "Software"), to deal in the Software without restriction, including * .\" without limitation the rights to use, copy, modify, merge, publish, * .\" distribute, distribute with modifications, sublicense, and/or sell * .\" copies of the Software, and to permit persons to whom the Software is * .\" furnished to do so, subject to the following conditions: * .\" * .\" The above copyright notice and this permission notice shall be included * .\" in all copies or substantial portions of the Software. * .\" * .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * .\" * .\" Except as contained in this notice, the name(s) of the above copyright * .\" holders shall not be used in advertising or otherwise to promote the * .\" sale, use or other dealings in this Software without prior written * .\" authorization. * .\"*************************************************************************** .\" .\" $From: menu_mark.3x,v 1.5 1998/08/27 21:21:04 Rick.Ohnemus Exp $ .TH menu_mark 3 "" .SH NAME \fBmenu_mark\fR - get and set the menu mark string .SH SYNOPSIS \fB#include \fR .br int set_menu_mark(MENU *menu, const char *mark); .br const char *menu_mark(const MENU *menu); .br .SH DESCRIPTION In order to make menu selections visible on older terminals without highlighting or color capability, the menu library marks selected items in a menu with a prefix string. The function \fBset_menu_mark\fR sets the mark string for the given menu. Calling \fBset_menu_mark\fR with a null menu item will abolish the mark string. Note that changing the length of the mark string for a menu while the menu is posted is likely to produce unhelpful behavior. The default string is "-" (a dash). Calling \fBset_menu_mark\fR with a \fBNULL\fR menu argument will change this default. The function \fBmenu_mark\fR returns the menu's mark string (or \fBNULL\fR if there is none). .SH RETURN VALUE The function \fBmenu_mark\fR returns \fBNULL\fR on error. The function \fBset_menu_mark\fR may return the following error codes: .TP 5 \fBE_OK\fR The routine succeeded. .TP 5 \fBE_SYSTEM_ERROR\fR System error occurred (see \fBerrno\fR). .TP 5 \fBE_BAD_ARGUMENT\fR Routine detected an incorrect or out-of-range argument. .SH SEE ALSO \fBcurses\fR(3), \fBmenu\fR(3). .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 Version 7 or BSD versions. .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: