diff options
Diffstat (limited to 'man/xkb/XkbGetNamedIndicator.man')
| -rw-r--r-- | man/xkb/XkbGetNamedIndicator.man | 58 |
1 files changed, 47 insertions, 11 deletions
diff --git a/man/xkb/XkbGetNamedIndicator.man b/man/xkb/XkbGetNamedIndicator.man index 803d656a..be65056b 100644 --- a/man/xkb/XkbGetNamedIndicator.man +++ b/man/xkb/XkbGetNamedIndicator.man @@ -1,4 +1,4 @@ -.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved. +.\" Copyright 1999, 2017, Oracle and/or its affiliates. All rights reserved. .\" .\" Permission is hereby granted, free of charge, to any person obtaining a .\" copy of this software and associated documentation files (the "Software"), @@ -25,9 +25,19 @@ XkbGetNamedIndicator \- Look up the indicator map and other information for an indicator by name .SH SYNOPSIS .HP -.B Bool XkbGetNamedIndicator +.B Bool XkbGetNamedDeviceIndicator .BI "(\^Display *" "dpy" "\^," .BI "unsigned int " "dev_spec" "\^," +.BI "unsigned int " "led_class" "\^," +.BI "unsigned int " "led_id" "\^," +.BI "Atom " "name" "\^," +.BI "int *" "ndx_rtrn" "\^," +.BI "Bool *" "state_rtrn" "\^," +.BI "XkbIndicatorMapPtr " "map_rtrn" "\^," +.BI "Bool *" "real_rtrn" "\^);" +.HP +.B Bool XkbGetNamedIndicator +.BI "(\^Display *" "dpy" "\^," .BI "Atom " "name" "\^," .BI "int *" "ndx_rtrn" "\^," .BI "Bool *" "state_rtrn" "\^," @@ -43,6 +53,12 @@ connection to the X server .I \- dev_spec keyboard device ID, or XkbUseCoreKbd .TP +.I \- led_class +feedback class, or XkbDfltXIClass +.TP +.I \- led_id +feedback ID, or XkbDfltXIId +.TP .I \- name name of the indicator to be retrieved .TP @@ -65,16 +81,16 @@ to get the indicator names. Using names eliminates the need for hard-coding bitmask values for particular keyboards. For example, instead of using vendor-specific constants such as WSKBLed_ScrollLock mask on Digital workstations or XLED_SCROLL_LOCK on Sun workstations, you can instead use -.I XkbGetNamedIndicator +.I XkbGetNamedDeviceIndicator to look up information on the indicator named "Scroll Lock." If the device specified by .I device_spec has an indicator named -.I name, XkbGetNamedIndicator +.IR name ", " XkbGetNamedDeviceIndicator returns True and populates the rest of the parameters with information about the indicator. Otherwise, -.I XkbGetNamedIndicator +.I XkbGetNamedDeviceIndicator returns False. The @@ -95,22 +111,42 @@ Each of the " " arguments is optional; you can pass NULL for any unneeded " .I _rtrn " arguments. + +.LP +.I XkbGetNamedIndicator +is a convenience function that calls +.I XkbGetNamedDeviceIndicator +with a +.I device_spec +of +.BR XkbUseCoreKbd , +a +.I led_class +of +.BR XkbDfltXIClass , +and a +.I led_id +of +.BR XkbDfltXIId . +It returns the return value from +.IR XkbGetNamedDeviceIndicator . + .SH "RETURN VALUES" .TP 15 True The -.I XkbGetNamedIndicator -function returns True if the device specified by +.IR XkbGetNamedIndicator " and " XkbGetNamedDeviceIndicator +functions return True if the device specified by .I device_spec has an indicator named -.I name. +.IR name . .TP 15 False The -.I XkbGetNamedIndicator -function returns False if the device specified by +.IR XkbGetNamedIndicator " and " XkbGetNamedDeviceIndicator +functions return False if the device specified by .I device_spec does not have an indicator named -.I name. +.IR name . .SH "SEE ALSO" .BR XkbGetNames (__libmansuffix__) |