menu/m_pad.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_pad                                                             *
  36 * Control menus padding character                                          *
  37 ***************************************************************************/
  38
  39 #include "menu.priv.h"
  40
  41 MODULE_ID("$Id: m_pad.c,v 1.6 2002/07/06 15:22:16 juergen Exp $")
  42
  43 /* Macro to redraw menu if it is posted and changed */
  44 #define Refresh_Menu(menu) \
  45    if ( (menu) && ((menu)->status & _POSTED) )\
  46    {\
  47       _nc_Draw_Menu( menu );\
  48       _nc_Show_Menu( menu );\
  49    }
  50
  51 /*---------------------------------------------------------------------------
  52 |   Facility      :  libnmenu
  53 |   Function      :  int set_menu_pad(MENU *menu, int pad)
  54 |
  55 |   Description   :  Set the character to be used to separate the item name
  56 |                    from its description. This must be a printable
  57 |                    character.
  58 |
  59 |   Return Values :  E_OK              - success
  60 |                    E_BAD_ARGUMENT    - an invalid value has been passed
  61 +--------------------------------------------------------------------------*/
  62 NCURSES_EXPORT(int)
  63 set_menu_pad (MENU *menu, int pad)
  64 {
  65   bool do_refresh = (menu != (MENU*)0);
  66
  67   if (!isprint((unsigned char)pad))
  68     RETURN(E_BAD_ARGUMENT);
  69
  70   Normalize_Menu( menu );
  71   menu->pad = pad;
  72
  73   if (do_refresh)
  74       Refresh_Menu( menu );
  75
  76   RETURN(E_OK);
  77 }
  78
  79 /*---------------------------------------------------------------------------
  80 |   Facility      :  libnmenu
  81 |   Function      :  int menu_pad(const MENU *menu)
  82 |
  83 |   Description   :  Return the value of the padding character
  84 |
  85 |   Return Values :  The pad character
  86 +--------------------------------------------------------------------------*/
  87 NCURSES_EXPORT(int)
  88 menu_pad (const MENU * menu)
  89 {
  90   return (Normalize_Menu( menu ) -> pad);
  91 }
  92
  93 /* m_pad.c ends here */