usr/src/man/man3xcurses/keyname.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH KEYNAME 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 keyname, key_name \- return character string used as key name
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBchar *\fR\fBkeyname\fR(\fBint\fR \fIc\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBchar *\fR\fBkey_name\fR(\fBwchar_t\fR \fIwc\fR);
  25 .fi
  26
  27 .SH PARAMETERS
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIc\fR\fR
  32 .ad
  33 .RS 6n
  34 Is an 8 bit-character or a key code.
  35 .RE
  36
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBwc\fR\fR
  41 .ad
  42 .RS 6n
  43 Is a wide character key name.
  44 .RE
  45
  46 .SH DESCRIPTION
  47 .sp
  48 .LP
  49 The \fBkeyname()\fR function returns a string pointer to the key name.   Make a
  50 duplicate copy of the returned string if you plan to modify it.
  51 .sp
  52 .LP
  53 The \fBkey_name()\fR function is similar except that it accepts a wide
  54 character key name.
  55 .sp
  56 .LP
  57 The following table shows the format of the key name based on the input.
  58 .sp
  59
  60 .sp
  61 .TS
  62 box;
  63 l l
  64 l l .
  65 \fBInput\fR     \fBFormat of Key Name\fR
  66 Visible character       The same character
  67 Control character       \fB^\fR\fIX\fR
  68 Meta-character (\fBkeyname()\fR only)   \fBM-\fR\fIX\fR
  69 T{
  70 Key value defined in \fB<curses.h>\fR (\fBkeyname()\fR only)
  71 T}      \fBKEY_\fR\fIname\fR
  72 None of the above       \fBUNKNOWN KEY\fR
  73 .TE
  74
  75 .sp
  76 .LP
  77 In the preceding table, \fIX\fR can be either a visible character with the high
  78 bit cleared or a control character.
  79 .SH RETURN VALUES
  80 .sp
  81 .LP
  82 On success, these functions return a pointer to the string used as the key's
  83 name. Otherwise, they return a null pointer.
  84 .SH ERRORS
  85 .sp
  86 .LP
  87 None.
  88 .SH ATTRIBUTES
  89 .sp
  90 .LP
  91 See \fBattributes\fR(5) for descriptions of the following attributes:
  92 .sp
  93
  94 .sp
  95 .TS
  96 box;
  97 c | c
  98 l | l .
  99 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 100 _
 101 Interface Stability     Standard
 102 _
 103 MT-Level        Unsafe
 104 .TE
 105
 106 .SH SEE ALSO
 107 .sp
 108 .LP
 109 \fBlibcurses\fR(3XCURSES), \fBmeta\fR(3XCURSES), \fBattributes\fR(5),
 110 \fBstandards\fR(5)