ncurses 6.2 - patch 20210213

[ncurses.git] / man / menu_opts.3x

diff --git a/man/menu_opts.3x b/man/menu_opts.3x
index 30cad58d495760be85d57cab4e6fff0b3b626c0b..99e950e5b8d495ef6bf657f7d36f69e9097884e2 100644 (file)
--- a/man/menu_opts.3x
+++ b/man/menu_opts.3x
@@ -1,6 +1,7 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
+.\" Copyright 1998-2015,2016 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            *
@@ -27,33 +28,36 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: menu_opts.3x,v 1.7 1998/11/29 01:10:21 Rick.Ohnemus Exp $
+.\" $Id: menu_opts.3x,v 1.18 2020/10/17 23:46:35 tom Exp $
 .TH menu_opts 3X ""
 .SH NAME
-\fBmenu_opts\fR - set and get menu options
+\fBset_menu_opts\fP,
+\fBmenu_opts_on\fP,
+\fBmenu_opts_off\fP,
+\fBmenu_opts\fR \- set and get menu options
 .SH SYNOPSIS
 \fB#include <menu.h>\fR
+.sp
+\fBint set_menu_opts(MENU *\fP\fImenu\fP\fB, Menu_Options \fP\fIopts\fP\fB);\fP
 .br
-int set_menu_opts(MENU *menu, OPTIONS opts);
+\fBMenu_Options menu_opts(const MENU *\fP\fImenu\fP\fB);\fP
+.sp
+\fBint menu_opts_on(MENU *\fP\fImenu\fP\fB, Menu_Options \fP\fIopts\fP\fB);\fP
 .br
-int menu_opts_on(MENU *menu, OPTIONS opts);
-.br
-int menu_opts_off(MENU *menu, OPTIONS opts);
-.br
-OPTIONS menu_opts(const MENU *menu);
+\fBint menu_opts_off(MENU *\fP\fImenu\fP\fB, Menu_Options \fP\fIopts\fP\fB);\fP
 .br
 .SH DESCRIPTION
 The function \fBset_menu_opts\fR sets all the given menu's option bits (menu
 option bits may be logically-OR'ed together).
-
+.PP
 The function \fBmenu_opts_on\fR turns on the given option bits, and leaves
 others alone.
-
+.PP
 The function \fBmenu_opts_off\fR turns off the given option bits, and leaves
 others alone.
-
+.PP
 The function \fBmenu_opts\fR returns the menu's current option bits.
-
+.PP
 The following options are defined (all are on by default):
 .TP 5
 O_ONEVALUE
@@ -74,16 +78,22 @@ Move the cursor to within the item name while pattern-matching.
 O_NONCYCLIC
 Don't wrap around next-item and previous-item,
 requests to the other end of the menu.
+.TP 5
+O_MOUSE_MENU
+If user clicks with the mouse
+and it does not fall on the currently active menu,
+push \fBKEY_MOUSE\fP and the \fBMEVENT\fP data
+back on the queue to allow processing in another part of the calling program.
 .SH RETURN VALUE
 Except for \fBmenu_opts\fR, each routine returns one of the following:
 .TP 5
-\fBE_OK\fR
+.B E_OK
 The routine succeeded.
 .TP 5
-\fBE_SYSTEM_ERROR\fR
-System error occurred (see \fBerrno\fR).
+.B E_SYSTEM_ERROR
+System error occurred (see \fBerrno\fR(3)).
 .TP 5
-\fBE_POSTED\fR
+.B E_POSTED
 The menu is already posted.
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBmenu\fR(3X).
@@ -91,14 +101,9 @@ The menu is already posted.
 The header file \fB<menu.h>\fR automatically includes the header file
 \fB<curses.h>\fR.
 .SH PORTABILITY
-These routines emulate the System V menu library.  They were not supported on
+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:
+Juergen Pfeifer.
+Manual pages and adaptation for new curses by Eric S. Raymond.