XMPRINTPOPUPPDM(3)

💖 XmPrintPopupPDM 💖

okay bestie, welcome to the XmPrintPopupPDM page — it's a library call and it is literally the little messenger that tells the PDM to show up. no cap. let's get into it 🫶

---

✨ NAME ✨

XmPrintPopupPDM — Send a notification for the PDM to be popped up 💅

---

🌸 SYNOPSIS 🌸

#include <Xm/Print.h>
XtEnum XmPrintPopupPDM(
Widgetprint_shell,
Widgetvideo_transient_for);

yes the spacing is exactly like that, do not come for me, I'm just the messenger 🎀

---

🦋 DESCRIPTION 🦋

okay so. XmPrintPopupPDM is a convenience function that sends a notification to start a Print Dialog Manager on behalf of the application. and the way it does that? it hides all the details of the X selection mechanism that's used to notify the PDM that a new dialog has to be popped up for this app. you don't have to think about it, it just handles it. iconic behaviour honestly. 👑

so here's the tea: XmPrintPopupPDM sends a selection request to either the print display of the print shell, or the video display of the transient_for video widget — and which one it picks depends on the environment variable XPDMDISPLAY, which can only take the value "print" or "video". it's asking for the PDM windows to be popped up on behalf of the app. that's the whole vibe check. 🌈

now for the important part, because this is where people get confused:

it returns right away, with either the status XmPDM_NOTIFY_FAIL or XmPDM_NOTIFY_SUCCESS.

• XmPDM_NOTIFY_FAIL happens when things go wrong — e.g. if the function couldn't malloc memory for the selection value, or if XPDMDISPLAY is not "print" or "video".
• XmPDM_NOTIFY_SUCCESS only means a "message" was sent out to the PDM specified by XPDMSELECTION. it does NOT mean it's already up on the screen yet. 😭 please internalise this, it's giving "delivered ≠ read".

🚨 and in order to actually know if the PDM is up, or not running, the application must register a XmNpdmNotificationCallback with the Print Shell. there is no other way, bestie. that's the rule. ⭐

one more cute detail: XmPrintPopupPDM puts up an InputOnly window on top of the dialog, so that the end user doesn't go poking at the print setup dialog while the PDM is still trying to come up. main character protective energy tbh. 🙈 and this window is automatically removed when the shell is about to call the callback for the first time. self-cleaning, we love to see it.

• print_shell — The Print Shell used for this print job and context.
• video_transient_for — The video widget dealing with application print setup.

---

💜 RETURN VALUE 💜

Returns XmPDM_NOTIFY_SUCCESS if the function was able to send the notification out to the PDM process, XmPDM_NOTIFY_FAIL otherwise.

that's it. that's the whole return story. short and sweet fr fr. 🍓

---

💀 ERRORS/WARNINGS 💀

Not applicable.

(nothing to see here, we're all good, no drama today ✨)

---

🎀 EXAMPLES 🎀

example one — callback from a Print set up dialog box "Setup..." button:

PrintSetupCallback(print_dialog...)
/*-------------*/
{
    if (XmPrintPopupPDM (pshell, XtParent(print_dialog)) !=
                                    XmPDM_NOTIFY_SUCCESS) {
        /* some error dialog */
    }
}

example two — XmNpdmNotificationCallback from a Print Shell:

pdmNotifyCB(print_shell...)
{
    XmPrintShellCallBackStruct * pr_cb = ...

    switch (pr_cb->reason) {
       case XmCR_PDM_NONE:
           /* no PDM available */
           PostErrorDialog(...);
           break;
       case XmCR_PDM_VXAUTH:
           /* PDM is not authorized ... */
           PostErrorDialog(...);
           break;
       case XmCR_PDM_UP: the PDM is up and running
           /* everything is fine */
           break;
               default: /* other cases */
   }
}

---

🌟 SEE ALSO 🌟

• XmPrintSetup(3)
• XmPrintShell(3)
• XmRedisplayWidget(3)
• XmPrintToFile(3)

---

and that's the page babes 🫶 this was XmPrintPopupPDM, from the library call section, and the footer of this page is literally just XmPrintPopupPDM(library call) — so consider this your lil sign-off. go forth and pop up that PDM. 💅✨🌸