ncurses 5.3
[ncurses.git] / menu / m_spacing.c
1 /****************************************************************************
2  * Copyright (c) 1998,2000 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  *   Contact: http://www.familiepfeifer.de/Contact.aspx?Lang=en             *
32  ****************************************************************************/
33
34 /***************************************************************************
35 * Module m_spacing                                                         *
36 * Routines to handle spacing between entries                               *
37 ***************************************************************************/
38
39 #include "menu.priv.h"
40
41 MODULE_ID("$Id: m_spacing.c,v 1.13 2002/07/06 15:22:16 juergen Exp $")
42
43 #define MAX_SPC_DESC ((TABSIZE) ? (TABSIZE) : 8)
44 #define MAX_SPC_COLS ((TABSIZE) ? (TABSIZE) : 8)
45 #define MAX_SPC_ROWS (3)
46
47 /*---------------------------------------------------------------------------
48 |   Facility      :  libnmenu
49 |   Function      :  int set_menu_spacing(MENU *menu,int desc, int r, int c);
50 |
51 |   Description   :  Set the spacing between entried
52 |
53 |   Return Values :  E_OK                 - on success
54 +--------------------------------------------------------------------------*/
55 NCURSES_EXPORT(int)
56 set_menu_spacing
57 (MENU *menu, int s_desc, int s_row, int s_col )
58 {
59   MENU *m; /* split for ATAC workaround */
60   m = Normalize_Menu(menu);
61
62   assert(m);
63   if (m->status & _POSTED)
64     RETURN(E_POSTED);
65
66   if (((s_desc < 0) || (s_desc > MAX_SPC_DESC)) ||
67       ((s_row  < 0) || (s_row  > MAX_SPC_ROWS)) ||
68       ((s_col  < 0) || (s_col  > MAX_SPC_COLS)))
69     RETURN(E_BAD_ARGUMENT);
70
71   m->spc_desc = s_desc ? s_desc : 1;
72   m->spc_rows = s_row  ? s_row  : 1;
73   m->spc_cols = s_col  ? s_col  : 1;
74   _nc_Calculate_Item_Length_and_Width(m);
75
76   RETURN(E_OK);
77 }
78
79
80 /*---------------------------------------------------------------------------
81 |   Facility      :  libnmenu
82 |   Function      :  int menu_spacing (const MENU *,int *,int *,int *);
83 |
84 |   Description   :  Retrieve info about spacing between the entries
85 |
86 |   Return Values :  E_OK             - on success
87 +--------------------------------------------------------------------------*/
88 NCURSES_EXPORT(int)
89 menu_spacing ( const MENU *menu, int* s_desc, int* s_row, int* s_col)
90 {
91   const MENU *m; /* split for ATAC workaround */
92   m = Normalize_Menu(menu);
93
94   assert(m);
95   if (s_desc) *s_desc = m->spc_desc;
96   if (s_row)  *s_row  = m->spc_rows;
97   if (s_col)  *s_col  = m->spc_cols;
98
99   RETURN(E_OK);
100 }
101
102 /* m_spacing.c ends here */