Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SettingRegistry

A namespace for SettingRegistry statics.

Index

Interfaces

Functions

Functions

filterDisabledItems

  • filterDisabledItems<T>(items: T[]): T[]

  • Remove disabled entries from menu items

    Type parameters

    Parameters

    • items: T[]

      Menu items

    Returns T[]

    Filtered menu items

reconcileItems

  • reconcileItems<T>(reference?: T[], addition?: T[], warn?: boolean, addNewItems?: boolean): T[] | undefined

  • Merge two set of menu items.

    Type parameters

    Parameters

    • Optional reference: T[]

      Reference set of menu items

    • Optional addition: T[]

      New items to add

    • Optional warn: boolean

      Whether to warn if item is duplicated; default to false

    • Optional addNewItems: boolean

    Returns T[] | undefined

    The merged set of items

reconcileMenus

  • reconcileMenus(reference: IMenu[] | null, addition: IMenu[] | null, warn?: boolean, addNewItems?: boolean): IMenu[]

  • Reconcile the menus.

    Parameters

    • reference: IMenu[] | null

      The reference list of menus.

    • addition: IMenu[] | null

      The list of menus to add.

    • Optional warn: boolean

      Warn if the command items are duplicated within the same menu.

    • Optional addNewItems: boolean

    Returns IMenu[]

    The reconciled list of menus.

reconcileShortcuts

  • Reconcile default and user shortcuts and return the composite list.

    Parameters

    • defaults: IShortcut[]

      The list of default shortcuts.

    • user: IShortcut[]

      The list of user shortcut overrides and additions.

    Returns IShortcut[]

    A loadable list of shortcuts (omitting disabled and overridden).

reconcileToolbarItems

  • Merge two set of toolbar items.

    Parameters

    • Optional reference: IToolbarItem[]

      Reference set of toolbar items

    • Optional addition: IToolbarItem[]

      New items to add

    • Optional warn: boolean

      Whether to warn if item is duplicated; default to false

    Returns IToolbarItem[] | undefined

    The merged set of items

Generated using TypeDoc