xmprintpopuppdm(3) [hpux man page]
XmPrintPopupPDM(library call) XmPrintPopupPDM(library call) NAME
XmPrintPopupPDM -- Send a notification for the PDM to be popped up SYNOPSIS
#include <Xm/Print.h> XtEnum XmPrintPopupPDM( Widgetprint_shell, Widgetvideo_transient_for); DESCRIPTION
A convenience function that sends a notification to start a Print Dialog Manager on behalf of the application, XmPrintPopupPDM hides the details of the X selection mechanism used to notify the PDM that a new dialog must be popped up for this application. XmPrintPopupPDM sends a selection request to either the print display of the print shell, or the video display of the transient_for video widget (depending on the environment variable XPDMDISPLAY, which can only takes the value "print" or "video"), asking for the PDM windows to be popped up on behalf of the app. Return right away with status of XmPDM_NOTIFY_FAIL (e.g. if the function couldn't malloc memory for the selection value, or if XPDMDISPLAY is not "print" or "video") or with XmPDM_NOTIFY_SUCCESS , which only means a "message" was sent out to the PDM specified by XPDMSELECTION , not that it's already up on the screen yet. In order to know if the PDM is up, or not running, the application must register a XmNpdmNotificationCallback with the Print Shell. XmPrintPopupPDM puts up an InputOnly window on top of the dialog, so that the end user doesn't use the print setup dialog while the PDM is trying to come up. This window is automatically removed when the shell is about to call the callback for the first time. 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. ERRORS
/WARNINGS Not applicable. EXAMPLES
Example of 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 of 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) XmPrintPopupPDM(library call)
Check Out this Related Man Page
XpGetPdmStartParams(3Xp) XPRINT FUNCTIONS XpGetPdmStartParams(3Xp) NAME
XpGetPdmStartParams - Builds up parameters in accordance with the PDM Selection Protocol as a standard convenience function. SYNOPSIS
cc [ flag... ] file... -lXp [ library... ] #include <X11/extensions/Print.h> Status XpGetPdmStartParams ( print_display print_window print_context video_display video_window selection_display_return selection_return type_return format_return data_return nelements_return ) Display *print_display; Window print_window; XPContext print_context; Display *video_display; Window video_window; Display **selection_display_return; Atom *selection_return; Atom *type_return; int *format_return; unsigned char **data_return; int *nelements_return; ARGUMENTS
print_display Specifies a pointer to the print Display structure; returned from XOpenDisplay on the X Print Server. print_window Specifies a client window on any screen of print_display long-lived enough for ICCCM communications of the final PDM status ("OK" or "CANCEL" ClientMessage) sent to print_window. print_context An existing print context that the PDM should reference. video_display Specifies a pointer to the video Display structure; returned from XOpenDisplay on the Video X-Server. video_window Specifies the window on video_display near which the transient dialogs from the PDM should be posted. selection_display_return Returns the display connection on which the PDM selection should be made. May be equal to print_display or video_display, or may be a new display connection that the caller should close when done. selection_return Returns the selection atom for which a PDM selection should be made. type_return Returns the type for the PDM Selection Protocol property the caller is expected to create. format_return Returns the format for the PDM Selection Protocol property the caller is expected to create. data_return Returns the data set for the PDM Selection Protocol property the caller is expected to create. The caller is expected to XFree the data when finished. nelements_return Returns the number of elements for the PDM Selection Protocol property the caller is expected to create. DESCRIPTION
This request returns a zero status if an error occurred, non-zero otherwise. XpGetPdmStartParams is a convenience routine used to construct the necessary property information and selection display connection informa- tion needed to initiate a PDM Selection per the "PDM Selection Protocol". Once the information is constructed, the caller is responsible for the creation of a property, the generation of a SelectionRequest, the receipt of a SelectionNotify event, and the receipt of a ClientMessage event, as described in the PDM Selection Protocol. When finished, the caller is expected to free data using XFree. XpGetPdmStartParams returns zero if an error occurred, else non-zero. If an error occurs all other_return values are undefined. Setting the environment variable XPDMSELECTION causes XpGetPdmStartParams to use an alternate selection name. If not set, the selection name PDM_MANAGER is used. Setting the environment variable XPDMDISPLAY causes XpGetPdmStartParams to locate the selection on an alternate X Server. If not set, selection_display_return is set equal to print_display. If XPDMDISPLAY is set to one of the keywords "print" or "video", selection_display_return is set to print_display or video_display, respectively. If XPDMDISPLAY is set to a valid DISPLAY-style string, selection_display_return may be set, as appropriate, to one of print_display, video_display, or to a new display connection opened from within XpGetPdmStartParams. Only in the single case where a new display connection is made should the caller close selection_display_return using XCloseDisplay. When XpGetPdmStartParams is called, the caller's locale (see XpSetLocaleHinter) is included in the information as a "hint" to the Print Dialog Manager (PDM). If supported by the implementation, the PDM will use the hint to display dialogs more appropriately labeled for the locale of the client. If the Print Dialog Manager cannot understand the hint, the PDM will choose a default. Note that the locale of the print attributes that the PDM will subsequently access, will already have been determined when the client called XpCreateContext. The environment variables XPDMDISPLAY and XPDMSELECTION are re-read each time XpGetPdmStartParams is called. SEE ALSO
XpCreateContext(3Xp), XpSetLocaleHinter(3Xp) X Version 11 libXp 1.0.0 XpGetPdmStartParams(3Xp)