ncurses 5.6 - patch 20070812
[ncurses.git] / ncurses / base / lib_slkclear.c
1 /****************************************************************************
2  * Copyright (c) 1998-2001,2006 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: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
32  ****************************************************************************/
33
34 /*
35  *      lib_slkclear.c
36  *      Soft key routines.
37  *      Remove soft labels from the screen.
38  */
39 #include <curses.priv.h>
40
41 MODULE_ID("$Id: lib_slkclear.c,v 1.9 2006/05/27 19:21:19 tom Exp $")
42
43 NCURSES_EXPORT(int)
44 slk_clear(void)
45 {
46     T((T_CALLED("slk_clear()")));
47
48     if (SP == NULL || SP->_slk == NULL)
49         returnCode(ERR);
50     SP->_slk->hidden = TRUE;
51     /* For simulated SLK's it's looks much more natural to
52        inherit those attributes from the standard screen */
53     SP->_slk->win->_nc_bkgd = stdscr->_nc_bkgd;
54     WINDOW_ATTRS(SP->_slk->win) = WINDOW_ATTRS(stdscr);
55     if (SP->_slk->win == stdscr) {
56         returnCode(OK);
57     } else {
58         werase(SP->_slk->win);
59         returnCode(wrefresh(SP->_slk->win));
60     }
61 }