IKScannerDeviceView Class Reference

Inherits from
Conforms to
Framework
/System/Library/Frameworks/Quartz.framework/ImageKit.framework
Availability
Available in OS X v10.6 and later.
Declared in
IKScannerDeviceView.h

Overview

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.

Tasks

Setting the Scanner Device

Display Mode of the Device View

Configuring Downloading

Specifying a Post Processing Application

Getting and Setting the Delegate

Customizing Button Labels

Properties

delegate

The scanner device delegate

@property(assign) id<IKScannerDeviceViewDelegate> delegate
Discussion

The delegate is sent notifications of errors as well as the completed scan content.

The delegate must conform to the IKScannerDeviceViewDelegate protocol.

Availability
  • Available in OS X v10.6 and later.
Declared In
IKScannerDeviceView.h

displaysDownloadsDirectoryControl

Determines whether the downloads directory control is displayed.

@property BOOL displaysDownloadsDirectoryControl
Availability
  • Available in OS X v10.6 and later.
Declared In
IKScannerDeviceView.h

displaysPostProcessApplicationControl

Specifies whether the post processing application control is displayed.

@property BOOL displaysPostProcessApplicationControl
Discussion

The post processing application is only relevant when the transfer mode is IKScannerDeviceViewTransferModeFileBased.

Availability
  • Available in OS X v10.6 and later.
Declared In
IKScannerDeviceView.h

documentName

Returns the document name.

@property(copy) NSString *documentName
Availability
  • Available in OS X v10.6 and later.
Declared In
IKScannerDeviceView.h

downloadsDirectory

The directory where scans are saved.

@property(retain) NSURL *downloadsDirectory
Availability
  • Available in OS X v10.6 and later.
Declared In
IKScannerDeviceView.h

hasDisplayModeAdvanced

Returns whether the scanner view is using the advanced display mode.

@property BOOL hasDisplayModeAdvanced
Availability
  • Available in OS X v10.6 and later.
Declared In
IKScannerDeviceView.h

hasDisplayModeSimple

Returns whether the scanner view is using the simple display mode.

@property BOOL hasDisplayModeSimple
Availability
  • Available in OS X v10.6 and later.
Declared In
IKScannerDeviceView.h

mode

The display mode used by the device view.

Discussion

The possible constants are described in “Scanner View Display Mode.”

Availability
  • Available in OS X v10.6 and later.
Declared In
IKScannerDeviceView.h

overviewControlLabel

Allows customization of the “Overview” label.

@property(copy) NSString *overviewControlLabel
Availability
  • Available in OS X v10.6 and later.
Declared In
IKScannerDeviceView.h

postProcessApplication

The URL of the application to use for post processing of the scan.

@property(retain) NSURL *postProcessApplication
Discussion

The post processing application is only relevant when the transfer mode is IKScannerDeviceViewTransferModeFileBased.

Availability
  • Available in OS X v10.6 and later.
Declared In
IKScannerDeviceView.h

scanControlLabel

Allows customization of the “Scan” label.

@property(copy) NSString *scanControlLabel
Availability
  • Available in OS X v10.6 and later.
Declared In
IKScannerDeviceView.h

scannerDevice

The device used for scanning

@property(assign) ICScannerDevice *scannerDevice
Availability
  • Available in OS X v10.6 and later.
Declared In
IKScannerDeviceView.h

transferMode

Determines how the scanned content is provided to the delegate.

@property IKScannerDeviceViewTransferMode transferMode
Discussion

The supported constants are defined in “Scanner Transfer Modes.”

Availability
  • Available in OS X v10.6 and later.
Declared In
IKScannerDeviceView.h

Constants

Scanner Transfer Modes

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;
Constants
IKScannerDeviceViewTransferModeFileBased

The scanned content will be saved to the specified download directory.

Available in 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 OS X v10.6 and later.

Declared in IKScannerDeviceView.h.

Scanner View Display Modes

These constants specify the display mode the scanner view will use. They are used by the mode property.

enum {
   IKScannerDeviceViewDisplayModeSimple,
   IKScannerDeviceViewDisplayModeAdvanced
};
typedef NSInteger IKScannerDeviceViewDisplayMode;
Constants
IKScannerDeviceViewDisplayModeSimple

The view will display in simple mode.

Available in OS X v10.6 and later.

Declared in IKScannerDeviceView.h.

IKScannerDeviceViewDisplayModeAdvanced

The view will display in advanced mode.

Available in OS X v10.6 and later.

Declared in IKScannerDeviceView.h.