ncurses 6.4 - patch 20240420

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

diff --git a/man/menu_driver.3x b/man/menu_driver.3x
index 5366040c18af024407a1157bcd58dd4004156626..6a117283705f138a3a95bbdf81ffaf47a82ce101 100644 (file)
--- a/man/menu_driver.3x
+++ b/man/menu_driver.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998-2007,2008 Free Software Foundation, Inc.              *
+.\" 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  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,30 +27,34 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: menu_driver.3x,v 1.15 2008/06/21 21:55:30 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
 .SH NAME

-\fBmenu_driver\fR - 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>\fR
-.br
-int menu_driver(MENU *menu, int c);
-.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
 .SH DESCRIPTION
 Once a menu has been posted (displayed), you should funnel input events to it

-through \fBmenu_driver\fR.  This routine has three major input cases:
-.TP 3
--
+through \fBmenu_driver\fP.  This routine has three major input cases:
+.bP

 The input is a form navigation request.
 Navigation request codes are constants defined in \fB<form.h>\fP,
 The input is a form navigation request.
 Navigation request codes are constants defined in \fB<form.h>\fP,

-which are distinct from the key- and character codes returned by \fBwgetch\fP.
-.TP 3
--
+which are distinct from the key- and character codes
+returned by \fBwgetch\fP(3X).
+.bP

 The input is a printable character.
 Printable characters (which must be positive, less than 256) are
 checked according to the program's locale settings.
 The input is a printable character.
 Printable characters (which must be positive, less than 256) are
 checked according to the program's locale settings.

-.TP 3
--
+.bP

 The input is the KEY_MOUSE special key associated with an mouse event.
 .PP
 The menu driver requests are as follows:
 The input is the KEY_MOUSE special key associated with an mouse event.
 .PP
 The menu driver requests are as follows:


@@ -107,75 +112,67 @@ Move to the previous item matching the pattern match.
 .PP
 If the second argument is a printable character, the code appends
 it to the pattern buffer and attempts to move to the next item matching
 .PP
 If the second argument is a printable character, the code appends
 it to the pattern buffer and attempts to move to the next item matching

-the new pattern.  If there is no such match, \fBmenu_driver\fR returns
-\fBE_NO_MATCH\fR and deletes the appended character from the buffer.
+the new pattern.
+If there is no such match, \fBmenu_driver\fP returns
+\fBE_NO_MATCH\fP and deletes the appended character from the buffer.

 .PP
 If the second argument is one of the above pre-defined requests, the
 corresponding action is performed.
 .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.
 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
+Currently only clicks in the user window (e.g., inside the menu display

 area or the decoration window) are handled.
 .PP
 If you click above the display region of the menu:
 area or the decoration window) are handled.
 .PP
 If you click above the display region of the menu:

-.RS
-.TP
+.bP

 a REQ_SCR_ULINE is generated for a single click,
 a REQ_SCR_ULINE is generated for a single click,

-.TP
+.bP

 a REQ_SCR_UPAGE is generated for a double-click and
 a REQ_SCR_UPAGE is generated for a double-click and

-.TP
+.bP

 a REQ_FIRST_ITEM is generated for a triple-click.
 a REQ_FIRST_ITEM is generated for a triple-click.

-.RE

 .PP
 If you click below the display region of the menu:
 .PP
 If you click below the display region of the menu:

-.RS
-.TP
+.bP

 a REQ_SCR_DLINE is generated for a single click,
 a REQ_SCR_DLINE is generated for a single click,

-.TP
+.bP

 a REQ_SCR_DPAGE is generated for a double-click and
 a REQ_SCR_DPAGE is generated for a double-click and

-.TP
+.bP

 a REQ_LAST_ITEM is generated for a triple-click.
 a REQ_LAST_ITEM is generated for a triple-click.

-.RE

 .PP
 If you click at an item inside the display area of the menu:
 .PP
 If you click at an item inside the display area of the menu:

-.RS
-.TP 3
--
+.bP

 the menu cursor is positioned to that item.
 the menu cursor is positioned to that item.

-.TP 3
--
+.bP

 If you double-click an item a REQ_TOGGLE_ITEM
 If you double-click an item a REQ_TOGGLE_ITEM

-is generated and \fBE_UNKNOWN_COMMAND\fR is returned.
+is generated and \fBE_UNKNOWN_COMMAND\fP is returned.

 This return value makes sense,
 because a double click usually means that an item-specific action should
 be returned.
 It is exactly the purpose of this return value to signal that an
 application specific command should be executed.
 This return value makes sense,
 because a double click usually means that an item-specific action should
 be returned.
 It is exactly the purpose of this return value to signal that an
 application specific command should be executed.

-.TP 3
--
+.bP

 If a translation
 If a translation

-into a request was done, \fBmenu_driver\fR returns the result of this request.
-.RE
-.PP
-If you clicked outside the user window or the mouse event could not be translated
-into a menu request an \fBE_REQUEST_DENIED\fR is returned.
-.SS APPLICATION-DEFINED COMMANDS
+into a request was done, \fBmenu_driver\fP returns the result of this request.

 .PP
 .PP

+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"

 If the second argument is neither printable nor one of the above
 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
-command and returns \fBE_UNKNOWN_COMMAND\fR.  Application-defined commands
-should be defined relative to \fBMAX_COMMAND\fR, the maximum value of these
+pre-defined menu requests or KEY_MOUSE,
+the drive assumes it is an application-specific
+command and returns \fBE_UNKNOWN_COMMAND\fP.  Application-defined commands
+should be defined relative to \fBMAX_COMMAND\fP, the maximum value of these

 pre-defined requests.
 .SH RETURN VALUE
 pre-defined requests.
 .SH RETURN VALUE

-\fBmenu_driver\fR return one of the following error codes:
+\fBmenu_driver\fP return one of the following error codes:

 .TP 5
 .B E_OK
 The routine succeeded.
 .TP 5
 .B E_SYSTEM_ERROR
 .TP 5
 .B E_OK
 The routine succeeded.
 .TP 5
 .B E_SYSTEM_ERROR

-System error occurred (see \fBerrno\fR).
+System error occurred (see \fBerrno\fP(3)).

 .TP 5
 .B E_BAD_ARGUMENT
 Routine detected an incorrect or out-of-range argument.
 .TP 5
 .B E_BAD_ARGUMENT
 Routine detected an incorrect or out-of-range argument.


@@ -194,22 +191,15 @@ 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\fR(3X),
-\fBmenu\fR(3X),
-\fBwgetch\fR(3X).
-.SH NOTES
-The header file \fB<menu.h>\fR automatically includes the header files
-\fB<curses.h>\fR.

 .SH PORTABILITY
 .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.
+These routines emulate the System V menu library.
+They were not supported on
+Version 7 or BSD versions.
+The support for mouse events is \fI\%ncurses\fP specific.

 .SH AUTHORS
 .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.
+.SH SEE ALSO
+\fB\%curses\fP(3X),
+\fB\%getch\fP(3X),
+\fB\%menu\fP(3X)