Up
Authors
- Scott Christley (
scottc@net-community.com)
-
- Fred Kiefer (
FredKiefer@gmx.de)
-
- Adam Fedor (
fedor@gnu.org)
-
- Chad Hardin (
cehardin@mac.com)
-
Controls generation of EPS, PDF or PS print jobs.
Copyright: (C) 1996,2001,2004 Free Software Foundation, Inc.
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.
- Declared in:
- AppKit/NSPrintOperation.h
Availability: OpenStep
Description forthcoming.
Instance Variables
Method summary
+ (
NSPrintOperation*)
currentOperation;
Availability: OpenStep
Returns the NSPrintOperation object that is
currently performing a print operation (if any).
+ (void)
setCurrentOperation: (
NSPrintOperation*)operation;
Availability: OpenStep
Set the current NSPrintOperation to the supplied
operation object. As this is currently
implemented, if a NSPrintOperation is
currently running, that operation is
lost (along with any associated context), so be
careful to call this only when there is no current
operation.
- (
NSView*)
accessoryView;
Availability: MacOS-X 10.0.0
Returns the accessory view used by the NSPrintPanel
associated with the receiver.
- (BOOL)
canSpawnSeparateThread;
Availability: MacOS-X 10.0.0
Description forthcoming.
- (void)
cleanUpOperation;
Availability: OpenStep
Called by the print operation after it has finished
running a printing operation.
- (
NSGraphicsContext*)
context;
Availability: OpenStep
Returns the graphic contexts used by the print
operation.
- (
NSGraphicsContext*)
createContext;
Availability: OpenStep
This method is used by the print operation to create a
special graphics context for use while running the
print operation.
- (int)
currentPage;
Availability: OpenStep
Returns the page currently being printing. Returns
0 if no page is currently being printed
- (BOOL)
deliverResult;
Availability: OpenStep
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 YES if the output
was delivered sucessfully.
- (void)
destroyContext;
Availability: OpenStep
This method is used by the print operation to destroy
the special graphic context used while running the
print operation.
- (id)
initEPSOperationWithView: (
NSView*)aView
insideRect: (
NSRect)rect
toData: (
NSMutableData*)data
printInfo: (
NSPrintInfo*)aPrintInfo;
Availability: OpenStep
Description forthcoming.
- (id)
initWithView: (
NSView*)aView
printInfo: (
NSPrintInfo*)aPrintInfo;
Availability: OpenStep
Description forthcoming.
- (BOOL)
isCopyingOperation;
Availability: MacOS-X 10.0.0
Description forthcoming.
- (BOOL)
isEPSOperation;
Availability: OpenStep
Returns YES if the receiver is
performing an operation whose output is EPS
format.
- (
NSString*)
jobStyleHint;
Availability: MacOS-X 10.2.0
Description forthcoming.
- (
NSPrintInfo*)
printInfo;
Availability: OpenStep
Returns the NSPrintInfo object associated with the
receiver.
- (
NSPrintPanel*)
printPanel;
Availability: OpenStep
Returns the NSPrintPanel associated with the
receiver.
- (BOOL)
runOperation;
Availability: OpenStep
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.
- (void)
runOperationModalForWindow: (
NSWindow*)docWindow
delegate: (id)delegate
didRunSelector: (SEL)didRunSelector
contextInfo: (void*)contextInfo;
Availability: MacOS-X 10.0.0
Run a print operation modally with respect to a window.
- (void)
setAccessoryView: (
NSView*)aView;
Availability: MacOS-X 10.0.0
Set the accessory view used by the NSPrintPanel
associated with the receiver.
- (void)
setCanSpawnSeparateThread: (BOOL)flag;
Availability: MacOS-X 10.0.0
Description forthcoming.
- (void)
setJobStyleHint: (
NSString*)hint;
Availability: MacOS-X 10.2.0
Description forthcoming.
- (void)
setPageOrder: (
NSPrintingPageOrder)order;
Availability: OpenStep
Set the page order used when printing.
- (void)
setPrintInfo: (
NSPrintInfo*)aPrintInfo;
Availability: OpenStep
Set the NSPrintInfo object associated with the
receiver.
- (void)
setPrintPanel: (
NSPrintPanel*)panel;
Availability: OpenStep
Sets the NSPrintPanel used by the receiver obtaining
and displaying printing information from/to the user.
- (void)
setShowPanels: (BOOL)flag;
Availability: OpenStep
Use this to set whether a print panel is displayed
during a printing operation. If set to
NO, then the receiver uses information
that was previously set and does not display any
status information about the progress of the
printing operation.
- (void)
setShowsPrintPanel: (BOOL)flag;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (void)
setShowsProgressPanel: (BOOL)flag;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (BOOL)
showPanels;
Availability: OpenStep
Returns YES if the reciever display an
NSPrintPanel and other information when
running a print operation.
- (BOOL)
showsPrintPanel;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (BOOL)
showsProgressPanel;
Availability: MacOS-X 10.4.0
Description forthcoming.
- (
NSView*)
view;
Availability: OpenStep
Return the view that is the being printed.
Instance Variables for NSPrintOperation Class
@protected NSView* _accessory_view;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSGraphicsContext* _context;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected int _currentPage;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSMutableData* _data;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSString* _job_style_hint;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSPrintingPageOrder _page_order;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSString* _path;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSPrintInfo* _print_info;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSPrintPanel* _print_panel;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSRect _rect;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSView* _view;
Availability: OpenStep
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected struct __Flags struct __Flags;
Availability: OpenStep
Description forthcoming.
- Declared in:
- AppKit/NSPrintOperation.h
Availability: OpenStep
Warning this category is private,
which means that the methods are for internal use by
the package. You should not use them in external code.
Method summary
Up