Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / refs/heads/android-16 / . / man / key_defined.3x
blob: f0184aa77df170411e248dceacdcefd17b478bb2 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1.\"***************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]2.\" Copyright 2018-2023,2024 Thomas E. Dickey *
3.\" Copyright 2003-2006,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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 2003
31.\"
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]32.\" $Id: key_defined.3x,v 1.34 2024/03/16 15:35:01 tom Exp $
33.TH key_defined 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]34.SH NAME
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]35\fB\%key_defined\fP \-
36test whether a \fIcurses\fR keycode is defined
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]37.SH SYNOPSIS
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]38.nf
39\fB#include <curses.h>
40.PP
41\fBint key_defined(const char *\fIdefinition\fP);
42.fi
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43.SH DESCRIPTION
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]44This is an extension to the \fIcurses\fP library.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]45It permits an application to determine if a string is currently bound
46to any keycode.
47.SH RETURN VALUE
48If the string is bound to a keycode, its value (greater than zero) is returned.
49If no keycode is bound, zero is returned.
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]50If the string conflicts with longer strings
51which are bound to keys, \-1 is returned.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]52.SH PORTABILITY
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]53This routine is specific to \fI\%ncurses\fP.
54It was not supported on
55Version 7, BSD or System V implementations.
56It is recommended that
57any code depending on them be conditioned using \fB\%NCURSES_VERSION\fP.
58.SH AUTHORS
59Thomas Dickey
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]60.SH SEE ALSO
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]61\fB\%define_key\fP(3X)