Struct gtk::TreePath

#[repr(transparent)]
pub struct TreePath { /* private fields */ }

Implementations

impl TreePath

pub fn new() -> TreePath

Creates a new TreePath-struct. This refers to a row.

Returns

A newly created TreePath-struct.

pub fn new_first() -> TreePath

Creates a new TreePath-struct.

The string representation of this path is “0”.

Returns

A new TreePath-struct

pub fn from_indicesv(indices: &[i32]) -> TreePath

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

indices

array of indices

Returns

A newly created TreePath-struct

pub fn from_string(path: &str) -> TreePath

Creates a new TreePath-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, None is returned.

path

The string representation of a path

Returns

A newly-created TreePath-struct, or None

pub fn append_index(&mut self, index_: i32)

Appends a new index to a path.

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

index_

the index

pub fn down(&mut self)

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

pub fn depth(&self) -> i32

Returns the current depth of self.

Returns

The depth of self

pub fn indices_with_depth(&mut self) -> Vec<i32>

Returns the current indices of self.

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, or None

pub fn is_ancestor(&self, descendant: &TreePath) -> bool

Returns true if descendant is a descendant of self.

descendant

another TreePath-struct

Returns

true if descendant is contained inside self

pub fn is_descendant(&self, ancestor: &TreePath) -> bool

Returns true if self is a descendant of ancestor.

ancestor

another TreePath-struct

Returns

true if ancestor contains self somewhere below it

pub fn next(&mut self)

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

pub fn prepend_index(&mut self, index_: i32)

Prepends a new index to a path.

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

index_

the index

pub fn prev(&mut self) -> bool

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

Returns

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

pub fn to_str(&self) -> GString

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

A newly-allocated string. Must be freed with g_free().

pub fn up(&mut self) -> bool

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

Returns

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

impl TreePath

pub fn indices(&self) -> Vec<i32>

Returns the current indices of self.

This is an array of integers, each representing a node in a tree. This value should not be freed.

The length of the array can be obtained with depth().

Returns

The current indices, or None

Trait Implementations

impl Clone for TreePath

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TreePath

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TreePath

fn default() -> Self

Returns the “default value” for a type.

impl Display for TreePath

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for TreePath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for TreePath

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<TreePath> for TreePath

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<TreePath> for TreePath

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for TreePath

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TreePath