man/XDeviceBell.man

   1 '\" t
   2 .\"     Title: xdevicebell
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 09/23/2011
   6 .\"    Manual: [FIXME: manual]
   7 .\"    Source: [FIXME: source]
   8 .\"  Language: English
   9 .\"
  10 .TH "XDEVICEBELL" "libmansuffix" "09/23/2011" "[FIXME: source]" "[FIXME: manual]"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 XDeviceBell \- ring a bell on a device supported through the input extension
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 #include <X11/extensions/XInput\&.h>
  36 .fi
  37 .sp
  38 .nf
  39 Status XDeviceBell( Display *display,
  40                     XDevice *device,
  41                     XID feedbackclass,
  42                     XID feedbackid,
  43                     int percent);
  44 display
  45        Specifies the connection to the X server\&.
  46 .fi
  47 .sp
  48 .nf
  49 device
  50        Specifies the device with which the bell is associated\&.
  51 .fi
  52 .sp
  53 .nf
  54 feedbackclass
  55        Specifies the class of the feedback with which the bell
  56        is associated\&.
  57 .fi
  58 .sp
  59 .nf
  60 feedbackid
  61        Specifies the id of the feedback with which the bell is
  62        associated\&.
  63 .fi
  64 .sp
  65 .nf
  66 percent
  67        Specifies the volume in the range \-100 to 100 at which
  68        the bell should be rung\&.
  69 .fi
  70 .SH "DESCRIPTION"
  71 .sp
  72 .if n \{\
  73 .RS 4
  74 .\}
  75 .nf
  76 The XDeviceBell request causes the server to ring a bell on the
  77 specified feedback of the specified device, if possible\&. The
  78 specified volume is relative to the base volume for the bell\&.
  79 If an invalid device is specified, a BadDevice error will be
  80 returned\&. The feedbackclass and feedbackid parameters contain
  81 values returned by an XGetFeedbackControl request and uniquely
  82 identify the bell to ring\&. If a feedbackclass is specified that
  83 does not support a bell, or if a nonexistent feedbackid is
  84 specified, or a percent value is specified that is not in the
  85 range \-100 to 100, a BadValue error will be returned\&.
  86 .fi
  87 .if n \{\
  88 .RE
  89 .\}
  90 .sp
  91 .if n \{\
  92 .RS 4
  93 .\}
  94 .nf
  95 The volume at which the bell is rung when the percent argument
  96 is nonnegative is: base \- [(base * percent) / 100] + percent
  97 .fi
  98 .if n \{\
  99 .RE
 100 .\}
 101 .sp
 102 .if n \{\
 103 .RS 4
 104 .\}
 105 .nf
 106 The volume at which the bell rings when the percent argument is
 107 negative is: base + [(base * percent) / 100]
 108 .fi
 109 .if n \{\
 110 .RE
 111 .\}
 112 .sp
 113 .if n \{\
 114 .RS 4
 115 .\}
 116 .nf
 117 To change the base volume of the bell, use
 118 XChangeFeedbackControl\&.
 119 .fi
 120 .if n \{\
 121 .RE
 122 .\}
 123 .sp
 124 .if n \{\
 125 .RS 4
 126 .\}
 127 .nf
 128 XDeviceBell can generate a BadDevice or a BadValue error\&.
 129 .fi
 130 .if n \{\
 131 .RE
 132 .\}
 133 .SH "DIAGNOSTICS"
 134 .sp
 135 .if n \{\
 136 .RS 4
 137 .\}
 138 .nf
 139 BadDevice
 140        An invalid device was specified\&. The specified device
 141        does not exist, or has not been opened by this client
 142        via XOpenInputDevice\&.
 143 .fi
 144 .if n \{\
 145 .RE
 146 .\}
 147 .sp
 148 .if n \{\
 149 .RS 4
 150 .\}
 151 .nf
 152 BadValue
 153        An invalid feedbackclass, feedbackid, or percent value
 154        was specified\&.
 155 .fi
 156 .if n \{\
 157 .RE
 158 .\}
 159 .SH "SEE ALSO"
 160 .sp
 161 .if n \{\
 162 .RS 4
 163 .\}
 164 .nf
 165 XChangeFeedbackControl(libmansuffix), XBell(libmansuffix)
 166 .fi
 167 .if n \{\
 168 .RE
 169 .\}