man/keyok.3x

   1 .\"***************************************************************************
   2 .\" Copyright 2018-2023,2024 Thomas E. Dickey                                *
   3 .\" Copyright 1998-2010,2017 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 .\" Author: Thomas E. Dickey 1997
  31 .\"
  32 .\" $Id: keyok.3x,v 1.40 2024/03/16 15:35:01 tom Exp $
  33 .TH keyok 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
  34 .SH NAME
  35 \fB\%keyok\fP \-
  36 enable or disable a \fIcurses\fR keycode
  37 .SH SYNOPSIS
  38 .nf
  39 \fB#include <curses.h>
  40 .PP
  41 \fBint keyok(int \fIkeycode\fP, bool \fIenable\fP);
  42 .fi
  43 .SH DESCRIPTION
  44 This is an extension to the \fIcurses\fP library.
  45 It permits an application to disable specific keycodes, rather than
  46 use the \fB\%keypad\fP function to disable all keycodes.
  47 Keys that have been disabled can be re-enabled.
  48 .SH RETURN VALUE
  49 The keycode must be greater than zero, else \fBERR\fP is returned.
  50 If it does not correspond to a defined key, then \fBERR\fP is returned.
  51 If the \fIenable\fP parameter is true, then the key must have been disabled,
  52 and vice versa.
  53 Otherwise, the function returns \fBOK\fP.
  54 .SH PORTABILITY
  55 This routine is specific to \fI\%ncurses\fP.
  56 It was not supported on
  57 Version 7, BSD or System V implementations.
  58 It is recommended that
  59 any code depending on them be conditioned using \fB\%NCURSES_VERSION\fP.
  60 .SH AUTHORS
  61 Thomas Dickey
  62 .SH SEE ALSO
  63 \fB\%define_key\fP(3X)