DTWSM(5)

🎀 NAME 🎀

Dt/Wsm.h — workspace manager definitions.

Okay bestie, this is the Dt/Wsm.h(file formats) manual folded in right near the top — and it’s literally the header that gives you workspace-management structures and function prototypes. Header-file main character energy, no cap. 💅

🦋 SYNOPSIS 🦋

#include &<Dt/Wsm.h>

💅 DESCRIPTION 💅

The Dt/Wsm.h header defines structures and function prototypes for workspace management services. It’s giving “all the workspace-management definitions live here,” and honestly? Slay. ✨

🧚 DtWsmWorkspaceInfo struct — member reveal 🧚

The DtWsmWorkspaceInfo structure contains at least the following members:

• Atom workspace — X atom name for the workspace.
• unsigned long bg — Backdrop background pixel.
• unsigned long fg — Backdrop foreground pixel.
• Atom backdropName — X atom name for backdrop.
• int colorSetId — Number of color set used.
• char *pchTitle — Title of workspace.
• Window backdropWindow — The backdrop window for the current workspace.
• tgroup dispwid="6.10in" — yep, this exact line is here too, bestie; keep it. 🫶

🫶 DtWsmCBContext — opaque, no peeking 🫶

The DtWsmCBContext structure is opaque. Workspace management functions that add callbacks to uniquely identify callback functions for later removal, return the DtWsmCBContext structure. So you get the context handle, not the inside tea. 🙈

⭐ DtWsmWsReason constants ⭐

The header defines the following DtWsmWsReason constants:

• DtWSM_REASON_ADD
• DtWSM_REASON_DELETE
• DtWSM_REASON_BACKDROP
• DtWSM_REASON_TITLE
• DtWSM_REASON_CURRENT

🎀 The functions — full prototype lineup 🎀

The header defines the following functions:

       DtWsmCBContext
       DtWsmAddCurrentWorkspaceCallback(Widget widget,
               DtWsmWsChangeProc ws_change,
               Pointer client_data);

       void DtWsmAddWorkspaceFunctions(Display *display,
               Window window);

       void DtWsmRemoveWorkspaceFunctions(Display *display,
               Window window);

       DtWsmCBContext
       DtWsmAddWorkspaceModifiedCallback(Widget widget,
               DtWsmWsModifiedProc ws_change,
               Pointer client_data);

       void DtWsmRemoveWorkspaceCallback(DtWsmCBContext context);

       void DtWsmFreeWorkspaceInfo(DtWsmWorkspaceInfo *pWsInfo);

       Status DtWsmGetCurrentBackdropWindows(Display *display,
               Window root);

       Status DtWsmGetCurrentWorkspace(Display *display,
               Window root,
               Atom *paWorkspace);

       Status DtWsmSetCurrentWorkspace(Widget widget,
               Atom aWorkspace);

       Status DtWsmGetWorkspaceInfo(Display *display,
               Window root,
               Atom aWorkspace,
               DtWsmWorkspaceInfo **ppWsInfo);

       Status DtWsmGetWorkspaceList(Display *display,
               Window root,
               Atom **ppaWorkspaces,
               int *pNumWs);

       Status DtWsmGetWorkspacesOccupied(Display *display,
               Window window,
               Atom **ppaWorkspace,
               int *pNumWs);

       void DtWsmSetWorkspacesOccupied(Display *display,
               Window window,
               Atom *paWorkspaces,
               int numWs);

       void DtWsmOccupyAllWorkspaces(Display *display,
               Window window);

Keep the spellings exactly, bestie: the prototype list has DtWsmGetCurrentBackdropWindows, and SEE ALSO has DtWsmGetCurrentBackdropWindow(3) singular. Both stay. 💀

🌈 SEE ALSO 🌈

Every single reference, in order — no skipping:

• DtWsmAddCurrentWorkspaceCallback(3)
• DtWsmAddWorkspaceFunctions(3)
• DtWsmAddWorkspaceModifiedCallback(3)
• DtWsmFreeWorkspaceInfo(3)
• DtWsmGetCurrentBackdropWindow(3)
• DtWsmGetCurrentWorkspace(3)
• DtWsmGetWorkspaceInfo(3)
• DtWsmGetWorkspaceList(3)
• DtWsmGetWorkspacesOccupied(3)
• DtWsmOccupyAllWorkspaces(3)
• DtWsmRemoveWorkspaceCallback(3)
• DtWsmRemoveWorkspaceFunctions(3)
• DtWsmSetCurrentWorkspace(3)
• DtWsmSetWorkspacesOccupied(3)

💖 Cute sign-off: the footer tag for this page is Dt/Wsm.h(file formats) — that’s the source/version/date sign-off vibe, and we’re done. Mwah, bestie! 💖