XCirculateRequestEvent(3)

📦
version 1.8.14 · 8 versions
, in alpine 3.24, arch rolling, nixos 26.05, nixpkgs unstable

✨ NAME ✨

XCirculateRequestEvent — CirculateRequest event structure 🌀

okay bestie, this is the XCirculateRequestEvent(3) page from the XLIB FUNCTIONS manual. It’s the struct for CirculateRequest events, and it’s lowkey iconic for stacking-order drama. 👑

🧚 STRUCTURES 🧚

The structure for CirculateRequest events contains:

typedef struct {
        int type;       /* CirculateRequest */
        unsigned long serial;   /* # of last request processed by server */
        Bool send_event;        /* true if this came from a SendEvent request */
        Display *display;       /* Display the event was read from */
        Window parent;
        Window window;
        int place;      /* PlaceOnTop, PlaceOnBottom */
} XCirculateRequestEvent;

When you receive this event, the structure members are set as follows, fr fr:

  • type — set to the event type constant name that uniquely identifies it. For example, when the X server reports a GraphicsExpose event to a client application, it sends an XGraphicsExposeEvent structure with the type member set to GraphicsExpose. 👀
  • display — set to a pointer to the display the event was read on. 🖥️
  • send_event — set to True if the event came from a SendEvent protocol request. 🫶
  • serial — set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. 🔢
  • window — set to the window that is most useful to toolkit dispatchers. 💅

Then the stacking-order part of the story:

  • parent — set to the parent window.
  • window — set to the subwindow to be restacked.
  • place — set to what the new position in the stacking order should be, and it’s either PlaceOnTop or PlaceOnBottom. If it is PlaceOnTop, the subwindow should be on top of all siblings. If it is PlaceOnBottom, the subwindow should be below all siblings. ✨
bestie note: yes, window shows up twice in the original description — once as “most useful to toolkit dispatchers” and once as “the subwindow to be restacked.” Both are real, no cap. 🫶

👑 SEE ALSO 👑

XAnyEvent(3), XButtonEvent(3), XCreateWindowEvent(3), XCirculateEvent(3), XColormapEvent(3), XConfigureEvent(3), XConfigureRequestEvent(3), XCrossingEvent(3), XDestroyWindowEvent(3), XErrorEvent(3), XExposeEvent(3), XFocusChangeEvent(3), XGraphicsExposeEvent(3), XGravityEvent(3), XKeymapEvent(3), XMapEvent(3), XMapRequestEvent(3), XPropertyEvent(3), XReparentEvent(3), XResizeRequestEvent(3), XSelectionClearEvent(3), XSelectionEvent(3), XSelectionRequestEvent(3), XUnmapEvent(3), XVisibilityEvent(3)

Xlib - C Language X Interface

that’s the whole page, bestie — footer energy is X Version 11 / libX11 1.8.14, date slot not printed on this one, and that’s the tea ☕💖✨

📦 where this page comes from