m_attribs.c revision 262629
1/**************************************************************************** 2 * Copyright (c) 1998-2004,2010 Free Software Foundation, Inc. * 3 * * 4 * Permission is hereby granted, free of charge, to any person obtaining a * 5 * copy of this software and associated documentation files (the * 6 * "Software"), to deal in the Software without restriction, including * 7 * without limitation the rights to use, copy, modify, merge, publish, * 8 * distribute, distribute with modifications, sublicense, and/or sell * 9 * copies of the Software, and to permit persons to whom the Software is * 10 * furnished to do so, subject to the following conditions: * 11 * * 12 * The above copyright notice and this permission notice shall be included * 13 * in all copies or substantial portions of the Software. * 14 * * 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * 16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * 17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * 18 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * 19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * 20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * 21 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * 22 * * 23 * Except as contained in this notice, the name(s) of the above copyright * 24 * holders shall not be used in advertising or otherwise to promote the * 25 * sale, use or other dealings in this Software without prior written * 26 * authorization. * 27 ****************************************************************************/ 28 29/**************************************************************************** 30 * Author: Juergen Pfeifer, 1995,1997 * 31 ****************************************************************************/ 32 33/*************************************************************************** 34* Module m_attribs * 35* Control menus display attributes * 36***************************************************************************/ 37 38#include "menu.priv.h" 39 40MODULE_ID("$Id: m_attribs.c,v 1.16 2010/01/23 21:16:54 tom Exp $") 41 42/* Macro to redraw menu if it is posted and changed */ 43#define Refresh_Menu(menu) \ 44 if ( (menu) && ((menu)->status & _POSTED) )\ 45 {\ 46 _nc_Draw_Menu( menu );\ 47 _nc_Show_Menu( menu );\ 48 } 49 50/* "Template" macro to generate a function to set a menus attribute */ 51#define GEN_MENU_ATTR_SET_FCT( name ) \ 52NCURSES_IMPEXP int NCURSES_API set_menu_ ## name (MENU* menu, chtype attr) \ 53{\ 54 T((T_CALLED("set_menu_" #name "(%p,%s)"), menu, _traceattr(attr))); \ 55 if (!(attr==A_NORMAL || (attr & A_ATTRIBUTES)==attr))\ 56 RETURN(E_BAD_ARGUMENT);\ 57 if (menu && ( menu -> name != attr))\ 58 {\ 59 (menu -> name) = attr;\ 60 Refresh_Menu(menu);\ 61 }\ 62 Normalize_Menu( menu ) -> name = attr;\ 63 RETURN(E_OK);\ 64} 65 66/* "Template" macro to generate a function to get a menu's attribute */ 67#define GEN_MENU_ATTR_GET_FCT( name ) \ 68NCURSES_IMPEXP chtype NCURSES_API menu_ ## name (const MENU * menu)\ 69{\ 70 T((T_CALLED("menu_" #name "(%p)"), (const void *) menu));\ 71 returnAttr(Normalize_Menu( menu ) -> name);\ 72} 73 74/*--------------------------------------------------------------------------- 75| Facility : libnmenu 76| Function : int set_menu_fore(MENU *menu, chtype attr) 77| 78| Description : Set the attribute for selectable items. In single- 79| valued menus this is used to highlight the current 80| item ((i.e. where the cursor is), in multi-valued 81| menus this is used to highlight the selected items. 82| 83| Return Values : E_OK - success 84| E_BAD_ARGUMENT - an invalid value has been passed 85+--------------------------------------------------------------------------*/ 86GEN_MENU_ATTR_SET_FCT(fore) 87 88/*--------------------------------------------------------------------------- 89| Facility : libnmenu 90| Function : chtype menu_fore(const MENU* menu) 91| 92| Description : Return the attribute used for selectable items that 93| are current (single-valued menu) or selected (multi- 94| valued menu). 95| 96| Return Values : Attribute value 97+--------------------------------------------------------------------------*/ 98GEN_MENU_ATTR_GET_FCT(fore) 99 100/*--------------------------------------------------------------------------- 101| Facility : libnmenu 102| Function : int set_menu_back(MENU *menu, chtype attr) 103| 104| Description : Set the attribute for selectable but not yet selected 105| items. 106| 107| Return Values : E_OK - success 108| E_BAD_ARGUMENT - an invalid value has been passed 109+--------------------------------------------------------------------------*/ 110GEN_MENU_ATTR_SET_FCT(back) 111 112/*--------------------------------------------------------------------------- 113| Facility : libnmenu 114| Function : chtype menu_back(const MENU *menu) 115| 116| Description : Return the attribute used for selectable but not yet 117| selected items. 118| 119| Return Values : Attribute value 120+--------------------------------------------------------------------------*/ 121GEN_MENU_ATTR_GET_FCT(back) 122 123/*--------------------------------------------------------------------------- 124| Facility : libnmenu 125| Function : int set_menu_grey(MENU *menu, chtype attr) 126| 127| Description : Set the attribute for unselectable items. 128| 129| Return Values : E_OK - success 130| E_BAD_ARGUMENT - an invalid value has been passed 131+--------------------------------------------------------------------------*/ 132GEN_MENU_ATTR_SET_FCT(grey) 133 134/*--------------------------------------------------------------------------- 135| Facility : libnmenu 136| Function : chtype menu_grey(const MENU *menu) 137| 138| Description : Return the attribute used for non-selectable items 139| 140| Return Values : Attribute value 141+--------------------------------------------------------------------------*/ 142GEN_MENU_ATTR_GET_FCT(grey) 143 144/* m_attribs.c ends here */ 145