Next Page > Hide TOC

NSPageLayout Class Reference

Overview

NSPageLayout is a panel that queries the user for information such as paper type and orientation. It is normally displayed in response to the user selecting the Page Setup menu item. You obtain an instance with the pageLayout class method. The pane can then be run as a sheet using beginSheetWithPrintInfo:modalForWindow:delegate:didEndSelector:contextInfo: or modally using runModal or runModalWithPrintInfo:.

Tasks

Creating an NSPageLayout Instance

• + pageLayout

Running a Page Setup Dialog

• – beginSheetWithPrintInfo:modalForWindow:delegate:didEndSelector:contextInfo:
• – runModal
• – runModalWithPrintInfo:

Customizing the Page Setup Dialog

• – addAccessoryController:
• – removeAccessoryController:
• – accessoryControllers

Accessing the NSPrintInfo Object

• – printInfo

Deprecated Methods

• – accessoryView Deprecated in Mac OS X v10.5
• – readPrintInfo Deprecated in Mac OS X v10.5
• – setAccessoryView: Deprecated in Mac OS X v10.5
• – writePrintInfo Deprecated in Mac OS X v10.5

Class Methods

pageLayout

Returns a newly created NSPageLayout object.

+ (NSPageLayout *)pageLayout

Availability

• Available in Mac OS X v10.0 and later.

Related Sample Code

• Quartz Composer WWDC 2005 TextEdit
• TextEditPlus

Declared In

Instance Methods

accessoryControllers

Returns an array of accessory view controllers belonging to the receiver.

- (NSArray *)accessoryControllers

Return Value

The NSViewController instances representing the accessory view controllers belonging to the receiver.

Availability

• Available in Mac OS X v10.5 and later.

See Also

• – addAccessoryController:
• – removeAccessoryController:

Declared In

addAccessoryController:

Adds the given controller of an accessory view to be presented in the page setup panel.

- (void)addAccessoryController:(NSViewController *)accessoryController

Parameters

accessoryController

The controller to add.

Availability

• Available in Mac OS X v10.5 and later.

See Also

• – removeAccessoryController:
• – accessoryControllers

Declared In

beginSheetWithPrintInfo:modalForWindow:delegate:didEndSelector:contextInfo:

Presents a page setup sheet for the given NSPrintInfo object, document-modal relative to the given window.

- (void)beginSheetWithPrintInfo:(NSPrintInfo *)printInfo modalForWindow:(NSWindow *)docWindow delegate:(id)delegate didEndSelector:(SEL)didEndSelector contextInfo:(void *)contextInfo

Parameters

printInfo

The NSPrintInfo object to use.

docWindow

The window to which the sheet is attached.

delegate

The delegate to which didEndSelector is sent. Can be nil.

didEndSelector

The selector sent to the delegate. Can be nil.

contextInfo

Context information object passed with didEndSelector.

Discussion

The didEndSelector argument must have the same signature as:

- (void)pageLayoutDidEnd:(NSPageLayout *)pageLayout returnCode:(int)returnCode  contextInfo: (void *)contextInfo;

The value passed as returnCode is either NSCancelButton or NSOKButton.

Availability

• Available in Mac OS X v10.0 and later.

Related Sample Code

• Quartz Composer WWDC 2005 TextEdit
• TextEditPlus

Declared In

printInfo

Returns the NSPrintInfo object used when the receiver is run.

- (NSPrintInfo *)printInfo

Discussion

The NSPrintInfo object is set using the beginSheetWithPrintInfo:modalForWindow:delegate:didEndSelector:contextInfo: or runModalWithPrintInfo: method. The shared NSPrintInfo object is used if the receiver is run using runModal.

Availability

• Available in Mac OS X v10.0 and later.

See Also

• – readPrintInfo
• – writePrintInfo

Declared In

removeAccessoryController:

Removes the given controller of an accessory view.

- (void)removeAccessoryController:(NSViewController *)accessoryController

Parameters

accessoryController

The controller to remove.

Availability

• Available in Mac OS X v10.5 and later.

See Also

• – addAccessoryController:
• – accessoryControllers

Declared In

runModal

Displays the receiver and begins the modal loop using the shared NSPrintInfo object.

- (NSInteger)runModal

Return Value

NSCancelButton if the user clicks the Cancel button; otherwise, NSOKButton.

Discussion

The receiver’s values are recorded in the shared NSPrintInfo object.

Availability

• Available in Mac OS X v10.0 and later.

See Also

• – runModalWithPrintInfo:

Declared In

runModalWithPrintInfo:

Displays the receiver and begins the modal loop using the given NSPrintInfo object.

- (NSInteger)runModalWithPrintInfo:(NSPrintInfo *)printInfo

Parameters

printInfo

The NSPrintInfo object to use.

Return Value

NSCancelButton if the user clicks the Cancel button; otherwise, NSOKButton.

Discussion

The receiver’s values are recorded in printInfo.

Availability

• Available in Mac OS X v10.0 and later.

See Also

• – runModal

Declared In

Next Page > Hide TOC