Gjsify LogoGjsify Logo

Hierarchy

  • TreePath

Index

Constructors

Properties

name: string

Methods

  • appendIndex(index: number): void
  • Appends a new index to a path.

    As a result, the depth of the path is increased.

    Parameters

    • index: number

      the index

    Returns void

  • Compares two paths.

    If a appears before b in a tree, then -1 is returned. If b appears before a, then 1 is returned. If the two nodes are equal, then 0 is returned.

    Parameters

    Returns number

  • down(): void
  • Moves path to point to the first child of the current path.

    Returns void

  • free(): void
  • getDepth(): number
  • getIndices(): number[]
  • Returns the current indices of path.

    This is an array of integers, each representing a node in a tree. It also returns the number of elements in the array. The array should not be freed.

    Returns number[]

  • Returns %TRUE if descendant is a descendant of path.

    Parameters

    Returns boolean

  • Returns %TRUE if path is a descendant of ancestor.

    Parameters

    Returns boolean

  • next(): void
  • Moves the path to point to the next node at the current depth.

    Returns void

  • prependIndex(index: number): void
  • Prepends a new index to a path.

    As a result, the depth of the path is increased.

    Parameters

    • index: number

      the index

    Returns void

  • prev(): boolean
  • Moves the path to point to the previous node at the current depth, if it exists.

    Returns boolean

  • toString(): string
  • Generates a string representation of the path.

    This string is a “:” separated list of numbers. For example, “4:10:0:3” would be an acceptable return value for this string.

    Returns string

  • up(): boolean
  • Moves the path to point to its parent node, if it has a parent.

    Returns boolean

  • Creates a new path with the given indices array of length.

    Parameters

    • indices: number[]

      array of indices

    Returns Gtk.TreePath

  • Creates a new #GtkTreePath-struct initialized to path.

    path is expected to be a colon separated list of numbers. For example, the string “10:4:0” would create a path of depth 3 pointing to the 11th child of the root node, the 5th child of that 11th child, and the 1st child of that 5th child. If an invalid path string is passed in, %NULL is returned.

    Parameters

    • path: string

      The string representation of a path

    Returns Gtk.TreePath

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method