| <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> |
| <!-- |
| * t |
| **************************************************************************** |
| * Copyright (c) 1998,2006 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. * |
| **************************************************************************** |
| * @Id: menu_mark.3x,v 1.9 2006/11/04 18:33:18 tom Exp @ |
| --> |
| <HTML> |
| <HEAD> |
| <TITLE>menu_mark 3x</TITLE> |
| <link rev=made href="mailto:bug-ncurses@gnu.org"> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| </HEAD> |
| <BODY> |
| <H1>menu_mark 3x</H1> |
| <HR> |
| <PRE> |
| <!-- Manpage converted by man2html 3.0.1 --> |
| <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG> <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG> |
| |
| |
| |
| |
| </PRE> |
| <H2>NAME</H2><PRE> |
| <STRONG>menu_mark</STRONG> - get and set the menu mark string |
| |
| |
| </PRE> |
| <H2>SYNOPSIS</H2><PRE> |
| <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> |
| int set_menu_mark(MENU *menu, const char *mark); |
| const char *menu_mark(const MENU *menu); |
| |
| |
| </PRE> |
| <H2>DESCRIPTION</H2><PRE> |
| In order to make menu selections visible on older termi- |
| nals without highlighting or color capability, the menu |
| library marks selected items in a menu with a prefix |
| string. |
| |
| The function <STRONG>set_menu_mark</STRONG> sets the mark string for the |
| given menu. Calling <STRONG>set_menu_mark</STRONG> 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 <STRONG>set_menu_mark</STRONG> |
| with a non-<STRONG>NULL</STRONG> menu argument will change this default. |
| |
| The function <STRONG>menu_mark</STRONG> returns the menu's mark string (or |
| <STRONG>NULL</STRONG> if there is none). |
| |
| |
| </PRE> |
| <H2>RETURN VALUE</H2><PRE> |
| The function <STRONG>menu_mark</STRONG> returns a pointer (which may be |
| <STRONG>NULL</STRONG>). It does not set errno. |
| |
| The function <STRONG>set_menu_mark</STRONG> may return the following error |
| codes: |
| |
| <STRONG>E_OK</STRONG> The routine succeeded. |
| |
| <STRONG>E_BAD_ARGUMENT</STRONG> |
| Routine detected an incorrect or out-of-range argu- |
| ment. |
| |
| <STRONG>E_SYSTEM_ERROR</STRONG> |
| System error occurred (see <STRONG>errno</STRONG>). |
| |
| |
| </PRE> |
| <H2>SEE ALSO</H2><PRE> |
| <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. |
| |
| |
| </PRE> |
| <H2>NOTES</H2><PRE> |
| The header file <STRONG><menu.h></STRONG> automatically includes the header |
| file <STRONG><curses.h></STRONG>. |
| |
| |
| </PRE> |
| <H2>PORTABILITY</H2><PRE> |
| These routines emulate the System V menu library. They |
| were not supported on Version 7 or BSD versions. |
| |
| |
| </PRE> |
| <H2>AUTHORS</H2><PRE> |
| Juergen Pfeifer. Manual pages and adaptation for new |
| curses by Eric S. Raymond. |
| |
| |
| |
| <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG> |
| </PRE> |
| <HR> |
| <ADDRESS> |
| Man(1) output converted with |
| <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> |
| </ADDRESS> |
| </BODY> |
| </HTML> |
