2000-02-28 16:33:27 +00:00
|
|
|
<?xml version="1.0"?>
|
2001-12-17 16:51:51 +00:00
|
|
|
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.7//EN" "http://www.gnustep.org/gsdoc-0_6_7.xml">
|
|
|
|
|
<gsdoc base="NSPrintOperation" next="NSPrintPanel" prev="NSPrintInfo" up="NSDocumentController">
|
2000-02-28 16:33:27 +00:00
|
|
|
<head>
|
|
|
|
|
<title>NSPrintOperation</title>
|
2001-12-17 16:51:51 +00:00
|
|
|
<author name="Scott Christley">
|
|
|
|
|
<email address="scottc@net-community.com">
|
|
|
|
|
scottc@net-community.com
|
|
|
|
|
</email>
|
|
|
|
|
</author>
|
2001-11-08 18:26:39 +00:00
|
|
|
<author name="Fred Kiefer">
|
2001-12-17 16:51:51 +00:00
|
|
|
<email address="FredKiefer@gmx.de">
|
|
|
|
|
FredKiefer@gmx.de
|
|
|
|
|
</email>
|
2000-02-28 16:33:27 +00:00
|
|
|
</author>
|
2001-11-08 18:26:39 +00:00
|
|
|
<author name="Adam Fedor">
|
2001-12-17 16:51:51 +00:00
|
|
|
<email address="fedor@gnu.org">
|
|
|
|
|
fedor@gnu.org
|
|
|
|
|
</email>
|
2001-11-08 18:26:39 +00:00
|
|
|
</author>
|
|
|
|
|
<abstract>
|
|
|
|
|
Controls generation of EPS, PDF or PS print jobs.
|
|
|
|
|
</abstract>
|
2001-12-17 16:51:51 +00:00
|
|
|
<copy>1996 Free Software Foundation, Inc.</copy>
|
2000-02-28 16:33:27 +00:00
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<chapter>
|
2001-11-08 18:26:39 +00:00
|
|
|
<heading>Class Description</heading>
|
|
|
|
|
<p>
|
|
|
|
|
NSPrintOperation controls printing of an
|
|
|
|
|
NSView. When invoked normally it will (optionally)
|
|
|
|
|
display a standard print panel (NSPrintPanel), and
|
|
|
|
|
based on the information entered by the user here as well
|
|
|
|
|
as information about page layout (see NSPageLayout) tells
|
|
|
|
|
the NSView to print it's contents. NSPrintOperation works
|
|
|
|
|
with the NSView to paginate the output into appropriately
|
|
|
|
|
sized and oriented pages and finally delivers the result
|
|
|
|
|
to the appropriate place, whether it be a printer, and
|
|
|
|
|
PostScript file, or another output.
|
|
|
|
|
</p>
|
2000-02-28 16:33:27 +00:00
|
|
|
<class name="NSPrintOperation" super="NSObject">
|
2001-12-17 16:51:51 +00:00
|
|
|
<declared>AppKit/NSPrintOperation.h</declared>
|
2001-11-08 18:26:39 +00:00
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
<method type="NSPrintOperation*" factory="yes">
|
|
|
|
|
<sel>EPSOperationWithView:</sel>
|
|
|
|
|
<arg type="NSView*">aView</arg>
|
|
|
|
|
<sel>insideRect:</sel>
|
|
|
|
|
<arg type="NSRect">rect</arg>
|
|
|
|
|
<sel>toData:</sel>
|
|
|
|
|
<arg type="NSMutableData*">data</arg>
|
2000-02-29 11:01:41 +00:00
|
|
|
<desc>
|
|
|
|
|
</desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
</method>
|
2000-02-29 11:01:41 +00:00
|
|
|
<method type="NSPrintOperation*" factory="yes">
|
|
|
|
|
<sel>EPSOperationWithView:</sel>
|
|
|
|
|
<arg type="NSView*">aView</arg>
|
|
|
|
|
<sel>insideRect:</sel>
|
|
|
|
|
<arg type="NSRect">rect</arg>
|
|
|
|
|
<sel>toData:</sel>
|
|
|
|
|
<arg type="NSMutableData*">data</arg>
|
2001-11-08 18:26:39 +00:00
|
|
|
<sel>printInfo:</sel>
|
|
|
|
|
<arg type="NSPrintInfo*">aPrintInfo</arg>
|
2000-02-29 11:01:41 +00:00
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSPrintOperation*" factory="yes">
|
|
|
|
|
<sel>EPSOperationWithView:</sel>
|
|
|
|
|
<arg type="NSView*">aView</arg>
|
|
|
|
|
<sel>insideRect:</sel>
|
|
|
|
|
<arg type="NSRect">rect</arg>
|
2001-11-08 18:26:39 +00:00
|
|
|
<sel>toPath:</sel>
|
|
|
|
|
<arg type="NSString*">path</arg>
|
|
|
|
|
<sel>printInfo:</sel>
|
|
|
|
|
<arg type="NSPrintInfo*">aPrintInfo</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSPrintOperation*" factory="yes">
|
|
|
|
|
<sel>PDFOperationWithView:</sel>
|
|
|
|
|
<arg type="NSView*">aView</arg>
|
|
|
|
|
<sel>insideRect:</sel>
|
|
|
|
|
<arg type="NSRect">rect</arg>
|
|
|
|
|
<sel>toData:</sel>
|
|
|
|
|
<arg type="NSMutableData*">data</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSPrintOperation*" factory="yes">
|
|
|
|
|
<sel>PDFOperationWithView:</sel>
|
|
|
|
|
<arg type="NSView*">aView</arg>
|
|
|
|
|
<sel>insideRect:</sel>
|
|
|
|
|
<arg type="NSRect">rect</arg>
|
2000-02-29 11:01:41 +00:00
|
|
|
<sel>toData:</sel>
|
|
|
|
|
<arg type="NSMutableData*">data</arg>
|
|
|
|
|
<sel>printInfo:</sel>
|
|
|
|
|
<arg type="NSPrintInfo*">aPrintInfo</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSPrintOperation*" factory="yes">
|
2001-11-08 18:26:39 +00:00
|
|
|
<sel>PDFOperationWithView:</sel>
|
2000-02-29 11:01:41 +00:00
|
|
|
<arg type="NSView*">aView</arg>
|
|
|
|
|
<sel>insideRect:</sel>
|
|
|
|
|
<arg type="NSRect">rect</arg>
|
|
|
|
|
<sel>toPath:</sel>
|
|
|
|
|
<arg type="NSString*">path</arg>
|
|
|
|
|
<sel>printInfo:</sel>
|
|
|
|
|
<arg type="NSPrintInfo*">aPrintInfo</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSPrintOperation*" factory="yes">
|
|
|
|
|
<sel>currentOperation</sel>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Returns the NSPrintOperation object that is
|
|
|
|
|
currently performing a print operation (if any).
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSPrintOperation*" factory="yes">
|
|
|
|
|
<sel>printOperationWithView:</sel>
|
|
|
|
|
<arg type="NSView*">aView</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSPrintOperation*" factory="yes">
|
|
|
|
|
<sel>printOperationWithView:</sel>
|
|
|
|
|
<arg type="NSView*">aView</arg>
|
|
|
|
|
<sel>printInfo:</sel>
|
|
|
|
|
<arg type="NSPrintInfo*">aPrintInfo</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void" factory="yes">
|
|
|
|
|
<sel>setCurrentOperation:</sel>
|
|
|
|
|
<arg type="NSPrintOperation*">operation</arg>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Set the current NSPrintOperation to the supplied
|
|
|
|
|
<var>operation</var> object. As this is currently
|
|
|
|
|
implemented, if a NSPrintOperation is
|
|
|
|
|
currently running, that <var>operation</var> is
|
|
|
|
|
lost (along with any associated context), so be
|
|
|
|
|
careful to call this only when there is no current
|
|
|
|
|
<var>operation</var>.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSView*">
|
|
|
|
|
<sel>accessoryView</sel>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Returns the accessory view used by the NSPrintPanel
|
|
|
|
|
associated with the receiver.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>cleanUpOperation</sel>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Called by the print operation and it has finished
|
|
|
|
|
running a printing operation.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
2001-11-08 18:26:39 +00:00
|
|
|
<method type="NSGraphicsContext*">
|
2000-02-29 11:01:41 +00:00
|
|
|
<sel>context</sel>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Returns the graphic contexts used by the print
|
|
|
|
|
operation.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
2001-11-08 18:26:39 +00:00
|
|
|
<method type="NSGraphicsContext*">
|
2000-02-29 11:01:41 +00:00
|
|
|
<sel>createContext</sel>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
This method is used by the print operation to create a
|
|
|
|
|
special graphics context for use while running the
|
|
|
|
|
print operation.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="int">
|
|
|
|
|
<sel>currentPage</sel>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Returns the page currently being printing. Returns
|
|
|
|
|
0 if no page is currently being printed
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>deliverResult</sel>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Called by the print operation to deliver the results
|
|
|
|
|
of the printing operation. This might include sending
|
|
|
|
|
the output to a printer, a file or a previewing
|
|
|
|
|
program. Returns <code>YES</code> if the output
|
|
|
|
|
was delivered sucessfully.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>destroyContext</sel>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
This method is used by the print operation to destroy
|
|
|
|
|
the special graphic context used while running the
|
|
|
|
|
print operation.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id">
|
|
|
|
|
<sel>initEPSOperationWithView:</sel>
|
|
|
|
|
<arg type="NSView*">aView</arg>
|
|
|
|
|
<sel>insideRect:</sel>
|
|
|
|
|
<arg type="NSRect">rect</arg>
|
|
|
|
|
<sel>toData:</sel>
|
|
|
|
|
<arg type="NSMutableData*">data</arg>
|
|
|
|
|
<sel>printInfo:</sel>
|
|
|
|
|
<arg type="NSPrintInfo*">aPrintInfo</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="id">
|
|
|
|
|
<sel>initWithView:</sel>
|
|
|
|
|
<arg type="NSView*">aView</arg>
|
|
|
|
|
<sel>printInfo:</sel>
|
|
|
|
|
<arg type="NSPrintInfo*">aPrintInfo</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
2001-11-08 18:26:39 +00:00
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>isCopyingOperation</sel>
|
|
|
|
|
<desc>
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
2000-02-29 11:01:41 +00:00
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>isEPSOperation</sel>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Returns <code>YES</code> if the receiver is
|
|
|
|
|
performing an operation whose output is EPS
|
|
|
|
|
format.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSPrintingPageOrder">
|
|
|
|
|
<sel>pageOrder</sel>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Returns the page order of printing.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSPrintInfo*">
|
|
|
|
|
<sel>printInfo</sel>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Returns the NSPrintInfo object associated with the
|
|
|
|
|
receiver.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSPrintPanel*">
|
|
|
|
|
<sel>printPanel</sel>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Returns the NSPrintPanel associated with the
|
|
|
|
|
receiver.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>runOperation</sel>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Call this message to run the print operation on a
|
|
|
|
|
view. This includes (optionally) displaying a print
|
|
|
|
|
panel and working with the NSView to paginate and
|
|
|
|
|
draw the contents of the view.
|
|
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>runOperationModalForWindow:</sel>
|
|
|
|
|
<arg type="NSWindow*">docWindow</arg>
|
|
|
|
|
<sel>delegate:</sel>
|
|
|
|
|
<arg type="id">delegate</arg>
|
|
|
|
|
<sel>didRunSelector:</sel>
|
|
|
|
|
<arg type="SEL">didRunSelector</arg>
|
|
|
|
|
<sel>contextInfo:</sel>
|
|
|
|
|
<arg type="void*">contextInfo</arg>
|
|
|
|
|
<desc>
|
|
|
|
|
Run a print operation modally with respect to a window.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>setAccessoryView:</sel>
|
|
|
|
|
<arg type="NSView*">aView</arg>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Set the accessory view used by the NSPrintPanel
|
|
|
|
|
associated with the receiver.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>setPageOrder:</sel>
|
|
|
|
|
<arg type="NSPrintingPageOrder">order</arg>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Set the page <var>order</var> used when printing.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>setPrintInfo:</sel>
|
|
|
|
|
<arg type="NSPrintInfo*">aPrintInfo</arg>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Set the NSPrintInfo object associated with the
|
|
|
|
|
receiver.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>setPrintPanel:</sel>
|
|
|
|
|
<arg type="NSPrintPanel*">panel</arg>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Sets the NSPrintPanel used by the receiver obtaining
|
|
|
|
|
and displaying printing information from/to the user.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="void">
|
|
|
|
|
<sel>setShowPanels:</sel>
|
|
|
|
|
<arg type="BOOL">flag</arg>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Use this to set whether a print panel is displayed
|
|
|
|
|
during a printing operation. If set to
|
|
|
|
|
<code>NO</code>, then the receiver uses information
|
|
|
|
|
that was previously set and does not display any
|
|
|
|
|
status information about the progress of the
|
|
|
|
|
printing operation.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="BOOL">
|
|
|
|
|
<sel>showPanels</sel>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Returns <code>YES</code> if the reciever display an
|
|
|
|
|
NSPrintPanel and other information when
|
|
|
|
|
running a print operation.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
|
|
|
|
</method>
|
|
|
|
|
<method type="NSView*">
|
|
|
|
|
<sel>view</sel>
|
|
|
|
|
<desc>
|
2001-11-08 18:26:39 +00:00
|
|
|
Return the view that is the being printed.
|
2000-02-29 11:01:41 +00:00
|
|
|
</desc>
|
2000-02-28 18:37:00 +00:00
|
|
|
</method>
|
2000-02-28 16:33:27 +00:00
|
|
|
</class>
|
|
|
|
|
</chapter>
|
|
|
|
|
</body>
|
|
|
|
|
</gsdoc>
|
