Struct Tree

pub struct Tree { /* private fields */ }

Available on crate feature dep_fltk only.

Defines a tree widget

Implementations

impl Tree

pub unsafe fn from_raw(ptr: *mut Fl_Tree) -> Option<Tree>

Creates a Tree from a raw Fl_Tree pointer

Safety

The pointer must be valid

pub fn begin(&self)

Begins the Tree widget

pub fn end(&self)

Ends the Tree widget

pub fn show_self(&mut self)

Shows the Tree widget

pub fn set_root_label(&mut self, new_label: &str)

Sets the root label

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

Gets the Tree’s root

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

Sets the Tree’s root

pub fn add(&mut self, path: &str) -> Option<TreeItem>

Adds a TreeItem

pub fn add_item(&mut self, path: &str, item: &TreeItem) -> Option<TreeItem>

Adds a TreeItem

pub fn insert_above(&mut self, above: &TreeItem, name: &str) -> Option<TreeItem>

Inserts a TreeItem above another tree item

pub fn insert( &mut self, item: &TreeItem, name: &str, pos: i32, ) -> Option<TreeItem>

Inserts a TreeItem at a position pos

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

Removes a TreeItem

Errors

Errors on failure to remove item

pub fn clear(&mut self)

Clears a tree

pub fn clear_children(&mut self, item: &TreeItem)

Clears all children

pub fn find_item(&self, path: &str) -> Option<TreeItem>

Finds a tree item

pub fn find_clicked(&self, yonly: bool) -> Option<TreeItem>

finds a clicked item

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

👎Deprecated since 1.2.21: use callback_item() instead

Set the item that was last clicked.

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

Gets the first tree item

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

Gets the first visible tree item

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

Gets the next tree item

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

Gets the previous tree item

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

Gets the last tree item

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

Gets the last visible tree item

pub fn next_visible_item( &self, start: &TreeItem, direction_key: Key, ) -> Option<TreeItem>

Gets the next visible tree item

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

Gets the first selected tree item

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

Gets the last selected tree item

pub fn next_item( &self, item: &TreeItem, direction_key: Key, visible: bool, ) -> Option<TreeItem>

Gets the next tree item, direction_key is by default Key::Down

pub fn next_selected_item( &mut self, item: &TreeItem, direction_key: Key, ) -> Option<TreeItem>

Gets the next selected tree item, direction_key is by default Key::Down

pub fn get_selected_items(&self) -> Option<Vec<TreeItem>>

Gets the selected tree items

pub fn get_items(&self) -> Option<Vec<TreeItem>>

Gets the all tree items

pub fn open(&mut self, path: &str, do_callback: bool) -> Result<(), FltkError>

Opens a tree item, causing the children to be shown

Errors

Errors on failure to open an item

pub fn open_toggle(&mut self, item: &TreeItem, do_callback: bool)

Toggle the open state

pub fn close(&mut self, path: &str, do_callback: bool) -> Result<(), FltkError>

Close a tree item, causing the children to be hidden

Errors

Errors on failure to close an item

pub fn is_open(&self, path: &str) -> bool

Returns whether an item is open

pub fn is_close(&self, path: &str) -> bool

Returns whether an item is closed

pub fn select(&mut self, path: &str, do_callback: bool) -> Result<(), FltkError>

Select a tree item

Errors

Errors on failure to select an item

pub fn select_toggle(&mut self, item: &TreeItem, do_callback: bool)

Toggle the select state of the specified

pub fn deselect( &mut self, path: &str, do_callback: bool, ) -> Result<(), FltkError>

Deselect an item at path and determine whether to do the callback

Errors

Errors on failure to deselect item

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

Deselect all items

Errors

Errors on failure to deselect all items

pub fn select_only( &mut self, selected_item: &TreeItem, do_callback: bool, ) -> Result<(), FltkError>

Select only the specified item, deselecting all others that might be selected.

Errors

Errors on failure to select an item

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

Select all items

Errors

Errors on failure to select an item

pub fn extend_selection_dir( &mut self, from: &TreeItem, to: &TreeItem, direction_key: Key, val: TreeItemSelect, visible: bool, ) -> Result<(), FltkError>

Extend the selection between and including from and to in a certain direction

Errors

Errors on failure to extend selection in direction

pub fn extend_selection( &mut self, from: &TreeItem, to: &TreeItem, val: TreeItemSelect, visible: bool, ) -> Result<(), FltkError>

Extend the selection between and including from and to

Errors

Errors on failure to extend selection

pub fn set_item_focus(&mut self, item: &TreeItem)

Set the item that currently should have keyboard focus

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

Get the item that currently has keyboard focus

pub fn is_selected(&self, path: &str) -> bool

Returns whether an item is selected

pub fn item_label_font(&self) -> Font

Gets the items’ label font

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

Sets the items’ label font

pub fn item_label_size(&self) -> i32

Gets the items’ label size

pub fn set_item_label_size(&mut self, val: i32)

Sets the items’ label size

pub fn item_label_fgcolor(&self) -> Color

Gets the items’ foreground color

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

Sets the items’ foreground color

pub fn item_label_bgcolor(&self) -> Color

Gets the items’ background color

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

Sets the items’ foreground color

pub fn connector_color(&self) -> Color

Gets the items’ connector color

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

Sets the items’ foreground color

pub fn margin_left(&self) -> i32

Gets the left margin

pub fn set_margin_left(&mut self, val: i32)

Sets the left margin

pub fn margin_top(&self) -> i32

Gets the top margin

pub fn set_margin_top(&mut self, val: i32)

Sets the top margin

pub fn margin_bottom(&self) -> i32

Gets the bottom margin

pub fn set_margin_bottom(&mut self, val: i32)

Sets the bottom margin

pub fn line_spacing(&self) -> i32

Gets the line spacing

pub fn set_line_spacing(&mut self, val: i32)

Sets the line spacing

pub fn open_child_margin_bottom(&self) -> i32

Gets the open child bottom margin

pub fn set_open_child_margin_bottom(&mut self, val: i32)

Sets the open child bottom margin

pub fn user_icon_margin_left(&self) -> i32

Gets the user icon left margin

pub fn set_user_icon_margin_left(&mut self, val: i32)

Sets the user icon left margin

pub fn label_margin_left(&self) -> i32

Gets the label’s left margin

pub fn set_label_margin_left(&mut self, val: i32)

Sets the label’s left margin

pub fn widget_margin_left(&self) -> i32

Gets the widget’s left margin

pub fn set_widget_margin_left(&mut self, val: i32)

Sets the widget’s left margin

pub fn connector_width(&self) -> i32

Gets the connector’s width

pub fn set_connector_width(&mut self, val: i32)

Sets the connector’s width

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 open_icon(&self) -> Option<Box<dyn ImageExt>>

Gets the open icon

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

where Img: ImageExt,

Sets the open icon

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

Gets the close icon

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

where Img: ImageExt,

Sets the close icon

pub fn show_collapse(&self) -> bool

Returns true if the collapse icon is enabled, false if not.

pub fn set_show_collapse(&mut self, flag: bool)

Sets whether the collapse icon is enabled

pub fn show_root(&self) -> bool

Returns whether the root is shown

pub fn set_show_root(&mut self, flag: bool)

Sets whether the root is shown

pub fn connector_style(&self) -> TreeConnectorStyle

Gets the connector style

pub fn set_connector_style(&mut self, val: TreeConnectorStyle)

Sets the connector style

pub fn sort_order(&self) -> TreeSort

Gets the sort order

pub fn set_sort_order(&mut self, val: TreeSort)

Sets the sort order

pub fn select_frame(&self) -> FrameType

Gets the select frame

pub fn set_select_frame(&mut self, val: FrameType)

Sets the select frame

pub fn select_mode(&self) -> TreeSelect

Gets the Tree select mode

pub fn set_select_mode(&mut self, val: TreeSelect)

Sets the Tree select mode

pub fn item_reselect_mode(&self) -> TreeItemReselectMode

Gets the Tree item’s reselect mode

pub fn set_item_reselect_mode(&mut self, mode: TreeItemReselectMode)

Sets the Tree item’s reselect mode

pub fn item_draw_mode(&self) -> TreeItemDrawMode

Gets the Tree item’s draw mode

pub fn set_item_draw_mode(&mut self, mode: TreeItemDrawMode)

Sets the Tree item’s draw mode

pub fn calc_dimensions(&mut self)

Recalculate widget dimensions and scrollbar visibility, normally done automatically

pub fn calc_tree(&mut self)

Recalculates the tree’s sizes and scrollbar visibility, normally done automatically

pub fn recalc_tree(&mut self)

Recalculates the tree’s sizes and scrollbar visibility, normally done automatically

pub fn displayed(&mut self, item: &TreeItem) -> bool

Returns whether an item is displayed

pub fn show_item(&mut self, item: &TreeItem, y_offset: i32)

Shows an item

pub fn show_item_top(&mut self, item: &TreeItem)

Adjust the vertical scrollbar so that item is visible

pub fn show_item_middle(&mut self, item: &TreeItem)

Adjust the vertical scrollbar so that item is in the middle of the display

pub fn show_item_bottom(&mut self, item: &TreeItem)

Adjust the vertical scrollbar so that the is at the bottom of the display.

pub fn display(&mut self, item: &TreeItem)

Display the item

pub fn vposition(&self) -> i32

Gets the vertical position of the item

pub fn set_vposition(&mut self, pos: i32)

Sets the vertical position of the item

pub fn hposition(&self) -> i32

Gets the horizontal position of the item

pub fn set_hposition(&mut self, pos: i32)

Sets the horizontal position of the item

pub fn is_scrollbar<W>(&mut self, w: &W) -> bool

where W: WidgetExt,

Returns whether the widget is a scrollbar

pub fn scrollbar_size(&self) -> i32

Gets the scrollbar size

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

Sets the scrollbar size

pub fn is_vscroll_visible(&self) -> bool

Returns whether vertical scrolling is visible

pub fn is_hscroll_visible(&self) -> bool

Returns whether horizontal scrolling is visible

pub fn set_callback_item(&mut self, item: &TreeItem)

Set the callback item

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

Get the callback item

pub fn set_callback_reason(&mut self, reason: TreeReason)

Set the callback reason

pub fn callback_reason(&self) -> TreeReason

Get the callback reason

pub fn item_pathname(&self, item: &TreeItem) -> Result<String, FltkError>

Get an item’s pathname

Trait Implementations

impl Clone for Tree

fn clone(&self) -> Tree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tree

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

Formats the value using the given formatter.

impl Default for Tree

fn default() -> Tree

Returns the “default value” for a type.

impl IntoIterator for Tree

type Item = TreeItem

The type of the elements being iterated over.

type IntoIter = IntoIter<<Tree as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Tree as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq for Tree

fn eq(&self, other: &Tree) -> 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 WidgetBase for Tree

fn new<'a, T>(x: i32, y: i32, width: i32, height: i32, title: T) -> Tree

where T: Into<Option<&'a str>>,

Creates a new widget, takes an x, y coordinates, as well as a width and height, plus a title

fn default_fill() -> Tree

Constructs a widget with the size of its parent

fn delete(wid: Tree)

Deletes widgets and their children.

unsafe fn from_widget_ptr(ptr: *mut Fl_Widget) -> Tree

transforms a widget pointer to a Widget, for internal use

unsafe fn from_widget<W>(w: W) -> Tree

where W: WidgetExt,

Get a widget from base widget

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

where F: FnMut(&mut Tree, Event) -> bool + 'static,

Set a custom handler, where events are managed manually, akin to Fl_Widget::handle(int). Handled or ignored events should return true, unhandled events should return false. takes the widget as a closure argument. The ability to handle an event might depend on handling other events, as explained here

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

where F: FnMut(&mut Tree) + 'static,

Set a custom draw method. takes the widget as a closure argument. macOS requires that WidgetBase::draw actually calls drawing functions

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

where F: FnMut(&mut Tree, i32, i32, i32, i32) + 'static,

Perform a callback on resize. Avoid resizing the parent or the same widget to avoid infinite recursion

unsafe fn assume_derived(&mut self)

Makes the widget derived

fn from_dyn_widget<W>(w: &W) -> Option<Tree>

where W: WidgetExt,

Cast a type-erased widget back to its original widget

fn from_dyn_widget_ptr(w: *mut Fl_Widget) -> Option<Tree>

Cast a type-erased widget pointer back to its original widget

impl WidgetExt for Tree

fn center_x<W>(self, w: &W) -> Tree

where W: WidgetExt,

Initialize center of another widget

fn center_y<W>(self, w: &W) -> Tree

where W: WidgetExt,

Initialize center of another widget

fn with_pos(self, x: i32, y: i32) -> Tree

Initialize to a position x, y

fn with_size(self, width: i32, height: i32) -> Tree

Initialize to size width, height

fn with_label(self, title: &str) -> Tree

Initialize with a label

fn with_align(self, align: Align) -> Tree

Initialize with alignment

fn with_type<T>(self, typ: T) -> Tree

where T: WidgetType,

Initialize with type

fn below_of<W>(self, wid: &W, padding: i32) -> Tree

where W: WidgetExt,

Initialize at bottom of another widget

fn above_of<W>(self, wid: &W, padding: i32) -> Tree

where W: WidgetExt,

Initialize above of another widget

fn right_of<W>(self, wid: &W, padding: i32) -> Tree

where W: WidgetExt,

Initialize right of another widget

fn left_of<W>(self, wid: &W, padding: i32) -> Tree

where W: WidgetExt,

Initialize left of another widget

fn center_of<W>(self, w: &W) -> Tree

where W: WidgetExt,

Initialize center of another widget

fn center_of_parent(self) -> Tree

Initialize center of parent

fn size_of<W>(self, w: &W) -> Tree

where W: WidgetExt,

Initialize to the size of another widget

fn size_of_parent(self) -> Tree

Initialize to the size of the parent

fn set_pos(&mut self, x: i32, y: i32)

Set to position x, y

fn set_size(&mut self, width: i32, height: i32)

Set to dimensions width and height

fn set_label(&mut self, title: &str)

Sets the widget’s label. labels support special symbols preceded by an @ sign. and for the associated formatting.

fn redraw(&mut self)

Redraws a widget, necessary for resizing and changing positions

fn show(&mut self)

Shows the widget

fn hide(&mut self)

Hides the widget

fn x(&self) -> i32

Returns the x coordinate of the widget

fn y(&self) -> i32

Returns the y coordinate of the widget

fn width(&self) -> i32

Returns the width of the widget

fn height(&self) -> i32

Returns the height of the widget

fn w(&self) -> i32

Returns the width of the widget

fn h(&self) -> i32

Returns the height of the widget

fn label(&self) -> String

Returns the label of the widget

fn measure_label(&self) -> (i32, i32)

Measures the label’s width and height

fn as_widget_ptr(&self) -> *mut Fl_Widget

transforms a widget to a base Fl_Widget, for internal use

fn activate(&mut self)

Activates the widget

fn deactivate(&mut self)

Deactivates the widget

fn redraw_label(&mut self)

Redraws the label of the widget

fn resize(&mut self, x: i32, y: i32, width: i32, height: i32)

Resizes and/or moves the widget, takes x, y, width and height

fn widget_resize(&mut self, x: i32, y: i32, width: i32, height: i32)

Does a simple resize ignoring class-specific resize functionality

fn tooltip(&self) -> Option<String>

Returns the tooltip text

fn set_tooltip(&mut self, txt: &str)

Sets the tooltip text

fn color(&self) -> Color

Returns the widget color

fn set_color(&mut self, color: Color)

Sets the widget’s color

fn label_color(&self) -> Color

Returns the widget label’s color

fn set_label_color(&mut self, color: Color)

Sets the widget label’s color

fn label_font(&self) -> Font

Returns the widget label’s font

fn set_label_font(&mut self, font: Font)

Sets the widget label’s font

fn label_size(&self) -> i32

Returns the widget label’s size

fn set_label_size(&mut self, sz: i32)

Sets the widget label’s size

fn label_type(&self) -> LabelType

Returns the widget label’s type

fn set_label_type(&mut self, typ: LabelType)

Sets the widget label’s type

fn frame(&self) -> FrameType

Returns the widget’s frame type

fn set_frame(&mut self, typ: FrameType)

Sets the widget’s frame type

fn changed(&self) -> bool

Returns whether the widget was changed

fn set_changed(&mut self)

Mark the widget as changed

fn clear_changed(&mut self)

Clears the changed status of the widget

fn align(&self) -> Align

Returns the alignment of the widget

fn set_align(&mut self, align: Align)

Sets the alignment of the widget

fn set_trigger(&mut self, trigger: CallbackTrigger)

Sets the default callback trigger for a widget, equivalent to when()

fn trigger(&self) -> CallbackTrigger

Return the callback trigger, equivalent to when()

fn parent(&self) -> Option<Group>

Returns the parent of the widget

fn selection_color(&self) -> Color

Gets the selection color of the widget

fn set_selection_color(&mut self, color: Color)

Sets the selection color of the widget

fn do_callback(&mut self)

Runs the already registered callback

fn window(&self) -> Option<Box<dyn WindowExt>>

Returns the direct window holding the widget

fn top_window(&self) -> Option<Box<dyn WindowExt>>

Returns the topmost window holding the widget

fn takes_events(&self) -> bool

Checks whether a widget is capable of taking events

fn take_focus(&mut self) -> Result<(), FltkError>

Make the widget take focus

fn set_visible_focus(&mut self)

Set the widget to have visible focus

fn clear_visible_focus(&mut self)

Clear visible focus

fn visible_focus(&mut self, v: bool)

Set the visible focus using a flag

fn has_visible_focus(&self) -> bool

Return whether the widget has visible focus

fn has_focus(&self) -> bool

Return whether the widget has focus

fn was_deleted(&self) -> bool

Check if a widget was deleted

fn damage(&self) -> bool

Return whether the widget was damaged

fn set_damage(&mut self, flag: bool)

Signal the widget as damaged and it should be redrawn in the next event loop cycle

fn damage_type(&self) -> Damage

Return the damage mask

fn set_damage_type(&mut self, mask: Damage)

Signal the type of damage a widget received

fn set_damage_area(&mut self, mask: Damage, x: i32, y: i32, w: i32, h: i32)

Signal damage for an area inside the widget

fn clear_damage(&mut self)

Clear the damaged flag

fn as_window(&self) -> Option<Box<dyn WindowExt>>

Return the widget as a window if it’s a window

fn as_group(&self) -> Option<Group>

Return the widget as a group widget if it’s a group widget

fn inside<W>(&self, wid: &W) -> bool

where W: WidgetExt,

Checks whether the self widget is inside another widget

fn get_type<T>(&self) -> T

where T: WidgetType,

Returns the widget type when applicable

fn set_type<T>(&mut self, typ: T)

where T: WidgetType,

Sets the widget type

fn set_image<I>(&mut self, image: Option<I>)

where I: ImageExt,

Sets the image of the widget

fn set_image_scaled<I>(&mut self, image: Option<I>)

where I: ImageExt,

Sets the image of the widget scaled to the widget’s size

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

Gets the image associated with the widget

unsafe fn image_mut(&self) -> Option<&mut Image>

Get a reference type of the widget’s image

fn set_deimage<I>(&mut self, image: Option<I>)

where I: ImageExt,

Sets the deactivated image of the widget

fn set_deimage_scaled<I>(&mut self, image: Option<I>)

where I: ImageExt,

Sets the deactivated image of the widget scaled to the widget’s size

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

Gets the deactivated image associated with the widget

unsafe fn deimage_mut(&self) -> Option<&mut Image>

Get a reference type of the widget’s deactivated image

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

where F: FnMut(&mut Tree) + 'static,

Sets the callback when the widget is triggered (clicks for example) takes the widget as a closure argument

fn emit<T>(&mut self, sender: Sender<T>, msg: T)

where T: 'static + Clone + Send + Sync,

Emits a message on callback using a sender

unsafe fn into_widget<W>(&self) -> W

where W: WidgetBase,

Upcast a WidgetExt to some widget type

fn visible(&self) -> bool

Returns whether a widget is visible

fn visible_r(&self) -> bool

Returns whether a widget or any of its parents are visible (recursively)

fn is_same<W>(&self, other: &W) -> bool

where W: WidgetExt,

Return whether two widgets object point to the same widget

fn active(&self) -> bool

Returns whether a widget is active

fn active_r(&self) -> bool

Returns whether a widget or any of its parents are active (recursively)

fn handle_event(&mut self, event: Event) -> bool

Handle a specific event

fn is_derived(&self) -> bool

Check whether a widget is derived

fn as_base_widget(&self) -> Widget

where Self: Sized,

Upcast a WidgetExt to a Widget

impl Eq for Tree

impl Send for Tree

impl Sync for Tree