Impl TextEditor (closes #149) & fix macOS text input cmds (cmd+a etc)

Author: stackotter

Examples/Sources/NotesExample/ContentView.swift

@@ -34,6 +34,17 @@ struct Note: Codable, Equatable, Identifiable {
 struct ContentView: View {
     let notesFile = URL(fileURLWithPath: "notes.json")
 
+    @Environment(\.colorScheme) var colorScheme
+
+    var textEditorBackground: Color {
+        switch colorScheme {
+            case .light:
+                Color(0.8, 0.8, 0.8)
+            case .dark:
+                Color(0.18, 0.18, 0.18)
+        }
+    }
+
     @State var notes: [Note] = [
         Note(title: "Hello, world!", content: "Welcome SwiftCrossNotes!"),
         Note(
@@ -118,25 +129,22 @@ struct ContentView: View {
                 }
             }
         } detail: {
-            VStack(alignment: .leading) {
-                if let selectedNote = selectedNote {
-                    VStack(alignment: .leading, spacing: 4) {
-                        Text("Title")
-                        TextField("Title", text: selectedNote.title)
-                    }
+            ScrollView {
+                VStack(alignment: .center) {
+                    if let selectedNote = selectedNote {
+                        HStack(spacing: 4) {
+                            Text("Title")
+                            TextField("Title", text: selectedNote.title)
+                        }
 
-                    VStack(alignment: .leading, spacing: 4) {
-                        Text("Content")
-                        TextField("Content", text: selectedNote.content)
+                        TextEditor(text: selectedNote.content)
+                            .padding()
+                            .background(textEditorBackground)
+                            .cornerRadius(4)
                     }
-                } else {
-                    Text("Select a note...")
                 }
+                .padding()
             }
-            .frame(maxWidth: 400)
-            .padding(10)
-
-            Spacer()
         }
     }
 }

Examples/Sources/WebViewExample/WebViewApp.swift

@@ -1,6 +1,6 @@
+import DefaultBackend
 import Foundation
 import SwiftCrossUI
-import DefaultBackend
 
 #if canImport(SwiftBundlerRuntime)
     import SwiftBundlerRuntime
@@ -21,7 +21,7 @@ struct WebViewApp: App {
                         TextField("URL", text: $urlInput)
                         Button("Go") {
                             guard let url = URL(string: urlInput) else {
-                                return // disabled
+                                return  // disabled
                             }
 
                             self.url = url

Package.resolved

@@ -64,7 +64,7 @@ public final class AppKitBackend: AppBackend {
             backing: .buffered,
             defer: true
         )
-        window.delegate = window.resizeDelegate
+        window.delegate = window.customDelegate
 
         return window
     }
@@ -94,7 +94,7 @@ public final class AppKitBackend: AppBackend {
         ofWindow window: Window,
         to action: @escaping (SIMD2<Int>) -> Void
     ) {
-        window.resizeDelegate.setHandler(action)
+        window.customDelegate.setHandler(action)
     }
 
     public func setTitle(ofWindow window: Window, to title: String) {
@@ -176,6 +176,9 @@ public final class AppKitBackend: AppBackend {
         let about = NSMenuItem()
         about.submenu = createDefaultAboutMenu()
         menuBar.addItem(about)
+        let edit = NSMenuItem()
+        edit.submenu = createDefaultEditMenu()
+        menuBar.addItem(edit)
 
         var helpMenu: NSMenu?
         for submenu in submenus {
@@ -230,6 +233,55 @@ public final class AppKitBackend: AppBackend {
         return appMenu
     }
 
+    public static func createDefaultEditMenu() -> NSMenu {
+        let appMenu = NSMenu(title: "Edit")
+        let undoItem = appMenu.addItem(
+            withTitle: "Undo",
+            action: "undo:",
+            keyEquivalent: "z"
+        )
+        undoItem.keyEquivalentModifierMask = .command
+
+        let redoItem = appMenu.addItem(
+            withTitle: "Redo",
+            action: "redo:",
+            keyEquivalent: "z"
+        )
+        redoItem.keyEquivalentModifierMask = [.command, .shift]
+
+        appMenu.addItem(NSMenuItem.separator())
+
+        let cutItem = appMenu.addItem(
+            withTitle: "Cut",
+            action: "cut:",
+            keyEquivalent: "x"
+        )
+        cutItem.keyEquivalentModifierMask = .command
+
+        let copyItem = appMenu.addItem(
+            withTitle: "Copy",
+            action: "copy:",
+            keyEquivalent: "c"
+        )
+        copyItem.keyEquivalentModifierMask = .command
+
+        let pasteItem = appMenu.addItem(
+            withTitle: "Paste",
+            action: "paste:",
+            keyEquivalent: "v"
+        )
+        pasteItem.keyEquivalentModifierMask = .command
+
+        let selectAllItem = appMenu.addItem(
+            withTitle: "Select all",
+            action: "selectAll:",
+            keyEquivalent: "a"
+        )
+        selectAllItem.keyEquivalentModifierMask = .command
+
+        return appMenu
+    }
+
     public func setApplicationMenu(_ submenus: [ResolvedMenu.Submenu]) {
         let (menuBar, helpMenu) = Self.renderMenuBar(submenus)
         NSApplication.shared.mainMenu = menuBar
@@ -448,7 +500,7 @@ public final class AppKitBackend: AppBackend {
 
     public func size(
         of text: String,
-        whenDisplayedIn textView: Widget,
+        whenDisplayedIn widget: Widget,
         proposedFrame: SIMD2<Int>?,
         environment: EnvironmentValues
     ) -> SIMD2<Int> {
@@ -458,7 +510,7 @@ public final class AppKitBackend: AppBackend {
             // reaches zero width.
             let size = size(
                 of: text,
-                whenDisplayedIn: textView,
+                whenDisplayedIn: widget,
                 proposedFrame: SIMD2(1, proposedFrame.y),
                 environment: environment
             )
@@ -676,7 +728,9 @@ public final class AppKitBackend: AppBackend {
         textField.isEnabled = environment.isEnabled
         textField.placeholderString = placeholder
         textField.appearance = environment.colorScheme.nsAppearance
-        textField.font = Self.font(for: environment)
+        if textField.font != Self.font(for: environment) {
+            textField.font = Self.font(for: environment)
+        }
         textField.onEdit = { textField in
             onChange(textField.stringValue)
         }
@@ -709,6 +763,58 @@ public final class AppKitBackend: AppBackend {
         textField.stringValue = content
     }
 
+    public func createTextEditor() -> Widget {
+        let textEditor = NSObservableTextView()
+        textEditor.drawsBackground = false
+        textEditor.delegate = textEditor
+        textEditor.allowsUndo = true
+        textEditor.textContainerInset = .zero
+        textEditor.textContainer?.lineFragmentPadding = 0
+        return textEditor
+    }
+
+    public func updateTextEditor(
+        _ textEditor: Widget,
+        environment: EnvironmentValues,
+        onChange: @escaping (String) -> Void
+    ) {
+        let textEditor = textEditor as! NSObservableTextView
+        textEditor.onEdit = { textView in
+            onChange(self.getContent(ofTextEditor: textView))
+        }
+        if textEditor.font != Self.font(for: environment) {
+            textEditor.font = Self.font(for: environment)
+        }
+        textEditor.appearance = environment.colorScheme.nsAppearance
+        textEditor.isEditable = environment.isEnabled
+
+        if #available(macOS 14, *) {
+            textEditor.contentType =
+                switch environment.textContentType {
+                    case .url:
+                        .URL
+                    case .phoneNumber:
+                        .telephoneNumber
+                    case .name:
+                        .name
+                    case .emailAddress:
+                        .emailAddress
+                    case .text, .digits(_), .decimal(_):
+                        nil
+                }
+        }
+    }
+
+    public func setContent(ofTextEditor textEditor: Widget, to content: String) {
+        let textEditor = textEditor as! NSObservableTextView
+        textEditor.string = content
+    }
+
+    public func getContent(ofTextEditor textEditor: Widget) -> String {
+        let textEditor = textEditor as! NSObservableTextView
+        return textEditor.string
+    }
+
     public func createScrollContainer(for child: Widget) -> Widget {
         let scrollView = NSScrollView()
 
@@ -1756,6 +1862,14 @@ class NSObservableTextField: NSTextField {
     }
 }
 
+class NSObservableTextView: NSTextView, NSTextViewDelegate {
+    func textDidChange(_ notification: Notification) {
+        onEdit?(self)
+    }
+
+    var onEdit: ((NSTextView) -> Void)?
+}
+
 // Source: https://gist.github.com/sindresorhus/3580ce9426fff8fafb1677341fca4815
 extension NSControl {
     typealias ActionClosure = ((NSControl) -> Void)
@@ -1870,7 +1984,8 @@ class NSSplitViewResizingDelegate: NSObject, NSSplitViewDelegate {
 }
 
 public class NSCustomWindow: NSWindow {
-    var resizeDelegate = ResizeDelegate()
+    var customDelegate = Delegate()
+    var persistentUndoManager = UndoManager()
 
     /// Allows the backing scale factor to be overridden. Useful for keeping
     /// UI tests consistent across devices.
@@ -1882,7 +1997,7 @@ public class NSCustomWindow: NSWindow {
         backingScaleFactorOverride ?? super.backingScaleFactor
     }
 
-    class ResizeDelegate: NSObject, NSWindowDelegate {
+    class Delegate: NSObject, NSWindowDelegate {
         var resizeHandler: ((SIMD2<Int>) -> Void)?
 
         func setHandler(_ resizeHandler: @escaping (SIMD2<Int>) -> Void) {
@@ -1907,6 +2022,10 @@ public class NSCustomWindow: NSWindow {
 
             return frameSize
         }
+
+        func windowWillReturnUndoManager(_ window: NSWindow) -> UndoManager? {
+            (window as! NSCustomWindow).persistentUndoManager
+        }
     }
 }
 

Sources/AppKitBackend/AppKitBackend.swift

@@ -241,6 +241,9 @@ open class Image: Widget {
     /// The symbolic size to display icons at.
     @GObjectProperty(named: "icon-size") public var iconSize: IconSize
 
+    /// The `GdkPaintable` to display.
+    @GObjectProperty(named: "paintable") public var paintable: OpaquePointer?
+
     /// The size in pixels to display icons at.
     ///
     /// If set to a value != -1, this property overrides the

Sources/Gtk/Generated/Image.swift

@@ -170,6 +170,9 @@ open class Picture: Widget {
     /// ratio.
     @GObjectProperty(named: "keep-aspect-ratio") public var keepAspectRatio: Bool
 
+    /// The `GdkPaintable` to be displayed by this `GtkPicture`.
+    @GObjectProperty(named: "paintable") public var paintable: OpaquePointer?
+
     public var notifyAlternativeText: ((Picture, OpaquePointer) -> Void)?
 
     public var notifyCanShrink: ((Picture, OpaquePointer) -> Void)?

Sources/Gtk/Generated/Picture.swift

@@ -17,6 +17,8 @@ public class Pango {
     /// acts as a suggested width. The text will attempt to take up less than or equal to the proposed
     /// width but if the text wrapping strategy doesn't allow the text to become as small as required
     /// than it may take up more the proposed width.
+    ///
+    /// Uses the `PANGO_WRAP_WORD_CHAR` text wrapping mode.
     public func getTextSize(
         _ text: String,
         proposedWidth: Double? = nil,