TICKIT_WINDOW_IS_STEAL_INPUT(3)

💅 NAME 💅

tickit_window_set_steal_input — bestie, this is the little switch that decides whether a window steals all the input events 👀✨

🌸 SYNOPSIS 🌸

#include <tickit.h>

bool tickit_window_is_steal_input(const TickitWindow *win);
void tickit_window_set_steal_input(TickitWindow *win, bool steal);

Link with -ltickit.

🎀 DESCRIPTION 🎀

Okay so first up, tickit_window_is_steal_input() — she's the read-only girlie. She tells you the current state of the input-stealing setting on the window. Returns a bool, no drama, no side effects. 🫶

And when it's true? Ooh bestie, that's main character energy for real. It gives the window special behaviour on input events, and the whole point is that it's likely to be useful for implementing popup windows. So here's the tea ☕:

• The window receives all key events on its parent — and it gets them even before the sibling with the input focus receives them, provided it is the front-most child of its parent. Yeah. Front of the line. 💅
• On top of that, the window will receive all mouse events, even those outside of its geometry. Not even contained, fr fr. 🌈

tickit_window_set_steal_input() is the one that actually changes the value of this setting. You pass steal, you set the vibe. ✨

The initial value is normally false — like, chill, not stealing anything — unless the TICKIT_WINDOW_STEAL_INPUT flag was passed to the tickit_window_new(3) function call that created the window. Then she came out of the box already in her villain era. 😭

⚠️ Heads up bestie: this function is discouraged in favour of using the TICKIT_WINCTL_STEAL_INPUT window control with tickit_window_setctl_int(3). So like… it works, it's iconic, but the cool kids are doing it the other way now. 🙈

💖 RETURN VALUE 💖

• tickit_window_is_steal_input() returns a boolean. true or false, that's it, that's the whole meal. 🍓
• tickit_window_set_steal_input() returns no value. She gives nothing back and that's on periodt. 💀

👑 SEE ALSO 👑

• tickit_window_new(3)
• tickit_window(7)
• tickit(7)

okay that's the whole page, you ate it, you understood it, I'm so proud 🥹💖

this has been the Library Functions Manual chapter of the Tickit saga, filed under TICKIT_WIN...STEAL_INPUT(3) — mwah, bye bestie, go steal some input 💅✨🦋