79659aa233fbd82c3f4ce8e8ee974f49e8be57c4
[ncurses.git] / menu / m_pad.c
1 /****************************************************************************
2  * Copyright (c) 1998-2003,2004 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_pad                                                             *
35 * Control menus padding character                                          *
36 ***************************************************************************/
37
38 #include "menu.priv.h"
39
40 MODULE_ID("$Id: m_pad.c,v 1.11 2009/02/07 23:11:44 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 /*---------------------------------------------------------------------------
51 |   Facility      :  libnmenu  
52 |   Function      :  int set_menu_pad(MENU* menu, int pad)
53 |   
54 |   Description   :  Set the character to be used to separate the item name
55 |                    from its description. This must be a printable 
56 |                    character.
57 |
58 |   Return Values :  E_OK              - success
59 |                    E_BAD_ARGUMENT    - an invalid value has been passed
60 +--------------------------------------------------------------------------*/
61 NCURSES_EXPORT(int)
62 set_menu_pad(MENU * menu, int pad)
63 {
64   bool do_refresh = (menu != (MENU *) 0);
65
66   T((T_CALLED("set_menu_pad(%p,%d)"), menu, pad));
67
68   if (!isprint(UChar(pad)))
69     RETURN(E_BAD_ARGUMENT);
70
71   Normalize_Menu(menu);
72   menu->pad = pad;
73
74   if (do_refresh)
75     Refresh_Menu(menu);
76
77   RETURN(E_OK);
78 }
79
80 /*---------------------------------------------------------------------------
81 |   Facility      :  libnmenu  
82 |   Function      :  int menu_pad(const MENU *menu)
83 |   
84 |   Description   :  Return the value of the padding character
85 |
86 |   Return Values :  The pad character
87 +--------------------------------------------------------------------------*/
88 NCURSES_EXPORT(int)
89 menu_pad(const MENU * menu)
90 {
91   T((T_CALLED("menu_pad(%p)"), menu));
92   returnCode(Normalize_Menu(menu)->pad);
93 }
94
95 /* m_pad.c ends here */