Inherits from | |
Conforms to | |
Framework | /System/Library/Frameworks/Quartz.framework/ImageKit.framework |
Availability | Available in Mac OS X v10.6 and later. |
Declared in | IKScannerDeviceView.h |
The IKScannerDeviceView
class displays a view that allows scanning. It can be customized by specifying the display mode. The delegate receives the scanned data and must implement the IKScannerDeviceViewDelegate
protocol.
scannerDevice
property
mode
property
hasDisplayModeAdvanced
property
hasDisplayModeSimple
property
displaysDownloadsDirectoryControl
property
downloadsDirectory
property
transferMode
property
documentName
property
displaysPostProcessApplicationControl
property
postProcessApplication
property
delegate
property
overviewControlLabel
property
scanControlLabel
property
For more about Objective-C properties, see “Properties” in The Objective-C Programming Language.
The scanner device delegate
@property(assign) id<IKScannerDeviceViewDelegate> delegate
The delegate is sent notifications of errors as well as the completed scan content.
The delegate must conform to the IKScannerDeviceViewDelegate
protocol.
IKScannerDeviceView.h
Determines whether the downloads directory control is displayed.
@property BOOL displaysDownloadsDirectoryControl
IKScannerDeviceView.h
Specifies whether the post processing application control is displayed.
@property BOOL displaysPostProcessApplicationControl
The post processing application is only relevant when the transfer mode is IKScannerDeviceViewTransferModeFileBased
.
IKScannerDeviceView.h
Returns the document name.
@property(copy) NSString *documentName
IKScannerDeviceView.h
The directory where scans are saved.
@property(retain) NSURL *downloadsDirectory
IKScannerDeviceView.h
Returns whether the scanner view is using the advanced display mode.
@property BOOL hasDisplayModeAdvanced
IKScannerDeviceView.h
Returns whether the scanner view is using the simple display mode.
@property BOOL hasDisplayModeSimple
IKScannerDeviceView.h
The display mode used by the device view.
@property IKScannerDeviceViewDisplayMode mode
The possible constants are described in “Scanner View Display Mode.”
IKScannerDeviceView.h
Allows customization of the “Overview” label.
@property(copy) NSString *overviewControlLabel
IKScannerDeviceView.h
The URL of the application to use for post processing of the scan.
@property(retain) NSURL *postProcessApplication
The post processing application is only relevant when the transfer mode is IKScannerDeviceViewTransferModeFileBased
.
IKScannerDeviceView.h
Allows customization of the “Scan” label.
@property(copy) NSString *scanControlLabel
IKScannerDeviceView.h
The device used for scanning
@property(assign) ICScannerDevice *scannerDevice
IKScannerDeviceView.h
Determines how the scanned content is provided to the delegate.
@property IKScannerDeviceViewTransferMode transferMode
The supported constants are defined in “Scanner Transfer Modes.”
IKScannerDeviceView.h
These constants determine how the scanner data is returned to the delegate. They are used by the transferMode
property.
enum { IKScannerDeviceViewTransferModeFileBased = 0, IKScannerDeviceViewTransferModeMemoryBased }; typedef NSInteger IKScannerDeviceViewTransferMode;
IKScannerDeviceViewTransferModeFileBased
The scanned content will be saved to the specified download directory.
Available in Mac OS X v10.6 and later.
Declared in IKScannerDeviceView.h
.
IKScannerDeviceViewTransferModeMemoryBased
The scanned data is returned to the delegate as a NSData
object.
Available in Mac OS X v10.6 and later.
Declared in IKScannerDeviceView.h
.
These constants specify the display mode the scanner view will use. They are used by the mode
property.
enum { IKScannerDeviceViewDisplayModeSimple, IKScannerDeviceViewDisplayModeAdvanced }; typedef NSInteger IKScannerDeviceViewDisplayMode;
Last updated: 2010-03-24