xcb_xkb_set_named_indicator(3)

πŸ“¦
version 1.17.0 Β· 4 versions
, in alpine 3.22, alpine 3.23, alpine 3.24, arch rolling, centos-stream 10, debian trixie, fedora 43, fedora 44, nixpkgs unstable, opensuse-leap 16.0, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– xcb_xkb_set_named_indicator πŸ’–

okay so bestie, welcome to the manual page for xcb_xkb_set_named_indicator, a lil request function from XCB Requests (that's the X protocol binding situation, iykyk). it lives in the XKB corner of libxcb and it's here to set a named indicator, bestie. that's the whole vibe. let's get into it πŸ¦‹


✨ NAME ✨

xcb_xkb_set_named_indicator β€” and honestly? the description slot is just… empty. blank. the void. not a single word was typed there in the original, so i'm not gonna make one up for you either. we respect the silence πŸ’…


🌸 SYNOPSIS 🌸

first up, you gotta pull in the header, like:

#include <xcb/xkb.h>

πŸŽ€ Request function πŸŽ€

and here's the actual function signature, copy it exactly, don't you dare get creative:

xcb_void_cookie_t xcb_xkb_set_named_indicator(xcb_connection_t *conn,
       xcb_xkb_device_spec_t deviceSpec,
       xcb_xkb_led_class_spec_t ledClass, xcb_xkb_id_spec_t ledID,
       xcb_atom_t indicator, uint8_t setState, uint8_t on,
       uint8_t setMap, uint8_t createMap, uint8_t map_flags,
       uint8_t map_whichGroups, uint8_t map_groups,
       uint8_t map_whichMods, uint8_t map_realMods, uint16_t map_vmods,
       uint32_t map_ctrls);

that's a lot of arguments, and yes, that's the point. she's thorough. πŸ‘‘


🫢 REQUEST ARGUMENTS 🫢

every single one of these, no skips:

  • conn β€” the XCB connection to X11. your link to the mothership, basically. πŸ’œ
  • deviceSpec β€” TODO: NOT YET DOCUMENTED. yeah bestie, they left it blank. iconic of them honestly 😭
  • ledClass β€” TODO: NOT YET DOCUMENTED. πŸ™ˆ
  • ledID β€” TODO: NOT YET DOCUMENTED. πŸ“
  • indicator β€” TODO: NOT YET DOCUMENTED. ✨
  • setState β€” TODO: NOT YET DOCUMENTED. 🧚
  • on β€” TODO: NOT YET DOCUMENTED. πŸ’€
  • setMap β€” TODO: NOT YET DOCUMENTED. 🌈
  • createMap β€” TODO: NOT YET DOCUMENTED. ⭐
  • map_flags β€” TODO: NOT YET DOCUMENTED. πŸŽ€
  • map_whichGroups β€” TODO: NOT YET DOCUMENTED. πŸ’…
  • map_groups β€” TODO: NOT YET DOCUMENTED. 🌸
  • map_whichMods β€” TODO: NOT YET DOCUMENTED. πŸ¦‹
  • map_realMods β€” TODO: NOT YET DOCUMENTED. πŸ’–
  • map_vmods β€” TODO: NOT YET DOCUMENTED. πŸ”₯
  • map_ctrls β€” TODO: NOT YET DOCUMENTED. πŸ‘‘
not me documenting a manpage where the entire argument list says NOT YET DOCUMENTED 😭 that's just how the original is, bestie, i'm keeping it 100% as-is. no cap.

πŸ’« DESCRIPTION πŸ’«

…and the DESCRIPTION section? empty. literally nothing under it in the original. she said "no thoughts, head empty" and honestly, slay. 🫢


πŸ”₯ RETURN VALUE πŸ”₯

so what do you get back? an xcb_void_cookie_t. that's it. that's the whole return value.

and here's the important part, bestie: errors (if any) have to be handled in the event loop. you don't get them handed to you right here, you gotta go catch them later like a lil detective πŸ•΅οΈβ™€οΈ

but WAIT β€” if you'd rather handle errors directly, there's another way:

use xcb_xkb_set_named_indicator_checked instead, together with xcb_request_check. the full deets live over in xcb-requests(3). go read it, i'll wait πŸ’œ

πŸ’€ ERRORS πŸ’€

okay this one's easy:

This request does never generate any errors.

that's it. that's the whole section. no errors, no drama, no stress. she's low maintenance fr fr ✨


πŸ¦‹ SEE ALSO πŸ¦‹

…nothing. the SEE ALSO section is empty in the original, so there's nothing to see and nothing to also. a moment of silence for the cross-references that never were πŸŽ€


πŸ‘‘ AUTHOR πŸ‘‘

Generated from xkb.xml. Contact xcb@lists.freedesktop.org for corrections and improvements β€” like, if something's wrong, tell them, don't just suffer in silence bestie, they literally asked 🫢


and that's the whole page!! πŸ’– this one came from X Version 11, libxcb 1.17.0, and it's the xcb_xkb_set_named_indicator(3) page itself. thanks for reading with me, bestie β€” go forth and set those named indicators, you absolute main character πŸŽ€βœ¨πŸ¦‹πŸ’