pop-up-printer-job-dialog
Arguments:
window &rest restarg
Pops up the print job dialog, where the end user may specify which
printer to print on and what style of printing that printer's driver
should use. This function is normally called only internally when
calling open-stream to create a printer
stream, but any of the arguments to this function may be specified as
initargs to open-stream.
Note that when a frame-with-single-child
instance
was passed to this operator as the value of the
window, the operator is applied to that object
and not its frame-child. If you intend this
operator to apply to the frame-child, pass that as the value of
window.
The argument values will determine the initially-selected options on
the print job dialog, unless :no-dialog-p t
is
passed to bypass the dialog, in which case the argument values
determine the actual print style.
Note that each printer driver supports some subset of these
properties, and ignores any specification of the others. When using
the print job dialog, a driver will typically suppress the properties
that it does not support. But when bypassing the print job dialog by
passing :no-dialog-p, it may not be clear which properties are
supported, and so it's probably best to pass initargs in this case
only for properties such as orientation that are
supported by most any printer driver.
The keyword arguments (open-stream initargs) are:
-
no-dialog-p: if true, then
the print job dialog is not invoked as usual, and the current Windows
printer is used with its current settings, except as overridden by
other initargs passed here.
-
start: the first page to print; see the start-page property.
-
end: the last page to print; see the end-page property.
-
min-start: the smallest number that the end user
is allowed to specify as the start-page on the print job dialog.
-
max-end: the largest number that the end user is
allowed to specify as the end-page on the print job dialog.
-
copies: the number of copies to print; see the
driver-copies and
user-copies
properties.
-
collate-p: if true, then the
output should be collated; see the driver-collate-p and user-collate-p properties.
-
orientation: either
:portrait
or :landscape
; see the orientation property.
-
scale: a scaling factor for the printer driver to
use; see the scale property.
-
print-to-file-p: true
requests that the output be printed to a file rather than to paper;
see the filename
property.
-
disable-print-to-file: if
true, then the option to print to a file will be
disabled (grayed) on the print job dialog.
-
hide-print-to-file: if true,
then the option to print to a file will not appear at all on the print
job dialog.
-
disable-page-numbers: if
true, then the Page Numbers radio button and
associated page range fields on the print job dialog will be
unavailable (grayed).
-
disable-selection: if true,
then the Selection radio button on the print job dialog will be
unavailable.
-
selection-p: if true, then
the Selection radio button on the print job dialog will be initially
selected, rather than the All Pages radio button.
-
disable-copies-and-collate-if-no-driver-support:
if true and the printer driver does not support
printing multiple copies or collation itself, then the options for
multiple copies and collation will be disabled on the print job dialog.
-
print-quality: the print quality to use; see the
print-quality
property.
-
paper-size: the paper size to use; see the
paper-size
property.
-
multicolor: whether to print in multicolor or
monochrome on a color printer; see the multicolor property.
-
no-warning-p: if true, then
no warning will appear if there is currently no default printer.
-
printer-name: a string indicating the printer on
which to print. The string should be equal to one of the values in the
list returned by printer-names. This option has an
effect only when the no-dialog-p option is true.
-
driver-name: a string indicating the printer
driver to use. The default is "winspool", which is normally the
appropriate value. But if you know the name of an alternate driver
that you would like to use, you may specify it here.
Copyright (c) 1998-2002, Franz Inc. Oakland, CA., USA. All rights reserved.
Documentation for Allegro CL version 6.2. This page was not revised from the 6.1 page.
Created 2002.2.26.