Gtk-4.0 ▶ Gtk ▶ TreePathDeprecated 4.10

Deprecatedconstructor

• new TreePath(properties?: Partial<{}>): Gtk.TreePath

  Parameters

  • OptionalDeprecatedproperties: Partial<{}>

  Returns Gtk.TreePath

StaticDeprecated$gtype

Deprecatedappend_index

• append_index(index_: number): void

  Appends a new index to a path.

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

  Parameters

  • Deprecatedindex_: number

    the index

  Returns void

Deprecatedcompare

• compare(b: Gtk.TreePath): number

  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

  • Deprecatedb: Gtk.TreePath

    a Gtk.TreePath to compare with

  Returns number

  the relative positions of a and b

Deprecatedcopy

• copy(): Gtk.TreePath

  Creates a new Gtk.TreePath as a copy of path.

  Returns Gtk.TreePath

  a new Gtk.TreePath

Deprecateddown

• down(): void

  Moves path to point to the first child of the current path.

  Returns void

Deprecatedfree

• free(): void

  Frees path. If path is null, it simply returns.

  Returns void

Deprecatedget_depth

• get_depth(): number

  Returns the current depth of path.

  Returns number

  The depth of path

Deprecatedget_indices

• get_indices(): 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[]

  The current indices

Deprecatedis_ancestor

• is_ancestor(descendant: Gtk.TreePath): boolean

  Returns true if descendant is a descendant of path.

  Parameters

  • Deprecateddescendant: Gtk.TreePath

    another Gtk.TreePath

  Returns boolean

  true if descendant is contained inside path

Deprecatedis_descendant

• is_descendant(ancestor: Gtk.TreePath): boolean

  Returns true if path is a descendant of ancestor.

  Parameters

  • Deprecatedancestor: Gtk.TreePath

    another Gtk.TreePath

  Returns boolean

  true if ancestor contains path somewhere below it

Deprecatednext

• next(): void

  Moves the path to point to the next node at the current depth.

  Returns void

Deprecatedprepend_index

• prepend_index(index_: number): void

  Prepends a new index to a path.

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

  Parameters

  • Deprecatedindex_: number

    the index

  Returns void

Deprecatedprev

• prev(): boolean

  Moves the path to point to the previous node at the current depth, if it exists.

  Returns boolean

  true if path has a previous node, and the move was made

Deprecatedto_string

• to_string(): 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. If the path has depth 0, null is returned.

  Returns string

  A newly-allocated string

Deprecatedup

• up(): boolean

  Moves the path to point to its parent node, if it has a parent.

  Returns boolean

  true if path has a parent, and the move was made

StaticDeprecatednew

• new(): Gtk.TreePath

  Returns Gtk.TreePath

StaticDeprecatednew_first

• new_first(): Gtk.TreePath

  Returns Gtk.TreePath

StaticDeprecatednew_from_indices

• new_from_indices(indices: number[]): Gtk.TreePath

  Parameters

  • Deprecatedindices: number[]

  Returns Gtk.TreePath

StaticDeprecatednew_from_string

• new_from_string(path: string): Gtk.TreePath

  Parameters

  • Deprecatedpath: string

  Returns Gtk.TreePath