← Back to branch summary

~peter-pearse/ubuntu/natty/libx11/prop001

« back to all changes in this revision

Viewing changes to man/xkb/XkbLookupKeySym.man

  • Committer: Bazaar Package Importer
  • Author(s): Julien Cristau, Julien Cristau, Josh Triplett
  • Date: 2007-08-02 04:13:46 UTC
  • mfrom: (1.1.4 upstream) (2.1.1 etch)
  • Revision ID: james.westby@ubuntu.com-20070802041346-yvhplp1k16naqg3c
Tags: 2:1.1.3-1
http://bugs.debian.org/427296
http://bugs.debian.org/431421
http://bugs.debian.org/133348
http://bugs.debian.org/393434
[ Julien Cristau ]
* New upstream release.
  + Fix locking in _XimGetWindowEventmask (closes: #427296).
  + fix XGetMotionEvents arguments order (closes: #431421).
  + XGetCommand(3) clarified (closes: #133348).
  + XrmCombineDatabase(3) fixed (closes: #393434).
* Install the upstream NEWS file in libx11-6 in addition to the git
  changelog.
* Use binary:Version instead of Source-Version in debian/control.

[ Josh Triplett ]
* Expand the description of the problem with Sun Java in libx11-6.NEWS.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/xkb/XkbLookupKeySym.man
 
1
.\" Copyright (c) 1999 - Sun Microsystems, Inc.
 
2
.\" All rights reserved.
 
3
.\" 
 
4
.\" Permission is hereby granted, free of charge, to any person obtaining a
 
5
.\" copy of this software and associated documentation files (the
 
6
.\" "Software"), to deal in the Software without restriction, including
 
7
.\" without limitation the rights to use, copy, modify, merge, publish,
 
8
.\" distribute, and/or sell copies of the Software, and to permit persons
 
9
.\" to whom the Software is furnished to do so, provided that the above
 
10
.\" copyright notice(s) and this permission notice appear in all copies of
 
11
.\" the Software and that both the above copyright notice(s) and this
 
12
.\" permission notice appear in supporting documentation.
 
13
.\" 
 
14
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 
15
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 
16
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
 
17
.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 
18
.\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
 
19
.\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
 
20
.\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 
21
.\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 
22
.\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
23
.\" 
 
24
.\" Except as contained in this notice, the name of a copyright holder
 
25
.\" shall not be used in advertising or otherwise to promote the sale, use
 
26
.\" or other dealings in this Software without prior written authorization
 
27
.\" of the copyright holder.
 
28
.\"
 
29
.TH XkbLookupKeySym __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
 
30
.SH NAME
 
31
XkbLookupKeySym \- Find the symbol associated with a key for a particular state
 
32
.SH SYNOPSIS
 
33
.B Bool XkbLookupKeySym
 
34
(
 
35
.I dpy,
 
36
.I key,
 
37
.I state,
 
38
.I mods_rtrn,
 
39
.I sym_rtrn
 
40
)
 
41
.br
 
42
      Display *\fIdpy\fP\^;
 
43
.br
 
44
      KeyCode \fIkey\fP\^;
 
45
.br
 
46
      unsigned int \fIstate\fP\^;
 
47
.br
 
48
      unsigned int *\fImods_rtrn\fP\^;
 
49
.br
 
50
      KeySym *\fIsym_rtrn\fP\^;
 
51
.if n .ti +5n
 
52
.if t .ti +.5i
 
53
.SH ARGUMENTS
 
54
.TP
 
55
.I \- dpy
 
56
connection to X server
 
57
.TP
 
58
.I \- key
 
59
key for which symbols are to be found
 
60
.TP
 
61
.I \- state
 
62
state for which symbol should be found
 
63
.TP
 
64
.I \- mods_rtrn
 
65
backfilled with unconsumed modifiers
 
66
.TP
 
67
.I \- sym_rtrn
 
68
backfilled with symbol associated with key + state
 
69
.SH DESCRIPTION
 
70
.LP
 
71
.I XkbLookupKeySym 
 
72
is the equivalent of the core 
 
73
.I XLookupKeySym 
 
74
function. For the core keyboard, given a keycode 
 
75
.I key 
 
76
and an Xkb state 
 
77
.I state, XkbLookupKeySym 
 
78
returns the symbol associated with the key in 
 
79
.I sym_rtrn 
 
80
and the list of modifiers that should still be applied in 
 
81
.I mods_rtrn. 
 
82
The 
 
83
.I state 
 
84
parameter is the state from a KeyPress or KeyRelease event. 
 
85
.I XkbLookupKeySym 
 
86
returns True if it succeeds.
 
87
.SH "SEE ALSO"
 
88
.BR XLookupKeySym (3X11)
 
89