mirror/ncursesw-morphos
2
0
Fork 0
mirror of https://github.com/Aigor44/ncursesw-morphos.git synced 2025-01-12 14:54:25 +08:00
Code Issues Packages Projects Releases Wiki Activity
2a32bee362
ncursesw-morphos/doc/html/man/menu_opts.3x.html

155 lines
6.4 KiB
HTML
Raw Normal View History

ncurses 5.3
2002-10-13 11:35:53 +08:00
<!--
* t
****************************************************************************
ncurses 6.0 - patch 20160326 + regenerate HTML manpages. + improve test/demo_menus.c, allowing mouse-click on the menu-headers to switch the active menu. This requires a new extension option O_MOUSE_MENU to tell the menu driver to put mouse events which do not apply to the active menu back into the queue so that the application can handle the event.
2016-03-27 09:05:59 +08:00
* Copyright (c) 1998-2015,2016 Free Software Foundation, Inc. *
ncurses 5.3
2002-10-13 11:35:53 +08:00
* *
* 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. *
****************************************************************************
ncurses 6.0 - patch 20160326 + regenerate HTML manpages. + improve test/demo_menus.c, allowing mouse-click on the menu-headers to switch the active menu. This requires a new extension option O_MOUSE_MENU to tell the menu driver to put mouse events which do not apply to the active menu back into the queue so that the application can handle the event.
2016-03-27 09:05:59 +08:00
* @Id: menu_opts.3x,v 1.14 2016/03/26 22:42:41 tom Exp @
ncurses 5.3
2002-10-13 11:35:53 +08:00
-->
ncurses 5.9 - patch 20150214 + regenerate html manpages using improved man2html from work on xterm. + regenerated ".map" and ".sym" files using improved script, accounting for the "--enable-weak-symbols" configure option (report by Werner Fink).
2015-02-15 09:42:27 +08:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
ncurses 4.1
1997-05-15 12:00:00 +08:00
<HTML>
ncurses 5.3
2002-10-13 11:35:53 +08:00
<HEAD>
ncurses 5.9 - patch 20150214 + regenerate html manpages using improved man2html from work on xterm. + regenerated ".map" and ".sym" files using improved script, accounting for the "--enable-weak-symbols" configure option (report by Werner Fink).
2015-02-15 09:42:27 +08:00
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
ncurses 5.3
2002-10-13 11:35:53 +08:00
<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>
ncurses 5.0
1999-10-24 12:32:42 +08:00
<BODY>
ncurses 5.9 - patch 20150516 + amend change to ".pc" files to only use the extra loader flags which may have rpath options (report by Sven Joachim, cf: 20150502). + change versioning for dpkg's in test-packages for Ada95 and ncurses-examples for consistency with Debian, to work with package updates. + regenerate html manpages. + clarify handling of carriage return in waddch manual page; it was discussed only in the portability section (prompted by comment on Stack Overflow forum):
2015-05-17 05:01:22 +08:00
<H1 class="no-header">menu_opts 3x</H1>
ncurses 4.1
1997-05-15 12:00:00 +08:00
<PRE>
ncurses 5.5
2005-10-10 02:41:57 +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>
ncurses 5.4
2004-02-09 10:15:26 +08:00
ncurses 5.1
2000-07-09 10:46:08 +08:00
ncurses 6.0 - patch 20160130 + improve formatting of man/curs_refresh.3x and man/tset.1 manpages + regenerate HTML manpages using newer man2html to eliminate some unwanted blank lines.
2016-01-31 10:15:39 +08:00
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
ncurses 6.0 - patch 20151205 + update form_cursor.3x, form_post.3x, menu_attributes.3x to list function names in NAME section (patch by Jason McIntyre). + minor fixes to manpage NAME/SYNOPSIS sections to consistently use rule that either all functions which are prototyped in SYNOPSIS are listed in the NAME section, or the manual-page name is the sole item listed in the NAME section. The latter is used to reduce clutter, e.g., for the top-level library manual pages as well as for certain feature-pages such as SP-funcs and threading (prompted by patches by Jason McIntyre). + add option to preserve leading whitespace in form fields (patch by Leon Winter).
2015-12-06 09:07:45 +08:00
<STRONG>set_menu_opts</STRONG>, <STRONG>menu_opts_on</STRONG>, <STRONG>menu_opts_off</STRONG>, <STRONG>menu_opts</STRONG> -
set and get menu options
ncurses 4.1
1997-05-15 12:00:00 +08:00
ncurses 6.0 - patch 20160130 + improve formatting of man/curs_refresh.3x and man/tset.1 manpages + regenerate HTML manpages using newer man2html to eliminate some unwanted blank lines.
2016-01-31 10:15:39 +08:00
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
ncurses 5.3
2002-10-13 11:35:53 +08:00
<STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
ncurses 5.6 - patch 20070303 + regenerated html documentation. + add NCURSES_OPAQUE symbol to curses.h, will use to make structs opaque in selected configurations. + move the chunk in lib_acs.c which resets acs capabilities when running on a terminal whose locale interferes with those into _nc_setupscreen(), so the libtinfo/libtinfow files can be made identical (requested by Miroslav Lichvar). + do not use configure variable SHLIB_LIBS for building libraries outside the ncurses directory, since that symbol is customized only for that directory, and using it introduces an unneeded dependency on libdl (requested by Miroslav Lichvar). + modify mk-1st.awk so the generated makefile rules for linking or installing shared libraries do not first remove the library, in case it is in use, e.g., libncurses.so by /bin/sh (report by Jeff Chua). + revised section "Using NCURSES under XTERM" in ncurses-intro.html (prompted by newsgroup comment by Nick Guenther).
2007-03-04 08:18:45 +08:00
int set_menu_opts(MENU *menu, Menu_Options opts);
int menu_opts_on(MENU *menu, Menu_Options opts);
int menu_opts_off(MENU *menu, Menu_Options opts);
Menu_Options menu_opts(const MENU *menu);
ncurses 4.1
1997-05-15 12:00:00 +08:00
ncurses 6.0 - patch 20160130 + improve formatting of man/curs_refresh.3x and man/tset.1 manpages + regenerate HTML manpages using newer man2html to eliminate some unwanted blank lines.
2016-01-31 10:15:39 +08:00
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
ncurses 6.0 - patch 20151205 + update form_cursor.3x, form_post.3x, menu_attributes.3x to list function names in NAME section (patch by Jason McIntyre). + minor fixes to manpage NAME/SYNOPSIS sections to consistently use rule that either all functions which are prototyped in SYNOPSIS are listed in the NAME section, or the manual-page name is the sole item listed in the NAME section. The latter is used to reduce clutter, e.g., for the top-level library manual pages as well as for certain feature-pages such as SP-funcs and threading (prompted by patches by Jason McIntyre). + add option to preserve leading whitespace in form fields (patch by Leon Winter).
2015-12-06 09:07:45 +08:00
The function <STRONG>set_menu_opts</STRONG> sets all the given menu's
option bits (menu option bits may be logically-OR'ed
ncurses 4.1
1997-05-15 12:00:00 +08:00
together).
ncurses 6.0 - patch 20151205 + update form_cursor.3x, form_post.3x, menu_attributes.3x to list function names in NAME section (patch by Jason McIntyre). + minor fixes to manpage NAME/SYNOPSIS sections to consistently use rule that either all functions which are prototyped in SYNOPSIS are listed in the NAME section, or the manual-page name is the sole item listed in the NAME section. The latter is used to reduce clutter, e.g., for the top-level library manual pages as well as for certain feature-pages such as SP-funcs and threading (prompted by patches by Jason McIntyre). + add option to preserve leading whitespace in form fields (patch by Leon Winter).
2015-12-06 09:07:45 +08:00
The function <STRONG>menu_opts_on</STRONG> turns on the given option bits,
ncurses 4.1
1997-05-15 12:00:00 +08:00
and leaves others alone.
ncurses 6.0 - patch 20151205 + update form_cursor.3x, form_post.3x, menu_attributes.3x to list function names in NAME section (patch by Jason McIntyre). + minor fixes to manpage NAME/SYNOPSIS sections to consistently use rule that either all functions which are prototyped in SYNOPSIS are listed in the NAME section, or the manual-page name is the sole item listed in the NAME section. The latter is used to reduce clutter, e.g., for the top-level library manual pages as well as for certain feature-pages such as SP-funcs and threading (prompted by patches by Jason McIntyre). + add option to preserve leading whitespace in form fields (patch by Leon Winter).
2015-12-06 09:07:45 +08:00
The function <STRONG>menu_opts_off</STRONG> turns off the given option
ncurses 4.1
1997-05-15 12:00:00 +08:00
bits, and leaves others alone.
ncurses 6.0 - patch 20151205 + update form_cursor.3x, form_post.3x, menu_attributes.3x to list function names in NAME section (patch by Jason McIntyre). + minor fixes to manpage NAME/SYNOPSIS sections to consistently use rule that either all functions which are prototyped in SYNOPSIS are listed in the NAME section, or the manual-page name is the sole item listed in the NAME section. The latter is used to reduce clutter, e.g., for the top-level library manual pages as well as for certain feature-pages such as SP-funcs and threading (prompted by patches by Jason McIntyre). + add option to preserve leading whitespace in form fields (patch by Leon Winter).
2015-12-06 09:07:45 +08:00
The function <STRONG>menu_opts</STRONG> returns the menu's current option
ncurses 4.1
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
ncurses 6.0 - patch 20151205 + update form_cursor.3x, form_post.3x, menu_attributes.3x to list function names in NAME section (patch by Jason McIntyre). + minor fixes to manpage NAME/SYNOPSIS sections to consistently use rule that either all functions which are prototyped in SYNOPSIS are listed in the NAME section, or the manual-page name is the sole item listed in the NAME section. The latter is used to reduce clutter, e.g., for the top-level library manual pages as well as for certain feature-pages such as SP-funcs and threading (prompted by patches by Jason McIntyre). + add option to preserve leading whitespace in form fields (patch by Leon Winter).
2015-12-06 09:07:45 +08:00
Move the cursor to within the item name while pat-
ncurses 4.1
1997-05-15 12:00:00 +08:00
tern-matching.
O_NONCYCLIC
ncurses 6.0 - patch 20151205 + update form_cursor.3x, form_post.3x, menu_attributes.3x to list function names in NAME section (patch by Jason McIntyre). + minor fixes to manpage NAME/SYNOPSIS sections to consistently use rule that either all functions which are prototyped in SYNOPSIS are listed in the NAME section, or the manual-page name is the sole item listed in the NAME section. The latter is used to reduce clutter, e.g., for the top-level library manual pages as well as for certain feature-pages such as SP-funcs and threading (prompted by patches by Jason McIntyre). + add option to preserve leading whitespace in form fields (patch by Leon Winter).
2015-12-06 09:07:45 +08:00
Don't wrap around next-item and previous-item,
ncurses 4.1
1997-05-15 12:00:00 +08:00
requests to the other end of the menu.
ncurses 6.0 - patch 20160326 + regenerate HTML manpages. + improve test/demo_menus.c, allowing mouse-click on the menu-headers to switch the active menu. This requires a new extension option O_MOUSE_MENU to tell the menu driver to put mouse events which do not apply to the active menu back into the queue so that the application can handle the event.
2016-03-27 09:05:59 +08:00
O_MOUSE_MENU
If user clicks with the mouse and it does not fall on
the currently active menu, push <STRONG>KEY_MOUSE</STRONG> and the
<STRONG>MEVENT</STRONG> data back on the queue to allow processing in
another part of the calling program.
ncurses 4.1
1997-05-15 12:00:00 +08:00
ncurses 6.0 - patch 20160130 + improve formatting of man/curs_refresh.3x and man/tset.1 manpages + regenerate HTML manpages using newer man2html to eliminate some unwanted blank lines.
2016-01-31 10:15:39 +08:00
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
ncurses 5.3
2002-10-13 11:35:53 +08:00
Except for <STRONG>menu_opts</STRONG>, each routine returns one of the fol-
ncurses 4.1
1997-05-15 12:00:00 +08:00
lowing:
ncurses 5.3
2002-10-13 11:35:53 +08:00
<STRONG>E_OK</STRONG> The routine succeeded.
ncurses 4.1
1997-05-15 12:00:00 +08:00
ncurses 5.3
2002-10-13 11:35:53 +08:00
<STRONG>E_SYSTEM_ERROR</STRONG>
System error occurred (see <STRONG>errno</STRONG>).
ncurses 5.1
2000-07-09 10:46:08 +08:00
ncurses 5.3
2002-10-13 11:35:53 +08:00
<STRONG>E_POSTED</STRONG>
ncurses 4.1
1997-05-15 12:00:00 +08:00
The menu is already posted.
ncurses 6.0 - patch 20160130 + improve formatting of man/curs_refresh.3x and man/tset.1 manpages + regenerate HTML manpages using newer man2html to eliminate some unwanted blank lines.
2016-01-31 10:15:39 +08:00
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
ncurses 5.3
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>.
ncurses 4.1
1997-05-15 12:00:00 +08:00
ncurses 6.0 - patch 20160130 + improve formatting of man/curs_refresh.3x and man/tset.1 manpages + regenerate HTML manpages using newer man2html to eliminate some unwanted blank lines.
2016-01-31 10:15:39 +08:00
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
ncurses 5.3
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>.
ncurses 4.1
1997-05-15 12:00:00 +08:00
ncurses 6.0 - patch 20160130 + improve formatting of man/curs_refresh.3x and man/tset.1 manpages + regenerate HTML manpages using newer man2html to eliminate some unwanted blank lines.
2016-01-31 10:15:39 +08:00
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
ncurses 6.0 - patch 20160326 + regenerate HTML manpages. + improve test/demo_menus.c, allowing mouse-click on the menu-headers to switch the active menu. This requires a new extension option O_MOUSE_MENU to tell the menu driver to put mouse events which do not apply to the active menu back into the queue so that the application can handle the event.
2016-03-27 09:05:59 +08:00
These routines emulate the System V menu library. They
ncurses 4.1
1997-05-15 12:00:00 +08:00
were not supported on Version 7 or BSD versions.
ncurses 6.0 - patch 20160130 + improve formatting of man/curs_refresh.3x and man/tset.1 manpages + regenerate HTML manpages using newer man2html to eliminate some unwanted blank lines.
2016-01-31 10:15:39 +08:00
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
ncurses 6.0 - patch 20160326 + regenerate HTML manpages. + improve test/demo_menus.c, allowing mouse-click on the menu-headers to switch the active menu. This requires a new extension option O_MOUSE_MENU to tell the menu driver to put mouse events which do not apply to the active menu back into the queue so that the application can handle the event.
2016-03-27 09:05:59 +08:00
Juergen Pfeifer. Manual pages and adaptation for new
ncurses 4.1
1997-05-15 12:00:00 +08:00
curses by Eric S. Raymond.
ncurses 5.5
2005-10-10 02:41:57 +08:00
<STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
ncurses 4.1
1997-05-15 12:00:00 +08:00
</PRE>
ncurses 5.9 - patch 20150214 + regenerate html manpages using improved man2html from work on xterm. + regenerated ".map" and ".sym" files using improved script, accounting for the "--enable-weak-symbols" configure option (report by Werner Fink).
2015-02-15 09:42:27 +08:00
<div class="nav">
<ul>
<li><a href="#h2-NAME">NAME</a></li>
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
<li><a href="#h2-NOTES">NOTES</a></li>
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
<li><a href="#h2-AUTHORS">AUTHORS</a></li>
</ul>
</div>
ncurses 4.1
1997-05-15 12:00:00 +08:00
</BODY>
</HTML>
Reference in New Issue Copy Permalink