Mac Developer Library

Developer

AppKit Framework Reference AppKit Data Types Reference

Options
Deployment Target:

On This Page
Language:

AppKit Data Types Reference

Inheritance


Not Applicable

Conforms To


Not Applicable

Import Statement


Swift

import AppKit

Objective-C

@import AppKit;

This document describes the data types defined in the Application Kit framework and not described in a document for an individual class.

Data Types

  • This type defines the standard system animation effects, which include both display and sound.

    Declaration

    Swift

    enum NSAnimationEffect : UInt { case DisappearingItemDefault case Poof }

    Objective-C

    typedef enum _NSAnimationEffect { NSAnimationEffectDisappearingItemDefault = 0, NSAnimationEffectPoof = 10 } NSAnimationEffect;

    Constants

    • DisappearingItemDefault

      NSAnimationEffectDisappearingItemDefault

      The default effect.

      Available in OS X v10.3 and later.

    • Poof

      NSAnimationEffectPoof

      An effect showing a puff of smoke.

      Available in OS X v10.3 and later.

    Discussion

    These effects are used to indicate that an item was removed from a collection, such as a toolbar, without deleting the underlying data. See NSShowAnimationEffect.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.3 and later.

  • A private data structure used internally by NSBrowser.

    Declaration

    Objective-C

    typedef struct NSBrowserAuxiliary NSBrowserAuxiliaryOpaque;

    Import Statement

    Objective-C

    @import AppKit;

    Availability

    Available in OS X v10.3 and later.

    Not available to 64-bit applications.

  • A private data structure used internally by NSColorList.

    Declaration

    Objective-C

    typedef struct NSColorListAuxiliary NSColorListAuxiliaryOpaque;

    Import Statement

    Objective-C

    @import AppKit;

    Availability

    Available in OS X v10.3 and later.

    Not available to 64-bit applications.

  • The focus ring style indicates how the focus ring will be drawn.

    Declaration

    Swift

    enum NSFocusRingPlacement : UInt { case Only case Below case Above }

    Objective-C

    typedef enum { NSFocusRingOnly = 0, NSFocusRingBelow = 1, NSFocusRingAbove = 2 } NSFocusRingPlacement;

    Constants

    • Above

      NSFocusRingAbove

      Use NSFocusRingAbove to draw over an image.

      Fill a shape to add the focus ring around the shape.

      Available in OS X v10.1 and later.

    • Below

      NSFocusRingBelow

      Use NSFocusRingBelow to draw the focus ring under text.

      Available in OS X v10.1 and later.

    • Only

      NSFocusRingOnly

      Use NSFocusRingOnly if you don’t have an image or text.

      Available in OS X v10.1 and later.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.1 and later.

  • The focus ring type is used by NSView and NSCell to configure if and how a control should draw its focus ring.

    Declaration

    Swift

    enum NSFocusRingType : UInt { case Default case None case Exterior }

    Objective-C

    typedef enum _NSFocusRingType { NSFocusRingTypeDefault = 0, NSFocusRingTypeNone = 1, NSFocusRingTypeExterior = 2 } NSFocusRingType;

    Constants

    • Default

      NSFocusRingTypeDefault

      The default focus ring type for NSView or NSCell.

      Available in OS X v10.3 and later.

    • None

      NSFocusRingTypeNone

      No focus ring. If you set the focus ring type to this value, NSView and NSCell will not draw any focus ring.

      Available in OS X v10.3 and later.

    • Exterior

      NSFocusRingTypeExterior

      The standard Aqua focus ring.

      Available in OS X v10.3 and later.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.3 and later.

  • These constants are used in NSResponder’s interfaceStyle method.

    Declaration

    Objective-C

    typedef enum { NSNoInterfaceStyle = 0, NSNextStepInterfaceStyle = 1, NSWindows95InterfaceStyle = 2, NSMacintoshInterfaceStyle = 3 } NSInterfaceStyle;

    Constants

    • NSNoInterfaceStyle

      NSNoInterfaceStyle

      The default interface style.

      Available in OS X v10.0 and later.

      Deprecated in OS X v10.8.

    • NSNextStepInterfaceStyle

      NSNextStepInterfaceStyle

      The NextStep interface style.

      Available in OS X v10.0 and later.

      Deprecated in OS X v10.8.

    • NSWindows95InterfaceStyle

      NSWindows95InterfaceStyle

      The Windows 95 interface style.

      Available in OS X v10.0 and later.

      Deprecated in OS X v10.8.

    • NSMacintoshInterfaceStyle

      NSMacintoshInterfaceStyle

      The Macintosh interface style.

      Available in OS X v10.0 and later.

      Deprecated in OS X v10.8.

    Import Statement

    Objective-C

    @import AppKit;

    Availability

    Available in OS X v10.0 and later.

    Deprecated in OS X v10.8.

  • Variables of type NSModalSession point to information used by the system between NSApplication’s beginModalSessionForWindow: and endModalSession: messages.

    Declaration

    Swift

    typealias NSModalSession = COpaquePointer

    Objective-C

    typedef struct _NSModalSession *NSModalSession;

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • A private data structure used by NSOpenGLContext.

    Declaration

    Swift

    typealias NSOpenGLContextAuxiliary = _CGLContextObject

    Objective-C

    typedef struct _CGLContextObject NSOpenGLContextAuxiliary;

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • These constants are option names for NSOpenGLSetOption and NSOpenGLGetOption.

    Declaration

    Swift

    struct NSOpenGLGlobalOption { init(_ value: UInt32) var value: UInt32 }

    Objective-C

    typedef enum { NSOpenGLGOFormatCacheSize = 501, NSOpenGLGOClearFormatCache = 502, NSOpenGLGORetainRenderers = 503, NSOpenGLGOUseBuildCache = 506, NSOpenGLGOResetLibrary = 504 } NSOpenGLGlobalOption;

    Constants

    • NSOpenGLGOFormatCacheSize

      NSOpenGLGOFormatCacheSize

      Sets the size of the pixel format cache.

      Available in OS X v10.0 and later.

    • NSOpenGLGOClearFormatCache

      NSOpenGLGOClearFormatCache

      Resets the pixel format cache if true.

      Available in OS X v10.0 and later.

    • NSOpenGLGORetainRenderers

      NSOpenGLGORetainRenderers

      Whether to retain loaded renderers in memory.

      Available in OS X v10.0 and later.

    • NSOpenGLGOUseBuildCache

      NSOpenGLGOUseBuildCache

      Whether to enable the function compilation block cache. This is off by default. It must be enabled at startup.

      Available in OS X v10.7 and later.

    • NSOpenGLGOResetLibrary

      NSOpenGLGOResetLibrary

      Does a soft reset of the CGL library if true.

      Available in OS X v10.0 and later.

      Deprecated in OS X v10.4.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • A private data structure used by NSOpenGLPixelFormat.

    Declaration

    Objective-C

    typedef struct _CGLPixelFormatObject NSOpenGLPixelFormatAuxiliary;

    Import Statement

    Objective-C

    @import AppKit;

    Availability

    Available in OS X v10.0 through OS X v10.9.

  • A private data structure used internally by NSSavePanel.

    Declaration

    Objective-C

    typedef struct NSSavePanelAuxiliary NSSavePanelAuxiliaryOpaque;

    Import Statement

    Objective-C

    @import AppKit;

    Availability

    Available in OS X v10.3 and later.

    Not available to 64-bit applications.

  • A private data structure used internally by NSScreen.

    Declaration

    Objective-C

    typedef struct NSScreenAuxiliary NSScreenAuxiliaryOpaque;

    Import Statement

    Objective-C

    @import AppKit;

    Availability

    Available in OS X v10.0 and later.

  • A private data structure used by NSTabViewItem.

    Declaration

    Objective-C

    typedef struct NSTabViewItemAuxiliary NSTabViewItemAuxiliaryOpaque;

    Import Statement

    Objective-C

    @import AppKit;

    Availability

    Available in OS X v10.2 and later.

    Not available to 64-bit applications.

  • This type is a caching structure used by NSSimpleHorizontalTypesetter.

    Declaration

    Objective-C

    typedef struct _NSTypesetterGlyphInfo { NSPoint curLocation; float extent; float belowBaseline; float aboveBaseline; unsigned glyphCharacterIndex; NSFont *font; NSSize attachmentSize; struct { BOOL defaultPositioning:1; BOOL dontShow:1; BOOL isAttachment:1; } _giflags; } NSTypesetterGlyphInfo;

    Import Statement

    Objective-C

    @import AppKit;

    Availability

    Available in OS X v10.0 through OS X v10.4.

    Not available to 64-bit applications.