iOS開発用のUIMenuController

序章

UIMenuControllerこれは多くの場所で使用できるメニュー編集インターフェイスであり、通常は切り取り、コピー、貼り付け、選択、すべて選択、削除コマンドなどに使用されます。目的の操作をカスタマイズすることもできます。次のようになります。

インターフェイスの紹介

open class UIMenuController : NSObject {
    open class var shared: UIMenuController { get }
    open var isMenuVisible: Bool // default is NO
    
    @available(iOS, introduced: 3.0, deprecated: 13.0, message: "Use showMenuFromView:rect: or hideMenuFromView: instead.")
    open func setMenuVisible(_ menuVisible: Bool, animated: Bool)

    @available(iOS, introduced: 3.0, deprecated: 13.0, message: "Use showMenuFromView:rect: instead.")
    open func setTargetRect(_ targetRect: CGRect, in targetView: UIView)

    @available(iOS 13.0, *)
    open func showMenu(from targetView: UIView, rect targetRect: CGRect)

    @available(iOS 13.0, *)
    open func hideMenu(from targetView: UIView)

    @available(iOS 13.0, *)
    open func hideMenu()

    @available(iOS 3.2, *)
    open var arrowDirection: UIMenuController.ArrowDirection // default is UIMenuControllerArrowDefault
    
    @available(iOS 3.2, *)
    open var menuItems: [UIMenuItem]? // default is nil. these are in addition to the standard items

    open func update()
    open var menuFrame: CGRect { get }
}

open class UIMenuItem : NSObject {
    public init(title: String, action: Selector)
    
    open var title: String
    open var action: Selector
}

UIMenuControllerそのシングルトンオブジェクトを使用する必要があることがインターフェイスからわかりますが、どのように使用する必要がありますか？まず、次のドキュメントの説明を見APIて。UIMenuController

シングルトンUIMenuControllerインスタンスは、編集メニューと呼ばれます。このメニューを表示すると、UIMenuControllerは画面上のターゲットの長方形を基準にしてメニューを配置します。この長方形は通常、選択範囲を定義します。メニューは、ターゲットの長方形の上、または十分なスペースがない場合はその下に表示されます。メニューのポインタは、必要に応じて、ターゲットの長方形の上部または下部の中央に配置されます。メニューを表示する前に、必ずトラッキング長方形を設定してください。また、選択範囲の検出、追跡、および表示も担当します。

The UIResponderStandardEditActions informal protocol declares methods that are invoked when the user taps a menu command. The canPerformAction(_:withSender:) method of UIResponder is also related to the editing menu. A responder implements this method to enable and disable commands of the editing menu just before the menu is displayed. You can force this updating of menu commands’ enabled state by calling the update() method.

You can also provide your own menu items via the menuItems property. When you modify the menu items, you can use the update() method to force the menu to update its display.

翻译如下：

UIMenuController 单例称为编辑菜单。当你使这个菜单可见时，UIMenuController 将它相对于屏幕上的目标矩形定位；这个矩形通常定义一个选择。菜单显示在目标矩形上方，如果没有足够的空间，则显示在其下方。菜单指针放置在目标矩形顶部或底部的中心，视情况而定。确保在使菜单可见之前设置跟踪矩形。您还负责检测、跟踪和显示选择。

UIResponderStandardEditActions 协议声明了在用户点击菜单命令时调用的方法。 UIResponder 的 canPerformAction(_:withSender:) 方法也和编辑菜单有关。响应者实现此方法以在菜单显示之前启用和禁用编辑菜单的命令。您可以通过调用 update() 方法强制更新菜单命令的启用状态。

您还可以通过 menuItems 属性提供您自己的菜单项。修改菜单项时，可以使用 update() 方法强制菜单更新其显示。

使用探索

根据 API 说明可知

UIMenuController 显示位置可以通过设置一个矩形来定位
要想显示 UIMenuController，需要成为响应者
如果没有设置 menuItems 时有自己默认的菜单，也可以通过 menuItems 添加自己的菜单

如何创建并显示 UIMenuController

首先，API 说的很清楚，UIMenuController 是单例，直接使用 UIMenuController.shared 即可，然后调用 open func showMenu(from targetView: UIView, rect targetRect: CGRect) 方法来显示，

override func touchesBegan(_ touches: Set<UITouch>, with event: UIEvent?) {
    let menu = UIMenuController.shared
    menu.showMenu(from: view, rect: CGRect(x: 50, y: 50, width: 20, height: 20))
}

运行代码发现并没有什么反应，回看 API，还需要设置第一响应者

override var canBecomeFirstResponder: Bool {
    true
}
// 上文提到的其他代码忽略

运行代码还是没反应，回看 API，UIResponder 的 canPerformAction(_:withSender:) 方法也和编辑菜单有关。响应者实现此方法以在菜单显示之前启用和禁用编辑菜单的命令，我们实现一下试试

override func canPerformAction(_ action: Selector, withSender sender: Any?) -> Bool {
    true
}
// 上文提到的其他代码忽略

当当当当，成功了！！！

实现 Item 点击事件

接下来，我鼠标轻轻的点在了菜单上 Cut，结果奔溃了：

*** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '-[SwiftTestiOS.ViewController cut:]: unrecognized selector sent to instance 0x7fec7300d480'

根据提示，我们实现 cut 方法。

override func cut(_ sender: Any?) {
    print("cut cut cut !!!")
}
// 上文提到的其他代码忽略

nice，没有奔溃，成功打印 cut cut cut !!!

其他的菜单也可以添加对应的实现，哈哈哈...搞定!!!

菜单 Item 太多？？？

问题：我不需要这么多菜单，咋整？

之前没有因为没有实现 canPerformAction(_:withSender:) 方法时，UIMenuController 无法出现，实现了之后就出现了一大堆菜单，此方法有一个action参数，是不是此方法决定了哪些action可以显示呢，试试看：

override func canPerformAction(_ action: Selector, withSender sender: Any?) -> Bool {
    let actions = [#selector(cut(_:)), #selector(copy(_:)),
                   #selector(paste(_:)), #selector(delete(_:))]
    return actions.contains(action)
}
// 上文提到的其他代码忽略

也就是说，canPerformAction(_:withSender:) 决定设置的哪些菜单可以生效。敲黑板，这点很重要！！！

UIResponderStandardEditActions 协议

根据 API 说明，UIResponderStandardEditActions 协议定义了 UIMenuController 的一些系统默认方法，内容如下

public protocol UIResponderStandardEditActions : NSObjectProtocol {
    @available(iOS 3.0, *)
    optional func cut(_ sender: Any?)

    @available(iOS 3.0, *)
    optional func copy(_ sender: Any?)

    @available(iOS 3.0, *)
    optional func paste(_ sender: Any?)

    @available(iOS 3.0, *)
    optional func select(_ sender: Any?)

    @available(iOS 3.0, *)
    optional func selectAll(_ sender: Any?)

    @available(iOS 3.2, *)
    optional func delete(_ sender: Any?)

    //... 其他方法略
}

而且上文实现 cut 方法的时候有override，也就是 UIViewController 有这个方法，根据线索可以查到对应关系

graph TD
UIViewController --> UIResponder --> UIResponderStandardEditActions
复制代码

添加自定义菜单

如果系统提供的菜单不满足我们自己的需求，可以通过 menuItems 添加自定义菜单

override func touchesBegan(_ touches: Set<UITouch>, with event: UIEvent?) {
    let menu = UIMenuController.shared
    let item1 = UIMenuItem(title: "hello", action: #selector(helloAction))
    let item2 = UIMenuItem(title: "world", action: #selector(worldAction))

    menu.menuItems = [item1, item2]
    menu.showMenu(from: view, rect: CGRect(x: 50, y: 50, width: 20, height: 20))
}

@objc func helloAction() {
    print(#function)
}

@objc func worldAction() {
    print(#function)
}

override func canPerformAction(_ action: Selector, withSender sender: Any?) -> Bool {
    let actions = [#selector(cut(_:)), #selector(copy(_:)),
                   #selector(paste(_:)), #selector(delete(_:)),
                   #selector(helloAction), #selector(worldAction)]
    return actions.contains(action)
}
// 上文提到的其他代码忽略

添加之后效果如下：

箭头的方向

UIMenuController 有个arrowDirection 属性，用于设置箭头的位置，它是ArrowDirection 类型的枚举

extension UIMenuController {
    public enum ArrowDirection : Int, @unchecked Sendable {
        case `default` = 0
        case up = 1
        case down = 2
        case left = 3
        case right = 4
    }
}

默认的时候，会根据需要调整箭头方向，而箭头的位置根据 API 描述（菜单指针放置在目标矩形顶部或底部的中心，视情况而定）是在设置的矩形区域的上下边的中间位置。

注意：如果强制设定了一个方向的话，而在该方向没有足够的空间，则不会显示菜单

实际使用

在显示 UIMenuController 的时候有一个方法 open func showMenu(from targetView: UIView, rect targetRect: CGRect)，此方法主要是用来设置显示位置的，targetView 指明位置参照对象，rect 表示参照 targetView 的位置，如：

let position = label.bounds
menu.showMenu(from: label, rect: position)

上述代码可以理解成：菜单显示在相对于 label 的 position 处

总结

UIMenuController 的使用总体还是比较简单的，主要是以下几点：

UIMenuController 是单例
必須のデフォルトUIMenuControllerメニューを表示する
- ファーストレスポンダーになる
- UIResponder 的 canPerformAction(_:withSender:)追加するために戻るUIMenuItem
- 対応するメソッドを実装UIMenuItemする
カスタマイズUIMenuItem
- UIMenuController.menuItemsプロパティを介してカスタムを追加UIMenuItem
- canPerformAction(_:withSender:)対応するUIMenuItemでaction
矢印の位置
- 使用をお勧めしますArrowDirection.default
- 他の値を使用すると、メニューが非表示になる可能性があるため、表示できることが確実でない限り、お勧めしません

序章