Struct gtk4::TreeViewColumn

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

A visible column in a TreeView widget

The TreeViewColumn object represents a visible column in a TreeView widget. It allows to set properties of the column header, and functions as a holding pen for the cell renderers which determine how the data in the column is displayed.

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, and to the TreeView documentation for specifics about the CSS node structure for treeviews and their headers.

Implements

glib::ObjectExt, BuildableExt, CellLayoutExt, CellLayoutExtManual

Implementations

impl TreeViewColumn

pub fn new() -> TreeViewColumn

Creates a new TreeViewColumn.

Returns

A newly created TreeViewColumn.

pub fn with_area(area: &impl IsA<CellArea>) -> TreeViewColumn

Creates a new TreeViewColumn using @area to render its cells.

area

the CellArea that the newly created column should use to layout cells.

Returns

A newly created TreeViewColumn.

pub fn builder() -> TreeViewColumnBuilder

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

This method returns an instance of TreeViewColumnBuilder which can be used to create TreeViewColumn objects.

pub fn cell_get_position(
    &self,
    cell_renderer: &impl IsA<CellRenderer>
) -> Option<(i32, i32)>

Obtains the horizontal position and size of a cell in a column.

If the cell is not found in the column, @start_pos and @width are not changed and false is returned.

cell_renderer

a CellRenderer

Returns

true if @cell belongs to @self

x_offset

return location for the horizontal position of @cell within @self

width

return location for the width of @cell

pub fn cell_get_size(&self) -> (i32, i32, i32, i32)

Obtains the width and height needed to render the column. This is used primarily by the TreeView.

Returns

x_offset

location to return x offset of a cell relative to @cell_area

y_offset

location to return y offset of a cell relative to @cell_area

width

location to return width needed to render a cell

height

location to return height needed to render a cell

pub fn cell_is_visible(&self) -> bool

Returns true if any of the cells packed into the @self are visible. For this to be meaningful, you must first initialize the cells with gtk_tree_view_column_cell_set_cell_data()

Returns

true, if any of the cells packed into the @self are currently visible

pub fn cell_set_cell_data(
    &self,
    tree_model: &impl IsA<TreeModel>,
    iter: &TreeIter,
    is_expander: bool,
    is_expanded: bool
)

Sets the cell renderer based on the @tree_model and @iter. That is, for every attribute mapping in @self, it will get a value from the set column on the @iter, and use that value to set the attribute on the cell renderer. This is used primarily by the TreeView.

tree_model

The TreeModel to get the cell renderers attributes from.

iter

The TreeIter to get the cell renderer’s attributes from.

is_expander

true, if the row has children

is_expanded

true, if the row has visible children

pub fn clicked(&self)

Emits the “clicked” signal on the column. This function will only work if @self is clickable.

pub fn focus_cell(&self, cell: &impl IsA<CellRenderer>)

Sets the current keyboard focus to be at @cell, if the column contains 2 or more editable and activatable cells.

cell

A CellRenderer

pub fn alignment(&self) -> f32

Returns the current x alignment of @self. This value can range between 0.0 and 1.0.

Returns

The current alignent of @self.

pub fn button(&self) -> Widget

Returns the button used in the treeview column header

Returns

The button for the column header.

pub fn is_clickable(&self) -> bool

Returns true if the user can click on the header for the column.

Returns

true if user can click the column header.

pub fn expands(&self) -> bool

Returns true if the column expands to fill available space.

Returns

true if the column expands to fill available space.

pub fn fixed_width(&self) -> i32

Gets the fixed width of the column. This may not be the actual displayed width of the column; for that, use gtk_tree_view_column_get_width().

Returns

The fixed width of the column.

pub fn max_width(&self) -> i32

Returns the maximum width in pixels of the @self, or -1 if no maximum width is set.

Returns

The maximum width of the @self.

pub fn min_width(&self) -> i32

Returns the minimum width in pixels of the @self, or -1 if no minimum width is set.

Returns

The minimum width of the @self.

pub fn is_reorderable(&self) -> bool

Returns true if the @self can be reordered by the user.

Returns

true if the @self can be reordered by the user.

pub fn is_resizable(&self) -> bool

Returns true if the @self can be resized by the end user.

Returns

true, if the @self can be resized.

pub fn sizing(&self) -> TreeViewColumnSizing

Returns the current type of @self.

Returns

The type of @self.

pub fn sort_column_id(&self) -> i32

Gets the logical @sort_column_id that the model sorts on when this column is selected for sorting.

See set_sort_column_id().

Returns

the current @sort_column_id for this column, or -1 if this column can’t be used for sorting

pub fn is_sort_indicator(&self) -> bool

Gets the value set by gtk_tree_view_column_set_sort_indicator().

Returns

whether the sort indicator arrow is displayed

pub fn sort_order(&self) -> SortType

Gets the value set by gtk_tree_view_column_set_sort_order().

Returns

the sort order the sort indicator is indicating

pub fn spacing(&self) -> i32

Returns the spacing of @self.

Returns

the spacing of @self.

pub fn title(&self) -> GString

Returns the title of the widget.

Returns

the title of the column. This string should not be modified or freed.

pub fn tree_view(&self) -> Option<Widget>

Returns the TreeView wherein @self has been inserted. If @column is currently not inserted in any tree view, None is returned.

Returns

The tree view wherein @column has been inserted

pub fn is_visible(&self) -> bool

Returns true if @self is visible.

Returns

whether the column is visible or not. If it is visible, then the tree will show the column.

pub fn widget(&self) -> Option<Widget>

Returns the Widget in the button on the column header.

If a custom widget has not been set then None is returned.

Returns

The Widget in the column header

pub fn width(&self) -> i32

Returns the current size of @self in pixels.

Returns

The current width of @self.

pub fn x_offset(&self) -> i32

Returns the current X offset of @self in pixels.

Returns

The current X offset of @self.

pub fn queue_resize(&self)

Flags the column, and the cell renderers added to this column, to have their sizes renegotiated.

pub fn set_alignment(&self, xalign: f32)

Sets the alignment of the title or custom widget inside the column header. The alignment determines its location inside the button – 0.0 for left, 0.5 for center, 1.0 for right.

xalign

The alignment, which is between [0.0 and 1.0] inclusive.

pub fn set_cell_data_func<P: Fn(&TreeViewColumn, &CellRenderer, &TreeModel, &TreeIter) + 'static>(
    &self,
    cell_renderer: &impl IsA<CellRenderer>,
    func: P
)

Sets the GtkTreeCellDataFunc to use for the column.

This function is used instead of the standard attributes mapping for setting the column value, and should set the value of @self’s cell renderer as appropriate. @func may be None to remove an older one.

cell_renderer

A CellRenderer

func

The GtkTreeCellDataFunc to use.

func_data

The user data for @func.

pub fn set_clickable(&self, clickable: bool)

Sets the header to be active if @clickable is true. When the header is active, then it can take keyboard focus, and can be clicked.

clickable

true if the header is active.

pub fn set_expand(&self, expand: bool)

Sets the column to take available extra space. This space is shared equally amongst all columns that have the expand set to true. If no column has this option set, then the last column gets all extra space. By default, every column is created with this false.

Along with “fixed-width”, the “expand” property changes when the column is resized by the user.

expand

true if the column should expand to fill available space.

pub fn set_fixed_width(&self, fixed_width: i32)

If @fixed_width is not -1, sets the fixed width of @self; otherwise unsets it. The effective value of @fixed_width is clamped between the minimum and maximum width of the column; however, the value stored in the “fixed-width” property is not clamped. If the column sizing is TreeViewColumnSizing::GrowOnly or TreeViewColumnSizing::Autosize, setting a fixed width overrides the automatically calculated width. Note that @fixed_width is only a hint to GTK; the width actually allocated to the column may be greater or less than requested.

Along with “expand”, the “fixed-width” property changes when the column is resized by the user.

fixed_width

The new fixed width, in pixels, or -1.

pub fn set_max_width(&self, max_width: i32)

Sets the maximum width of the @self. If @max_width is -1, then the maximum width is unset. Note, the column can actually be wider than max width if it’s the last column in a view. In this case, the column expands to fill any extra space.

max_width

The maximum width of the column in pixels, or -1.

pub fn set_min_width(&self, min_width: i32)

Sets the minimum width of the @self. If @min_width is -1, then the minimum width is unset.

min_width

The minimum width of the column in pixels, or -1.

pub fn set_reorderable(&self, reorderable: bool)

If @reorderable is true, then the column can be reordered by the end user dragging the header.

reorderable

true, if the column can be reordered.

pub fn set_resizable(&self, resizable: bool)

If @resizable is true, then the user can explicitly resize the column by grabbing the outer edge of the column button.

If resizable is true and sizing mode of the column is TreeViewColumnSizing::Autosize, then the sizing mode is changed to TreeViewColumnSizing::GrowOnly.

resizable

true, if the column can be resized

pub fn set_sizing(&self, type_: TreeViewColumnSizing)

Sets the growth behavior of @self to @type_.

type_

The TreeViewColumnSizing.

pub fn set_sort_column_id(&self, sort_column_id: i32)

Sets the logical @sort_column_id that this column sorts on when this column is selected for sorting. Doing so makes the column header clickable.

sort_column_id

The @sort_column_id of the model to sort on.

pub fn set_sort_indicator(&self, setting: bool)

Call this function with a @setting of true to display an arrow in the header button indicating the column is sorted. Call gtk_tree_view_column_set_sort_order() to change the direction of the arrow.

setting

true to display an indicator that the column is sorted

pub fn set_sort_order(&self, order: SortType)

Changes the appearance of the sort indicator.

This does not actually sort the model. Use gtk_tree_view_column_set_sort_column_id() if you want automatic sorting support. This function is primarily for custom sorting behavior, and should be used in conjunction with gtk_tree_sortable_set_sort_column_id() to do that. For custom models, the mechanism will vary.

The sort indicator changes direction to indicate normal sort or reverse sort. Note that you must have the sort indicator enabled to see anything when calling this function; see gtk_tree_view_column_set_sort_indicator().

order

sort order that the sort indicator should indicate

pub fn set_spacing(&self, spacing: i32)

Sets the spacing field of @self, which is the number of pixels to place between cell renderers packed into it.

spacing

distance between cell renderers in pixels.

pub fn set_title(&self, title: &str)

Sets the title of the @self. If a custom widget has been set, then this value is ignored.

title

The title of the @self.

pub fn set_visible(&self, visible: bool)

Sets the visibility of @self.

visible

true if the @self is visible.

pub fn set_widget(&self, widget: Option<&impl IsA<Widget>>)

Sets the widget in the header to be @widget. If widget is None, then the header button is set with a Label set to the title of @self.

widget

A child Widget

pub fn cell_area(&self) -> Option<CellArea>

The CellArea used to layout cell renderers for this column.

If no area is specified when creating the tree view column with gtk_tree_view_column_new_with_area() a horizontally oriented CellAreaBox will be used.

pub fn connect_clicked<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted when the column’s header has been clicked.

pub fn connect_alignment_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_clickable_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_expand_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_fixed_width_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_max_width_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_min_width_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_reorderable_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_resizable_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_sizing_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_sort_column_id_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_sort_indicator_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_sort_order_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_spacing_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_title_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_visible_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_widget_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_width_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_x_offset_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

impl TreeViewColumn

pub fn with_attributes(
    title: &str,
    cell_renderer: &impl IsA<CellRenderer>,
    attributes: &[(&str, i32)]
) -> Self

Creates a new TreeViewColumn with a number of default values. This is equivalent to calling gtk_tree_view_column_set_title(), gtk_tree_view_column_pack_start(), and gtk_tree_view_column_set_attributes() on the newly created TreeViewColumn.

Here’s a simple example:

⚠️ The following code is in C ⚠️

 enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
 // ...
 {
   GtkTreeViewColumn *column;
   GtkCellRenderer   *renderer = gtk_cell_renderer_text_new ();

   column = gtk_tree_view_column_new_with_attributes ("Title",
                                                      renderer,
                                                      "text", TEXT_COLUMN,
                                                      "foreground", COLOR_COLUMN,
                                                      NULL);
 }

title

The title to set the header to

cell

The CellRenderer

Returns

A newly created TreeViewColumn.

pub fn add_attribute(
    &self,
    cell_renderer: &impl IsA<CellRenderer>,
    attribute: &str,
    column: i32
)

pub fn pack_end(&self, cell_renderer: &impl IsA<CellRenderer>, expand: bool)

pub fn pack_start(&self, cell_renderer: &impl IsA<CellRenderer>, expand: bool)

pub fn set_attributes(
    &self,
    cell_renderer: &impl IsA<CellRenderer>,
    attributes: &[(&str, i32)]
)

pub fn clear(&self)

pub fn clear_attributes(&self, cell_renderer: &impl IsA<CellRenderer>)

pub fn unset_cell_data_func(&self, cell_renderer: &impl IsA<CellRenderer>)

Trait Implementations

impl Clone for TreeViewColumn

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 TreeViewColumn

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

Formats the value using the given formatter.

impl Default for TreeViewColumn

fn default() -> Self

Returns the “default value” for a type.

impl Display for TreeViewColumn

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

Formats the value using the given formatter.

impl Hash for TreeViewColumn

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for TreeViewColumn

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 ParentClassIs for TreeViewColumn

type Parent = Object

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

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 !=.

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

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 TreeViewColumn

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TreeViewColumn

impl IsA<Buildable> for TreeViewColumn

impl IsA<CellLayout> for TreeViewColumn