150276Speter/**************************************************************************** 2174993Srafan * Copyright (c) 1998-2003,2007 Free Software Foundation, Inc. * 350276Speter * * 450276Speter * Permission is hereby granted, free of charge, to any person obtaining a * 550276Speter * copy of this software and associated documentation files (the * 650276Speter * "Software"), to deal in the Software without restriction, including * 750276Speter * without limitation the rights to use, copy, modify, merge, publish, * 850276Speter * distribute, distribute with modifications, sublicense, and/or sell * 950276Speter * copies of the Software, and to permit persons to whom the Software is * 1050276Speter * furnished to do so, subject to the following conditions: * 1150276Speter * * 1250276Speter * The above copyright notice and this permission notice shall be included * 1350276Speter * in all copies or substantial portions of the Software. * 1450276Speter * * 1550276Speter * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * 1650276Speter * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * 1750276Speter * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * 1850276Speter * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * 1950276Speter * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * 2050276Speter * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * 2150276Speter * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * 2250276Speter * * 2350276Speter * Except as contained in this notice, the name(s) of the above copyright * 2450276Speter * holders shall not be used in advertising or otherwise to promote the * 2550276Speter * sale, use or other dealings in this Software without prior written * 2650276Speter * authorization. * 2750276Speter ****************************************************************************/ 2850276Speter 2950276Speter/**************************************************************************** 30166124Srafan * Author: Juergen Pfeifer, 1995,1997 * 3150276Speter ****************************************************************************/ 3250276Speter 33174993Srafan/* $Id: menu.h,v 1.19 2007/02/24 17:32:13 tom Exp $ */ 34166124Srafan 3550276Speter#ifndef ETI_MENU 3650276Speter#define ETI_MENU 3750276Speter 3866963Speter#ifdef AMIGA 3966963Speter#define TEXT TEXT_ncurses 4066963Speter#endif 4166963Speter 4250276Speter#include <curses.h> 4350276Speter#include <eti.h> 4450276Speter 4550276Speter#ifdef __cplusplus 4650276Speterextern "C" { 4750276Speter#endif 4850276Speter 4950276Spetertypedef int Menu_Options; 5050276Spetertypedef int Item_Options; 5150276Speter 5250276Speter/* Menu options: */ 5350276Speter#define O_ONEVALUE (0x01) 5450276Speter#define O_SHOWDESC (0x02) 5550276Speter#define O_ROWMAJOR (0x04) 5650276Speter#define O_IGNORECASE (0x08) 5750276Speter#define O_SHOWMATCH (0x10) 5850276Speter#define O_NONCYCLIC (0x20) 5950276Speter 6050276Speter/* Item options: */ 6150276Speter#define O_SELECTABLE (0x01) 6250276Speter 6350276Spetertypedef struct 6450276Speter{ 6550276Speter const char* str; 6650276Speter unsigned short length; 6750276Speter} TEXT; 6850276Speter 6950276Spetertypedef struct tagITEM 7050276Speter{ 7150276Speter TEXT name; /* name of menu item */ 7250276Speter TEXT description; /* description of item, optional in display */ 7350276Speter struct tagMENU *imenu; /* Pointer to parent menu */ 7450276Speter void *userptr; /* Pointer to user defined per item data */ 7550276Speter Item_Options opt; /* Item options */ 7650276Speter short index; /* Item number if connected to a menu */ 7750276Speter short y; /* y and x location of item in menu */ 7850276Speter short x; 7950276Speter bool value; /* Selection value */ 8050276Speter 81166124Srafan struct tagITEM *left; /* neighbor items */ 8250276Speter struct tagITEM *right; 8350276Speter struct tagITEM *up; 8450276Speter struct tagITEM *down; 8550276Speter 8650276Speter} ITEM; 8750276Speter 8850276Spetertypedef void (*Menu_Hook)(struct tagMENU *); 8950276Speter 9050276Spetertypedef struct tagMENU 9150276Speter{ 9250276Speter short height; /* Nr. of chars high */ 9350276Speter short width; /* Nr. of chars wide */ 9450276Speter short rows; /* Nr. of items high */ 9550276Speter short cols; /* Nr. of items wide */ 9650276Speter short frows; /* Nr. of formatted items high */ 9750276Speter short fcols; /* Nr. of formatted items wide */ 9850276Speter short arows; /* Nr. of items high (actual) */ 9950276Speter short namelen; /* Max. name length */ 10050276Speter short desclen; /* Max. description length */ 10150276Speter short marklen; /* Length of mark, if any */ 10250276Speter short itemlen; /* Length of one item */ 10350276Speter short spc_desc; /* Spacing for descriptor */ 10450276Speter short spc_cols; /* Spacing for columns */ 10550276Speter short spc_rows; /* Spacing for rows */ 10650276Speter char *pattern; /* Buffer to store match chars */ 10750276Speter short pindex; /* Index into pattern buffer */ 10850276Speter WINDOW *win; /* Window containing menu */ 10950276Speter WINDOW *sub; /* Subwindow for menu display */ 11050276Speter WINDOW *userwin; /* User's window */ 11150276Speter WINDOW *usersub; /* User's subwindow */ 11250276Speter ITEM **items; /* array of items */ 11350276Speter short nitems; /* Nr. of items in menu */ 11450276Speter ITEM *curitem; /* Current item */ 11550276Speter short toprow; /* Top row of menu */ 11650276Speter chtype fore; /* Selection attribute */ 11750276Speter chtype back; /* Nonselection attribute */ 11850276Speter chtype grey; /* Inactive attribute */ 11950276Speter unsigned char pad; /* Pad character */ 12050276Speter 12150276Speter Menu_Hook menuinit; /* User hooks */ 12250276Speter Menu_Hook menuterm; 12350276Speter Menu_Hook iteminit; 12450276Speter Menu_Hook itemterm; 12550276Speter 12650276Speter void *userptr; /* Pointer to menus user data */ 12750276Speter char *mark; /* Pointer to marker string */ 12850276Speter 12950276Speter Menu_Options opt; /* Menu options */ 13050276Speter unsigned short status; /* Internal state of menu */ 13150276Speter 13250276Speter} MENU; 13350276Speter 13450276Speter 13550276Speter/* Define keys */ 13650276Speter 13750276Speter#define REQ_LEFT_ITEM (KEY_MAX + 1) 13850276Speter#define REQ_RIGHT_ITEM (KEY_MAX + 2) 13950276Speter#define REQ_UP_ITEM (KEY_MAX + 3) 14050276Speter#define REQ_DOWN_ITEM (KEY_MAX + 4) 14150276Speter#define REQ_SCR_ULINE (KEY_MAX + 5) 14250276Speter#define REQ_SCR_DLINE (KEY_MAX + 6) 14350276Speter#define REQ_SCR_DPAGE (KEY_MAX + 7) 14450276Speter#define REQ_SCR_UPAGE (KEY_MAX + 8) 14550276Speter#define REQ_FIRST_ITEM (KEY_MAX + 9) 14650276Speter#define REQ_LAST_ITEM (KEY_MAX + 10) 14750276Speter#define REQ_NEXT_ITEM (KEY_MAX + 11) 14850276Speter#define REQ_PREV_ITEM (KEY_MAX + 12) 14950276Speter#define REQ_TOGGLE_ITEM (KEY_MAX + 13) 15050276Speter#define REQ_CLEAR_PATTERN (KEY_MAX + 14) 15150276Speter#define REQ_BACK_PATTERN (KEY_MAX + 15) 15250276Speter#define REQ_NEXT_MATCH (KEY_MAX + 16) 15350276Speter#define REQ_PREV_MATCH (KEY_MAX + 17) 15450276Speter 15550276Speter#define MIN_MENU_COMMAND (KEY_MAX + 1) 15650276Speter#define MAX_MENU_COMMAND (KEY_MAX + 17) 15750276Speter 15850276Speter/* 15950276Speter * Some AT&T code expects MAX_COMMAND to be out-of-band not 16050276Speter * just for menu commands but for forms ones as well. 16150276Speter */ 16250276Speter#if defined(MAX_COMMAND) 16350276Speter# if (MAX_MENU_COMMAND > MAX_COMMAND) 16450276Speter# error Something is wrong -- MAX_MENU_COMMAND is greater than MAX_COMMAND 16550276Speter# elif (MAX_COMMAND != (KEY_MAX + 128)) 16650276Speter# error Something is wrong -- MAX_COMMAND is already inconsistently defined. 16750276Speter# endif 16850276Speter#else 16950276Speter# define MAX_COMMAND (KEY_MAX + 128) 17050276Speter#endif 17150276Speter 17250276Speter 17350276Speter/* --------- prototypes for libmenu functions ----------------------------- */ 17450276Speter 17576726Speterextern NCURSES_EXPORT(ITEM **) menu_items (const MENU *); 17676726Speterextern NCURSES_EXPORT(ITEM *) current_item (const MENU *); 17776726Speterextern NCURSES_EXPORT(ITEM *) new_item (const char *,const char *); 17850276Speter 17976726Speterextern NCURSES_EXPORT(MENU *) new_menu (ITEM **); 18050276Speter 18176726Speterextern NCURSES_EXPORT(Item_Options) item_opts (const ITEM *); 18276726Speterextern NCURSES_EXPORT(Menu_Options) menu_opts (const MENU *); 18350276Speter 18476726Speterextern NCURSES_EXPORT(Menu_Hook) item_init (const MENU *); 18576726Speterextern NCURSES_EXPORT(Menu_Hook) item_term (const MENU *); 18676726Speterextern NCURSES_EXPORT(Menu_Hook) menu_init (const MENU *); 18776726Speterextern NCURSES_EXPORT(Menu_Hook) menu_term (const MENU *); 18850276Speter 18976726Speterextern NCURSES_EXPORT(WINDOW *) menu_sub (const MENU *); 19076726Speterextern NCURSES_EXPORT(WINDOW *) menu_win (const MENU *); 19150276Speter 19276726Speterextern NCURSES_EXPORT(const char *) item_description (const ITEM *); 19376726Speterextern NCURSES_EXPORT(const char *) item_name (const ITEM *); 19476726Speterextern NCURSES_EXPORT(const char *) menu_mark (const MENU *); 19576726Speterextern NCURSES_EXPORT(const char *) menu_request_name (int); 19650276Speter 19776726Speterextern NCURSES_EXPORT(char *) menu_pattern (const MENU *); 19850276Speter 19976726Speterextern NCURSES_EXPORT(void *) menu_userptr (const MENU *); 20076726Speterextern NCURSES_EXPORT(void *) item_userptr (const ITEM *); 20150276Speter 20276726Speterextern NCURSES_EXPORT(chtype) menu_back (const MENU *); 20376726Speterextern NCURSES_EXPORT(chtype) menu_fore (const MENU *); 20476726Speterextern NCURSES_EXPORT(chtype) menu_grey (const MENU *); 20550276Speter 20676726Speterextern NCURSES_EXPORT(int) free_item (ITEM *); 20776726Speterextern NCURSES_EXPORT(int) free_menu (MENU *); 20876726Speterextern NCURSES_EXPORT(int) item_count (const MENU *); 20976726Speterextern NCURSES_EXPORT(int) item_index (const ITEM *); 21076726Speterextern NCURSES_EXPORT(int) item_opts_off (ITEM *,Item_Options); 21176726Speterextern NCURSES_EXPORT(int) item_opts_on (ITEM *,Item_Options); 21276726Speterextern NCURSES_EXPORT(int) menu_driver (MENU *,int); 21376726Speterextern NCURSES_EXPORT(int) menu_opts_off (MENU *,Menu_Options); 21476726Speterextern NCURSES_EXPORT(int) menu_opts_on (MENU *,Menu_Options); 21576726Speterextern NCURSES_EXPORT(int) menu_pad (const MENU *); 21676726Speterextern NCURSES_EXPORT(int) pos_menu_cursor (const MENU *); 21776726Speterextern NCURSES_EXPORT(int) post_menu (MENU *); 21876726Speterextern NCURSES_EXPORT(int) scale_menu (const MENU *,int *,int *); 21976726Speterextern NCURSES_EXPORT(int) set_current_item (MENU *menu,ITEM *item); 220174993Srafanextern NCURSES_EXPORT(int) set_item_init (MENU *, Menu_Hook); 22176726Speterextern NCURSES_EXPORT(int) set_item_opts (ITEM *,Item_Options); 222174993Srafanextern NCURSES_EXPORT(int) set_item_term (MENU *, Menu_Hook); 22376726Speterextern NCURSES_EXPORT(int) set_item_userptr (ITEM *, void *); 22476726Speterextern NCURSES_EXPORT(int) set_item_value (ITEM *,bool); 22576726Speterextern NCURSES_EXPORT(int) set_menu_back (MENU *,chtype); 22676726Speterextern NCURSES_EXPORT(int) set_menu_fore (MENU *,chtype); 22776726Speterextern NCURSES_EXPORT(int) set_menu_format (MENU *,int,int); 22876726Speterextern NCURSES_EXPORT(int) set_menu_grey (MENU *,chtype); 229174993Srafanextern NCURSES_EXPORT(int) set_menu_init (MENU *, Menu_Hook); 23076726Speterextern NCURSES_EXPORT(int) set_menu_items (MENU *,ITEM **); 23176726Speterextern NCURSES_EXPORT(int) set_menu_mark (MENU *, const char *); 23276726Speterextern NCURSES_EXPORT(int) set_menu_opts (MENU *,Menu_Options); 23376726Speterextern NCURSES_EXPORT(int) set_menu_pad (MENU *,int); 23476726Speterextern NCURSES_EXPORT(int) set_menu_pattern (MENU *,const char *); 23576726Speterextern NCURSES_EXPORT(int) set_menu_sub (MENU *,WINDOW *); 236174993Srafanextern NCURSES_EXPORT(int) set_menu_term (MENU *, Menu_Hook); 23776726Speterextern NCURSES_EXPORT(int) set_menu_userptr (MENU *,void *); 23876726Speterextern NCURSES_EXPORT(int) set_menu_win (MENU *,WINDOW *); 23976726Speterextern NCURSES_EXPORT(int) set_top_row (MENU *,int); 24076726Speterextern NCURSES_EXPORT(int) top_row (const MENU *); 24176726Speterextern NCURSES_EXPORT(int) unpost_menu (MENU *); 24276726Speterextern NCURSES_EXPORT(int) menu_request_by_name (const char *); 24376726Speterextern NCURSES_EXPORT(int) set_menu_spacing (MENU *,int,int,int); 24476726Speterextern NCURSES_EXPORT(int) menu_spacing (const MENU *,int *,int *,int *); 24550276Speter 24650276Speter 24776726Speterextern NCURSES_EXPORT(bool) item_value (const ITEM *); 24876726Speterextern NCURSES_EXPORT(bool) item_visible (const ITEM *); 24950276Speter 25076726Speterextern NCURSES_EXPORT(void) menu_format (const MENU *,int *,int *); 25150276Speter 25250276Speter#ifdef __cplusplus 25350276Speter } 25450276Speter#endif 25550276Speter 25650276Speter#endif /* ETI_MENU */ 257