← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/vnc4/gutsy

« back to all changes in this revision

Viewing changes to unix/xc/doc/man/Xi/XSelExtEv.man

  • Committer: Bazaar Package Importer
  • Author(s): Ola Lundqvist
  • Date: 2006-05-15 20:35:17 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060515203517-l4lre1ku942mn26k
Tags: 4.1.1+X4.3.0-10
* Correction of critical security issue. Thanks to Martin Kogler
  <e9925248@student.tuwien.ac.at> that informed me about the issue,
  and provided the patch.
  This flaw was originally found by Steve Wiseman of intelliadmin.com.
* Applied patch from Javier Kohen <jkohen@users.sourceforge.net> that
  inform the user that only 8 first characters of the password will
  actually be used when typing more than 8 characters, closes:
  #355619.

Show diffs side-by-side

added added

removed removed

Lines of Context:
unix/xc/doc/man/Xi/XSelExtEv.man
 
1
.\"
 
2
.\" $XFree86: xc/doc/man/Xi/XSelExtEv.man,v 1.2 2001/01/27 18:20:22 dawes Exp $
 
3
.\"
 
4
.\"
 
5
.\" Copyright ([\d,\s]*) by Hewlett-Packard Company, Ardent Computer, 
 
6
.\" 
 
7
.\" Permission to use, copy, modify, distribute, and sell this documentation 
 
8
.\" for any purpose and without fee is hereby granted, provided that the above
 
9
.\" copyright notice and this permission notice appear in all copies.
 
10
.\" Ardent, and Hewlett-Packard make no representations about the 
 
11
.\" suitability for any purpose of the information in this document.  It is 
 
12
.\" provided \`\`as is'' without express or implied warranty.
 
13
.\" 
 
14
.\" $Xorg: XSelExtEv.man,v 1.3 2000/08/17 19:41:57 cpqbld Exp $
 
15
.ds xL Programming with Xlib
 
16
.TH XSelectExtensionEvent 3X11 __xorgversion__ "X FUNCTIONS"
 
17
.SH NAME
 
18
XSelectExtensionEvent, XGetSelectedExtensionEvents \- select extension events, get the list of currently selected extension events
 
19
.SH SYNTAX
 
20
XSelectExtensionEvent\^(\^\fIdisplay\fP, \fIw\fP\^, \fIevent_list\fP\^, \fIevent_count\fP\^)
 
21
.br
 
22
      Display *\fIdisplay\fP\^;
 
23
.br
 
24
      Window \fIw\fP\^;
 
25
.br
 
26
      XEventClass *\fIevent_list\fP\^;
 
27
.br
 
28
      int \fIevent_count\fP\^;
 
29
.sp 
 
30
XGetSelectedExtensionEvents\^(\^\fIdisplay\fP, \fIw\fP\^, \fIthis_client_event_count_return\fP\^, 
 
31
.br
 
32
\fIthis_client_event_list_return\fP\^, \fIall_clients_event_count_return\fP\^,
 
33
\fIall_clients_event_list_return\fP\^)
 
34
.br
 
35
      Display *\fIdisplay\fP\^;
 
36
.br
 
37
      Window \fIw\fP\^;
 
38
.br
 
39
      int \fIthis_client_event_count_return\fP\^;
 
40
.br
 
41
      XEventClass *\fIthis_client_event_list_return\fP\^;
 
42
.br
 
43
      int \fIall_clients_event_count_return\fP\^;
 
44
.br
 
45
      XEventClass *\fIall_clients_event_list_return\fP\^;
 
46
.SH ARGUMENTS
 
47
.TP 12
 
48
.I display
 
49
Specifies the connection to the X server.
 
50
.ds Wi whose events you are interested in
 
51
.TP 12
 
52
.I w
 
53
Specifies the window \*(Wi.
 
54
.TP 12
 
55
.I event_list
 
56
Specifies the list of event classes that describe the events you are interested in.
 
57
.TP 12
 
58
.I event_count
 
59
Specifies the count of event classes in the event list.
 
60
.TP 12
 
61
.I this_client_event_count_return
 
62
Returns the count of event classes selected by this client.
 
63
.TP 12
 
64
.I this_client_event_list_return
 
65
Returns a pointer to the list of event classes selected by this client.
 
66
.TP 12
 
67
.I all_clients_event_count_return
 
68
Returns the count of event classes selected by all clients.
 
69
.TP 12
 
70
.I all_clients_event_list_return
 
71
Returns a pointer to the list of event classes selected by all clients.
 
72
.SH DESCRIPTION
 
73
The
 
74
\fIXSelectExtensionEvent\fP request causes the X server to report the 
 
75
events associated with the 
 
76
specified list of event classes.
 
77
Initially, X will not report any of these events.
 
78
Events are reported relative to a window.
 
79
If a window is not interested in a device event, it usually propagates to
 
80
the closest ancestor that is interested,
 
81
unless the do_not_propagate mask prohibits it.
 
82
.LP
 
83
Multiple clients can select for the same events on the same window
 
84
with the following restrictions:
 
85
.IP \(bu 5
 
86
Multiple clients can select events on the same window because their event masks
 
87
are disjoint.
 
88
When the X server generates an event, it reports it
 
89
to all interested clients.
 
90
.IP \(bu 5
 
91
Only one client at a time can select a 
 
92
\fIDeviceButtonPress\fP 
 
93
event with automatic passive grabbing enabled, which is associated with
 
94
the event class \fIDeviceButtonPressGrab\fP.
 
95
To receive \fIDeviceButtonPress\fP events without automatic passive
 
96
grabbing, use event class \fIDeviceButtonPress\fP but do not specify
 
97
event class \fIDeviceButtonPressGrab\fP.
 
98
.LP
 
99
The server reports the event to all interested clients.
 
100
.LP
 
101
Information contained in the \fIXDevice\fP structure returned by
 
102
\fIXOpenDevice\fP is used
 
103
by macros to obtain the event classes that clients use in making
 
104
\fIXSelectExtensionEvent\fP requests.  Currently defined macros include
 
105
\fIDeviceKeyPress\fP, \fIDeviceKeyRelease\fP, \fIDeviceButtonPress\fP, 
 
106
\fIDeviceButtonRelese\fP, \fIDeviceMotionNotify\fP, \fIDeviceFocusIn\fP, 
 
107
\fIDeviceFocusOut\fP, \fIProximityIn\fP, \fIProximityOut\fP, 
 
108
\fIDeviceStateNotify\fP, \fIDeviceMappiingNotify\fP, 
 
109
\fIChangeDeviceNotify\fP, \fIDevicePointerMotionHint\fP, 
 
110
\fIDeviceButton1Motion\fP, \fIDeviceButton2Motion\fP, \fIDeviceButton3Motion\fP,
 
111
\fIDeviceButton4Motion\fP, \fIDeviceButton5Motion\fP, \fIDeviceButtonMotion\fP,
 
112
\fIDeviceOwnerGrabButton\fP, \fIDeviceButtonPressGrab\fP, and
 
113
\fINoExtensionEvent\fP.
 
114
.LP
 
115
To obtain the proper event class for a particular device, one of the above
 
116
macros is invoked using the \fIXDevice\fP structure for that device.  For
 
117
example, 
 
118
.LP
 
119
.DS 0
 
120
.TA .5i
 
121
.ta .5i
 
122
DeviceKeyPress (*device, type, eventclass);
 
123
.DE
 
124
.LP
 
125
returns the \fIDeviceKeyPress\fP event type and the eventclass for selecting
 
126
\fIDeviceKeyPress\fP events from this device.
 
127
.LP
 
128
\fIXSelectExtensionEvent\fP
 
129
can generate a \fIBadWindow\fP or \fIBadClass\fP error.
 
130
The
 
131
\fIXGetSelectedExtensionEvents\fP
 
132
request reports the extension events selected by this client and all clients
 
133
for the specified window.  This request returns pointers to two 
 
134
\fIXEventClass\fP
 
135
arrays.  One lists the input extension events selected by this client from
 
136
the specified window.  The other lists the event classes selected by all
 
137
clients from the specified window.  You should use \fIXFree\fP to free these
 
138
two arrays.
 
139
.LP
 
140
\fIXGetSelectedExtensionEvents\fP
 
141
can generate a \fIBadWindow\fP error.
 
142
.SH DIAGNOSTICS
 
143
.TP 12
 
144
\fIBadWindow\fP
 
145
A value for a Window argument does not name a defined Window.
 
146
.TP 12
 
147
\fIBadClass\fP
 
148
A value for an XEventClass argument is invalid.
 
149
.SH "SEE ALSO"
 
150
.br
 
151
\fI\*(xL\fP