Descendants

DtPrintSetupBox creates the descendants shown in the following table. An application can use XtNameToWidget to gain access to the named descendent. In addition, a user or an application can use the descendant name when specifying resource values.

Classes

DtPrintSetupBox inherits behavior and resources from the Core, Composite, Constraint, XmManager, and XmBulletinBoard superclasses.

The class pointer is dtPrintSetupBoxWidgetClass.

The class name is DtPrintSetupBox.

Resources

The following table lists the DtPrintSetupBox resources.

The DtPrintSetupBox resources are defined as follows:

DtNcancelCallback

Specifies the list of callbacks that is called when the Cancel button is activated. The callback reason is DtPRINT_CR_CANCEL.

DtNclosePrintDisplayCallback

When the value of the DtNprintSetupMode resource is DtPRINT_SETUP_XP, DtPrintSetupBox will manage the X printing display connection and print context. As such, DtNclosePrintDisplayCallback is provided to allow an application to perform any desired processing (such as destroying windows created on the print display) before DtPrintSetupBox destroys the current print context and closes the current print display connection.

This callback list will not be called if the value of the DtNprintSetupMode resource is anything other than DtPRINT_SETUP_XP.

The callback reason is DtPRINT_CR_CLOSE_PRINT_DISPLAY.

DtNcopies

The number of copies of the document to print. This is a spin box into which the user may enter a positive integer.

DtNdescription

A description of the printer as provided by the system administrator.

DtNfileName

Specifies the name of the destination file. Setting this resource will update the value of the File Name text field.

DtNgetAttributesCallback

Specifies the list of callbacks that is called whenever DtPrintSetupBox receives an XPAttributeNotify event, or immediately after a new X printer connection is established. This callback list will only be called if the value of the DtNprintSetupMode resource is DtPRINT_SETUP_XP.

This callback is intended to be used by applications that utilize X Print Service attributes directly. These applications will be interested in changes made to the printing attributes by DtPrintSetupBox or by other processes, such as the Print Dialog Manager (PDM).

One of two callback reason codes will be set for this callback. The two reasons are of particular interest to applications that elect to present information in their GUI based on X Print Service attributes. The following indicates how such applications should respond to each code:

DtNminimizeButtons

If false, sets the dimensions of all of the buttons at the bottom of the widget to the width of the widest button and the height of the tallest button. If true, the dimensions of the buttons are not altered.

DtNprintCallback

Specifies the list of callbacks that is called when the Print button is activated. The callback reason is DtPRINT_CR_PRINT. This callback is used to initiate the print job.

DtNprintDestination

Indicates where the print output should be directed. Valid values for this resource are:

DtNprinterInfoProc

This resource specifies the procedure that will be used to present printer information in response to activation of the Printer Information button. The printer selection dialog presented by the default DtNselectPrinterProc will also call this procedure in response to activation of its Printer Information button.

If the value of the DtNprintSetupMode resource is DtPRINT_SETUP_XP, a default procedure that presents a printer information dialog is used. For other values of DtNprintSetupMode, the default value of DtNprinterInfoProc is NULL.

Typically, this procedure does not update DtPrintSetupBox resources nor X Print Service attributes. The return value of this procedure is ignored by DtPrintSetupBox. However, it is recommended that the procedure follow the conventions presented in the "DtPrintSetupProc" section to ensure future compatibility.

DtNprinterName

The name of the printer to send the print job to.

If the value of the DtNprintSetupMode resource is DtPRINT_SETUP_XP, setting this resource will update the Printer Name field based on the value of the XpPrinterNameMode XRM resource. See the "EXTERNAL INFLUENCES" section in this man page for more information. If the value of the DtNprintSetupMode resource is DtPRINT_SETUP_PLAIN, setting this resource will update the value of the Printer Name text field with the value of this resource.

DtNprintSetupMode

Instructs the widget as to whether or not it is being used in an application that utilizes the X Print Service. If so, then the widget will manage the X printing display connection and print context, and provide defaults for a number of X printing operations, such as printer selection and information dialogs, and printer verification. Refer to individual resource descriptions to determine if and how they are affected by the value of this resource. Valid values for this resource are:

DtNselectFileProc

This resource specifies the procedure that will be used in response to activation of the Select File button. The default value for this resource is a pointer to a procedure which will invoke an XmFileSelectionBox dialog to select a file name.

If the user cancels the file selection dialog, no DtPrintSetupBox components will be updated. If the user selects a file name, the file name will be set as the value for the DtNfileName resource. This procedure communicates the newly selected file name to DtPrintSetupBox by setting the DtNfileName resource.

Since the default procedure presents a File Selection Dialog, the resource is actually set after the procedure returns, due to the asynchronous nature of widgets and callbacks. The return value of this procedure is ignored by DtPrintSetupBox. However, it is recommended that the procedure follow the conventions presented in the "DtPrintSetupProc" section to ensure future compatibility.

DtNselectPrinterProc

This resource specifies the procedure that will be used in response to activation of the Select Printer button. If the value of the DtNprintSetupMode resource is DtPRINT_SETUP_XP, a default procedure that invokes a DtPrinterSelectionDialog is used. If the user cancels the printer selection dialog no DtPrintSetupBox components will be updated. If the user selects a printer, the printer will be set as the value for the DtNprinterName resource.

This procedure communicates the newly selected printer name to DtPrintSetupBox by setting the DtNprinterName resource. Since the default procedure presents a Printer Selection Dialog, the resource is actually set after the procedure returns, due to the asynchronous nature of widgets and callbacks.

If the value of the DtNprintSetupMode resource is anything other than DtPRINT_SETUP_XP, the default value of DtNselectPrinterProc is NULL.

The return value of this procedure is ignored by DtPrintSetupBox. However, it is recommended that the procedure follow the conventions presented in the "DtPrintSetupProc" section to ensure future compatibility.

DtNsetAttributesCallback

Specifies the list of callbacks that is called whenever DtPrintSetupBox is about to perform an operation that will utilize X Print Service attributes. This callback list will only be called if the value of the DtNprintSetupMode resource is DtPRINT_SETUP_XP.

This callback is intended to be used by applications that utilize X Print Service attributes directly. This callback provides these applications with a chance to set attributes whenever a subsequent DtPrintSetupBox operation will utilize the current set of attributes (for example, prior to calling the DtNprintCallback list).

The callback reason is DtPRINT_CR_SET_ATTRIBUTES.

DtNsetupProc

This resource specifies the procedure that will be used in response to activation of the Setup button. If the value of the DtNprintSetupMode resource is DtPRINT_SETUP_XP, a default procedure is provided that will call XpNotifyPDM in order to present the setup dialog provided by the Print Dialog Manager.

If the value of the DtNprintSetupMode resource is anything other than DtPRINT_SETUP_XP, the default value of DtNsetupProc is NULL.

This procedure typically updates X Print Service attributes, and does not set any DtPrintSetupBox resources.

The return value of this procedure is ignored by DtPrintSetupBox. However, it is recommended that the procedure follow the conventions presented in the "DtPrintSetupProc" section to ensure future compatibility.

DtNverifyPrinterProc

This resource specifies the procedure that will be used to verify the current value of the DtNprinterName resource before any operation requiring a valid printer is performed. If the current value of the DtNprinterName resource is NULL, this procedure will set a default printer as the value of the DtNprinterName resource.

If this procedure provides a default printer name, or a fully qualified X printer name, it should communicate the new name to DtPrintSetupBox by setting the DtNprinterName resource before returning.

If the value of the DtNprintSetupMode resource is DtPRINT_SETUP_XP, a default procedure will be set as the value of the DtNverifyPrinterProc resource. This default procedure will verify the X printer, and establish a print display connection and print context for the printer. The procedure communicates the new print display and context to DtPrintSetupBox by updating the print_data->print_display and print_data->print_context elements of the callback structure prior to returning.

If the value of the DtNprintSetupMode resource is anything other than DtPRINT_SETUP_XP, the default value of DtNverifyPrinterProc is NULL.

If the value of the DtNverifyPrinterProc resource is NULL, the printer name is always considered valid.

If this procedure determines the printer name is valid or sets a valid printer name (and X printer connection information), it should return DtPRINT_SUCCESS. If the printer name is invalid or no valid default can be determined, this procedure should return DtPRINT_FAILURE.

DtNworkAreaLocation

Indicates how to position work area children within the DtPrintSetupBox. Possible values are:

The effect of adding more work area children than indicated by the value of DtNworkAreaLocation is undefined.

Inherited Resources

DtPrintSetupBox inherits resources from the XmBulletinBoard, XmManager, Constraint, Composite, and Core superclasses. Refer to the reference pages for these superclasses for inherited resources and their descriptions.

Callback And Procedure Resource Information

DtPrintSetupBox defines a new structure, DtPrintSetupData, that is passed to callbacks and procedure resource values. For callbacks only, DtPrintSetupBox defines a new callback structure, DtPrintSetupCallbackStruct. Not all fields in these structures are valid for all callbacks and procedures. For callbacks, the application must first look at the reason field, and use only the structure members that are valid for that particular reason. For each procedure, the application should only reference structure members that are defined as valid for that particular procedure. The DtPrintSetupData and DtPrintSetupCallbackStruct structures are defined as follows:

typedef struct
{


    String              printer_name;


    Display             *print_display;


    XPContext           print_context;


    XtEnum              destination;


    String              dest_info;
} DtPrintSetupData;

printer_name

Contains the current value of the DtNprinterName resource.

print_display

If DtNprintSetupMode is DtPRINT_SETUP_XP, print_display contains a pointer to the Display structure for the current X Printer. For other values of DtNprintSetupMode, this field is NULL.

print_context

If DtNprintSetupMode is DtPRINT_SETUP_XP, print_context contains the print context handle for the current X Printer. For other values of DtNprintSetupMode, this field is NULL.

destination

Contains the current value of the DtNprintDestination resource.

dest_info

Additional information about the print destination as indicated by the destination field.

If destination is DtPRINT_TO_FILE, this field contains the name of the file to print to.

If destination is DtPRINT_TO_PRINTER, this field contains the name of the currently selected printer as determined by the current value of the XpPrinterNameMode resource. This is useful for display within dialogs displaying print status, etc. because it is the printer name as presented to the user in DtPrintSetupBox.

typedef struct
{


    int                 reason;


    XEvent              *event;


    DtPrintSetupData    *print_data;
} DtPrintSetupCallbackStruct;

reason

Indicates why the callback was invoked.

event

Points to the XEvent that triggered the callback. It can be NULL.

print_data

Points to a DtPrintSetupData structure containing additional callback information.

The following table indicates for each callback reason which DtPrintSetupCallbackStruct and DtPrintSetupData members are valid.

The following table indicates for each procedure resource which DtPrintSetupData members are valid:

Translations

DtPrintSetupBox inherits translations from XmBulletinBoard.

Virtual Bindings

The bindings for virtual keys are implementation-dependent. For information about bindings for virtual buttons and keys, see VirtualBindings(3).

XRM Application Resources

XpPrinter

This variable defines the default destination X Printer Specifier for DtPrintSetupBox. If the specifier is just a printerName, the host:display portion of the specifier is obtained by checking if the X Server to which the client application is connected is an X Print Server managing printerName. Otherwise, the first server in the XpServerList or XPSERVERLIST that manages the printer will be used. If the :display number is omitted, :0 is assumed.

Example:

Dtmail*XpPrinter: laser_1@callisto:6

XpPrinterNameMode

This resource indicates how an X Printer Specifier shall be shown in the Printer Name combo box text. Valid values for this resource are:

printer@host

printer@host:6

If this resource is not specified, DtPrintSetupBox will assume a default of DtSHORT_NAME.

XpPrinterList

This resource defines the initial set of X Printer Specifiers shown in the Printer Name combo box list.

The resource value is a whitespace-delimited list of partially or fully specified X Printer Specifiers. When the user selects a specifier from this list, if the specifier is just a printerName, the host:display portion of the specifier is obtained by checking if the X Server to which the client application is connected is an X Print Server managing printerName. Otherwise the first server in the XpServerList or XPSERVERLIST that manages the printer will be used. If the: display number is omitted, :0 is assumed.

Example:

*xpPrinterList: laser laser2@argon:3 laser7@xenon

XpServerList

This resource contains a list of X Print Server specifiers. Each entry in the list is of the form host:display, and is separated from other entries by whitespace. DtPrintSetupBox uses this list to fully qualify partial X Printer Specifiers consisting of just the printerName.

Example:

*.XpServerList: hanz:6 franz:6 ahnold:6

Environment Variables

PDPRINTER, LPDEST, PRINTER

If the XPRINTER, environment variable and the XpPrinter resource are not specified, DtPrintSetupBox will check the environment variables (in order) PDPRINTER, LPDEST, and PRINTER to obtain' a printerName that can be used to generate an X Printer Specifier to use for the default X Printer shown in the Printer Name combo box text field. The host:display portion of the specifier is obtained by checking if the X Server to which the client application is connected is an X Print Server managing printerName. If not, the list of X Print Servers specified in the XpServerList or XPSERVERLIST is queried, until the first X Printer with a matching printerName is found.

XPRINTER

The specification of the XPRINTER environment variable is the same as the XpPrinter resource.

XPRINTERLIST

The specification of the XPRINTERLIST environment variable is the same as the the XpPrinterList resource.

XPSERVERLIST

The specification of the XPSERVERLIST environment variable is the same as the the XpServerList resource.