xref: /freebsd/contrib/ncurses/menu/m_opts.c (revision 06bfebdedb0d353f1771adb65731f64461d9bd01)
10e3d5408SPeter Wemm /****************************************************************************
2*06bfebdeSXin LI  * Copyright (c) 1998-2004,2010 Free Software Foundation, Inc.              *
30e3d5408SPeter Wemm  *                                                                          *
40e3d5408SPeter Wemm  * Permission is hereby granted, free of charge, to any person obtaining a  *
50e3d5408SPeter Wemm  * copy of this software and associated documentation files (the            *
60e3d5408SPeter Wemm  * "Software"), to deal in the Software without restriction, including      *
70e3d5408SPeter Wemm  * without limitation the rights to use, copy, modify, merge, publish,      *
80e3d5408SPeter Wemm  * distribute, distribute with modifications, sublicense, and/or sell       *
90e3d5408SPeter Wemm  * copies of the Software, and to permit persons to whom the Software is    *
100e3d5408SPeter Wemm  * furnished to do so, subject to the following conditions:                 *
110e3d5408SPeter Wemm  *                                                                          *
120e3d5408SPeter Wemm  * The above copyright notice and this permission notice shall be included  *
130e3d5408SPeter Wemm  * in all copies or substantial portions of the Software.                   *
140e3d5408SPeter Wemm  *                                                                          *
150e3d5408SPeter Wemm  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
160e3d5408SPeter Wemm  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
170e3d5408SPeter Wemm  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
180e3d5408SPeter Wemm  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
190e3d5408SPeter Wemm  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
200e3d5408SPeter Wemm  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
210e3d5408SPeter Wemm  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
220e3d5408SPeter Wemm  *                                                                          *
230e3d5408SPeter Wemm  * Except as contained in this notice, the name(s) of the above copyright   *
240e3d5408SPeter Wemm  * holders shall not be used in advertising or otherwise to promote the     *
250e3d5408SPeter Wemm  * sale, use or other dealings in this Software without prior written       *
260e3d5408SPeter Wemm  * authorization.                                                           *
270e3d5408SPeter Wemm  ****************************************************************************/
280e3d5408SPeter Wemm 
290e3d5408SPeter Wemm /****************************************************************************
304a1a9510SRong-En Fan  *   Author:  Juergen Pfeifer, 1995,1997                                    *
310e3d5408SPeter Wemm  ****************************************************************************/
320e3d5408SPeter Wemm 
330e3d5408SPeter Wemm /***************************************************************************
340e3d5408SPeter Wemm * Module m_opts                                                            *
350e3d5408SPeter Wemm * Menus option routines                                                    *
360e3d5408SPeter Wemm ***************************************************************************/
370e3d5408SPeter Wemm 
380e3d5408SPeter Wemm #include "menu.priv.h"
390e3d5408SPeter Wemm 
40*06bfebdeSXin LI MODULE_ID("$Id: m_opts.c,v 1.20 2010/01/23 21:20:10 tom Exp $")
410e3d5408SPeter Wemm 
420e3d5408SPeter Wemm /*---------------------------------------------------------------------------
430e3d5408SPeter Wemm |   Facility      :  libnmenu
440e3d5408SPeter Wemm |   Function      :  int set_menu_opts(MENU *menu, Menu_Options opts)
450e3d5408SPeter Wemm |
460e3d5408SPeter Wemm |   Description   :  Set the options for this menu. If the new settings
470e3d5408SPeter Wemm |                    end up in a change of the geometry of the menu, it
480e3d5408SPeter Wemm |                    will be recalculated. This operation is forbidden if
490e3d5408SPeter Wemm |                    the menu is already posted.
500e3d5408SPeter Wemm |
510e3d5408SPeter Wemm |   Return Values :  E_OK           - success
520e3d5408SPeter Wemm |                    E_BAD_ARGUMENT - invalid menu options
530e3d5408SPeter Wemm |                    E_POSTED       - menu is already posted
540e3d5408SPeter Wemm +--------------------------------------------------------------------------*/
557a69bbfbSPeter Wemm NCURSES_EXPORT(int)
567a69bbfbSPeter Wemm set_menu_opts(MENU * menu, Menu_Options opts)
570e3d5408SPeter Wemm {
58*06bfebdeSXin LI   T((T_CALLED("set_menu_opts(%p,%d)"), (void *)menu, opts));
594a1a9510SRong-En Fan 
600e3d5408SPeter Wemm   opts &= ALL_MENU_OPTS;
610e3d5408SPeter Wemm 
620e3d5408SPeter Wemm   if (opts & ~ALL_MENU_OPTS)
630e3d5408SPeter Wemm     RETURN(E_BAD_ARGUMENT);
640e3d5408SPeter Wemm 
650e3d5408SPeter Wemm   if (menu)
660e3d5408SPeter Wemm     {
670e3d5408SPeter Wemm       if (menu->status & _POSTED)
680e3d5408SPeter Wemm 	RETURN(E_POSTED);
690e3d5408SPeter Wemm 
700e3d5408SPeter Wemm       if ((opts & O_ROWMAJOR) != (menu->opt & O_ROWMAJOR))
710e3d5408SPeter Wemm 	{
720e3d5408SPeter Wemm 	  /* we need this only if the layout really changed ... */
730e3d5408SPeter Wemm 	  if (menu->items && menu->items[0])
740e3d5408SPeter Wemm 	    {
750e3d5408SPeter Wemm 	      menu->toprow = 0;
760e3d5408SPeter Wemm 	      menu->curitem = menu->items[0];
770e3d5408SPeter Wemm 	      assert(menu->curitem);
780e3d5408SPeter Wemm 	      set_menu_format(menu, menu->frows, menu->fcols);
790e3d5408SPeter Wemm 	    }
800e3d5408SPeter Wemm 	}
810e3d5408SPeter Wemm 
820e3d5408SPeter Wemm       menu->opt = opts;
830e3d5408SPeter Wemm 
840e3d5408SPeter Wemm       if (opts & O_ONEVALUE)
850e3d5408SPeter Wemm 	{
860e3d5408SPeter Wemm 	  ITEM **item;
870e3d5408SPeter Wemm 
880e3d5408SPeter Wemm 	  if (((item = menu->items) != (ITEM **) 0))
890e3d5408SPeter Wemm 	    for (; *item; item++)
900e3d5408SPeter Wemm 	      (*item)->value = FALSE;
910e3d5408SPeter Wemm 	}
920e3d5408SPeter Wemm 
930e3d5408SPeter Wemm       if (opts & O_SHOWDESC)	/* this also changes the geometry */
940e3d5408SPeter Wemm 	_nc_Calculate_Item_Length_and_Width(menu);
950e3d5408SPeter Wemm     }
960e3d5408SPeter Wemm   else
970e3d5408SPeter Wemm     _nc_Default_Menu.opt = opts;
980e3d5408SPeter Wemm 
990e3d5408SPeter Wemm   RETURN(E_OK);
1000e3d5408SPeter Wemm }
1010e3d5408SPeter Wemm 
1020e3d5408SPeter Wemm /*---------------------------------------------------------------------------
1030e3d5408SPeter Wemm |   Facility      :  libnmenu
1040e3d5408SPeter Wemm |   Function      :  int menu_opts_off(MENU *menu, Menu_Options opts)
1050e3d5408SPeter Wemm |
1060e3d5408SPeter Wemm |   Description   :  Switch off the options for this menu. If the new settings
1070e3d5408SPeter Wemm |                    end up in a change of the geometry of the menu, it
1080e3d5408SPeter Wemm |                    will be recalculated. This operation is forbidden if
1090e3d5408SPeter Wemm |                    the menu is already posted.
1100e3d5408SPeter Wemm |
1110e3d5408SPeter Wemm |   Return Values :  E_OK           - success
1120e3d5408SPeter Wemm |                    E_BAD_ARGUMENT - invalid options
1130e3d5408SPeter Wemm |                    E_POSTED       - menu is already posted
1140e3d5408SPeter Wemm +--------------------------------------------------------------------------*/
1157a69bbfbSPeter Wemm NCURSES_EXPORT(int)
1167a69bbfbSPeter Wemm menu_opts_off(MENU * menu, Menu_Options opts)
1170e3d5408SPeter Wemm {
1180e3d5408SPeter Wemm   MENU *cmenu = menu;		/* use a copy because set_menu_opts must detect
1194a1a9510SRong-En Fan 
1204a1a9510SRong-En Fan 				   NULL menu itself to adjust its behavior */
1214a1a9510SRong-En Fan 
122*06bfebdeSXin LI   T((T_CALLED("menu_opts_off(%p,%d)"), (void *)menu, opts));
1230e3d5408SPeter Wemm 
1240e3d5408SPeter Wemm   opts &= ALL_MENU_OPTS;
1250e3d5408SPeter Wemm   if (opts & ~ALL_MENU_OPTS)
1260e3d5408SPeter Wemm     RETURN(E_BAD_ARGUMENT);
1270e3d5408SPeter Wemm   else
1280e3d5408SPeter Wemm     {
1290e3d5408SPeter Wemm       Normalize_Menu(cmenu);
1300e3d5408SPeter Wemm       opts = cmenu->opt & ~opts;
1314a1a9510SRong-En Fan       returnCode(set_menu_opts(menu, opts));
1320e3d5408SPeter Wemm     }
1330e3d5408SPeter Wemm }
1340e3d5408SPeter Wemm 
1350e3d5408SPeter Wemm /*---------------------------------------------------------------------------
1360e3d5408SPeter Wemm |   Facility      :  libnmenu
1370e3d5408SPeter Wemm |   Function      :  int menu_opts_on(MENU *menu, Menu_Options opts)
1380e3d5408SPeter Wemm |
1390e3d5408SPeter Wemm |   Description   :  Switch on the options for this menu. If the new settings
1400e3d5408SPeter Wemm |                    end up in a change of the geometry of the menu, it
1410e3d5408SPeter Wemm |                    will be recalculated. This operation is forbidden if
1420e3d5408SPeter Wemm |                    the menu is already posted.
1430e3d5408SPeter Wemm |
1440e3d5408SPeter Wemm |   Return Values :  E_OK           - success
1450e3d5408SPeter Wemm |                    E_BAD_ARGUMENT - invalid menu options
1460e3d5408SPeter Wemm |                    E_POSTED       - menu is already posted
1470e3d5408SPeter Wemm +--------------------------------------------------------------------------*/
1487a69bbfbSPeter Wemm NCURSES_EXPORT(int)
1497a69bbfbSPeter Wemm menu_opts_on(MENU * menu, Menu_Options opts)
1500e3d5408SPeter Wemm {
1510e3d5408SPeter Wemm   MENU *cmenu = menu;		/* use a copy because set_menu_opts must detect
1524a1a9510SRong-En Fan 
1534a1a9510SRong-En Fan 				   NULL menu itself to adjust its behavior */
1544a1a9510SRong-En Fan 
155*06bfebdeSXin LI   T((T_CALLED("menu_opts_on(%p,%d)"), (void *)menu, opts));
1560e3d5408SPeter Wemm 
1570e3d5408SPeter Wemm   opts &= ALL_MENU_OPTS;
1580e3d5408SPeter Wemm   if (opts & ~ALL_MENU_OPTS)
1590e3d5408SPeter Wemm     RETURN(E_BAD_ARGUMENT);
1600e3d5408SPeter Wemm   else
1610e3d5408SPeter Wemm     {
1620e3d5408SPeter Wemm       Normalize_Menu(cmenu);
1630e3d5408SPeter Wemm       opts = cmenu->opt | opts;
1644a1a9510SRong-En Fan       returnCode(set_menu_opts(menu, opts));
1650e3d5408SPeter Wemm     }
1660e3d5408SPeter Wemm }
1670e3d5408SPeter Wemm 
1680e3d5408SPeter Wemm /*---------------------------------------------------------------------------
1690e3d5408SPeter Wemm |   Facility      :  libnmenu
1700e3d5408SPeter Wemm |   Function      :  Menu_Options menu_opts(const MENU *menu)
1710e3d5408SPeter Wemm |
1720e3d5408SPeter Wemm |   Description   :  Return the options for this menu.
1730e3d5408SPeter Wemm |
1740e3d5408SPeter Wemm |   Return Values :  Menu options
1750e3d5408SPeter Wemm +--------------------------------------------------------------------------*/
1767a69bbfbSPeter Wemm NCURSES_EXPORT(Menu_Options)
1777a69bbfbSPeter Wemm menu_opts(const MENU * menu)
1780e3d5408SPeter Wemm {
179*06bfebdeSXin LI   T((T_CALLED("menu_opts(%p)"), (const void *)menu));
1804a1a9510SRong-En Fan   returnMenuOpts(ALL_MENU_OPTS & Normalize_Menu(menu)->opt);
1810e3d5408SPeter Wemm }
1820e3d5408SPeter Wemm 
1830e3d5408SPeter Wemm /* m_opts.c ends here */
184