ncurses 6.2 - patch 20200212

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

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

-.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc.              *
+.\" Copyright 2018-2019,2020 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,10 +27,14 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: menu_driver.3x,v 1.14 2007/06/02 22:50:09 tom Exp $
+.\" $Id: menu_driver.3x,v 1.26 2020/02/02 23:34:34 tom Exp $

 .TH menu_driver 3X ""
 .TH menu_driver 3X ""

+.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\fR \- command-processing loop of the menu system

 .SH SYNOPSIS
 \fB#include <menu.h>\fR
 .br
 .SH SYNOPSIS
 \fB#include <menu.h>\fR
 .br


@@ -37,9 +42,19 @@ int menu_driver(MENU *menu, int c);
 .br
 .SH DESCRIPTION
 Once a menu has been posted (displayed), you should funnel input events to it
 .br
 .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; either
-the input is a menu navigation request, it is a printable ASCII character or it
-is the KEY_MOUSE special key associated with an mouse event.
+through \fBmenu_driver\fR.  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,
+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.
+.bP
+The input is the KEY_MOUSE special key associated with an mouse event.
+.PP

 The menu driver requests are as follows:
 .TP 5
 REQ_LEFT_ITEM
 The menu driver requests are as follows:
 .TP 5
 REQ_LEFT_ITEM


@@ -93,9 +108,10 @@ Move to the next item matching the pattern match.
 REQ_PREV_MATCH
 Move to the previous item matching the pattern match.
 .PP
 REQ_PREV_MATCH
 Move to the previous item matching the pattern match.
 .PP

-If the second argument is a printable ASCII character, the code appends
+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
 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
+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.
 .PP
 If the second argument is one of the above pre-defined requests, the
 \fBE_NO_MATCH\fR and deletes the appended character from the buffer.
 .PP
 If the second argument is one of the above pre-defined requests, the


@@ -104,36 +120,29 @@ corresponding action is performed.
 .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.
 .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
+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
 is generated and \fBE_UNKNOWN_COMMAND\fR is returned.
 This return value makes sense,
 If you double-click an item a REQ_TOGGLE_ITEM
 is generated and \fBE_UNKNOWN_COMMAND\fR is returned.
 This return value makes sense,


@@ -141,18 +150,18 @@ 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.
 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
 into a request was done, \fBmenu_driver\fR returns the result of this request.
 If a translation
 into a request was done, \fBmenu_driver\fR returns the result of this request.

-.RE

 .PP
 .PP

-If you clicked outside the user window or the mouse event couldn't be translated
+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
 .PP
 into a menu request an \fBE_REQUEST_DENIED\fR is returned.
 .SS APPLICATION-DEFINED COMMANDS
 .PP

-If the second argument is neither printable ASCII 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

 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 requests.
 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 requests.


@@ -163,7 +172,7 @@ pre-defined requests.
 The routine succeeded.
 .TP 5
 .B E_SYSTEM_ERROR
 The routine succeeded.
 .TP 5
 .B E_SYSTEM_ERROR

-System error occurred (see \fBerrno\fR).
+System error occurred (see \fBerrno\fR(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.


@@ -183,19 +192,17 @@ Character failed to match.
 .B E_REQUEST_DENIED
 The menu driver could not process the request.
 .SH SEE ALSO
 .B E_REQUEST_DENIED
 The menu driver could not process the request.
 .SH SEE ALSO

-\fBcurses\fR(3X), \fBmenu\fR(3X).
+\fBcurses\fR(3X),
+\fBmenu\fR(3X),
+\fBgetch\fR(3X).

 .SH NOTES
 The header file \fB<menu.h>\fR automatically includes the header files
 \fB<curses.h>\fR.
 .SH PORTABILITY
 .SH NOTES
 The header file \fB<menu.h>\fR automatically includes the header files
 \fB<curses.h>\fR.
 .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 ncurses 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.