xref: /openbsd/lib/libmenu/m_pad.c (revision 274d7c50)
1 /* $OpenBSD: m_pad.c,v 1.5 2010/01/12 23:22:08 nicm Exp $ */
2 
3 /****************************************************************************
4  * Copyright (c) 1998-2003,2004 Free Software Foundation, Inc.              *
5  *                                                                          *
6  * Permission is hereby granted, free of charge, to any person obtaining a  *
7  * copy of this software and associated documentation files (the            *
8  * "Software"), to deal in the Software without restriction, including      *
9  * without limitation the rights to use, copy, modify, merge, publish,      *
10  * distribute, distribute with modifications, sublicense, and/or sell       *
11  * copies of the Software, and to permit persons to whom the Software is    *
12  * furnished to do so, subject to the following conditions:                 *
13  *                                                                          *
14  * The above copyright notice and this permission notice shall be included  *
15  * in all copies or substantial portions of the Software.                   *
16  *                                                                          *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24  *                                                                          *
25  * Except as contained in this notice, the name(s) of the above copyright   *
26  * holders shall not be used in advertising or otherwise to promote the     *
27  * sale, use or other dealings in this Software without prior written       *
28  * authorization.                                                           *
29  ****************************************************************************/
30 
31 /****************************************************************************
32  *   Author:  Juergen Pfeifer, 1995,1997                                    *
33  ****************************************************************************/
34 
35 /***************************************************************************
36 * Module m_pad                                                             *
37 * Control menus padding character                                          *
38 ***************************************************************************/
39 
40 #include "menu.priv.h"
41 
42 MODULE_ID("$Id: m_pad.c,v 1.5 2010/01/12 23:22:08 nicm Exp $")
43 
44 /* Macro to redraw menu if it is posted and changed */
45 #define Refresh_Menu(menu) \
46    if ( (menu) && ((menu)->status & _POSTED) )\
47    {\
48       _nc_Draw_Menu( menu );\
49       _nc_Show_Menu( menu );\
50    }
51 
52 /*---------------------------------------------------------------------------
53 |   Facility      :  libnmenu
54 |   Function      :  int set_menu_pad(MENU *menu, int pad)
55 |
56 |   Description   :  Set the character to be used to separate the item name
57 |                    from its description. This must be a printable
58 |                    character.
59 |
60 |   Return Values :  E_OK              - success
61 |                    E_BAD_ARGUMENT    - an invalid value has been passed
62 +--------------------------------------------------------------------------*/
63 NCURSES_EXPORT(int)
64 set_menu_pad(MENU * menu, int pad)
65 {
66   bool do_refresh = (menu != (MENU *) 0);
67 
68   T((T_CALLED("set_menu_pad(%p,%d)"), menu, pad));
69 
70   if (!isprint(UChar(pad)))
71     RETURN(E_BAD_ARGUMENT);
72 
73   Normalize_Menu(menu);
74   menu->pad = pad;
75 
76   if (do_refresh)
77     Refresh_Menu(menu);
78 
79   RETURN(E_OK);
80 }
81 
82 /*---------------------------------------------------------------------------
83 |   Facility      :  libnmenu
84 |   Function      :  int menu_pad(const MENU *menu)
85 |
86 |   Description   :  Return the value of the padding character
87 |
88 |   Return Values :  The pad character
89 +--------------------------------------------------------------------------*/
90 NCURSES_EXPORT(int)
91 menu_pad(const MENU * menu)
92 {
93   T((T_CALLED("menu_pad(%p)"), menu));
94   returnCode(Normalize_Menu(menu)->pad);
95 }
96 
97 /* m_pad.c ends here */
98