Package org.gnome.gtk

Class TreePath

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gtk.TreePath

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
@Deprecated
public class TreePath
extends ProxyInstance

Deprecated.

An opaque structure representing a path to a row in a model.

Constructor Summary

Constructors

Constructor	Description
TreePath()	Deprecated.
TreePath(MemorySegment address)	Deprecated. Create a TreePath proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	appendIndex(int index)	Deprecated.
int	compare(TreePath b)	Deprecated.
TreePath	copy()	Deprecated.
void	down()	Deprecated.
static TreePath	first()	Deprecated.
void	free()	Deprecated.
static TreePath	fromIndices(@org.jspecify.annotations.Nullable int @Nullable [] indices)	Deprecated.
static TreePath	fromString(String path)	Deprecated.
int	getDepth()	Deprecated.
@org.jspecify.annotations.Nullable int @Nullable []	getIndices()	Deprecated.
static @Nullable Type	getType()	Deprecated. Get the GType of the TreePath class
boolean	isAncestor(TreePath descendant)	Deprecated.
boolean	isDescendant(TreePath ancestor)	Deprecated.
void	next()	Deprecated.
void	prependIndex(int index)	Deprecated.
boolean	prev()	Deprecated.
@Nullable String	toString()	Deprecated.
boolean	up()	Deprecated.

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

TreePath

public TreePath(MemorySegment address)

Deprecated.

Create a TreePath proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

TreePath

@Deprecated
public TreePath()

Deprecated.

Creates a new GtkTreePath This refers to a row.

Method Details

getType

public static @Nullable Type getType()

Deprecated.

Get the GType of the TreePath class

Returns:

the GType

first

@Deprecated
public static TreePath first()

Deprecated.

Creates a new GtkTreePath.

The string representation of this path is “0”.

Returns:

A new GtkTreePath

fromIndices

@Deprecated
public static TreePath fromIndices(@org.jspecify.annotations.Nullable int @Nullable [] indices)

Deprecated.

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

Parameters:

indices - array of indices

Returns:

A newly created GtkTreePath

fromString

@Deprecated
public static TreePath fromString(String path)

Deprecated.

Creates a new GtkTreePath 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 - The string representation of a path

Returns:

A newly-created GtkTreePath

appendIndex

@Deprecated
public void appendIndex(int index)

Deprecated.

Appends a new index to a path.

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

Parameters:

index - the index

compare

@Deprecated
public int compare(TreePath b)

Deprecated.

Compares two paths.

If this TreePath 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:

b - a GtkTreePath to compare with

Returns:

the relative positions of this TreePath and b

copy

@Deprecated
public TreePath copy()

Deprecated.

Creates a new GtkTreePath as a copy of path.

Returns:

a new GtkTreePath

down

@Deprecated
public void down()

Deprecated.

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

free

@Deprecated
public void free()

Deprecated.

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

getDepth

@Deprecated
public int getDepth()

Deprecated.

Returns the current depth of path.

Returns:

The depth of this TreePath

getIndices

@Deprecated
public @org.jspecify.annotations.Nullable int @Nullable [] getIndices()

Deprecated.

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:

The current indices

isAncestor

@Deprecated
public boolean isAncestor(TreePath descendant)

Deprecated.

Returns true if descendant is a descendant of path.

Parameters:

descendant - another GtkTreePath

Returns:

true if descendant is contained inside this TreePath

isDescendant

@Deprecated
public boolean isDescendant(TreePath ancestor)

Deprecated.

Returns true if this TreePath is a descendant of ancestor.

Parameters:

ancestor - another GtkTreePath

Returns:

true if ancestor contains this TreePath somewhere below it

next

@Deprecated
public void next()

Deprecated.

Moves the this TreePath to point to the next node at the current depth.

prependIndex

@Deprecated
public void prependIndex(int index)

Deprecated.

Prepends a new index to a path.

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

Parameters:

index - the index

prev

@Deprecated
public boolean prev()

Deprecated.

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

Returns:

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

toString

@Deprecated
public @Nullable String toString()

Deprecated.

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.

Overrides:

toString in class Object

Returns:

A newly-allocated string

up

@Deprecated
public boolean up()

Deprecated.

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

Returns:

true if this TreePath has a parent, and the move was made