XkbSetNamedIndicator(3)

💖 XkbSetNamedIndicator(3) 💖

okay bestie, welcome to the XkbSetNamedIndicator(3) page, which lives in the XKB FUNCTIONS manual and is lowkey about naming indicators, toggling them, setting their state, and setting their map. it’s giving “LED but make it XKB” ✨

---

✨ 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. iconic behavior, no cap 💅

---

🎀 SYNOPSIS 🎀

the synopsis is a whole two-function mood, fr fr:

       Bool XkbSetNamedDeviceIndicator (Display *dpy, unsigned int device_spec,
              unsigned int led_class, unsigned int led_id, Atom name, Bool
              change_state, Bool state, Bool create_new, XkbIndicatorMapPtr
              map); Bool XkbSetNamedIndicator (Display *dpy, Atom name, Bool
              change_state, Bool state, Bool create_new, XkbIndicatorMapPtr
              map);

---

🌸 ARGUMENTS 🌸

• dpy — connection to the X server. literally your link to the server, bestie 🫶
• device_spec — device ID, or XkbUseCoreKbd.
• led_class — feedback class, or XkbDfltXIClass.
• led_id — feedback ID, or XkbDfltXIId.
• name — name of the indicator to change.
• change_state — whether to change the indicator state or not.
• state — desired new state for the indicator.
• create_new — whether a new indicator with the specified name should be created when necessary.
• map — new map for the indicator.

---

🦋 DESCRIPTION 🦋

okay so first thing: if a compatible version of the Xkb extension is not available in the server, XkbSetNamedDeviceIndicator returns False. Otherwise, it sends a request to the X server to change the indicator specified by name and returns True. slay 💅

If change_state is True, XkbSetNamedDeviceIndicator tells the server to change the state of the named indicator to the value specified by state. If change_state is False, then state is not used. periodt.

If an indicator with the name specified by name does not already exist, the create_new parameter tells the server whether it should create a new named indicator. If create_new is True, the server finds the first indicator that doesn't have a name and gives it the name specified by name. If the optional parameter, map, is not NULL, XkbSetNamedDeviceIndicator tells the server to change the indicator's map to the values specified in map. main character energy for real 😭

In addition, it can also generate XkbIndicatorStateNotify, XkbIndicatorMapNotify, and XkbNamesNotify events. so many notifications, iykyk ✨

XkbSetNamedIndicator is a convenience function that calls XkbSetNamedDeviceIndicator with a device_spec of XkbUseCoreKbd, a led_class of XkbDfltXIClass, and a led_id of XkbDfltXIId. It returns the return value from XkbSetNamedDeviceIndicator. convenient and iconic, as always 👑

---

🔥 RETURN VALUES 🔥

• True — the XkbSetNamedIndicator and XkbSetNamedDeviceIndicator functions return True if a compatible version of the Xkb extension is available in the server.
• False — the XkbSetNamedIndicator and XkbSetNamedDeviceIndicator functions return False if a compatible version of the Xkb extension is not available in the server.

---

💀 DIAGNOSTICS 💀

• BadAtom — a name is neither a valid Atom or None.
• BadImplementation — invalid reply from server.
• BadKeyboard — device_spec does not specify a device with indicators.
• BadMatch — led_id is not DfltXIId and does not specify a feedback of the class specified by led_class on the device specified by device_spec.
• BadValue — led_class does not specify DfltXIClass, LedFeedbackClass, or KbdFeedbackClass.

---

💜 SEE ALSO 💜

XkbIndicatorMapNotify(3), XkbIndicatorStateNotify(3), XkbNamesNotify(3)

---

okay bestie, that’s the whole page 🫶 this footer energy is: X Version 11, libX11 1.8.14, and XkbSetNamedIndicator(3) — no date listed here, so don’t come for me 😭✨ bye and stay hydrated 💖