man/xkb/XkbSetNamedIndicator.man

   1 .\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining a
   4 .\" copy of this software and associated documentation files (the "Software"),
   5 .\" to deal in the Software without restriction, including without limitation
   6 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   7 .\" and/or sell copies of the Software, and to permit persons to whom the
   8 .\" Software is furnished to do so, subject to the following conditions:
   9 .\"
  10 .\" The above copyright notice and this permission notice (including the next
  11 .\" paragraph) shall be included in all copies or substantial portions of the
  12 .\" Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20 .\" DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .TH XkbSetNamedIndicator __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  23 .SH NAME
  24 XkbSetNamedIndicator \- Names an indicator if it is not already named; toggles
  25 the state of the indicator; sets the indicator to a specified state and sets the
  26 indicator map for the indicator
  27 .SH SYNOPSIS
  28 .HP
  29 .B Bool XkbSetNamedIndicator
  30 .BI "(\^Display *" "dpy" "\^,"
  31 .BI "unsigned int " "device_spec" "\^,"
  32 .BI "Atom " "name" "\^,"
  33 .BI "Bool " "change_state" "\^,"
  34 .BI "Bool " "state" "\^,"
  35 .BI "Bool " "create_new" "\^,"
  36 .BI "XkbIndicatorMapPtr " "map" "\^);"
  37 .if n .ti +5n
  38 .if t .ti +.5i
  39 .SH ARGUMENTS
  40 .TP
  41 .I \- dpy
  42 connection to the X server
  43 .TP
  44 .I \- device_spec
  45 device ID, or XkbUseCoreKbd
  46 .TP
  47 .I \- name
  48 name of the indicator to change
  49 .TP
  50 .I \- change_state
  51 whether to change the indicator state or not
  52 .TP
  53 .I \- state
  54 desired new state for the indicator
  55 .TP
  56 .I \- create_new
  57 whether a new indicator with the specified name should be created when necessary
  58 .TP
  59 .I \- map
  60 new map for the indicator
  61 .SH DESCRIPTION
  62 .LP
  63 If a compatible version of the Xkb extension is not available in the server,
  64 .I XkbSetNamedIndicator
  65 returns False. Otherwise, it sends a request to the X server to change the
  66 indicator specified by
  67 .I name
  68 and returns True.
  69
  70 If
  71 .I change_state
  72 is True, and the optional parameter,
  73 .I state,
  74 is not NULL,
  75 .I XkbSetNamedIndicator
  76 tells the server to change the state of the named indicator to the value
  77 specified by
  78 .I state.
  79
  80 If an indicator with the name specified by
  81 .I name
  82 does not already exist, the
  83 .I create_new
  84 parameter tells the server whether it should create a new named indicator. If
  85 .I create_new
  86 is True, the server finds the first indicator that doesn't have a name and gives
  87 it the name specified by
  88 .I name.
  89 If the optional parameter,
  90 .I map, is not NULL,
  91 .I XkbSetNamedIndicator
  92 tells the server to change the indicator's map to the values specified in
  93 .I map.
  94
  95 In addition, it can also generate XkbIndicatorStateNotify,
  96 XkbIndicatorMapNotify, and XkbNamesNotify events.
  97 .SH "RETURN VALUES"
  98 .TP 15
  99 True
 100 The
 101 .I XkbSetNamedIndicator
 102 function returns True if a compatible version of the Xkb extension is available in the server.
 103 .TP 15
 104 False
 105 The
 106 .I XkbSetNamedIndicator
 107 function returns False if a compatible version of the Xkb extension is not available in the server.
 108 .SH DIAGNOSTICS
 109 .TP 15
 110 .B BadAtom
 111 A name is neither a valid Atom or None
 112 .TP 15
 113 .B BadImplementation
 114 Invalid reply from server
 115 .SH "SEE ALSO"
 116 .BR XkbIndicatorMapNotify (__libmansuffix__),
 117 .BR XkbIndicatorStateNotify (__libmansuffix__),
 118 .BR XkbNamesNotify (__libmansuffix__)
 119