Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: MultiSorterMeta

[139:14] static extends: object

Generated metadata helpers for MultiSorter class surfaces.

Methods

  • properties ()

    Returns property metadata for MultiSorter.

    • @r A list.

class: MultiSorter

[13:7] extends: object

Combines multiple sorters by trying them in turn. If the first sorter compares two items as equal, the second is tried next, and so on.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • MultiSorter ()

    Creates a new multi sorter. This sorter compares items by trying each of the sorters in turn, until one returns non-zero. In particular, if no sorter has been added to it, it will always compare items as equal.

  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.
  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.
  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.
  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.
  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.
  • asSorter ()

    Wraps this handle as Sorter.

    • @r A Sorter object.
  • asListModel ()

    Wraps this handle as ListModel.

    • @r A ListModel object.
  • asBuildable ()

    Wraps this handle as Buildable.

    • @r A Buildable object.
  • append (object sorter)

    Add @sorter to @self to use for sorting at the end. @self will consult all existing sorters before it will sort with the given @sorter.

    • @p sorter is a sorter to add.
    • @r None.
  • remove (int position)

    Removes the sorter at the given @position from the list of sorter used by

    • @self. If @position is larger than the number of sorters, nothing happens.
    • @p position is position of sorter to remove.
    • @r None.