| Allegro CL version 8.2 Unrevised from 8.1 to 8.2. 8.1 version |
Arguments: printer-stream &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. An application should not call this function directly, because Common Graphics calls it internally whenever a printer stream is opened. This page documents the printer-specific arguments that you would pass to open-stream or with-output-to-printer, which Common Graphics will pass along to this function.
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:
:portrait
or :landscape
; see the
orientation
property.
nil
to print output to a physical printer as usual,
or else a pathname or path namestring to print to a file instead.
When printing is done to a file, the file will contain printer code
such as PCL or PostScript, as written by the driver of the selected
printer. When a path is specified, the output will go to the file even
if the print-to-file-p argument is nil
or if the user unchecks the Print to file
check-box on the Print Job dialog; therefore it is probably best to
pass either no-dialog-p or
hide-print-to-file as true when passing a
filename.
nil
, it will be unchecked.
Some printer drivers may not support printing to a file, in which case
this check-box will not appear. If filename is
nil
or unspecified and the user exits the
Print Job dialog with the Print to file check-box checked, then
the OS will ask for the path to print to, and there is no way for lisp
to know what path was specified; therefore, if you need to know what
file was created then you should instead pass the desired path as the
filename argument, perhaps after calling ask-user-for-new-pathname
to ask the user for the path.
nil
(or
unspecified), then the printer's default setting will be used. If
:no
, then printing will be single-sided. If
:short-edge-binding
, then printing will be
double-sided and oriented toward binding (or flipping) the pages along
the shorter side of the paper. If
:long-edge-binding
(or any true value other than
the ones mentioned), then printing will be double-sided and oriented
toward binding along the longer side of the paper. (Since binding
along the longer side is typical, it may be easier to remember to
specify t
for double-sided.) Note that on
the print job dialog for some printer drivers this option is called
"Duplex". See double-sided.
See also pop-up-printer-setup-dialog and with-printer.
Printing (hardcopy) is not implemented on the GTK platform at this
time. Opening a printer stream will simply invoke the *gtk-compatibility-warning-action*
.
Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.
| Allegro CL version 8.2 Unrevised from 8.1 to 8.2. 8.1 version |