diff options
Diffstat (limited to 'libX11/man/xkb/XkbSetNamedIndicator.man')
-rw-r--r-- | libX11/man/xkb/XkbSetNamedIndicator.man | 238 |
1 files changed, 119 insertions, 119 deletions
diff --git a/libX11/man/xkb/XkbSetNamedIndicator.man b/libX11/man/xkb/XkbSetNamedIndicator.man index 2b9a7f4e5..119dc8a37 100644 --- a/libX11/man/xkb/XkbSetNamedIndicator.man +++ b/libX11/man/xkb/XkbSetNamedIndicator.man @@ -1,119 +1,119 @@ -.\" Copyright 1999 Sun Microsystems, Inc. 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"), -.\" to deal in the Software without restriction, including without limitation -.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, -.\" and/or sell copies of the Software, and to permit persons to whom the -.\" Software is furnished to do so, subject to the following conditions: -.\" -.\" The above copyright notice and this permission notice (including the next -.\" paragraph) shall be included in all copies or substantial portions of the -.\" Software. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -.\" DEALINGS IN THE SOFTWARE. -.\" -.TH XkbSetNamedIndicator __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" -.SH NAME -XkbSetNamedIndicator \- Names an indicator if it is not already named; toggles -the state of the indicator; sets the indicator to a specified state and sets the -indicator map for the indicator -.SH SYNOPSIS -.HP -.B Bool XkbSetNamedIndicator -.BI "(\^Display *" "dpy" "\^," -.BI "unsigned int " "device_spec" "\^," -.BI "Atom " "name" "\^," -.BI "Bool " "change_state" "\^," -.BI "Bool " "state" "\^," -.BI "Bool " "create_new" "\^," -.BI "XkbIndicatorMapPtr " "map" "\^);" -.if n .ti +5n -.if t .ti +.5i -.SH ARGUMENTS -.TP -.I \- dpy -connection to the X server -.TP -.I \- device_spec -device ID, or XkbUseCoreKbd -.TP -.I \- name -name of the indicator to change -.TP -.I \- change_state -whether to change the indicator state or not -.TP -.I \- state -desired new state for the indicator -.TP -.I \- create_new -whether a new indicator with the specified name should be created when necessary -.TP -.I \- map -new map for the indicator -.SH DESCRIPTION -.LP -If a compatible version of the Xkb extension is not available in the server, -.I XkbSetNamedIndicator -returns False. Otherwise, it sends a request to the X server to change the -indicator specified by -.I name -and returns True. - -If -.I change_state -is True, and the optional parameter, -.I state, -is not NULL, -.I XkbSetNamedIndicator -tells the server to change the state of the named indicator to the value -specified by -.I state. - -If an indicator with the name specified by -.I name -does not already exist, the -.I create_new -parameter tells the server whether it should create a new named indicator. If -.I create_new -is True, the server finds the first indicator that doesn't have a name and gives -it the name specified by -.I name. -If the optional parameter, -.I map, is not NULL, -.I XkbSetNamedIndicator -tells the server to change the indicator's map to the values specified in -.I map. - -In addition, it can also generate XkbIndicatorStateNotify, -XkbIndicatorMapNotify, and XkbNamesNotify events. -.SH "RETURN VALUES" -.TP 15 -True -The -.I XkbSetNamedIndicator -function returns True if a compatible version of the Xkb extension is available in the server. -.TP 15 -False -The -.I XkbSetNamedIndicator -function returns False if a compatible version of the Xkb extension is not available in the server. -.SH DIAGNOSTICS -.TP 15 -.B BadAtom -A name is neither a valid Atom or None -.TP 15 -.B BadImplementation -Invalid reply from server -.SH "SEE ALSO" -.BR XkbIndicatorMapNotify (__libmansuffix__), -.BR XkbIndicatorStateNotify (__libmansuffix__), -.BR XkbNamesNotify (__libmansuffix__) - +.\" Copyright 1999 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"),
+.\" to deal in the Software without restriction, including without limitation
+.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
+.\" and/or sell copies of the Software, and to permit persons to whom the
+.\" Software is furnished to do so, subject to the following conditions:
+.\"
+.\" The above copyright notice and this permission notice (including the next
+.\" paragraph) shall be included in all copies or substantial portions of the
+.\" Software.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+.\" DEALINGS IN THE SOFTWARE.
+.\"
+.TH XkbSetNamedIndicator __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
+.SH NAME
+XkbSetNamedIndicator \- Names an indicator if it is not already named; toggles
+the state of the indicator; sets the indicator to a specified state and sets the
+indicator map for the indicator
+.SH SYNOPSIS
+.HP
+.B Bool XkbSetNamedIndicator
+.BI "(\^Display *" "dpy" "\^,"
+.BI "unsigned int " "device_spec" "\^,"
+.BI "Atom " "name" "\^,"
+.BI "Bool " "change_state" "\^,"
+.BI "Bool " "state" "\^,"
+.BI "Bool " "create_new" "\^,"
+.BI "XkbIndicatorMapPtr " "map" "\^);"
+.if n .ti +5n
+.if t .ti +.5i
+.SH ARGUMENTS
+.TP
+.I \- dpy
+connection to the X server
+.TP
+.I \- device_spec
+device ID, or XkbUseCoreKbd
+.TP
+.I \- name
+name of the indicator to change
+.TP
+.I \- change_state
+whether to change the indicator state or not
+.TP
+.I \- state
+desired new state for the indicator
+.TP
+.I \- create_new
+whether a new indicator with the specified name should be created when necessary
+.TP
+.I \- map
+new map for the indicator
+.SH DESCRIPTION
+.LP
+If a compatible version of the Xkb extension is not available in the server,
+.I XkbSetNamedIndicator
+returns False. Otherwise, it sends a request to the X server to change the
+indicator specified by
+.I name
+and returns True.
+
+If
+.I change_state
+is True, and the optional parameter,
+.I state,
+is not NULL,
+.I XkbSetNamedIndicator
+tells the server to change the state of the named indicator to the value
+specified by
+.I state.
+
+If an indicator with the name specified by
+.I name
+does not already exist, the
+.I create_new
+parameter tells the server whether it should create a new named indicator. If
+.I create_new
+is True, the server finds the first indicator that doesn't have a name and gives
+it the name specified by
+.I name.
+If the optional parameter,
+.I map, is not NULL,
+.I XkbSetNamedIndicator
+tells the server to change the indicator's map to the values specified in
+.I map.
+
+In addition, it can also generate XkbIndicatorStateNotify,
+XkbIndicatorMapNotify, and XkbNamesNotify events.
+.SH "RETURN VALUES"
+.TP 15
+True
+The
+.I XkbSetNamedIndicator
+function returns True if a compatible version of the Xkb extension is available in the server.
+.TP 15
+False
+The
+.I XkbSetNamedIndicator
+function returns False if a compatible version of the Xkb extension is not available in the server.
+.SH DIAGNOSTICS
+.TP 15
+.B BadAtom
+A name is neither a valid Atom or None
+.TP 15
+.B BadImplementation
+Invalid reply from server
+.SH "SEE ALSO"
+.BR XkbIndicatorMapNotify (__libmansuffix__),
+.BR XkbIndicatorStateNotify (__libmansuffix__),
+.BR XkbNamesNotify (__libmansuffix__)
+
|