From 7f69ddc749d397e4f5b36f18cd09274d80f3fd55 Mon Sep 17 00:00:00 2001 From: Nate Weaver Date: Sat, 8 Oct 2022 01:27:35 -0500 Subject: [PATCH] Add documentation comment and rename window parameter --- Mac/Browser.swift | 8 +++++++- Mac/MainWindow/MainWindowController.swift | 2 +- .../Timeline/TimelineViewController+ContextualMenus.swift | 2 +- Mac/MainWindow/Timeline/TimelineViewController.swift | 2 +- 4 files changed, 10 insertions(+), 4 deletions(-) diff --git a/Mac/Browser.swift b/Mac/Browser.swift index f53e95631..3ab1fbcac 100644 --- a/Mac/Browser.swift +++ b/Mac/Browser.swift @@ -76,7 +76,13 @@ extension Browser { extension Browser { - static func open(_ urlStrings: [String], alertingInWindow window: NSWindow?, invertPreference: Bool = false) { + /// Open multiple pages in the default browser, warning if over a certain number of URLs are passed. + /// - Parameters: + /// - urlStrings: The URL strings to open. + /// - window: The window on which to display the "over limit" alert sheet. If `nil`, will be displayed as a + /// modal dialog. + /// - invertPreference: Whether to invert the user's "Open web pages in background in browser" preference. + static func open(_ urlStrings: [String], fromWindow window: NSWindow?, invertPreference: Bool = false) { if urlStrings.count > 500 { return } diff --git a/Mac/MainWindow/MainWindowController.swift b/Mac/MainWindow/MainWindowController.swift index e27c8fbb5..8455b8d1a 100644 --- a/Mac/MainWindow/MainWindowController.swift +++ b/Mac/MainWindow/MainWindowController.swift @@ -343,7 +343,7 @@ class MainWindowController : NSWindowController, NSUserInterfaceValidations { @IBAction func openArticleInBrowser(_ sender: Any?) { guard let selectedArticles else { return } let urlStrings = selectedArticles.compactMap { $0.preferredLink } - Browser.open(urlStrings, alertingInWindow: window, invertPreference: NSApp.currentEvent?.modifierFlags.contains(.shift) ?? false) + Browser.open(urlStrings, fromWindow: window, invertPreference: NSApp.currentEvent?.modifierFlags.contains(.shift) ?? false) } @IBAction func openInBrowser(_ sender: Any?) { diff --git a/Mac/MainWindow/Timeline/TimelineViewController+ContextualMenus.swift b/Mac/MainWindow/Timeline/TimelineViewController+ContextualMenus.swift index cc90504a4..6da82f3e7 100644 --- a/Mac/MainWindow/Timeline/TimelineViewController+ContextualMenus.swift +++ b/Mac/MainWindow/Timeline/TimelineViewController+ContextualMenus.swift @@ -93,7 +93,7 @@ extension TimelineViewController { return } - Browser.open(urlStrings, alertingInWindow: self.view.window) + Browser.open(urlStrings, fromWindow: self.view.window) } @objc func copyURLFromContextualMenu(_ sender: Any?) { diff --git a/Mac/MainWindow/Timeline/TimelineViewController.swift b/Mac/MainWindow/Timeline/TimelineViewController.swift index 424892a72..67472a2b0 100644 --- a/Mac/MainWindow/Timeline/TimelineViewController.swift +++ b/Mac/MainWindow/Timeline/TimelineViewController.swift @@ -316,7 +316,7 @@ final class TimelineViewController: NSViewController, UndoableCommandRunner, Unr @objc func openArticleInBrowser(_ sender: Any?) { let urlStrings = selectedArticles.compactMap { $0.preferredLink } - Browser.open(urlStrings, alertingInWindow: self.view.window) + Browser.open(urlStrings, fromWindow: self.view.window) } @IBAction func toggleStatusOfSelectedArticles(_ sender: Any?) {