menu_driver(3) [netbsd man page]

MENU_DRIVER(3)						   BSD Library Functions Manual 					    MENU_DRIVER(3)

NAME

     menu_driver -- main menu handling function

LIBRARY

     Curses Menu Library (libmenu, -lmenu)

SYNOPSIS

     #include <menu.h>

     int
     menu_driver(MENU *menu, int c);

DESCRIPTION

     The menu_driver() function is the guts of the menu system.  It takes the commands passed by c parameter and performs the requested action on
     the menu given.  The following commands may be given to the menu driver:

     Command		Action
     REQ_LEFT_ITEM	Sets the new current item to be the item to the left of the current item.
     REQ_RIGHT_ITEM	Sets the new current item to be the item to the rights of the current item.
     REQ_UP_ITEM	Sets the new current item to be the item above the current item.
     REQ_DOWN_ITEM	Sets the new current item to be the item below the current item.
     REQ_SCR_ULINE	Scroll the menu one line towards the bottom of the menu window.  The new current item becomes the item immediately above
			the current item.
     REQ_SCR_DLINE	Scroll the menu one line towards the top of the menu window.  The new current item becomes the item immediately below the
			current item.
     REQ_SCR_DPAGE	Scroll the menu one page towards the bottom of the menu window.
     REQ_SCR_UPAGE	Scroll the menu one page towards the top of the menu window.
     REQ_FIRST_ITEM	Set the current item to be the first item in the menu.
     REQ_LAST_ITEM	Set the current item to be the last item in the menu.
     REQ_NEXT_ITEM	Set the new current item to be the next item in the item array after the current item.
     REQ_PREV_ITEM	Set the new current item to be the item before the current item in the items array.
     REQ_TOGGLE_ITEM	If the item is selectable then toggle the item's value.
     REQ_CLEAR_PATTERN	Clear all the characters currently in the menu's pattern buffer.
     REQ_BACK_PATTERN	Remove the last character from the pattern buffer.
     REQ_NEXT_MATCH	Attempt to find the next item that matches the pattern buffer.
     REQ_PREV_MATCH	Attempt to find the previous item that matches the pattern buffer.
     If menu_driver() is passed a command that is greater than MAX_COMMAND then the command passed is assumed to be a user defined command and
     menu_driver() returns E_UNKNOWN_COMMAND.  Otherwise if the command is a printable character then the character represented by the command is
     placed at the end of the pattern buffer and an attempt is made to match the pattern buffer against the items in the menu.

RETURN VALUES

     The functions return one of the following error values:

     E_OK		The function was successful.
     E_SYSTEM_ERROR	There was a system error during the call.
     E_BAD_ARGUMENT	One or more of the arguments passed to the function was incorrect.
     E_NOT_POSTED	The menu is not posted.
     E_UNKNOWN_COMMAND	The menu driver does not recognize the request passed to it.
     E_NO_MATCH 	The character search failed to find a match.
     E_NOT_CONNECTED	The item is not connected to a menu.
     E_REQUEST_DENIED	The menu driver could not process the request.

SEE ALSO

     curses(3), menus(3)

NOTES

     The header <menu.h> automatically includes both <curses.h> and <eti.h>.

BSD
								September 10, 1999							       BSD

Check Out this Related Man Page

menu_driver(3CURSES)					     Curses Library Functions					      menu_driver(3CURSES)

NAME

       menu_driver - command processor for the menus subsystem

SYNOPSIS

       cc [ flag... ] file... -lmenu  -lcurses	[ library... ]
       #include <menu.h>

       int menu_driver(MENU *menu, int c);

DESCRIPTION

       menu_driver()  is the workhorse of the menus subsystem. It checks to determine whether the character c is a menu request or data. If c is a
       request, the menu driver executes the request and reports the result. If c is data (a printable ASCII character), it enters the	data  into
       the  pattern buffer and tries to find a matching item. If no match is found, the menu driver deletes  the character from the pattern buffer
       and returns E_NO_MATCH. If the character is not recognized, the menu driver assumes  it	is  an	application-defined  command  and  returns
       E_UNKNOWN_COMMAND.

       Menu driver requests:

       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 up a page.

       REQ_SCR_UPAGE	    Scroll down 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/de-select an item.

       REQ_CLEAR_PATTERN    Clear the menu pattern buffer.

       REQ_BACK_PATTERN     Delete the previous character from pattern buffer.

       REQ_NEXT_MATCH	    Move the next matching item.

       REQ_PREV_MATCH	    Move to the previous matching item.

RETURN VALUES

       menu_driver() returns one of the following:

       E_OK		    The routine returned successfully.

       E_SYSTEM_ERROR	    System error.

       E_BAD_ARGUMENT	    An incorrect argument was passed to the routine.

       E_BAD_STATE	    The routine was called from an initialization or termination function.

       E_NOT_POSTED	    The menu has not been posted.

       E_UNKNOWN_COMMAND    An unknown request was passed to the menu driver.

       E_NO_MATCH	    The character failed to match.

       E_NOT_SELECTABLE     The item cannot be selected.

       E_REQUEST_DENIED     The menu driver could not process the request.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       curses(3CURSES), menus(3CURSES), attributes(5)

NOTES

       Application-defined commands should be defined relative to (greater than) MAX_COMMAND, the maximum value of a request listed above.

       The header <menu.h> automatically includes the headers  <eti.h> and <curses.h>.

SunOS 5.11							    31 Dec 1996 					      menu_driver(3CURSES)

Linux and UNIX Man Pages

menu_driver(3) [netbsd man page]

Check Out this Related Man Page