DTPRINT(5)

💖 Dt/Print.h — print definitions 💖

the file formats manual page, but make it group chat, bestie ✨

🎀 NAME 🎀

Dt/Print.h — print definitions. That's the whole vibe: this header is the blueprint for the Print widget class, and it's giving resource names, resource values, callback lore, structs, and function prototypes. 🫶

✨ SYNOPSIS ✨

#include &<Dt/Print.h>

Okay so you include it like that, exactly. 💅

💅 DESCRIPTION 💅

The Dt/Print.h header defines resource names, resource values, callback reasons, callback structures, and function prototypes for the Print widget class. It's a lot, but we're gonna get through it together. 🌸

🏷️ Resource names (the DtN girlies)

The Dt/Print.h header defines the following resource names:

• DtNcancelCallback → cancelCallback
• DtNclosePrintDisplayCallback → closePrintDisplayCallback
• DtNcopies → copies
• DtNdescription → description
• DtNdestroyContextCallback → destroyContextCallback
• DtNfileName → fileName
• DtNminimizeButtons → minimizeButtons (if not otherwise named)
• DtNoptionCount → optionCount
• DtNoptions → options
• DtNprintCallback → printCallback
• DtNprintDestination → printDestination
• DtNprinterInfoProc → printerInfoProc
• DtNprinterName → printerName
• DtNprintSetupMode → printSetupMode
• DtNselectFileProc → selectFileProc
• DtNselectPrinterProc → selectPrinterProc
• DtNsetupCallback → setupCallback
• DtNverifyPrinterProc → verifyPrinterProc
• DtNworkAreaLocation → workAreaLocation

🎀 Resource values (the DtC crew, plus one DtR)

And these are the resource values, no cap:

• DtCCancelCallback → CancelCallback
• DtCClosePrintDisplayCallback → ClosePrintDisplayCallback
• DtCCopies → Copies
• DtCDescription → Description
• DtCDestroyContextCallback → DestroyContextCallback
• DtCFileName → FileName
• DtCMinimizeButtons → MinimizeButtons (if not otherwise named)
• DtCOptionCount → OptionCount
• DtCOptions → Options
• DtCPrintCallback → PrintCallback
• DtCPrintDestination → PrintDestination
• DtCPrinterInfoProc → PrinterInfoProc
• DtCPrinterName → PrinterName
• DtCPrintSetupMode → PrintSetupMode
• DtCSelectFileProc → SelectFileProc
• DtCSelectPrinterProc → SelectPrinterProc
• DtCSetupCallback → SetupCallback
• DtCVerifyPrinterProc → VerifyPrinterProc
• DtCWorkAreaLocation → WorkAreaLocation
• DtRPrintSetupProc → PrintSetupProc

🌈 Values for DtNsetupMode

The Dt/Print.h header declares the following values for the DtNsetupMode resource:

• DtPRINT_SETUP_PLAIN
• DtPRINT_SETUP_XP

🦋 Values for DtNworkAreaLocation

The Dt/Print.h header declares the following values for the DtNworkAreaLocation resource:

• DtWORK_AREA_NONE
• DtWORK_AREA_TOP
• DtWORK_AREA_TOP_AND_BOTTOM
• DtWORK_AREA_BOTTOM

💜 Values for DtNprintDestination

The Dt/Print.h header declares the following values for the DtNprintDestination resource:

• DtPRINT_NO_DESTINATION
• DtPRINT_TO_PRINTER
• DtPRINT_TO_FILE

🍓 Values for DtNprinterNameMode

The Dt/Print.h header declares the following values for the DtNprinterNameMode resource:

• DtSHORT_NAME
• DtMEDIUM_NAME
• DtLONG_NAME

🧚 Mode values for DtPrintSetupBoxResetConnection()

The Dt/Print.h header declares the following mode values for DtPrintSetupBoxResetConnection():

       typedef enum {
           DtPRINT_CLOSE_CONNECTION,
           DtPRINT_RELEASE_CONNECTION
       } DtPrintResetConnectionMode;

🔥 Callback reasons

The Dt/Print.h header declares the following callback reasons:

• DtPRINT_CR_NONE
• DtPRINT_CR_CANCEL
• DtPRINT_CR_CLOSE_PRINT_DISPLAY
• DtPRINT_CR_PRINT
• DtPRINT_CR_SETUP

👑 Return values for the DtPrint procedure

The Dt/Print.h header declares the following return values for the DtPrint procedure:

• DtPRINT_SUCCESS,
• DtPRINT_BAD_PARM,
• DtPRINT_FAILURE,
• DtPRINT_INVALID_DISPLAY,
• DtPRINT_NOT_XP_DISPLAY,
• DtPRINT_NO_CONNECTION,
• DtPRINT_NO_DEFAULT,
• DtPRINT_NO_DEFAULT_DISPLAY,
• DtPRINT_NO_PRINTER,
• DtPRINT_PRINTER_MISSING

💀 What those return values mean (where the page gives the tea)

• DtPRINT_SUCCESS — The X printer connection was successfully obtained.
• DtPRINT_BAD_PARM — The value passed for print_data is NULL, or the value of the DtNprintSetupMode resource for wid is not DtPRINT_SETUP_XP.
• DtPRINT_FAILURE — The X printer connection failed.
• DtPRINT_INVALID_DISPLAY — The indicated X print server could not be found.
• DtPRINT_NOT_XP_DISPLAY — The indicated X server does not support the X Printing Extension.
• DtPRINT_NO_CONNECTION — An open X print server connection is not currently being managed by the DtPrintSetupBox.
• DtPRINT_NO_PRINTER — The indicated printer could not be found on the X print server, or a default printer could not be determined.

The page doesn't give one-liners for DtPRINT_NO_DEFAULT, DtPRINT_NO_DEFAULT_DISPLAY, or DtPRINT_PRINTER_MISSING, so we're not inventing any. 💅

🌟 Class record constants

The Dt/Print.h header declares the following class record constants:

       WidgetClass dtPrintSetupBoxWidgetClass;

       _DtPrintSetupBoxClassRec * DtPrintSetupBoxWidgetClass;
       _DtPrintSetupBoxRec      * DtPrintSetupBoxWidget;

🫶 Callback prototypes

The header defines the following callback prototypes:

       typedef struct _DtPrintSetupData
       {
           String    printer_name;
           Display   *print_display;
           XPContext      print_context;
           XtEnum    destination;
           String    dest_info;
       } DtPrintSetupData;

       typedef struct _DtPrintSetupCallbackStruct
       {
           int       reason;
           XEvent         *event;
           DtPrintSetupData    *print_data;
       } DtPrintSetupCallbackStruct;

🌸 Functions

The header defines the following functions:

       Widget DtCreatePrintSetupBox(
                           Widget   p,
                           String   name,
                           ArgList  args,
                           Cardinal n);

       Widget DtCreatePrintSetupDialog(
                           Widget   ds_p,
                           String   name,
                           ArgList  sb_args,
                           Cardinal sb_n);

       DtPrintSetupData* DtPrintCopySetupData(
                                  DtPrintSetupData*        target,
                                  const DtPrintSetupData*  source);

       XtEnum DtPrintFillSetupData(
                          Widget          psub,
                          DtPrintSetupData*   print_data);

       void DtPrintFreeSetupData(
                        DtPrintSetupData* target);

       XtEnum DtPrintResetConnection(
                            Widget                     psub,
                            DtPrintResetConnectionMode m);

🌈 SEE ALSO 🌈

DtCreatePrintSetupBox(3), DtCreatePrintSetupDialog(3), DtPrintCopySetupData(3), DtPrintFillSetupData(3), DtPrintFreeSetupData(3), DtPrintResetConnection(3), DtPrintSetupBox(3), Print(4), and dtprintinfo(1).

---

✨ signed off with the Dt/Print.h (file formats) footer energy — that's the source/version tea, and no separate date is shown, so we're keeping it cute and factual. Periodt. 🫶💅