DragonFly On-Line Manual Pages
menu(3) menu(3)
NAME
menu - curses extension for programming menus
SYNOPSIS
#include <menu.h>
DESCRIPTION
The menu library provides terminal-independent facilities for composing
menu systems on character-cell terminals. The library includes: item
routines, which create and modify menu items; and menu routines, which
group items into menus, display menus on the screen, and handle inter-
action with the user.
The menu library uses the curses libraries, and a curses initialization
routine such as initscr must be called before using any of these func-
tions. To use the menu library, link with the options -lmenu -lcurses.
Current Default Values for Item Attributes
The menu library maintains a default value for item attributes. You
can get or set this default by calling the appropriate get_ or set_
routine with a NULL item pointer. Changing this default with a set_
function affects future item creations, but does not change the render-
ing of items already created.
Routine Name Index
The following table lists each menu routine and the name of the manual
page on which it is described.
curses Routine Name Manual Page Name
-------------------------------------------
current_item mitem_current(3)
free_item mitem_new(3)
free_menu menu_new(3)
item_count menu_items(3)
item_description mitem_name(3)
item_index mitem_current(3)
item_init menu_hook(3)
item_name mitem_name(3)
item_opts mitem_opts(3)
item_opts_off mitem_opts(3)
item_opts_on mitem_opts(3)
item_term menu_hook(3)
item_userptr mitem_userptr(3)
item_value mitem_value(3)
item_visible mitem_visible(3)
menu_back menu_attributes(3)
menu_driver menu_driver(3)
menu_fore menu_attributes(3)
menu_format menu_format(3)
menu_grey menu_attributes(3)
menu_init menu_hook(3)
menu_items menu_items(3)
menu_mark menu_mark(3)
menu_opts menu_opts(3)
menu_opts_off menu_opts(3)
menu_opts_on menu_opts(3)
menu_pad menu_attributes(3)
menu_pattern menu_pattern(3)
menu_request_by_name menu_requestname(3)
menu_request_name menu_requestname(3)
menu_spacing menu_spacing(3)
menu_sub menu_win(3)
menu_term menu_hook(3)
menu_userptr menu_userptr(3)
menu_win menu_win(3)
new_item mitem_new(3)
new_menu menu_new(3)
pos_menu_cursor menu_cursor(3)
post_menu menu_post(3)
scale_menu menu_win(3)
set_current_item mitem_current(3)
set_item_init menu_hook(3)
set_item_opts mitem_opts(3)
set_item_term menu_hook(3)
set_item_userptr mitem_userptr(3)
set_item_value mitem_value(3)
set_menu_back menu_attributes(3)
set_menu_fore menu_attributes(3)
set_menu_format menu_format(3)
set_menu_grey menu_attributes(3)
set_menu_init menu_hook(3)
set_menu_items menu_items(3)
set_menu_mark menu_mark(3)
set_menu_opts mitem_opts(3)
set_menu_pad menu_attributes(3)
set_menu_pattern menu_pattern(3)
set_menu_spacing menu_spacing(3)
set_menu_sub menu_win(3)
set_menu_term menu_hook(3)
set_menu_userptr menu_userptr(3)
set_menu_win menu_win(3)
set_top_row mitem_current(3)
top_row mitem_current(3)
unpost_menu menu_post(3)
RETURN VALUE
Routines that return pointers return NULL on error. Routines that
return an integer return one of the following error codes:
E_OK The routine succeeded.
E_BAD_ARGUMENT
Routine detected an incorrect or out-of-range argument.
E_BAD_STATE
Routine was called from an initialization or termination function.
E_NO_MATCH
Character failed to match.
E_NO_ROOM
Menu is too large for its window.
E_NOT_CONNECTED
No items are connected to the menu.
E_NOT_POSTED
The menu has not been posted.
E_NOT_SELECTABLE
The designated item cannot be selected.
E_POSTED
The menu is already posted.
E_REQUEST_DENIED
The menu driver could not process the request.
E_SYSTEM_ERROR
System error occurred (see errno).
E_UNKNOWN_COMMAND
The menu driver code saw an unknown request code.
SEE ALSO
curses(3) and related pages whose names begin "menu_" for detailed
descriptions of the entry points.
NOTES
The header file <menu.h> automatically includes the header files
<curses.h> and <eti.h>.
In your library list, libmenu.a should be before libncurses.a; that is,
you want to say `-lmenu -lncurses', not the other way around (which
would usually give a link-error).
PORTABILITY
These routines emulate the System V menu library. They were not sup-
ported on Version 7 or BSD versions.
AUTHORS
Juergen Pfeifer. Manual pages and adaptation for ncurses by Eric S.
Raymond.
SEE ALSO
This describes ncurses version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch
@NCURSES_PATCH@).
menu(3)
menu_driver(3X) menu_driver(3X)
NAME
menu_driver - command-processing loop of the menu system
SYNOPSIS
#include <menu.h>
int menu_driver(MENU *menu, int c);
DESCRIPTION
Once a menu has been posted (displayed), you should funnel input events
to it through menu_driver. This routine has three major input cases:
o The input is a form navigation request. Navigation request codes
are constants defined in <form.h>, which are distinct from the key-
and character codes returned by wgetch(3X).
o The input is a printable character. Printable characters (which
must be positive, less than 256) are checked according to the
program's locale settings.
o The input is the KEY_MOUSE special key associated with an mouse
event.
The menu driver requests are as follows:
REQ_LEFT_ITEM
Move left to an item.
REQ_RIGHT_ITEM
Move right to an item.
REQ_UP_ITEM
Move up to an item.
REQ_DOWN_ITEM
Move down to an item.
REQ_SCR_ULINE
Scroll up a line.
REQ_SCR_DLINE
Scroll down a line.
REQ_SCR_DPAGE
Scroll down a page.
REQ_SCR_UPAGE
Scroll up a page.
REQ_FIRST_ITEM
Move to the first item.
REQ_LAST_ITEM
Move to the last item.
REQ_NEXT_ITEM
Move to the next item.
REQ_PREV_ITEM
Move to the previous item.
REQ_TOGGLE_ITEM
Select/deselect an item.
REQ_CLEAR_PATTERN
Clear the menu pattern buffer.
REQ_BACK_PATTERN
Delete the previous character from the pattern buffer.
REQ_NEXT_MATCH
Move to the next item matching the pattern match.
REQ_PREV_MATCH
Move to the previous item matching the pattern match.
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, menu_driver returns E_NO_MATCH
and deletes the appended character from the buffer.
If the second argument is one of the above pre-defined requests, the
corresponding action is performed.
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
area or the decoration window) are handled.
If you click above the display region of the menu:
o a REQ_SCR_ULINE is generated for a single click,
o a REQ_SCR_UPAGE is generated for a double-click and
o a REQ_FIRST_ITEM is generated for a triple-click.
If you click below the display region of the menu:
o a REQ_SCR_DLINE is generated for a single click,
o a REQ_SCR_DPAGE is generated for a double-click and
o a REQ_LAST_ITEM is generated for a triple-click.
If you click at an item inside the display area of the menu:
o the menu cursor is positioned to that item.
o If you double-click an item a REQ_TOGGLE_ITEM is generated and
E_UNKNOWN_COMMAND 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.
o If a translation into a request was done, menu_driver 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 E_REQUEST_DENIED is returned.
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 command and returns E_UNKNOWN_COMMAND.
Application-defined commands should be defined relative to MAX_COMMAND,
the maximum value of these pre-defined requests.
RETURN VALUE
menu_driver return one of the following error codes:
E_OK The routine succeeded.
E_SYSTEM_ERROR
System error occurred (see errno(3)).
E_BAD_ARGUMENT
Routine detected an incorrect or out-of-range argument.
E_BAD_STATE
Routine was called from an initialization or termination function.
E_NOT_POSTED
The menu has not been posted.
E_UNKNOWN_COMMAND
The menu driver code saw an unknown request code.
E_NO_MATCH
Character failed to match.
E_REQUEST_DENIED
The menu driver could not process the request.
SEE ALSO
curses(3X), getch(3X), menu(3X).
NOTES
The header file <menu.h> automatically includes the header files
<curses.h>.
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.
AUTHORS
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
Raymond.
menu_driver(3X)