Up

# NSPrintPanel

### Authors

Adam Fedor (`fedor@gnu.org`)
Chad Hardin (`cehardin@mac.com`)

> Standard panel for querying user about printing.

Copyright: (C) 2001,2004 Free Software Foundation, Inc.

### Contents -

1. Class
2. Software documentation for the NSPrintPanel(Private) category
3. Software documentation for the NSPrintPanelAccessorizing protocol

# Class Description

NSPrintPanel provides a standard print panel allowing the user to specify information about how a document is to be printed, including the page range, number of copies and scale of the document. It also allows the user to save the document to a file or preview it. When a print: message is sent to an NSView or NSWindow, an NSPrintOpertation is created which manages printing of a view. The NSPrintOperation object would by default show a print panel in a modal loop for the user. You can avoid showing the print panel by sending the setShowsPanels: message in the print operation with a `NO` argument.

## NSPrintPanel : NSPanel

> Declared in:
>   AppKit/NSPrintPanel.h

Availability: OpenStep
Description forthcoming.

Instance Variables
Method summary

- -_getSavePath
- -_setStatusStringValue:
- +printPanel
- -accessoryControllers
- -accessoryView
- -addAccessoryController:
- -beginSheetWithPrintInfo:modalForWindow:delegate:didEndSelector:contextInfo:
- -defaultButtonTitle
- -finalWritePrintInfo
- -helpAnchor
- -jobStyleHint
- -options
- -pickedAllPages:
- -pickedButton:
- -pickedLayoutList:
- -printInfo
- -removeAccessoryController:
- -runModal
- -runModalWithPrintInfo:
- -setAccessoryView:
- -setDefaultButtonTitle:
- -setHelpAnchor:
- -setJobStyleHint:
- -setOptions:
- -updateFromPrintInfo

### printPanel

+ (NSPrintPanel*) printPanel;
Availability: OpenStep
Creates (if needed) and returns a shared instance of the NSPrintPanel panel.

### accessoryControllers

- (NSArray*) accessoryControllers;
Availability: MacOS-X 10.5.0
Description forthcoming.

### accessoryView

- (NSView*) accessoryView;
Availability: Not in OpenStep/MacOS-X removed at MacOS-X 10.5.0

Returns the accessory view for the print panel

See Also: -setAccessoryView:

### addAccessoryController:

- (void) addAccessoryController: (NSViewController<NSPrintPanelAccessorizing>*)accessoryController;
Availability: MacOS-X 10.5.0
Description forthcoming.

### beginSheetWithPrintInfo: modalForWindow: delegate: didEndSelector: contextInfo:

- (void) beginSheetWithPrintInfo: (NSPrintInfo*)printInfo modalForWindow: (NSWindow*)docWindow delegate: (id)delegate didEndSelector: (SEL)didEndSelector contextInfo: (void*)contextInfo;
Availability: MacOS-X 10.0.0
Description forthcoming.

### defaultButtonTitle

- (NSString*) defaultButtonTitle;
Availability: MacOS-X 10.5.0
Description forthcoming.

### finalWritePrintInfo

- (void) finalWritePrintInfo;
Availability: Not in OpenStep/MacOS-X removed at MacOS-X 10.5.0
Saves information set by the user in the receiver's panel in the NSPrintInfo object from the current NSPrintOperation.

### helpAnchor

- (NSString*) helpAnchor;
Availability: MacOS-X 10.5.0
Description forthcoming.

### jobStyleHint

- (NSString*) jobStyleHint;
Availability: MacOS-X 10.2.0
Description forthcoming.

### options

- (NSPrintPanelOptions) options;
Availability: MacOS-X 10.5.0
Description forthcoming.

### pickedAllPages:

- (void) pickedAllPages: (id)sender;
Availability: Not in OpenStep/MacOS-X removed at MacOS-X 10.5.0
This method has been depreciated. It doesn't do anything useful.

### pickedButton:

- (void) pickedButton: (id)sender;
Availability: Not in OpenStep/MacOS-X removed at MacOS-X 10.5.0
This method has been depreciated. It doesn't do anything useful.

### pickedLayoutList:

- (void) pickedLayoutList: (id)sender;
Availability: Not in OpenStep/MacOS-X removed at MacOS-X 10.5.0
This method has been depreciated. It doesn't do anything useful.

### printInfo

- (NSPrintInfo*) printInfo;
Availability: MacOS-X 10.5.0
Description forthcoming.

### removeAccessoryController:

- (void) removeAccessoryController: (NSViewController<NSPrintPanelAccessorizing>*)accessoryController;
Availability: MacOS-X 10.5.0
Description forthcoming.

### runModal

- (NSInteger) runModal;
Availability: OpenStep
Display the Print panel in a modal loop. Saves any aquired information in the NSPrintInfo object for the current NSPrintOperation. Returns NSCancelButton if the user clicks the Cancel button or NSOKButton otherwise. Unlike other panels, this one does not order itself out after the modal session is finished. You must do that yourself.

### runModalWithPrintInfo:

- (NSInteger) runModalWithPrintInfo: (NSPrintInfo*)printInfo;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setAccessoryView:

- (void) setAccessoryView: (NSView*)aView;
Availability: Not in OpenStep/MacOS-X removed at MacOS-X 10.5.0

Sets the accessory view for the print panel to aView

See Also: -accessoryView

### setDefaultButtonTitle:

- (void) setDefaultButtonTitle: (NSString*)defaultButtonTitle;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setHelpAnchor:

- (void) setHelpAnchor: (NSString*)helpAnchor;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setJobStyleHint:

- (void) setJobStyleHint: (NSString*)hint;
Availability: MacOS-X 10.2.0
Description forthcoming.

### setOptions:

- (void) setOptions: (NSPrintPanelOptions)options;
Availability: MacOS-X 10.5.0
Description forthcoming.

### updateFromPrintInfo

- (void) updateFromPrintInfo;
Availability: Not in OpenStep/MacOS-X removed at MacOS-X 10.5.0
Setup the display in the receiver's panel based on the values stored in the NSPrintInfo object from the current NSPrintOperation.

## Instance Variables for NSPrintPanel Class

### _accessoryControllers

@protected NSMutableArray* _accessoryControllers;
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.

### _accessoryView

@protected NSView* _accessoryView;
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.

### _helpAnchor

@protected NSString* _helpAnchor;
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.

### _jobStyleHint

@protected NSString* _jobStyleHint;
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.

### _optionPanel

@protected id _optionPanel;
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.

### _options

@protected NSPrintPanelOptions _options;
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.

### _pages

@protected NSRange _pages;
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.

### _panel

@protected id _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.

### _picked

@protected int _picked;
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.

### _printInfo

@protected NSPrintInfo* _printInfo;
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.

### _savePath

@protected NSString* _savePath;
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.

# Software documentation for the NSPrintPanel(Private) category

## NSPrintPanel(Private)

> Declared in:
>   AppKit/NSPrintPanel.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

- -_getSavePath
- -_setStatusStringValue:

### _getSavePath

- (BOOL) _getSavePath;
Availability: OpenStep
Warning the underscore at the start of the name of this method indicates that it is private, for internal use only, and you should not use the method in your code.

### _setStatusStringValue:

- (void) _setStatusStringValue: (NSString*)string;
Availability: OpenStep
Warning the underscore at the start of the name of this method indicates that it is private, for internal use only, and you should not use the method in your code.

# Software documentation for the NSPrintPanelAccessorizing protocol

## NSPrintPanelAccessorizing

> Declared in:
>   AppKit/NSPrintPanel.h

Availability: MacOS-X 10.5.0
Description forthcoming.
Method summary

- -keyPathsForValuesAffectingPreview
- -localizedSummaryItems

### keyPathsForValuesAffectingPreview

- (NSSet*) keyPathsForValuesAffectingPreview;
Availability: MacOS-X 10.5.0
Description forthcoming.

### localizedSummaryItems

- (NSArray*) localizedSummaryItems;
Availability: MacOS-X 10.5.0
Description forthcoming.

Up