SFWBAR-IDLEINHIBIT(1)

✨ NAME ✨

sfwbar-idleinhibit β€” the Sfwbar IdleInhibitor module, bestie πŸ’–

  • Filename: idleinhibit.so
  • Requires: none (literally nothing, she's low maintenance πŸ’…)

🌸 SYNOPSIS 🌸

Okay so the IdleInhibit module lets you attach an idle inhibitor to any widget in the taskbar. No cap. 🫢

And here's the vibe: if an idle inhibitor is active on a visible widget, it will stop the compositor from going into an idle state β€” and by that we mean blanking a screen, going into a suspend mode, or activating a screensaver. She said "not today" and meant it. 😀✨


πŸ¦‹ EXPRESSION FUNCTIONS πŸ¦‹

IdleInhibitState()

Queries an idle inhibitor state on a calling widget. πŸŽ€

It returns a string, and the possible values are:

  • "On" β€” if an idle inhibitor is set on the widget
  • "Off" β€” if it isn't
Heads up bestie: if the function gets called from an expression that isn't attached to a widget, the value it hands back will be "Off". That's just how it is. πŸ™ˆ

πŸ’… ACTIONS πŸ’…

SetIdleInhibitor Command

Sets the idle inhibitor state for a widget. The possible command values are:

  • "On" β€” turn on an idle inhibitor πŸ”₯
  • "Off" β€” turn off an idle inhibitor πŸ’€
  • "Toggle" β€” toggle the state of an idle inhibitor πŸ”

⭐ TRIGGERS ⭐

The module defines one trigger, and it's called "IdleInhibitor". πŸ‘‘

It gets emitted whenever the state of any idle inhibitor changes. That's it, that's the whole trigger. Iconic behaviour honestly. πŸ’–


GPLv3+


Okay that's the whole page, mwah πŸ’‹ β€” this was the General Commands Manual entry for sfwbar-idleinhibit(1), so if you ever need to find her again that's exactly where she lives. Go forth and inhibit those idles, bestie. πŸ¦‹βœ¨πŸ’œ

πŸ“¦ where this page comes from