ncurses 6.4 - patch 20231014

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

diff --git a/man/menu_driver.3x b/man/menu_driver.3x
index 706005fa21649a4b28ef602d599d9ae088a3c554..10e9d2167a6807222123141a8d5e5e69250dc715 100644 (file)
--- a/man/menu_driver.3x
+++ b/man/menu_driver.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright 2018-2021,2022 Thomas E. Dickey                                *
+.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *

 .\" Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *


@@ -27,19 +27,21 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: menu_driver.3x,v 1.31 2022/02/12 20:05:11 tom Exp $
-.TH menu_driver 3X ""
+.\" $Id: menu_driver.3x,v 1.41 2023/10/07 21:19:07 tom Exp $
+.TH menu_driver 3X 2023-10-07 "ncurses 6.4" "Library calls"

 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
 .SH NAME
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
 .SH NAME

-\fBmenu_driver\fP \- command-processing loop of the menu system
+\fBmenu_driver\fP \-
+command-processing loop of the menu system

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <menu.h>\fP
-.sp
-\fBint menu_driver(MENU *\fImenu\fB, int \fIc\fB);\fR
-.br
+.nf
+\fB#include <menu.h>
+.PP
+\fBint menu_driver(MENU *\fImenu\fP, int \fIc\fP);
+.fi

 .SH DESCRIPTION
 Once a menu has been posted (displayed), you should funnel input events to it
 through \fBmenu_driver\fP.  This routine has three major input cases:
 .SH DESCRIPTION
 Once a menu has been posted (displayed), you should funnel input events to it
 through \fBmenu_driver\fP.  This routine has three major input cases:


@@ -117,7 +119,6 @@ If there is no such match, \fBmenu_driver\fP returns
 If the second argument is one of the above pre-defined requests, the
 corresponding action is performed.
 .SS MOUSE HANDLING
 If the second argument is one of the above pre-defined requests, the
 corresponding action is performed.
 .SS MOUSE HANDLING

-.PP

 If the second argument is the KEY_MOUSE special key, the associated
 mouse event is translated into one of the above pre-defined requests.
 Currently only clicks in the user window (e.g., inside the menu display
 If the second argument is the KEY_MOUSE special key, the associated
 mouse event is translated into one of the above pre-defined requests.
 Currently only clicks in the user window (e.g., inside the menu display


@@ -158,7 +159,6 @@ If you clicked outside the user window
 or the mouse event could not be translated
 into a menu request an \fBE_REQUEST_DENIED\fP is returned.
 .SS APPLICATION-DEFINED COMMANDS
 or the mouse event could not be translated
 into a menu request an \fBE_REQUEST_DENIED\fP is returned.
 .SS APPLICATION-DEFINED COMMANDS

-.PP

 If the second argument is neither printable nor one of the above
 pre-defined menu requests or KEY_MOUSE,
 the drive assumes it is an application-specific
 If the second argument is neither printable nor one of the above
 pre-defined menu requests or KEY_MOUSE,
 the drive assumes it is an application-specific


@@ -191,10 +191,6 @@ Character failed to match.
 .TP 5
 .B E_REQUEST_DENIED
 The menu driver could not process the request.
 .TP 5
 .B E_REQUEST_DENIED
 The menu driver could not process the request.

-.SH SEE ALSO
-\fBcurses\fP(3X),
-\fBgetch\fP(3X),
-\fBmenu\fP(3X).

 .SH NOTES
 The header file \fB<menu.h>\fP automatically includes the header files
 \fB<curses.h>\fP.
 .SH NOTES
 The header file \fB<menu.h>\fP automatically includes the header files
 \fB<curses.h>\fP.


@@ -206,3 +202,7 @@ The support for mouse events is ncurses specific.
 .SH AUTHORS
 Juergen Pfeifer.
 Manual pages and adaptation for new curses by Eric S. Raymond.
 .SH AUTHORS
 Juergen Pfeifer.
 Manual pages and adaptation for new curses by Eric S. Raymond.

+.SH SEE ALSO
+\fB\%curses\fP(3X),
+\fB\%getch\fP(3X),
+\fB\%menu\fP(3X)