Mac Developer Library

Developer

AppKit Framework Reference NSDockTilePlugIn Protocol Reference

Options
Deployment Target:

On This Page
Language:

NSDockTilePlugIn

The NSDockTilePlugIn protocol defines the methods implemented by plug-ins that allow an application’s Dock tile to be customized while the application is not running. More...

Inheritance


Not Applicable

Import Statement


import AppKit @import AppKit;

Availability


Available in OS X v10.6 and later.
  • Invoked when the plug-in is first loaded and when the application is removed from the Dock. (required)

    Declaration

    Swift

    func setDockTile(_ dockTile: NSDockTile!)

    Objective-C

    - (void)setDockTile:(NSDockTile *)dockTile

    Parameters

    dockTile

    The dock tile associated with the application, or nil if the application has been removed from the Dock.

    Discussion

    The plugin is loaded in a system process at login time or when the application tile is added to the Dock.

    The principal class of the plug-in must implement the NSDockTilePlugIn protocol.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.6 and later.

  • Invoked when the user causes the application's dock menu to be shown.

    Declaration

    Swift

    optional func dockMenu() -> NSMenu!

    Objective-C

    - (NSMenu *)dockMenu

    Return Value

    The menu the dock tile displays.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.6 and later.