File: XDeviceBell.txt

package info (click to toggle)
libxi 2:1.3-8
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 2,476 kB
  • ctags: 906
  • sloc: sh: 10,500; ansic: 6,600; makefile: 454
file content (78 lines) | stat: -rw-r--r-- 2,302 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
XDEVICEBELL(libmansuffix)
=========================

NAME
----

   XDeviceBell - ring a bell on a device supported through the
   input extension

SYNOPSIS
--------

   #include <X11/extensions/XInput.h>

   Status XDeviceBell( Display *display,
                       XDevice *device,
                       XID feedbackclass,
                       XID feedbackid,
                       int percent);
   display
          Specifies the connection to the X server.

   device
          Specifies the device with which the bell is associated.

   feedbackclass
          Specifies the class of the feedback with which the bell
          is associated.

   feedbackid
          Specifies the id of the feedback with which the bell is
          associated.

   percent
          Specifies the volume in the range -100 to 100 at which
          the bell should be rung.

DESCRIPTION
-----------

   The XDeviceBell request causes the server to ring a bell on the
   specified feedback of the specified device, if possible. The
   specified volume is relative to the base volume for the bell.
   If an invalid device is specified, a BadDevice error will be
   returned. The feedbackclass and feedbackid parameters contain
   values returned by an XGetFeedbackControl request and uniquely
   identify the bell to ring. If a feedbackclass is specified that
   does not support a bell, or if a nonexistent feedbackid is
   specified, or a percent value is specified that is not in the
   range -100 to 100, a BadValue error will be returned.

   The volume at which the bell is rung when the percent argument
   is nonnegative is: base - [(base * percent) / 100] + percent

   The volume at which the bell rings when the percent argument is
   negative is: base + [(base * percent) / 100]

   To change the base volume of the bell, use
   XChangeFeedbackControl.

   XDeviceBell can generate a BadDevice or a BadValue error.

DIAGNOSTICS
-----------

   BadDevice
          An invalid device was specified. The specified device
          does not exist, or has not been opened by this client
          via XOpenInputDevice.

   BadValue
          An invalid feedbackclass, feedbackid, or percent value
          was specified.

SEE ALSO
--------

   XChangeFeedbackControl(libmansuffix), XBell(libmansuffix)