~ubuntu-branches/ubuntu/natty/libxi/natty-201011191114

« back to all changes in this revision

Viewing changes to man/XDeviceBell.txt

  • Committer: Bazaar Package Importer
  • Author(s): Julien Cristau
  • Date: 2009-11-21 18:39:28 UTC
  • mfrom: (1.1.10 upstream) (0.1.6 experimental)
  • Revision ID: james.westby@ubuntu.com-20091121183928-ek2jwqx3rmhv3zjz
Tags: 2:1.3-1
* Bump Standards-Version to 3.8.3.
* Add build-deps on xmlto and asciidoc to build the manpages.
* New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
XDEVICEBELL(libmansuffix)
 
2
=========================
 
3
 
 
4
NAME
 
5
----
 
6
 
 
7
   XDeviceBell - ring a bell on a device supported through the
 
8
   input extension
 
9
 
 
10
SYNOPSIS
 
11
--------
 
12
 
 
13
   #include <X11/extensions/XInput.h>
 
14
 
 
15
   Status XDeviceBell( Display *display,
 
16
                       XDevice *device,
 
17
                       XID feedbackclass,
 
18
                       XID feedbackid,
 
19
                       int percent);
 
20
   display
 
21
          Specifies the connection to the X server.
 
22
 
 
23
   device
 
24
          Specifies the device with which the bell is associated.
 
25
 
 
26
   feedbackclass
 
27
          Specifies the class of the feedback with which the bell
 
28
          is associated.
 
29
 
 
30
   feedbackid
 
31
          Specifies the id of the feedback with which the bell is
 
32
          associated.
 
33
 
 
34
   percent
 
35
          Specifies the volume in the range -100 to 100 at which
 
36
          the bell should be rung.
 
37
 
 
38
DESCRIPTION
 
39
-----------
 
40
 
 
41
   The XDeviceBell request causes the server to ring a bell on the
 
42
   specified feedback of the specified device, if possible. The
 
43
   specified volume is relative to the base volume for the bell.
 
44
   If an invalid device is specified, a BadDevice error will be
 
45
   returned. The feedbackclass and feedbackid parameters contain
 
46
   values returned by an XGetFeedbackControl request and uniquely
 
47
   identify the bell to ring. If a feedbackclass is specified that
 
48
   does not support a bell, or if a nonexistent feedbackid is
 
49
   specified, or a percent value is specified that is not in the
 
50
   range -100 to 100, a BadValue error will be returned.
 
51
 
 
52
   The volume at which the bell is rung when the percent argument
 
53
   is nonnegative is: base - [(base * percent) / 100] + percent
 
54
 
 
55
   The volume at which the bell rings when the percent argument is
 
56
   negative is: base + [(base * percent) / 100]
 
57
 
 
58
   To change the base volume of the bell, use
 
59
   XChangeFeedbackControl.
 
60
 
 
61
   XDeviceBell can generate a BadDevice or a BadValue error.
 
62
 
 
63
DIAGNOSTICS
 
64
-----------
 
65
 
 
66
   BadDevice
 
67
          An invalid device was specified. The specified device
 
68
          does not exist, or has not been opened by this client
 
69
          via XOpenInputDevice.
 
70
 
 
71
   BadValue
 
72
          An invalid feedbackclass, feedbackid, or percent value
 
73
          was specified.
 
74
 
 
75
SEE ALSO
 
76
--------
 
77
 
 
78
   XChangeFeedbackControl(libmansuffix), XBell(libmansuffix)