Struct gtk4::TreeView

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

Use ListView for lists, and ColumnView for tabular lists A widget for displaying both trees and lists

Widget that displays any object that implements the TreeModel interface.

Please refer to the tree widget conceptual overview for an overview of all the objects and data types related to the tree widget and how they work together.

Coordinate systems in GtkTreeView API

Several different coordinate systems are exposed in the TreeView API. These are:

• Widget coordinates: Coordinates relative to the widget (usually widget->window).

• Bin window coordinates: Coordinates relative to the window that GtkTreeView renders to.

• Tree coordinates: Coordinates relative to the entire scrollable area of GtkTreeView. These coordinates start at (0, 0) for row 0 of the tree.

Several functions are available for converting between the different coordinate systems. The most common translations are between widget and bin window coordinates and between bin window and tree coordinates. For the former you can use TreeViewExt::convert_widget_to_bin_window_coords() (and vice versa), for the latter TreeViewExt::convert_bin_window_to_tree_coords() (and vice versa).

TreeView as Buildable

The TreeView implementation of the Buildable interface accepts TreeViewColumn objects as <child> elements and exposes the internal TreeSelection in UI definitions.

An example of a UI definition fragment with TreeView:

<object class="GtkTreeView" id="treeview">
  <property name="model">liststore1</property>
  <child>
    <object class="GtkTreeViewColumn" id="test-column">
      <property name="title">Test</property>
      <child>
        <object class="GtkCellRendererText" id="test-renderer"/>
        <attributes>
          <attribute name="text">1</attribute>
        </attributes>
      </child>
    </object>
  </child>
  <child internal-child="selection">
    <object class="GtkTreeSelection" id="selection">
      <signal name="changed" handler="on_treeview_selection_changed"/>
    </object>
  </child>
</object>

CSS nodes

treeview.view
├── header
│   ├── button
│   │   ╰── [sort-indicator]
┊   ┊
│   ╰── button
│       ╰── [sort-indicator]
│
├── [rubberband]
╰── [dndtarget]

TreeView has a main CSS node with name treeview and style class .view. It has a subnode with name header, which is the parent for all the column header widgets’ CSS nodes.

Each column header consists of a button, which among other content, has a child with name sort-indicator, which carries the .ascending or .descending style classes when the column header should show a sort indicator. The CSS is expected to provide a suitable image using the -gtk-icon-source property.

For rubberband selection, a subnode with name rubberband is used.

For the drop target location during DND, a subnode with name dndtarget is used.

Implements

TreeViewExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, ScrollableExt, TreeViewExtManual, WidgetExtManual, AccessibleExtManual

Implementations

impl TreeView

pub const NONE: Option<&'static TreeView> = None

pub fn new() -> TreeView

Creates a new TreeView widget.

Deprecated since 4.10

Use ListView or ColumnView instead

Returns

A newly created TreeView widget.

pub fn with_model(model: &impl IsA<TreeModel>) -> TreeView

Creates a new TreeView widget with the model initialized to @model.

Deprecated since 4.10

Use ListView or ColumnView instead

model

the model.

Returns

A newly created TreeView widget.

pub fn builder() -> TreeViewBuilder

Creates a new builder-pattern struct instance to construct TreeView objects.

This method returns an instance of TreeViewBuilder which can be used to create TreeView objects.

Trait Implementations

impl Clone for TreeView

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 TreeView

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

Formats the value using the given formatter.

impl Default for TreeView

fn default() -> Self

Returns the “default value” for a type.

impl Display for TreeView

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

Formats the value using the given formatter.

impl Hash for TreeView

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T: TreeViewImpl> IsSubclassable<T> for TreeView

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for TreeView

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for TreeView

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for TreeView

fn eq(&self, other: &OT) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for TreeView

fn partial_cmp(&self, other: &OT) -> 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 TreeView

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TreeView

impl IsA<Accessible> for TreeView

impl IsA<Buildable> for TreeView

impl IsA<ConstraintTarget> for TreeView

impl IsA<Scrollable> for TreeView

impl IsA<Widget> for TreeView