Sync usage with man page.
[netbsd-mini2440.git] / lib / libcurses / keypad.c
blobe223ca1ac5110154275e79a40c038638a2ab9324
1 /* $NetBSD: keypad.c,v 1.10 2007/01/21 13:25:36 jdc Exp $ */
3 /*-
4 * Copyright (c) 1998-1999 Brett Lymn (blymn@baea.com.au, brett_lymn@yahoo.com)
5 * All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. The name of the author may not be used to endorse or promote products
13 * derived from this software without specific prior written permission
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 #include <sys/cdefs.h>
30 #ifndef lint
31 __RCSID("$NetBSD: keypad.c,v 1.10 2007/01/21 13:25:36 jdc Exp $");
32 #endif /* not lint */
34 #include "curses.h"
35 #include "curses_private.h"
38 * keypad --
39 * Turn on and off interpretation of function/keypad keys in the
40 * given window.
42 int
43 keypad(WINDOW *win, bool bf)
45 #ifdef DEBUG
46 __CTRACE(__CTRACE_MISC,
47 "keypad: win %p, %s\n", win, bf ? "TRUE" : "FALSE");
48 #endif
49 if (bf) {
50 win->flags |= __KEYPAD;
51 if (!(curscr->flags & __KEYPAD)) {
52 tputs (__tc_ks, 0, __cputchar);
53 curscr->flags |= __KEYPAD;
55 } else
56 win->flags &= ~__KEYPAD;
58 return OK;