foo-webview-sdk
    Preparing search index...

    Interface MenuTreeNode

    A separator, submenu with children, or command with state and address fields.

    interface MenuTreeNode {
        addressCandidates?: MenuAddressCandidate[];
        availability?: MenuAvailability;
        available?: boolean;
        checked?: boolean;
        children?: MenuTreeNode[];
        commandId?: number;
        displayLabel?: string;
        displayPath?: string;
        enabled?: boolean;
        executable?: boolean;
        fallback?: boolean;
        flags?: number;
        guid?: string;
        hidden?: boolean;
        label?: string;
        path?: string;
        radioChecked?: boolean;
        source?:
            | "mainmenu_static"
            | "mainmenu_dynamic"
            | "contextmenu_static"
            | "contextmenu_dynamic"
            | "hmenu_fallback";
        subGuid?: string;
        type: "command"
        | "separator"
        | "submenu";
        unaddressableReason?:
            | "dynamicParent"
            | "noStableIdentifier"
            | "ambiguousMatch"
            | "missingDynamicIdentifier"
            | "incompleteHierarchy";
    }
    Index
    addressCandidates?: MenuAddressCandidate[]

    Diagnostic candidates for an ambiguous main-menu node; never select the first automatically.

    availability?: MenuAvailability

    Command counts below this submenu; only with withAvailability, and not on submenus nested inside the Win32 menus.

    available?: boolean

    The same as enabled; only on a command.

    checked?: boolean

    Whether the command shows a check mark (a radio mark counts too); only on a command.

    children?: MenuTreeNode[]

    The children, in menu order; only on a submenu.

    commandId?: number

    Menu item id. For a context-menu command, menu.runContextCommandById runs it. The id is valid only for the menu it came from, so do not store it. Absent on the flat list.

    displayLabel?: string

    label translated for locale; the same as label when translation is off or has no entry for it.

    displayPath?: string

    path made of display labels.

    enabled?: boolean

    Whether the command can run; only on a command.

    executable?: boolean

    For main menus, whether the command has a unique complete execution address, independently of enabled. For context menus, whether a command GUID is present.

    fallback?: boolean

    true on a command of the flat list.

    flags?: number

    Raw display flags. Their bits depend on where the node came from: SDK menu flags from the menu tree and the flat list, Win32 menu state from the Win32 menus. Absent on a submenu of the Win32 menus.

    guid?: string

    Command GUID, the stable address to pass to menu.runMainMenuCommand or menu.runContextCommand; absent when it could not be resolved.

    hidden?: boolean

    Whether the host would not draw the command; only on a command.

    label?: string

    Label as the host reports it (localized on a translated build).

    path?: string

    Slash-separated labels from the top of the menu.

    radioChecked?: boolean

    Whether the check mark is a radio mark; only on a command.

    source?:
        | "mainmenu_static"
        | "mainmenu_dynamic"
        | "contextmenu_static"
        | "contextmenu_dynamic"
        | "hmenu_fallback"

    Main-menu sources reflect the provider's node kind, even when a dynamic leaf has no usable subGuid. Context-menu sources use subGuid presence. Win32 menu commands use hmenu_fallback.

    subGuid?: string

    GUID of a dynamic child command, passed together with guid.

    type: "command" | "separator" | "submenu"

    Node kind.

    unaddressableReason?:
        | "dynamicParent"
        | "noStableIdentifier"
        | "ambiguousMatch"
        | "missingDynamicIdentifier"
        | "incompleteHierarchy"

    Why the command cannot be run; present when executable is false.