m_pad.c

   1 /****************************************************************************
   2  * Copyright 2020 Thomas E. Dickey                                          *
   3  * Copyright 1998-2010,2012 Free Software Foundation, Inc.                  *
   4  *                                                                          *
   5  * Permission is hereby granted, free of charge, to any person obtaining a  *
   6  * copy of this software and associated documentation files (the            *
   7  * "Software"), to deal in the Software without restriction, including      *
   8  * without limitation the rights to use, copy, modify, merge, publish,      *
   9  * distribute, distribute with modifications, sublicense, and/or sell       *
  10  * copies of the Software, and to permit persons to whom the Software is    *
  11  * furnished to do so, subject to the following conditions:                 *
  12  *                                                                          *
  13  * The above copyright notice and this permission notice shall be included  *
  14  * in all copies or substantial portions of the Software.                   *
  15  *                                                                          *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23  *                                                                          *
  24  * Except as contained in this notice, the name(s) of the above copyright   *
  25  * holders shall not be used in advertising or otherwise to promote the     *
  26  * sale, use or other dealings in this Software without prior written       *
  27  * authorization.                                                           *
  28  ****************************************************************************/
  29
  30 /****************************************************************************
  31  *   Author:  Juergen Pfeifer, 1995,1997                                    *
  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.14 2020/02/02 23:34:34 tom 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   T((T_CALLED("set_menu_pad(%p,%d)"), (void *)menu, pad));
  68
  69   if (!isprint(UChar(pad)))
  70     RETURN(E_BAD_ARGUMENT);
  71
  72   Normalize_Menu(menu);
  73   menu->pad = (unsigned char)pad;
  74
  75   if (do_refresh)
  76     Refresh_Menu(menu);
  77
  78   RETURN(E_OK);
  79 }
  80
  81 /*---------------------------------------------------------------------------
  82 |   Facility      :  libnmenu
  83 |   Function      :  int menu_pad(const MENU *menu)
  84 |
  85 |   Description   :  Return the value of the padding character
  86 |
  87 |   Return Values :  The pad character
  88 +--------------------------------------------------------------------------*/
  89 NCURSES_EXPORT(int)
  90 menu_pad(const MENU * menu)
  91 {
  92   T((T_CALLED("menu_pad(%p)"), (const void *)menu));
  93   returnCode(Normalize_Menu(menu)->pad);
  94 }
  95
  96 /* m_pad.c ends here */