Struct TreeItem

pub struct TreeItem { /* private fields */ }

Available on crate feature dep_fltk only.

Defines a tree item

Implementations

impl TreeItem

pub unsafe fn from_raw(ptr: *mut Fl_Tree_Item) -> Option<TreeItem>

Create a TreeItem from a raw pointer

Safety

The pointer must be valid

pub fn new(tree: &Tree, label: &str) -> TreeItem

Creates a new TreeItem

pub fn draw_item_content<F>(&mut self, cb: F)

where F: FnMut(&mut TreeItem, bool) -> i32,

Overrides the draw_item_content method Example usage:

use fltk::{draw, enums::*, tree};
let mut tree = tree::Tree::default();
let mut item = tree::TreeItem::new(&tree, "Hello");
item.draw_item_content(|item, render| {
    // Our item's dimensions + text content
    let x = item.label_x();
    let y = item.label_y();
    let w = item.label_w();
    let h = item.label_h();
    let txt = if let Some(txt) = item.label() {
        txt
    } else {
        String::new()
    };
    if render {
        // Draw bg -- a filled rectangle
        draw::draw_rect_fill(x, y, w, h, item.label_bgcolor());
        // Draw label
        draw::set_font(Font::Helvetica, 14);
        draw::set_draw_color(Color::ForeGround); // use recommended fg color
        draw::draw_text2(&txt, x, y, w, h, Align::Left); // draw the item's label
    }
    // Rendered or not, we must calculate content's max X position
    let (lw, _) = draw::measure(&txt, true); // get width of label text
    return x + lw; // return X + label width
});
// Add our custom item to a path
let _third = tree.add_item("first/second/thrid", &item).unwrap();

pub fn set_user_data<T>(&mut self, data: T)

where T: Clone + 'static,

Set the internal data of the tree item

Warning

This method doesn’t store the type information of the passed data

pub unsafe fn user_data<T>(&self) -> Option<T>

where T: Clone + 'static,

Get the stored data in the tree item

Safety

Setting the user data doesn’t store type information, as such it’s on the developer to maintain the correct type

pub fn x(&self) -> i32

Gets the x position

pub fn y(&self) -> i32

Gets the y position

pub fn w(&self) -> i32

Gets the width

pub fn h(&self) -> i32

Gets the height

pub fn label_x(&self) -> i32

Gets the label’s x position

pub fn label_y(&self) -> i32

Gets the label’s y position

pub fn label_w(&self) -> i32

Gets the label’s width

pub fn label_h(&self) -> i32

Gets the label’s height

pub fn show_self(&self, indent: &str)

Shows the tree item

pub fn set_label(&mut self, val: &str)

Sets the label of the tree item

pub fn label(&self) -> Option<String>

Gets the label of the tree item

pub fn set_label_font(&mut self, val: Font)

Sets the label’s font

pub fn label_font(&self) -> Font

Gets the label’s font

pub fn set_label_size(&mut self, sz: i32)

Sets the label’s size

pub fn label_size(&self) -> i32

Gets the label’s size

pub fn set_label_fgcolor(&mut self, val: Color)

Sets the label’s foreground color

pub fn label_fgcolor(&self) -> Color

Gets the label’s foreground color

pub fn set_label_fg_color(&mut self, val: Color)

👎Deprecated since 1.2.19: please use set_label_fgcolor instead

Sets the label’s foreground color

pub fn label_fg_color(&self) -> Color

👎Deprecated since 1.2.19: please use label_fgcolor instead

Gets the label’s foreground color

pub fn set_label_color(&mut self, val: Color)

Sets the label’s color

pub fn label_color(&self) -> Color

Gets the label’s color

pub fn set_label_bgcolor(&mut self, val: Color)

Sets the label’s background color

pub fn label_bgcolor(&self) -> Color

Gets the label’s foreground color

pub fn set_widget<W>(&mut self, val: &W)

where W: WidgetExt,

Sets the item’s associated widget

pub fn widget(&self) -> Widget

👎Deprecated since 1.2.18: please use try_widget instead

Gets the item’s associated widget

pub fn try_widget(&self) -> Option<impl WidgetExt>

Gets the item’s associated widget

pub fn children(&self) -> i32

Gets the children count

pub fn child(&self, idx: i32) -> Option<TreeItem>

Gets the child item at idx position

pub fn has_children(&self) -> bool

Returns whether the item has children

pub fn find_child(&mut self, name: &str) -> Result<i32, FltkError>

Find a child using its name, returns index result

Errors

Errors on failure to find child

pub fn remove_child(&mut self, new_label: &str) -> Result<(), FltkError>

Remove child using its name

Errors

Errors on failure to remove child

pub fn clear_children(&mut self)

Remove all children

pub fn swap_children( &mut self, a: &TreeItem, b: &TreeItem, ) -> Result<(), FltkError>

Swap children a and b

Errors

Errors on failure to swap children

pub fn find_child_item(&self, name: &str) -> Option<TreeItem>

Find child by name, returns option of the item

pub fn replace(&mut self, new_item: &TreeItem) -> Option<TreeItem>

Replace a tree item

pub fn replace_child( &mut self, old_item: &TreeItem, new_item: &TreeItem, ) -> Option<TreeItem>

Replace a child

pub fn deparent(&mut self, index: i32) -> Option<TreeItem>

Deparent a child by index

pub fn reparent( &mut self, new_child: &TreeItem, index: i32, ) -> Result<(), FltkError>

Reparent a child by index

Errors

Errors on failure to move item

pub fn move_item(&mut self, to: i32, from: i32) -> Result<(), FltkError>

Move the item ‘from’ to sibling position of ‘to’.

Errors

Errors on failure to move item

pub fn move_above(&mut self, item: &TreeItem) -> Result<(), FltkError>

Move the current item above the specified item

Errors

Errors on failure to move item

pub fn move_below(&mut self, item: &TreeItem) -> Result<(), FltkError>

Move the current item below the specified item

Errors

Errors on failure to move item

pub fn move_into(&mut self, item: &TreeItem, pos: i32) -> Result<(), FltkError>

Parent the current item as a child of the specified item.

Errors

Errors on failure to move item

pub fn depth(&self) -> i32

Gets the depth of the item

pub fn prev(&self) -> Option<TreeItem>

Gets the previous item

pub fn next(&self) -> Option<TreeItem>

Gets the next item

pub fn next_sibling(&self) -> Option<TreeItem>

Gets the next sibling

pub fn prev_sibling(&self) -> Option<TreeItem>

Gets the previous sibling

pub fn update_prev_next(&mut self, index: i32)

Update surrounding siblings

pub fn parent(&self) -> Option<TreeItem>

Return the parent of the item

pub fn set_parent(&mut self, val: &TreeItem)

Set the parent of the item

pub fn tree(&self) -> Option<Tree>

Return the tree of the item

pub fn open(&mut self)

Open the item exposing all children

pub fn close(&mut self)

Close the item hiding all children

pub fn is_open(&self) -> bool

Returns whether an item is open

pub fn is_close(&self) -> bool

Returns whether an item is closed

pub fn open_toggle(&mut self)

Toggle the open state of the item

pub fn select(&mut self, index: i32)

Select an item at index

pub fn select_toggle(&mut self)

Toggle the select state of an item

pub fn select_all(&mut self) -> i32

Select all subitems, returns number of selected items

pub fn deselect(&mut self)

Deselect an item

pub fn deselect_all(&mut self) -> i32

Deselect all subitems

pub fn is_root(&self) -> bool

Returns whether an item is root

pub fn is_visible(&self) -> bool

Returns whether an item is visible

pub fn is_active(&self) -> bool

Returns whether an item is active

pub fn is_activated(&self) -> bool

Returns whether an item is activated

pub fn deactivate(&mut self)

Deactivate an item

pub fn activate(&mut self, val: bool)

Activate an item

pub fn is_selected(&self) -> bool

Returns whether an item is selected

pub fn was_deleted(&self) -> bool

Check if the tree item was deleted

pub fn user_icon(&self) -> Option<Box<dyn ImageExt>>

Gets the user icon

pub fn set_user_icon<Img>(&mut self, image: Option<Img>)

where Img: ImageExt,

Sets the user icon

pub fn as_ptr(&self) -> *mut Fl_Tree_Item

Return the internal pointer of the tree item

Trait Implementations

impl Clone for TreeItem

fn clone(&self) -> TreeItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TreeItem

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

Formats the value using the given formatter.

impl Iterator for TreeItem

fn next(&mut self) -> Option<<TreeItem as Iterator>::Item>

Gets the next item

type Item = TreeItem

The type of the elements being iterated over.

fn next_chunk<const N: usize>( &mut self, ) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>

where Self: Sized,

🔬This is a nightly-only experimental API. (iter_next_chunk)

Advances the iterator and returns an array containing the next N values.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator.

fn count(self) -> usize

where Self: Sized,

Consumes the iterator, counting the number of iterations and returning it.

fn last(self) -> Option<Self::Item>

where Self: Sized,

Consumes the iterator, returning the last element.

fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

🔬This is a nightly-only experimental API. (iter_advance_by)

Advances the iterator by n elements.

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator.

fn step_by(self, step: usize) -> StepBy<Self>

where Self: Sized,

Creates an iterator starting at the same point, but stepping by the given amount at each iteration.

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>

where Self: Sized, U: IntoIterator<Item = Self::Item>,

Takes two iterators and creates a new iterator over both in sequence.

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>

where Self: Sized, U: IntoIterator,

‘Zips up’ two iterators into a single iterator of pairs.

fn intersperse(self, separator: Self::Item) -> Intersperse<Self>

where Self: Sized, Self::Item: Clone,

🔬This is a nightly-only experimental API. (iter_intersperse)

Creates a new iterator which places a copy of separator between adjacent items of the original iterator.

fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>

where Self: Sized, G: FnMut() -> Self::Item,

🔬This is a nightly-only experimental API. (iter_intersperse)

Creates a new iterator which places an item generated by separator between adjacent items of the original iterator.

fn map<B, F>(self, f: F) -> Map<Self, F>

where Self: Sized, F: FnMut(Self::Item) -> B,

Takes a closure and creates an iterator which calls that closure on each element.

fn for_each<F>(self, f: F)

where Self: Sized, F: FnMut(Self::Item),

Calls a closure on each element of an iterator.

fn filter<P>(self, predicate: P) -> Filter<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator which uses a closure to determine if an element should be yielded.

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>

where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both filters and maps.

fn enumerate(self) -> Enumerate<Self>

where Self: Sized,

Creates an iterator which gives the current iteration count as well as the next value.

fn peekable(self) -> Peekable<Self>

where Self: Sized,

Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See their documentation for more information.

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that skips elements based on a predicate.

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that yields elements based on a predicate.

fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>

where Self: Sized, P: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both yields elements based on a predicate and maps.

fn skip(self, n: usize) -> Skip<Self>

where Self: Sized,

Creates an iterator that skips the first n elements.

fn take(self, n: usize) -> Take<Self>

where Self: Sized,

Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner.

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>

where Self: Sized, F: FnMut(&mut St, Self::Item) -> Option<B>,

An iterator adapter which, like fold, holds internal state, but unlike fold, produces a new iterator.

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>

where Self: Sized, U: IntoIterator, F: FnMut(Self::Item) -> U,

Creates an iterator that works like map, but flattens nested structure.

fn flatten(self) -> Flatten<Self>

where Self: Sized, Self::Item: IntoIterator,

Creates an iterator that flattens nested structure.

fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>

where Self: Sized, F: FnMut(&[Self::Item; N]) -> R,

🔬This is a nightly-only experimental API. (iter_map_windows)

Calls the given function f for each contiguous window of size N over self and returns an iterator over the outputs of f. Like slice::windows(), the windows during mapping overlap as well.

fn fuse(self) -> Fuse<Self>

where Self: Sized,

Creates an iterator which ends after the first None.

fn inspect<F>(self, f: F) -> Inspect<Self, F>

where Self: Sized, F: FnMut(&Self::Item),

Does something with each element of an iterator, passing the value on.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Borrows an iterator, rather than consuming it.

fn collect<B>(self) -> B

where B: FromIterator<Self::Item>, Self: Sized,

Transforms an iterator into a collection.

fn try_collect<B>( &mut self, ) -> <<Self::Item as Try>::Residual as Residual<B>>::TryType

where Self: Sized, Self::Item: Try, <Self::Item as Try>::Residual: Residual<B>, B: FromIterator<<Self::Item as Try>::Output>,

🔬This is a nightly-only experimental API. (iterator_try_collect)

Fallibly transforms an iterator into a collection, short circuiting if a failure is encountered.

fn collect_into<E>(self, collection: &mut E) -> &mut E

where E: Extend<Self::Item>, Self: Sized,

🔬This is a nightly-only experimental API. (iter_collect_into)

Collects all the items from an iterator into a collection.

fn partition<B, F>(self, f: F) -> (B, B)

where Self: Sized, B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool,

Consumes an iterator, creating two collections from it.

fn partition_in_place<'a, T, P>(self, predicate: P) -> usize

where T: 'a, Self: Sized + DoubleEndedIterator<Item = &'a mut T>, P: FnMut(&T) -> bool,

🔬This is a nightly-only experimental API. (iter_partition_in_place)

Reorders the elements of this iterator in-place according to the given predicate, such that all those that return true precede all those that return false. Returns the number of true elements found.

fn is_partitioned<P>(self, predicate: P) -> bool

where Self: Sized, P: FnMut(Self::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_is_partitioned)

Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return true precede all those that return false.

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R

where Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Output = B>,

An iterator method that applies a function as long as it returns successfully, producing a single, final value.

fn try_for_each<F, R>(&mut self, f: F) -> R

where Self: Sized, F: FnMut(Self::Item) -> R, R: Try<Output = ()>,

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error.

fn fold<B, F>(self, init: B, f: F) -> B

where Self: Sized, F: FnMut(B, Self::Item) -> B,

Folds every element into an accumulator by applying an operation, returning the final result.

fn reduce<F>(self, f: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(Self::Item, Self::Item) -> Self::Item,

Reduces the elements to a single one, by repeatedly applying a reducing operation.

fn try_reduce<R>( &mut self, f: impl FnMut(Self::Item, Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryType

where Self: Sized, R: Try<Output = Self::Item>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (iterator_try_reduce)

Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately.

fn all<F>(&mut self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if every element of the iterator matches a predicate.

fn any<F>(&mut self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if any element of the iterator matches a predicate.

fn find<P>(&mut self, predicate: P) -> Option<Self::Item>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator that satisfies a predicate.

fn find_map<B, F>(&mut self, f: F) -> Option<B>

where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Applies function to the elements of iterator and returns the first non-none result.

fn try_find<R>( &mut self, f: impl FnMut(&Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType

where Self: Sized, R: Try<Output = bool>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (try_find)

Applies function to the elements of iterator and returns the first true result or the first error.

fn position<P>(&mut self, predicate: P) -> Option<usize>

where Self: Sized, P: FnMut(Self::Item) -> bool,

Searches for an element in an iterator, returning its index.

fn rposition<P>(&mut self, predicate: P) -> Option<usize>

where P: FnMut(Self::Item) -> bool, Self: Sized + ExactSizeIterator + DoubleEndedIterator,

Searches for an element in an iterator from the right, returning its index.

fn max(self) -> Option<Self::Item>

where Self: Sized, Self::Item: Ord,

Returns the maximum element of an iterator.

fn min(self) -> Option<Self::Item>

where Self: Sized, Self::Item: Ord,

Returns the minimum element of an iterator.

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>

where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the maximum value from the specified function.

fn max_by<F>(self, compare: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the maximum value with respect to the specified comparison function.

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>

where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the minimum value from the specified function.

fn min_by<F>(self, compare: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the minimum value with respect to the specified comparison function.

fn rev(self) -> Rev<Self>

where Self: Sized + DoubleEndedIterator,

Reverses an iterator’s direction.

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)

where FromA: Default + Extend<A>, FromB: Default + Extend<B>, Self: Sized + Iterator<Item = (A, B)>,

Converts an iterator of pairs into a pair of containers.

fn copied<'a, T>(self) -> Copied<Self>

where T: 'a + Copy, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which copies all of its elements.

fn cloned<'a, T>(self) -> Cloned<Self>

where T: 'a + Clone, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which clones all of its elements.

fn cycle(self) -> Cycle<Self>

where Self: Sized + Clone,

Repeats an iterator endlessly.

fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>

where Self: Sized,

🔬This is a nightly-only experimental API. (iter_array_chunks)

Returns an iterator over N elements of the iterator at a time.

fn sum<S>(self) -> S

where Self: Sized, S: Sum<Self::Item>,

Sums the elements of an iterator.

fn product<P>(self) -> P

where Self: Sized, P: Product<Self::Item>,

Iterates over the entire iterator, multiplying all the elements

fn cmp<I>(self, other: I) -> Ordering

where I: IntoIterator<Item = Self::Item>, Self::Item: Ord, Self: Sized,

Lexicographically compares the elements of this Iterator with those of another.

fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,

🔬This is a nightly-only experimental API. (iter_order_by)

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function.

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

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Lexicographically compares the PartialOrd elements of this Iterator with those of another. The comparison works like short-circuit evaluation, returning a result without comparing the remaining elements. As soon as an order can be determined, the evaluation stops and a result is returned.

fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,

🔬This is a nightly-only experimental API. (iter_order_by)

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function.

fn eq<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are equal to those of another.

fn eq_by<I, F>(self, other: I, eq: F) -> bool

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_order_by)

Determines if the elements of this Iterator are equal to those of another with respect to the specified equality function.

fn ne<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are not equal to those of another.

fn lt<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less than those of another.

fn le<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less or equal to those of another.

fn gt<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than those of another.

fn ge<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another.

fn is_sorted(self) -> bool

where Self: Sized, Self::Item: PartialOrd,

Checks if the elements of this iterator are sorted.

fn is_sorted_by<F>(self, compare: F) -> bool

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> bool,

Checks if the elements of this iterator are sorted using the given comparator function.

fn is_sorted_by_key<F, K>(self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> K, K: PartialOrd,

Checks if the elements of this iterator are sorted using the given key extraction function.

impl PartialEq for TreeItem

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TreeItem

impl Send for TreeItem

impl Sync for TreeItem