X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmenu_driver.3x;h=6a117283705f138a3a95bbdf81ffaf47a82ce101;hb=75a9c36c205ebefe07580acd0b1053a2abbd44b9;hp=0a4809967bf567fd6413c2eb4d93ee3f3d78e051;hpb=74433bcf4f6fe40862a28f3c00edaedcd5054b01;p=ncurses.git
diff --git a/man/menu_driver.3x b/man/menu_driver.3x
index 0a480996..6a117283 100644
--- a/man/menu_driver.3x
+++ b/man/menu_driver.3x
@@ -1,5 +1,5 @@
.\"***************************************************************************
-.\" Copyright 2018-2020,2021 Thomas E. Dickey *
+.\" Copyright 2018-2023,2024 Thomas E. Dickey *
.\" 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. *
.\"***************************************************************************
.\"
-.\" $Id: menu_driver.3x,v 1.30 2021/12/25 21:49:32 tom Exp $
-.TH menu_driver 3X ""
+.\" $Id: menu_driver.3x,v 1.47 2024/03/16 15:35:01 tom Exp $
+.TH menu_driver 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
.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
-\fB#include
\fP
-.sp
-\fBint menu_driver(MENU *\fP\fImenu\fP\fB, int \fP\fIc\fP\fB);\fP
-.br
+.nf
+\fB#include
+.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:
@@ -116,8 +118,7 @@ If there is no such match, \fBmenu_driver\fP returns
.PP
If the second argument is one of the above pre-defined requests, the
corresponding action is performed.
-.SS MOUSE HANDLING
-.PP
+.SS "Mouse Handling"
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
@@ -157,8 +158,7 @@ into a request was done, \fBmenu_driver\fP returns the result of this request.
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
-.PP
+.SS "Application-defined Commands"
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,18 +191,15 @@ Character failed to match.
.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\fP automatically includes the header files
-\fB\fP.
.SH PORTABILITY
These routines emulate the System V menu library.
They were not supported on
Version 7 or BSD versions.
-The support for mouse events is ncurses specific.
+The support for mouse events is \fI\%ncurses\fP specific.
.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)