Struct UiKeyboardEnhancement 

pub struct UiKeyboardEnhancement;

Whether to request the terminal’s keyboard-enhancement protocol (the “kitty protocol”) when the terminal reports support for it.

true (default) – push DISAMBIGUATE_ESCAPE_CODES when supports_keyboard_enhancement() says yes. This is what makes <S-CR>, <C-CR> and <M-S-CR> distinguishable from a bare <CR>; without it every terminal sends the same \r for all four, so those chords are unreachable however they are bound. lattice-protocol has always spelled them and the GPUI peer has always delivered them – this closes a renderer asymmetry rather than adding a capability.

false – never push it. Set this if a terminal answers the support probe wrongly and keys start arriving mangled; recovering from that should not need a rebuild.

TUI-only. The GPUI peer gets these chords from the windowing system and ignores this option.

Implementations

impl UiKeyboardEnhancement

pub fn build_spec() -> Option<bool>

Build the runtime spec for this declaration. Used by the registry’s self-registration boot path; not generally called by hand. Direct construction of Option<T> is the macro’s internal-only path – consumer code uses config.get_typed::<#name_ident>() to read and config.set_typed::<#name_ident>(...) to write.

Trait Implementations

impl HasGroup for UiKeyboardEnhancement

const GROUP_NAME: &'static str = <lattice_config::Appearance as ::lattice_config::OptionGroup>::NAME

Group display name ("editor", "lsp", …). The macro pulls this from the group = SomeGroup; directive at the declaration block’s head.

impl OptionDecl for UiKeyboardEnhancement

const NAME: &'static str = UiKeyboardEnhancement

Public display name. Boundary-facing only – :set <NAME>=…, TOML keys, completion candidates, :describe-option. Internal access is type-driven. The macro derives this from the option’s identifier (with namespace prefix when declared via mode_options!); manually-typed NAMEs are not supported for built-in options.

const DOC: &'static str = UiKeyboardEnhancement

Doc string. Shown in :describe-option, the :customize form’s per-row help, and :apropos results.

const CUSTOMIZABLE: bool = true

Customize-visibility flag. true (the default) ⇒ option appears in :set autocomplete + the :customize group view. false ⇒ plugin / engine-internal state, hidden from user surfaces. Equivalent of emacs’s defvar vs defcustom. (See mode-architecture.md §6.5.3.)

type Value = bool

The runtime value type. bool, i64, String, plus any domain enum that impls OptionType.

fn default_value() -> Self::Value

Default value. Returned by a function (rather than a const) so non-const-constructible types like String can be defaults.

fn type_id() -> TypeId

where Self: Sized,

TypeId of the declaration type itself. Hot-path key for the registry’s type-driven storage. Default impl works for every concrete impl.