Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / ae271bcd1ff942b3c4cb099f04bb5882f812da13 / . / doc / html / man / key_defined.3x.html
blob: 62d52d18f0d6453d5e2e47c23a7eb9798409f04b [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1<!--
2 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]3 * Copyright (c) 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 * Author: Thomas E. Dickey 2003
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]30 * @Id: key_defined.3x,v 1.6 2010/12/04 18:40:45 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]31-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]32<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]33<HTML>
34<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]35<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]37<TITLE>key_defined 3x</TITLE>
38<link rev=made href="mailto:bug-ncurses@gnu.org">
39<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40</HEAD>
41<BODY>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]42<H1 class="no-header">key_defined 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]44<STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG> <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>
45
46
47
48
49</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]50<H2><a name="h2-NAME">NAME</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]51 <STRONG>key_defined</STRONG> - check if a keycode is defined
52
53
54</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]55<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]56 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58 <STRONG>int</STRONG> <STRONG>key_defined(const</STRONG> <STRONG>char</STRONG> <STRONG>*definition);</STRONG>
59
60
61</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]62<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]63 This is an extension to the curses library. It permits an
64 application to determine if a string is currently bound to
65 any keycode.
66
67
68</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]69<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]70 If the string is bound to a keycode, its value (greater
71 than zero) is returned. If no keycode is bound, zero is
72 returned. If the string conflicts with longer strings
73 which are bound to keys, -1 is returned.
74
75
76</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]77<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]78 These routines are specific to ncurses. They were not
79 supported on Version 7, BSD or System V implementations.
80 It is recommended that any code depending on them be con-
81 ditioned using NCURSES_VERSION.
82
83
84</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]85<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]86 <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>.
87
88
89</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]90<H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]91 Thomas Dickey.
92
93
94
95 <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>
96</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]97<div class="nav">
98<ul>
99<li><a href="#h2-NAME">NAME</a></li>
100<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
101<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
102<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
103<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
104<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
105<li><a href="#h2-AUTHOR">AUTHOR</a></li>
106</ul>
107</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]108</BODY>
109</HTML>