xref: /freebsd/contrib/ncurses/menu/m_sub.c (revision 640235e2c2ba32947f7c59d168437ffa1280f1e6)
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_sub                                                             *
35 * Menus subwindow association routines                                     *
36 ***************************************************************************/
37 
38 #include "menu.priv.h"
39 
40 MODULE_ID("$Id: m_sub.c,v 1.12 2010/01/23 21:20:11 tom Exp $")
41 
42 /*---------------------------------------------------------------------------
43 |   Facility      :  libnmenu
44 |   Function      :  int set_menu_sub(MENU *menu, WINDOW *win)
45 |
46 |   Description   :  Sets the subwindow of the menu.
47 |
48 |   Return Values :  E_OK           - success
49 |                    E_POSTED       - menu is already posted
50 +--------------------------------------------------------------------------*/
51 NCURSES_EXPORT(int)
52 set_menu_sub(MENU * menu, WINDOW *win)
53 {
54   T((T_CALLED("set_menu_sub(%p,%p)"), (void *)menu, (void *)win));
55 
56   if (menu)
57     {
58       if (menu->status & _POSTED)
59 	RETURN(E_POSTED);
60       else
61 #if NCURSES_SP_FUNCS
62 	{
63 	  /* We ensure that usersub is never null. So even if a null
64 	     WINDOW parameter is passed, we store the SCREENS stdscr.
65 	     The only MENU that can have a null usersub is the static
66 	     _nc_default_Menu.
67 	   */
68 	  SCREEN *sp = _nc_screen_of(menu->usersub);
69 
70 	  menu->usersub = win ? win : sp->_stdscr;
71 	  _nc_Calculate_Item_Length_and_Width(menu);
72 	}
73 #else
74 	menu->usersub = win;
75 #endif
76     }
77   else
78     _nc_Default_Menu.usersub = win;
79 
80   RETURN(E_OK);
81 }
82 
83 /*---------------------------------------------------------------------------
84 |   Facility      :  libnmenu
85 |   Function      :  WINDOW* menu_sub(const MENU *menu)
86 |
87 |   Description   :  Returns a pointer to the subwindow of the menu
88 |
89 |   Return Values :  NULL on error, otherwise a pointer to the window
90 +--------------------------------------------------------------------------*/
91 NCURSES_EXPORT(WINDOW *)
92 menu_sub(const MENU * menu)
93 {
94   const MENU *m = Normalize_Menu(menu);
95 
96   T((T_CALLED("menu_sub(%p)"), (const void *)menu));
97   returnWin(Get_Menu_Window(m));
98 }
99 
100 /* m_sub.c ends here */
101