Interface IToolbarItems

Interface describing a toolbar item list

Hierarchy

Properties

A signal emitted when the list has changed.

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

length: number

The length of the list.

Notes

This is a read-only property.

type: "List"

The type of this object.

Methods

  • 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

  • Insert a set of items into the list at the specified index.

    Parameters

    Returns void

  • Move a value from one index to another.

    Parameters

    • fromIndex: number

      The index of the element to move.

    • toIndex: number

      The index to move the element to.

      Complexity

      Constant.

      Iterator Validity

      Iterators pointing at the lesser of the fromIndex and the toIndex and beyond are invalidated.

      Undefined Behavior

      A fromIndex or a toIndex which is non-integral.

    Returns void

  • Remove a range of items from the list.

    Parameters

    • startIndex: number

      The start index of the range to remove (inclusive).

    • endIndex: number

      The end index of the range to remove (exclusive).

    Returns number

    The new length of the list.

    Complexity

    Linear.

    Iterator Validity

    Iterators pointing to the first removed value and beyond are invalid.

    Undefined Behavior

    A startIndex or endIndex which is non-integral.

  • Remove the first occurrence of a value from the list.

    Parameters

    Returns number

    The index of the removed value, or -1 if the value is not contained in the list.

    Complexity

    Linear.

    Iterator Validity

    Iterators pointing at the removed value and beyond are invalidated.

Generated using TypeDoc