96c2d84eb3af769ef23ba3701aa8e3f0f9351c8b
[ncurses.git] / menu / m_scale.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_scale                                                           *
35 * Menu scaling routine                                                     *
36 ***************************************************************************/
37
38 #include "menu.priv.h"
39
40 MODULE_ID("$Id: m_scale.c,v 1.9 2004/12/11 23:29:34 tom Exp $")
41
42 /*---------------------------------------------------------------------------
43 |   Facility      :  libnmenu  
44 |   Function      :  int scale_menu(const MENU *menu)
45 |   
46 |   Description   :  Returns the minimum window size necessary for the
47 |                    subwindow of menu.  
48 |
49 |   Return Values :  E_OK                  - success
50 |                    E_BAD_ARGUMENT        - invalid menu pointer
51 |                    E_NOT_CONNECTED       - no items are connected to menu
52 +--------------------------------------------------------------------------*/
53 NCURSES_EXPORT(int)
54 scale_menu(const MENU * menu, int *rows, int *cols)
55 {
56   T((T_CALLED("scale_menu(%p,%p,%p)"), menu, rows, cols));
57
58   if (!menu)
59     RETURN(E_BAD_ARGUMENT);
60
61   if (menu->items && *(menu->items))
62     {
63       if (rows)
64         *rows = menu->height;
65       if (cols)
66         *cols = menu->width;
67       RETURN(E_OK);
68     }
69   else
70     RETURN(E_NOT_CONNECTED);
71 }
72
73 /* m_scale.c ends here */