Interface IHelpMenu

An interface for a Help menu.

interface IHelpMenu {
    getKernel: SemanticCommand;
    isDisposed: boolean;
    items: readonly IItem[];
    rank?: number;
    addGroup(items: IItemOptions[], rank?: number): IDisposable;
    addItem(options: IRankedMenu.IItemOptions): IDisposable;
    dispose(): void;
}

Hierarchy (View Summary)

Implemented by

Properties

getKernel isDisposed items rank?

Methods

addGroup addItem dispose

Properties

ReadonlygetKernel

getKernel: SemanticCommand

A semantic command to get the kernel for the help menu. This is used to populate additional help links provided by the kernel of a widget.

Note

The command must return a Kernel.IKernelConnection object

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonlyitems

items: readonly IItem[]

A read-only array of the menu items in the menu.

Optional Readonlyrank

rank?: number

Menu rank

Methods

addGroup

  • addGroup(items: IItemOptions[], rank?: number): IDisposable

  • Add a group of menu items specific to a particular plugin.

    The rank can be set for all items in the group using the function argument or per item.

    Parameters

    • items: IItemOptions[]

      the list of menu items to add.

    • Optionalrank: number

      the default rank in the menu in which to insert the group.

    Returns IDisposable

    Disposable of the group

addItem

dispose

  • dispose(): void

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods