New convenience initializer

NSMenu and rightClicks support

Package.swift

@@ -6,7 +6,7 @@ import PackageDescription
 let package = Package(
     name: "Popover",
     platforms: [
-        .macOS(.v10_14)
+        .macOS(.v10_11)
     ],
     products: [
         // Products define the executables and libraries produced by a package, and make them visible to other packages.

README.md

@@ -1,6 +1,116 @@
 # Popover
 
-Mac OS custom popover. Made with ❤️
+Mac OS custom popover.
 ![alt text](popover.png "Popover")
 
-Heavily inspired by [CCNStatusItem](https://github.com/phranck/CCNStatusItem)
+# Install
+
+Since this is a Swift Package, the installation process is pretty stright forward.
+
+### Manual way
+Update your `Package.swift` dependencies:
+
+```
+dependencies: [
+    .package(url: "https://github.com/iSapozhnik/Popover", from: "1.0.8")
+]
+```
+
+### Via Xcode:
+1. Go to `File -> Swift Packages -> Add Package Dependency`. 
+2. Put GitHub URL `https://github.com/iSapozhnik/Popover` and click `Next`
+3. Select the latest version
+4. Click `Finish`
+
+# How to use
+
+1. In your `AppDelegate` import Popover
+2. Create a view you want to put into a status bar.
+3. Create a content view controller which would be embedded inside Popover
+4. Optionally create menu items
+5. Create a Popover instance. Here you can use either standard configuration (you don't need to pass `windowConfiguration` parameter in this case) or you can subclass `DefaultConfiguration`, override some properties and pass a new instance as a parameter. If in ste 4 you have created menu items, pass it here as well.
+6. Call `prepare` to set everything up.
+
+And here is how typical `AppDelegate` may look like:
+
+```swift
+import Cocoa
+import Popover
+
+class MyPopoverConfiguration: DefaultConfiguration {
+    override var backgroundColor: NSColor {
+        return NSColor.systemRed
+    }
+
+    override var borderColor: NSColor? {
+        return NSColor.red
+    }
+}
+
+@NSApplicationMain
+class AppDelegate: NSObject, NSApplicationDelegate {
+    var popover: Popover!
+
+    func applicationDidFinishLaunching(_ aNotification: Notification) {
+        let statusItemView = StatusItemView(frame: NSRect(width: 22.0, height: 20))
+
+        let viewController = MainViewController()
+
+        let menuItems: [Popover.MenuItemType] = [
+            .item(Popover.MenuItem(title: "Settings", action: viewController.showSettings)),
+            .separator,
+            .item(Popover.MenuItem(title: "Quit", key: "q", action: viewController.quit))
+        ]
+
+        popover = Popover(with: MyPopoverConfiguration(), menuItems: menuItems)
+        popover.prepare(with: statusItemView, contentViewController: viewController)
+    }
+}
+
+```
+
+# What can be customized?
+
+Quite a lot of things:
+
+```swift
+public protocol PopoverConfiguration {
+    /// The distance from Popover's arrow to a status item.
+    var popoverToStatusItemMargin:  CGFloat { get }
+
+    /// Popover's background color.
+    var backgroundColor:            NSColor { get }
+
+    /// Popover's border color.
+    /// - Important:
+    ///     If `borderColor` returns `nil`, settings `borderWidth` won't make any effect. See also: `borderWidth`.
+    var borderColor:                NSColor? { get }
+
+    /// Popover's border width.
+    /// - Important:
+    ///      If Popover's border color is set to `nil`, setting `borderWidth` won't make any effect.
+    var borderWidth:                CGFloat { get }
+
+    /// Defines Popover arrow height.
+    var arrowHeight:                CGFloat { get }
+
+    /// Defines Popover arrow width.
+    var arrowWidth:                 CGFloat { get }
+
+    /// Defines Popover corner radius.
+    /// - Warning:
+    ///     If this value is too big and if the Popover's status item (menu bar view) is too close to the right edge, the appearence of the Popover might be odd.
+    var cornerRadius:               CGFloat { get }
+
+    /// Defines Popover content edge insets.
+    var contentEdgeInsets:          NSEdgeInsets { get }
+
+    /// The distance from the right side of the Popover to the screen's edge.
+    /// - Warning:
+    ///     If this value is too big and if the Popover's status item (menu bar view) is too close to the right edge, the appearence of the Popover might be odd.
+    var rightEdgeMargin:            CGFloat { get }
+}
+```
+
+
+Heavily inspired by [CCNStatusItem](https://github.com/phranck/CCNStatusItem)

Sources/Popover/EventMonitor.swift

@@ -8,13 +8,25 @@
 import Cocoa
 
 class EventMonitor {
+    enum MonitorType {
+        case global
+        case local
+    }
+    
+    typealias GlobalEventHandler = (NSEvent?) -> Void
+    typealias LocalEventHandler = (NSEvent?) -> NSEvent?
+
     private var monitor: Any?
     private let mask: NSEvent.EventTypeMask
-    private let handler: (NSEvent?) -> Void
+    private let monitorType: MonitorType
+    private let globalHandler: GlobalEventHandler?
+    private let localHandler: LocalEventHandler?
 
-    init(mask: NSEvent.EventTypeMask, handler: @escaping (NSEvent?) -> Void) {
+    init(monitorType: MonitorType, mask: NSEvent.EventTypeMask, globalHandler: GlobalEventHandler?, localHandler: LocalEventHandler?) {
         self.mask = mask
-        self.handler = handler
+        self.monitorType = monitorType
+        self.globalHandler = globalHandler
+        self.localHandler = localHandler
     }
 
     deinit {
@@ -22,7 +34,12 @@ class EventMonitor {
     }
 
     func start() {
-        monitor = NSEvent.addGlobalMonitorForEvents(matching: mask, handler: handler)
+        switch monitorType {
+        case .global:
+            startGlobalMonitor()
+        case .local:
+            startLocalMonitor()
+        }
     }
 
     func stop() {
@@ -31,4 +48,20 @@ class EventMonitor {
         NSEvent.removeMonitor(monitor)
         self.monitor = nil
     }
+
+    private func startGlobalMonitor() {
+        guard let handler = globalHandler else {
+            assertionFailure("Global event handler is not set.")
+            return
+        }
+        monitor = NSEvent.addGlobalMonitorForEvents(matching: mask, handler: handler)
+    }
+
+    private func startLocalMonitor() {
+        guard let handler = localHandler else {
+            assertionFailure("Local event handler is not set.")
+            return
+        }
+        monitor = NSEvent.addLocalMonitorForEvents(matching: mask, handler: handler)
+    }
 }

Sources/Popover/Extensions.swift

@@ -0,0 +1,20 @@
+//
+//  File.swift
+//  
+//
+//  Created by Ivan Sapozhnik on 06.04.20.
+//
+
+import Cocoa
+
+extension CAEdgeAntialiasingMask {
+    static var all: CAEdgeAntialiasingMask {
+        return [.layerLeftEdge, .layerRightEdge, .layerBottomEdge, .layerTopEdge]
+    }
+}
+
+extension Array {
+    var isNotEmpty: Bool {
+        return !isEmpty
+    }
+}

Sources/Popover/MenuItem.swift

@@ -0,0 +1,36 @@
+//
+//  File.swift
+//  
+//
+//  Created by Ivan Sapozhnik on 07.04.20.
+//
+
+import Foundation
+
+public extension Popover {
+    enum MenuItemType {
+        case item(MenuItem)
+        case separator
+    }
+
+    class MenuItem: NSObject {
+        let title: String
+        let key: String
+        let _action: () -> Void
+
+        public convenience init(title: String, action: @escaping () -> Void) {
+            self.init(title: title, key: "", action: action)
+        }
+
+        public init(title: String, key: String, action: @escaping () -> Void) {
+            self.title = title
+            self.key = key
+            _action = action
+        }
+
+        @objc
+        func action() {
+            _action()
+        }
+    }
+}

Sources/Popover/Popover.swift

@@ -8,59 +8,113 @@
 import Cocoa
 
 public class Popover: NSObject {
-    var item: NSStatusItem!
+    var item: NSStatusItem! {
+        didSet {
+            prepareMenu()
+        }
+    }
 
     private let wConfig: PopoverConfiguration
     private var popoverWindowController: PopoverWindowController?
-    private var statusItemContainer: StatusItemContainerView?
-    private var eventMonitor: EventMonitor?
+    private var globalEventMonitor: EventMonitor?
+    private var localEventMonitor: EventMonitor?
+    private var menu: NSMenu?
+    private var menuItems: [MenuItemType]?
 
     private var isPopoverWindowVisible: Bool {
         return (popoverWindowController != nil) ? popoverWindowController!.windowIsOpen : false
     }
 
+    /// Convenience initializer which is using default configuration
+    public convenience override init() {
+        self.init(with: DefaultConfiguration(), menuItems: nil)
+    }
+
+    /// Convenience initializer
+    ///
+    /// - Parameters:
+    ///     - windowConfiguration: Popover window configuration. Subclass `DefaultConfiguration` and override properties or conform to `PopoverConfiguration` protocol.
+    public convenience override init(with windowConfiguration: PopoverConfiguration) {
+        self.init(with: windowConfiguration, menuItems: nil)
+    }
+
+    /// Convenience initializer which is using default configuration and optiona menu items
+    ///
+    /// - Parameters:
+    ///     - menuItems: Array of items that NSMenu will show
+    public convenience init(with menuItems: [MenuItemType]?) {
+        self.init(with: DefaultConfiguration(), menuItems: menuItems)
+    }
+
     /// Creates a Popover with given PopoverConfiguration. Popover configuration can be either `DefaultConfiguration` or you can sublclass this class and override some of the properties.
+    ///
     /// By default Popover is using Event Monitor and by doing left or right click ouside of the Popover's frame, the Popover will be automatically dismissed.
-    public init(with windowConfiguration: PopoverConfiguration) {
+    ///
+    /// - Parameters:
+    ///     - windowConfiguration: Popover window configuration. By default `DefaultConfiguration` instance is being used.
+    ///     - menuItems: Array of items that NSMenu will show
+    public init(with windowConfiguration: PopoverConfiguration, menuItems: [MenuItemType]?) {
         wConfig = windowConfiguration
+        self.menuItems = menuItems
 
         super.init()
 
-        eventMonitor = EventMonitor(mask: [.rightMouseDown, .leftMouseDown], handler: { [weak self] event in
-            guard let self = self else { return }
-            self.dismiss()
-        })
-    }
-
-    /// Convenience initializer which is using default configuration
-    public convenience override init() {
-        self.init(with: DefaultConfiguration())
+        setupMonitors()
     }
 
     /// Creates a Popover with given image and contentViewController
+    ///
     /// By default it won't present any Popover until the user clicks on status bar item
-    public func createPopover(with image: NSImage, contentViewController viewController: NSViewController) {
+    public func prepare(with image: NSImage, contentViewController viewController: NSViewController) {
         configureStatusBarButton(with: image)
         popoverWindowController = PopoverWindowController(with: self, contentViewController: viewController, windowConfiguration: wConfig)
+        localEventMonitor?.start()
     }
 
     /// Creates a Popover with given view and contentViewController. The view's height will be scaled down to 18pt and also will be vertically aligned. The wdith can be any.
+    ///
     /// By default it won't present any Popover until the user clicks on status bar item
-    public func createPopover(with view: NSView, contentViewController viewController: NSViewController) {
+    public func prepare(with view: NSView, contentViewController viewController: NSViewController) {
         configureStatusBarButton(with: view)
         popoverWindowController = PopoverWindowController(with: self, contentViewController: viewController, windowConfiguration: wConfig)
+        localEventMonitor?.start()
     }
 
     /// Shows the Popover with no animation
     public func show() {
+        guard !isPopoverWindowVisible else { return }
         popoverWindowController?.show()
-        eventMonitor?.start()
+        globalEventMonitor?.start()
     }
 
-    /// Dismisses the Popover with default animation. Animation behaviour is `AnimationBehavior.utilityWindow`
+    /// Dismisses the Popover with default animation. Animation behavior is `AnimationBehavior.utilityWindow`
     public func dismiss() {
+        guard isPopoverWindowVisible else { return }
         popoverWindowController?.dismiss()
-        eventMonitor?.stop()
+        globalEventMonitor?.stop()
+    }
+
+    private func setupMonitors() {
+        globalEventMonitor = EventMonitor(monitorType: .global, mask: [.leftMouseDown, .rightMouseDown], globalHandler: { [weak self] _ in
+            guard let self = self else { return }
+            self.dismiss()
+        }, localHandler: nil)
+
+        if menuItems != nil, menuItems?.isNotEmpty ?? false {
+            localEventMonitor = EventMonitor(monitorType: .local, mask: [.leftMouseDown, .rightMouseDown], globalHandler: nil, localHandler: { [weak self] event -> NSEvent? in
+                guard let self = self, let currentEvent = event else { return event }
+
+                let isRightMouseClick = currentEvent.type == .rightMouseDown
+                let isControlLeftClick = currentEvent.type == .leftMouseDown && currentEvent.modifierFlags.contains(.control)
+
+                if isRightMouseClick || isControlLeftClick {
+                    self.dismiss()
+                    self.item.menu = self.menu
+                }
+
+                return event
+            })
+        }
     }
 
     private func configureStatusBarButton(with image: NSImage) {
@@ -68,9 +122,8 @@ public class Popover: NSObject {
         guard let button = item.button else { return }
 
         image.isTemplate = true
-        button.target = self
-        button.action = #selector(handleStatusItemButtonAction(_:))
         button.image = image
+        setTargetAction(for: button)
     }
 
     private func configureStatusBarButton(with view: NSView) {
@@ -79,17 +132,43 @@ public class Popover: NSObject {
 
         let statusItemContainer = StatusItemContainerView()
 
-        button.target = self
-        button.action = #selector(handleStatusItemButtonAction(_:))
+        setTargetAction(for: button)
         button.addSubview(statusItemContainer)
 
         statusItemContainer.embed(view)
-
-        button.frame = statusItemContainer.frame
-        self.statusItemContainer = statusItemContainer
     }
 
     @objc private func handleStatusItemButtonAction(_ sender: Any?) {
         isPopoverWindowVisible ? dismiss() : show()
     }
+
+    private func setTargetAction(for button: NSButton) {
+        button.target = self
+        button.action = #selector(handleStatusItemButtonAction(_:))
+    }
+
+    private func prepareMenu() {
+        guard menuItems != nil, menuItems?.isNotEmpty ?? false else { return }
+
+        let menu = NSMenu()
+        menuItems?.forEach { menuItemType in
+            switch menuItemType {
+            case .item(let actionItem):
+                let menuItem = NSMenuItem(title: actionItem.title, action: #selector(MenuItem.action), keyEquivalent: actionItem.key)
+                menuItem.target = actionItem
+                menu.addItem(menuItem)
+            case .separator:
+                menu.addItem(NSMenuItem.separator())
+            }
+        }
+
+        menu.delegate = self
+        self.menu = menu
+    }
+}
+
+extension Popover: NSMenuDelegate {
+    public func menuDidClose(_ menu: NSMenu) {
+        item.menu = nil
+    }
 }

Sources/Popover/PopoverConfiguration.swift

@@ -16,12 +16,12 @@ public protocol PopoverConfiguration {
 
     /// Popover's border color.
     /// - Important:
-    ///     If `borderColor` returns `nil`, settings `borderWidth` won't make any affect. See also: `borderWidth`.
+    ///     If `borderColor` returns `nil`, settings `borderWidth` won't make any effect. See also: `borderWidth`.
     var borderColor:                NSColor? { get }
 
     /// Popover's border width.
     /// - Important:
-    ///      If Popover's border color is set to `nil`, setting `borderWidth` won't make any affect.
+    ///      If Popover's border color is set to `nil`, setting `borderWidth` won't make any effect.
     var borderWidth:                CGFloat { get }
 
     /// Defines Popover arrow height.

Sources/Popover/PopoverWindow.swift

@@ -17,9 +17,20 @@ class PopoverWindow: NSPanel {
     private var childContentView: NSView?
     private var backgroundView: PopoverWindowBackgroundView?
 
-    private init(contentRect: NSRect, styleMask style: NSWindow.StyleMask, backing backingStoreType: NSWindow.BackingStoreType, defer flag: Bool, configuration: PopoverConfiguration) {
+    private init(
+        contentRect: NSRect,
+        styleMask style: NSWindow.StyleMask,
+        backing backingStoreType: NSWindow.BackingStoreType,
+        defer flag: Bool,
+        configuration: PopoverConfiguration
+    ) {
         wConfig = configuration
-        super.init(contentRect: contentRect, styleMask: style, backing: backingStoreType, defer: flag)
+        super.init(
+            contentRect: contentRect,
+            styleMask: style,
+            backing: backingStoreType,
+            defer: flag
+        )
 
         isOpaque = false
         hasShadow = true
@@ -50,12 +61,10 @@ class PopoverWindow: NSPanel {
         set {
             guard childContentView != newValue, let bounds = newValue?.bounds else { return }
 
-            let antialiasingMask: CAEdgeAntialiasingMask = [.layerLeftEdge, .layerRightEdge, .layerBottomEdge, .layerTopEdge]
-
             backgroundView = super.contentView as? PopoverWindowBackgroundView
             if (backgroundView == nil) {
                 backgroundView = PopoverWindowBackgroundView(frame: bounds, windowConfiguration: wConfig)
-                backgroundView?.layer?.edgeAntialiasingMask = antialiasingMask
+                backgroundView?.layer?.edgeAntialiasingMask = .all
                 super.contentView = backgroundView
             }
 
@@ -68,7 +77,7 @@ class PopoverWindow: NSPanel {
             childContentView?.wantsLayer = true
             childContentView?.layer?.cornerRadius = wConfig.cornerRadius
             childContentView?.layer?.masksToBounds = true
-            childContentView?.layer?.edgeAntialiasingMask = antialiasingMask
+            childContentView?.layer?.edgeAntialiasingMask = .all
 
             guard let userContentView = self.childContentView, let backgroundView = self.backgroundView else { return }
             backgroundView.addSubview(userContentView)
@@ -97,7 +106,7 @@ class PopoverWindow: NSPanel {
     }
 
     private func updateArrowPosition() {
-        guard let backgroundView = self.backgroundView as? PopoverWindowBackgroundView else { return }
+        guard let backgroundView = self.backgroundView else { return }
         backgroundView.arrowXLocation = arrowXLocation
     }
 }

Sources/Popover/PopoverWindowBackgroundView.swift

@@ -9,9 +9,6 @@ import Cocoa
 
 class PopoverWindowBackgroundView: NSView {
     private let wConfig: PopoverConfiguration
-
-    private var visualEffect: NSVisualEffectView?
-    
     var arrowXLocation: CGFloat = 0.0 {
         didSet {
             needsDisplay = true
@@ -21,36 +18,6 @@ class PopoverWindowBackgroundView: NSView {
     init(frame frameRect: NSRect, windowConfiguration: PopoverConfiguration) {
         self.wConfig = windowConfiguration
         super.init(frame: frameRect)
-
-//        setupVisualEffect()
-    }
-
-    private func setupVisualEffect() {
-        let visualEffect = NSVisualEffectView()
-        visualEffect.translatesAutoresizingMaskIntoConstraints = false
-        visualEffect.blendingMode = .behindWindow
-        visualEffect.state = .active
-        visualEffect.appearance = NSAppearance.current
-        guard let appearence = NSAppearance.current else { return }
-        switch appearence.name {
-        case .aqua:
-            visualEffect.material = .dark
-        case .darkAqua:
-            visualEffect.material = .dark
-        default:
-            break
-        }
-
-        self.visualEffect = visualEffect
-
-        addSubview(visualEffect)
-
-        NSLayoutConstraint.activate([
-            visualEffect.leadingAnchor.constraint(equalTo: self.leadingAnchor),
-            visualEffect.trailingAnchor.constraint(equalTo: self.trailingAnchor),
-            visualEffect.topAnchor.constraint(equalTo: self.topAnchor),
-            visualEffect.bottomAnchor.constraint(equalTo: self.bottomAnchor)
-        ])
     }
 
     required init?(coder: NSCoder) {
@@ -105,16 +72,10 @@ class PopoverWindowBackgroundView: NSView {
             windowPath.stroke()
         }
 
+
         wConfig.backgroundColor.setFill()
         windowPath.fill()
 
-        let antialiasingMask: CAEdgeAntialiasingMask = [.layerLeftEdge, .layerRightEdge, .layerBottomEdge, .layerTopEdge]
-        let mask = CAShapeLayer()
-        mask.edgeAntialiasingMask = antialiasingMask
-        mask.path = windowPath.cgPath
-        visualEffect?.layer?.mask = mask
-
-
 //        NSColor.red.setFill()
 //        controlPoints.fill()
     }
@@ -125,27 +86,3 @@ class PopoverWindowBackgroundView: NSView {
         }
     }
 }
-
-extension NSBezierPath {
-    var cgPath: CGPath {
-        let path = CGMutablePath()
-        var points = [CGPoint](repeating: .zero, count: 3)
-        for i in 0 ..< self.elementCount {
-            let type = self.element(at: i, associatedPoints: &points)
-
-            switch type {
-            case .moveTo:
-                path.move(to: points[0])
-            case .lineTo:
-                path.addLine(to: points[0])
-            case .curveTo:
-                path.addCurve(to: points[2], control1: points[0], control2: points[1])
-            case .closePath:
-                path.closeSubpath()
-            @unknown default:
-                break
-            }
-        }
-        return path
-    }
-}

Sources/Popover/PopoverWindowController.swift

@@ -82,5 +82,4 @@ class PopoverWindowController: NSWindowController {
 
         return currentScreen ?? NSScreen.main ?? NSScreen()
     }
-
 }

Sources/Popover/StatusItemContainerView.swift

@@ -24,7 +24,7 @@ class StatusItemContainerView: NSView {
         )
         let contentFrame = NSRect(
             x: 0,
-            y: (Constants.maxContainerSize-Constants.maxContentHeight) / 2,
+            y: (Constants.maxContainerSize - Constants.maxContentHeight) / 2,
             width: NSWidth(view.bounds),
             height: Constants.maxContentHeight
         )