man/XChangeDeviceDontPropagateList.man

   1 '\" t
   2 .\"     Title: xchangedevicedontpropagatelist
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
   5 .\"      Date: 09/07/2010
   6 .\"    Manual: [FIXME: manual]
   7 .\"    Source: [FIXME: source]
   8 .\"  Language: English
   9 .\"
  10 .TH "XCHANGEDEVICEDONTPRO" "libmansuffix" "09/07/2010" "[FIXME: source]" "[FIXME: manual]"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 XChangeDeviceDontPropagateList, XGetDeviceDontPropagateList \- query or change the dont\-propagate\-list for extension devices
  23 .SH "SYNOPSIS"
  24 .sp
  25 .nf
  26 #include <X11/extensions/XInput\&.h>
  27 .fi
  28 .sp
  29 .nf
  30 int XChangeDeviceDontPropagateList( Display *display,
  31                                     Window window,
  32                                     int count,
  33                                     XEventClass *event_list,
  34                                     int mode);
  35 .fi
  36 .sp
  37 .nf
  38 XEventClass* XGetDeviceDontPropagateList( Display *display,
  39                                           Window window,
  40                                           int *count);
  41 .fi
  42 .sp
  43 .nf
  44 display
  45        Specifies the connection to the X server\&.
  46 .fi
  47 .sp
  48 .nf
  49 window
  50        Specifies the window whose dont\-propagate\-list is to be
  51        queried or modified\&.
  52 .fi
  53 .sp
  54 .nf
  55 event_list
  56        Specifies a pointer to a list of event classes\&.
  57 .fi
  58 .sp
  59 .nf
  60 mode
  61        Specifies the mode\&.You can pass AddToList, or
  62        DeleteFromList\&.
  63 .fi
  64 .sp
  65 .nf
  66 count
  67        Specifies the number of event classes in the list\&.
  68 .fi
  69 .SH "DESCRIPTION"
  70 .sp
  71 .if n \{\
  72 .RS 4
  73 .\}
  74 .nf
  75 The XChangeDeviceDontPropagateList request modifies the list of
  76 events that should not be propagated to ancestors of the event
  77 window\&. This request allows extension events to be added to or
  78 deleted from that list\&. By default, all events are propagated
  79 to ancestor windows\&. Once modified, the list remains modified
  80 for the life of the window\&. Events are not removed from the
  81 list because the client that added them has terminated\&.
  82 .fi
  83 .if n \{\
  84 .RE
  85 .\}
  86 .sp
  87 .if n \{\
  88 .RS 4
  89 .\}
  90 .nf
  91 Suppression of event propagation is not allowed for all input
  92 extension events\&. If a specified event class is one that cannot
  93 be suppressed, a BadClass error will result\&. Events that can be
  94 suppressed include DeviceKeyPress, DeviceKeyRelease,
  95 DeviceButtonPress, DeviceButtonRelease, DeviceMotionNotify,
  96 ProximityIn, and ProximityOut\&.
  97 .fi
  98 .if n \{\
  99 .RE
 100 .\}
 101 .sp
 102 .if n \{\
 103 .RS 4
 104 .\}
 105 .nf
 106 XChangeDeviceDontPropagateList can generate a BadDevice,
 107 BadClass, or BadValue error\&.
 108 .fi
 109 .if n \{\
 110 .RE
 111 .\}
 112 .sp
 113 .if n \{\
 114 .RS 4
 115 .\}
 116 .nf
 117 The XGetDeviceDontPropagateList request queries the list of
 118 events that should not be propagated to ancestors of the event
 119 window\&.
 120 .fi
 121 .if n \{\
 122 .RE
 123 .\}
 124 .sp
 125 .if n \{\
 126 .RS 4
 127 .\}
 128 .nf
 129 XGetDeviceDontPropagateList can generate a BadClass or
 130 BadWindow error\&.
 131 .fi
 132 .if n \{\
 133 .RE
 134 .\}
 135 .SH "DIAGNOSTICS"
 136 .sp
 137 .if n \{\
 138 .RS 4
 139 .\}
 140 .nf
 141 BadDevice
 142        An invalid device was specified\&. The specified device
 143        does not exist or has not been opened by this client via
 144        XOpenInputDevice\&. This error may also occur if some
 145        other client has caused the specified device to become
 146        the X keyboard or X pointer device via the
 147        XChangeKeyboardDevice or XChangePointerDevice requests\&.
 148 .fi
 149 .if n \{\
 150 .RE
 151 .\}
 152 .sp
 153 .if n \{\
 154 .RS 4
 155 .\}
 156 .nf
 157 BadValue
 158        Some numeric value falls outside the range of values
 159        accepted by the request\&. Unless a specific range is
 160        specified for an argument, the full range defined by the
 161        argument\'s type is accepted\&. Any argument defined as a
 162        set of alternatives can generate this error\&.
 163 .fi
 164 .if n \{\
 165 .RE
 166 .\}
 167 .sp
 168 .if n \{\
 169 .RS 4
 170 .\}
 171 .nf
 172 BadWindow
 173        An invalid window id was specified\&.
 174 .fi
 175 .if n \{\
 176 .RE
 177 .\}
 178 .sp
 179 .if n \{\
 180 .RS 4
 181 .\}
 182 .nf
 183 BadClass
 184        An invalid event class was specified\&.
 185 .fi
 186 .if n \{\
 187 .RE
 188 .\}