Interface IFileMenu

An interface for a File menu.

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

Hierarchy (View Summary)

Implemented by

Properties

closeAndCleaners consoleCreators isDisposed items newMenu quitEntry rank?

Methods

addGroup addItem dispose

Properties

ReadonlycloseAndCleaners

closeAndCleaners: SemanticCommand

The close and cleanup semantic command.

ReadonlyconsoleCreators

consoleCreators: SemanticCommand

The console creator semantic command.

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.

ReadonlynewMenu

newMenu: IRankedMenu

A submenu for creating new files/launching new activities.

quitEntry

quitEntry: boolean

Option to add a Quit entry in the File 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