Mac Developer Library

Developer

Quartz Framework Reference IKScannerDeviceView Class Reference

Options
Deployment Target:

On This Page
Language:

IKScannerDeviceView

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.

Inheritance


Import Statement


Swift

import Quartz

Objective-C

@import Quartz;

Availability


Available in OS X v10.6 and later.
  • The device used for scanning

    Declaration

    Swift

    unowned(unsafe) var scannerDevice: ICScannerDevice!

    Objective-C

    @property(assign) ICScannerDevice *scannerDevice

    Import Statement

    Objective-C

    @import Quartz;

    Swift

    import Quartz

    Availability

    Available in OS X v10.6 and later.

  • Allows customization of the “Overview” label.

    Declaration

    Swift

    var overviewControlLabel: String!

    Objective-C

    @property(copy) NSString *overviewControlLabel

    Import Statement

    Objective-C

    @import Quartz;

    Swift

    import Quartz

    Availability

    Available in OS X v10.6 and later.

  • Allows customization of the “Scan” label.

    Declaration

    Swift

    var scanControlLabel: String!

    Objective-C

    @property(copy) NSString *scanControlLabel

    Import Statement

    Objective-C

    @import Quartz;

    Swift

    import Quartz

    Availability

    Available in OS X v10.6 and later.

  • These constants determine how the scanner data is returned to the delegate. They are used by the transferMode property.

    Declaration

    Swift

    enum IKScannerDeviceViewTransferMode : Int { case FileBased case MemoryBased }

    Objective-C

    enum { IKScannerDeviceViewTransferModeFileBased = 0, IKScannerDeviceViewTransferModeMemoryBased }; typedef NSInteger IKScannerDeviceViewTransferMode;

    Constants

    • FileBased

      IKScannerDeviceViewTransferModeFileBased

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

      Available in OS X v10.6 and later.

    • MemoryBased

      IKScannerDeviceViewTransferModeMemoryBased

      The scanned data is returned to the delegate as a NSData object.

      Available in OS X v10.6 and later.

    Import Statement

    Objective-C

    @import Quartz;

    Swift

    import Quartz

    Availability

    Available in OS X v10.6 and later.

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

    Declaration

    Swift

    enum IKScannerDeviceViewDisplayMode : Int { case Simple case Advanced }

    Objective-C

    enum { IKScannerDeviceViewDisplayModeSimple, IKScannerDeviceViewDisplayModeAdvanced }; typedef NSInteger IKScannerDeviceViewDisplayMode;

    Constants

    • Simple

      IKScannerDeviceViewDisplayModeSimple

      The view will display in simple mode.

      Available in OS X v10.6 and later.

    • Advanced

      IKScannerDeviceViewDisplayModeAdvanced

      The view will display in advanced mode.

      Available in OS X v10.6 and later.

    Import Statement

    Objective-C

    @import Quartz;

    Swift

    import Quartz

    Availability

    Available in OS X v10.6 and later.