PtPrintSel

A widget for selecting printing properties

Class hierarchy:

PtWidget → PtBasic → PtContainer → PtPrintSel

For more information, see the diagram of the widget hierarchy.

PhAB icon:

Public header:

<photon/PtPrintSel.h>

Description:

The PtPrintSel widget lets you select a printer, change its properties, and optionally select a range of pages and the number of copies to print.

A PtPrintSel widget.

The widget has a resource for a print context, Pt_ARG_PRINT_CONTEXT, that you must set to one you've created with PpCreatePC():

PtSetArg(&args[0], Pt_ARG_PRINT_CONTEXT, pc, 0);
/* Set some other resources... */
printsel = PtCreateWidget(PtPrintSel, window, nargs, args);

The widget automatically handles all aspects of selecting a printer and also runs the properties application to modify elements in the print context. When you're finished selecting the printer, you can get the modified print context by using PtGetResource() or PtGetResources() to get the widget's print-context resource:

/* The user has finished configuring the print session. */

PtGetResource( printsel, Pt_ARG_PRINT_CONTEXT, &pc, 0);

New resources:

---

If you click on the Preferences button, the widget displays the Printer Properties dialog by PtPrintPropSelect(). You can customize this dialog by setting some pseudo-resources. They aren't really widget resources, but you can set them for PtPrintSel as if they were, and the widget passes the settings to PtPrintPropSelect(). For details about these resources, see the Photon Library Reference.

---

Pt_ARG_PRINT_CONTEXT

The current Print Context settings. This resource isn't available through PhAB, but you'll need a Print Context in order to do any printing. Use PpCreatePC() to create a Print Context, and PpSetPC() to change its settings.

---

When you use PtGetResources() to get this resource, you must provide a PpPrintContext_t structure, which is filled in directly with the values of the context. Unlike most calls to PtGetResources(), you aren't given a pointer into the widget's internal memory.

---

Pt_ARG_PRINT_FILE

The name of the destination file when a document is printed to a file.

Pt_ARG_PRINT_FLAGS

Flags that modify the appearance of the widget:

Pt_PRINTSEL_FILE_PANE

Enable the Send to file pane.

Pt_PRINTSEL_NO_COPIES

Disable the Copies widget.

Pt_PRINTSEL_NO_PAGE_RANGE

Disable the Print Range toggle button and the From and To fields.

Pt_PRINTSEL_NO_PRINTSELECT

Disable the printer-name combobox. Physical output goes to the default physical printer whose name is shown.

Pt_PRINTSEL_NO_SELECT_RANGE

Disable the Print Selection toggle button.

Pt_PRINTSEL_PREFERENCES

Enable the Preferences button.

Pt_PRINTSEL_SETTINGS_PANE

Enable the Print Pages, Print Order and Copies panes.

The following flag macros are defined in <PtPrintSel.h>:

Pt_PRINTSEL_ALL_PANES

Pt_PRINTSEL_FILE_PANE | Pt_PRINTSEL_SETTINGS_PANE

Pt_PRINTSEL_DFLT_LOOK

Pt_PRINTSEL_FILE_PANE | Pt_PRINTSEL_SETTINGS_PANE | Pt_PRINTSEL_PREFERENCES

Pt_ARG_PS_LBL_ALL

The label used for the button used to print all the pages.

Pt_ARG_PS_LBL_COLLATED

The label used for the toggle button used to collate the pages.

Pt_ARG_PS_LBL_COPIES

The label for the field for specifying the number of copies.

Pt_ARG_PS_LBL_DOUBLE_SIDED

The label for the toggle button used to choose between single- and double-sided printing.

Pt_ARG_PS_LBL_FILE

The label of the field used to specify the name of the file to print to.

Pt_ARG_PS_LBL_FROM

The label used for the lower end of a range of pages to print.

Pt_ARG_PS_LBL_NAME

The label for the field that holds the printer's name.

Pt_ARG_PS_LBL_NOT_COLLATED

The label for the button that requests noncollated printing.

Pt_ARG_PS_LBL_PREFERENCES

The label for the button for choosing print preferences.

Pt_ARG_PS_LBL_PRINT_ORDER

The title for the pane for selecting the order in which pages are printed.

Pt_ARG_PS_LBL_PRINT_PAGES

The title of the pane for choosing which pages to print.

Pt_ARG_PS_LBL_RANGE

The label of the button and fields used to select a range of pages for printing.

Pt_ARG_PS_LBL_REVERSED

The label for the button to select printing in reverse order.

Pt_ARG_PS_LBL_SELECTION

The label for the button for printing just the selected pages.

Pt_ARG_PS_LBL_SEND_TO_FILE

The title of the pane used to send the output to a file.

Pt_ARG_PS_LBL_SEND_TO_PRINTER

The title of the pane used to send the output to a printer.

Pt_ARG_PS_LBL_TO

The label used for the upper end of a range of pages to print.

Pt_CB_PRINT_PROPS

A list of PtCallback_t structures that define the callbacks that are invoked when you click on the Preferences button. If this resource isn't set or is set to NULL, clicking the Preferences button displays the Print Properties dialog by invoking the PtPrintPropSelect() convenience function; for more information, see the Photon Library Reference.

Each callback is passed a PtCallbackInfo_t structure that contains at least the following members:

reason

Pt_CB_PRINT_PROPS

reason_subtype

One of the following:

• Pt_CB_PRINT_PROPS_END
• Pt_CB_PRINT_PROPS_START

event

A pointer to a PhEvent_t structure that describes the event that caused the callback to be invoked.

cbdata

A pointer to a PpPrintContext_t structure. For more information, see the Printing chapter of the Photon Programmer's Guide.

These callbacks should return Pt_CONTINUE.

Inherited resources:

If the widget modifies an inherited resource, the “Default override” column indicates the new value. This modification affects any subclasses of the widget.

Convenience functions:

The PtPrintSel class defines the following convenience function:

PtPrintSelect()

Display a custom modal dialog for selecting print options

PtPrintSelection()

Display a modal dialog for initiating printing

For more information, see the Photon Library Reference.