config: make the proxy icon documentation more detailed

This commit is contained in:
Mitchell Hashimoto
2024-10-24 20:56:33 -07:00
parent e11fb62627
commit 495925355a
2 changed files with 17 additions and 6 deletions

View File

@ -229,15 +229,15 @@ extension Ghostty {
return String(cString: ptr)
}
var macosTitlebarProxyIcon: Ghostty.MacOSTitlebarProxyIcon {
let defaultValue = Ghostty.MacOSTitlebarProxyIcon.visible
var macosTitlebarProxyIcon: MacOSTitlebarProxyIcon {
let defaultValue = MacOSTitlebarProxyIcon.visible
guard let config = self.config else { return defaultValue }
var v: UnsafePointer<Int8>? = nil
let key = "macos-titlebar-proxy-icon"
guard ghostty_config_get(config, &v, key, UInt(key.count)) else { return defaultValue }
guard let ptr = v else { return defaultValue }
let str = String(cString: ptr)
return Ghostty.MacOSTitlebarProxyIcon(rawValue: str) ?? defaultValue
return MacOSTitlebarProxyIcon(rawValue: str) ?? defaultValue
}
var macosWindowShadow: Bool {

View File

@ -1444,9 +1444,20 @@ keybind: Keybinds = .{},
/// Changing this option at runtime only applies to new windows.
@"macos-titlebar-style": MacTitlebarStyle = .transparent,
/// State of the proxy icon for the macOS titlebar.
/// The "hidden" style hides the proxy icon.
/// The default value is "visible".
/// Whether the proxy icon in the macOS titlebar is visible. The proxy icon
/// is the icon that represents the folder of the current working directory.
/// You can see this very clearly in the macOS built-in Terminal.app
/// titlebar.
///
/// The proxy icon is only visible with the native macOS titlebar style.
///
/// The default value is `visible`.
///
/// This setting can be changed at runtime and will affect all currently
/// open windows but only after their working directory changes again.
/// Therefore, to make this work after changing the setting, you must
/// usually `cd` to a different directory, open a different file in an
/// editor, etc.
@"macos-titlebar-proxy-icon": MacTitlebarProxyIcon = .visible,
/// If `true`, the *Option* key will be treated as *Alt*. This makes terminal