Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xkbgetdetectableautorepeat(3) [suse man page]

XkbGetDetectableAutorepeat(3)					   XKB FUNCTIONS				     XkbGetDetectableAutorepeat(3)

NAME

       XkbGetDetectableAutorepeat - Determines whether or not the server supports DetectableAutorepeat

SYNOPSIS

       Bool XkbGetDetectableAutorepeat (Display *display, Bool *supported_rtrn);

ARGUMENTS

       - display
	      connection to X server

       - supported_rtrn
	      backfilled True if DetectableAutorepeat supported

DESCRIPTION

       Auto-repeat  is	the  generation  of multiple key events by a keyboard when the user presses a key and holds it down. Keyboard hardware and
       device-dependent X server software often implement auto-repeat by generating multiple KeyPress events with no intervening KeyRelease event.
       The  standard  behavior	of  the  X server is to generate a KeyRelease event for every KeyPress event. If the keyboard hardware and device-
       dependent software of the X server implement auto-repeat by generating multiple KeyPress events,  the  device-independent  part	of  the  X
       server  by  default synthetically generates a KeyRelease event after each KeyPress event. This provides predictable behavior for X clients,
       but does not allow those clients to detect the fact that a key is auto-repeating.

       Xkb allows clients to request detectable auto-repeat.  If a client requests and the server  supports  DetectableAutorepeat,  Xkb  generates
       KeyRelease  events only when the key is physically released. If DetectableAutorepeat is not supported or has not been requested, the server
       synthesizes a KeyRelease event for each repeating KeyPress event it generates.

       DetectableAutorepeat, unlike other controls, is not contained in the XkbControlsRec structure, nor can it be enabled or	disabled  via  the
       EnabledControls control.  Instead, query and set DetectableAutorepeat using XkbGetDetectableAutorepeat and XkbSetDetectableAutorepeat.

       DetectableAutorepeat is a condition that applies to all keyboard devices for a client's connection to a given X server; it cannot be selec-
       tively set for some devices and not for others. For this reason, none of the Xkb library functions involving DetectableAutorepeat involve a
       device specifier.

       XkbGetDetectableAutorepeat queries the server for the current state of DetectableAutorepeat and waits for a reply. If supported_rtrn is not
       NULL, it backfills supported_rtrn with True if the server supports DetectableAutorepeat, and False  otherwise.	XkbGetDetectableAutorepeat
       returns the current state of DetectableAutorepeat for the requesting client: True if DetectableAutorepeat is set, and False otherwise.

RETURN VALUES

       True	      The XkbGetDetectableAutorepeat function returns True if the server supports DetectableAutorepeat.

       False	      The XkbGetDetectableAutorepeat function returns False if the server does not support DetectableAutorepeat.

X Version 11							   libX11 1.3.2 				     XkbGetDetectableAutorepeat(3)

Check Out this Related Man Page

XkbGetAutoRepeatRate(3) 					   XKB FUNCTIONS					   XkbGetAutoRepeatRate(3)

NAME

       XkbGetAutoRepeatRate - Gets the current attributes of the RepeatKeys control for a keyboard device

SYNOPSIS

       Bool XkbGetAutoRepeatRate (Display *display, unsigned int device_spec, unsigned int *timeout_rtrn, unsigned int *interval_rtrn);

ARGUMENTS

       - display
	      connection to X server

       - device_spec
	      desired device ID, or XkbUseCoreKbd

       - timeout_rtrn
	      backfilled with initial repeat delay, ms

       - interval_rtrn
	      backfilled with subsequent repeat delay, ms

DESCRIPTION

       The  core  protocol  allows  only  control  over  whether  or not the entire keyboard or individual keys should auto-repeat when held down.
       RepeatKeys is a boolean control that extends this capability by adding control over the delay until a key begins to repeat and the rate	at
       which  it repeats. RepeatKeys is coupled with the core auto-repeat control: when RepeatKeys is enabled or disabled, the core auto-repeat is
       enabled or disabled and vice versa.

       Auto-repeating keys are controlled by two attributes. The first, timeout, is the delay after the initial press of an auto-repeating key and
       the  first  generated  repeat event. The second, interval, is the delay between all subsequent generated repeat events. As with all boolean
       controls, configuring the attributes that determine how the control operates does not automatically enable the control as a whole.

       XkbGetAutoRepeatRate queries the server for the current values of the RepeatControls control attributes, backfills timeout_rtrn and  inter-
       val_rtrn  with  them,  and  returns  True. If a compatible version of the Xkb extension is not available in the server XkbGetAutoRepeatRate
       returns False.

RETURN VALUES

       True	      The XkbGetAutoRepeatRate function returns True if a compatible version of the Xkb extension is available in the server.

       False	      The XkbGetAutoRepeatRate function returns False if a compatible version of the Xkb extension is not available in the server.

X Version 11							   libX11 1.6.0 					   XkbGetAutoRepeatRate(3)
Man Page