ncursesw-morphos/doc/html/man/menu_opts.3x.html

149 lines
5.4 KiB
HTML
Raw Normal View History

2002-10-13 11:35:53 +08:00
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
* t
****************************************************************************
* 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. *
****************************************************************************
* @Id: menu_opts.3x,v 1.7 1998/11/29 01:10:21 Rick.Ohnemus Exp @
-->
1997-05-15 12:00:00 +08:00
<HTML>
2002-10-13 11:35:53 +08:00
<HEAD>
<TITLE>menu_opts 3x</TITLE>
<link rev=made href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
1999-10-24 12:32:42 +08:00
<BODY>
2002-10-13 11:35:53 +08:00
<H1>menu_opts 3x</H1>
<HR>
1997-05-15 12:00:00 +08:00
<PRE>
2000-07-09 10:46:08 +08:00
<!-- Manpage converted by man2html 3.0.1 -->
2004-02-09 10:15:26 +08:00
<STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG> <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
2000-07-09 10:46:08 +08:00
</PRE>
<H2>NAME</H2><PRE>
2002-10-13 11:35:53 +08:00
<STRONG>menu_opts</STRONG> - set and get menu options
1997-05-15 12:00:00 +08:00
</PRE>
<H2>SYNOPSIS</H2><PRE>
2002-10-13 11:35:53 +08:00
<STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
1997-05-15 12:00:00 +08:00
int set_menu_opts(MENU *menu, OPTIONS opts);
int menu_opts_on(MENU *menu, OPTIONS opts);
int menu_opts_off(MENU *menu, OPTIONS opts);
OPTIONS menu_opts(const MENU *menu);
</PRE>
<H2>DESCRIPTION</H2><PRE>
2002-10-13 11:35:53 +08:00
The function <STRONG>set_menu_opts</STRONG> sets all the given menu's
1997-05-15 12:00:00 +08:00
option bits (menu option bits may be logically-OR'ed
together).
2002-10-13 11:35:53 +08:00
The function <STRONG>menu_opts_on</STRONG> turns on the given option bits,
1997-05-15 12:00:00 +08:00
and leaves others alone.
2002-10-13 11:35:53 +08:00
The function <STRONG>menu_opts_off</STRONG> turns off the given option
1997-05-15 12:00:00 +08:00
bits, and leaves others alone.
2002-10-13 11:35:53 +08:00
The function <STRONG>menu_opts</STRONG> returns the menu's current option
1997-05-15 12:00:00 +08:00
bits.
The following options are defined (all are on by default):
O_ONEVALUE
Only one item can be selected for this menu.
O_SHOWDESC
Display the item descriptions when the menu is
posted.
O_ROWMAJOR
Display the menu in row-major order.
O_IGNORECASE
Ignore the case when pattern-matching.
O_SHOWMATCH
Move the cursor to within the item name while pat-
tern-matching.
O_NONCYCLIC
Don't wrap around next-item and previous-item,
requests to the other end of the menu.
</PRE>
<H2>RETURN VALUE</H2><PRE>
2002-10-13 11:35:53 +08:00
Except for <STRONG>menu_opts</STRONG>, each routine returns one of the fol-
1997-05-15 12:00:00 +08:00
lowing:
2002-10-13 11:35:53 +08:00
<STRONG>E_OK</STRONG> The routine succeeded.
1997-05-15 12:00:00 +08:00
2002-10-13 11:35:53 +08:00
<STRONG>E_SYSTEM_ERROR</STRONG>
System error occurred (see <STRONG>errno</STRONG>).
2000-07-09 10:46:08 +08:00
2002-10-13 11:35:53 +08:00
<STRONG>E_POSTED</STRONG>
1997-05-15 12:00:00 +08:00
The menu is already posted.
</PRE>
<H2>SEE ALSO</H2><PRE>
2002-10-13 11:35:53 +08:00
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
1997-05-15 12:00:00 +08:00
</PRE>
<H2>NOTES</H2><PRE>
2002-10-13 11:35:53 +08:00
The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
file <STRONG>&lt;curses.h&gt;</STRONG>.
1997-05-15 12:00:00 +08:00
</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.
2004-02-09 10:15:26 +08:00
<STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
1997-05-15 12:00:00 +08:00
</PRE>
2000-07-09 10:46:08 +08:00
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
1997-05-15 12:00:00 +08:00
</BODY>
</HTML>