Last week I started an open source app Xliff Tool. It was an app to help developers translate Xliff files exported by Xcode.
We know that for the main menu of an app, its menu items look up the responder chain to find actions to perform. So those functions need to be dynamic. For example, a "Open..." menu item under "File" menu, it looks up for a function called openDocument(_:)
, so I could create a function in AppDelegate.swift
like this:
@objc func openDocument(_ sender: Any?) {
...
}
However, when I created another customized menu item of my own, I could not find the function name in first responder with Interface Builder.
@objc func openDatabaseDirectory(_ sender: Any?) {
...
}
The fix was easy, just changed @objc
to @IBAction
, and the function name would be shown.
@IBAction func openDatabaseDirectory(_ sender: Any?) {
...
}
The answer is the prior @objc function wasn't shown. What was shown in Interface Builder is another @IBAction from NSDocumentController
.
/* The action of the File menu's Open... item in a document-based application. The default implementation of this method invokes -beginOpenPanelWithCompletionHandler:, unless -fileNamesFromRunningOpenPanel is overridden, in which case that method is invoked instead for backward binary compatibility with Mac OS 10.3 and earlier. If an array other than nil is obtained from that call, it invokes -openDocumentWithContentsOfURL:display:completionHandler: for each URL and, if an error is signaled for any of them, presents the error in an application-modal panel.
*/
@IBAction open func openDocument(_ sender: Any?)
So in Interface Builder the @IBAction function was shown and in app runtime, the dynamic function on the first responder is the @objc one.
Both @IBAction and @objc are dynamic/objective-c functions, one difference is that the prior can be shown in Interface Builder.
An interesting bug/feature of Interface Builder
There was a "Save as..." menu item under "File" menu, connecting to saveAs(_:)
, I firstly implemented that function
@objc func saveAs(_ sender: Any?) {
...
}
Then I changed the "Save As..." menu item to "Export Xliff File...", and refactored the name of the function as well.
@objc func exportXliffFile(_ sender: Any?) {
...
}
Then I ran the app, the @objc func exportXliffFile(_ sender: Any?)
still worked.
Let me explain this. Though in the above picture it was shown that the menu item "Export Xliff File..." is connected to "exportXliffFile:" function of first responder. As we explained in Q1, there was no corresponding @IBAction function named "exportXliffFile:", so no one could choose "exportXliffFile:" in Interface Builder at all.
Q2: Then why was "exportXliffFile:" connected in Interface Builder and it still worked?
The answer is the operations that I did.
- There is @IBAction in
NSDocument.saveAs(_:)
. So @objc func saveAs(_ sender: Any?)
worked.
- When refactored in Xcode, both the name of
@objc func saveAs(_ sender: Any?)
and the connection "saveAs:" in Interface Builder were changed.
- The name of @IBAction in
NSDocument.saveAs(_:)
was unchanged as it was in a readonly header.
- When the app ran, the menu item looked up for a function called "exportXliffFile:" and found.
You can not pick a @objc function in Interface Builder, but if you refactor its name from a @IBAction, it will still work.
Others
The Real Reason of Not Working NSMenuDelegate with Interface Builder