Struct gtk4::TreeViewColumn[][src]

pub struct TreeViewColumn(_);
Expand description

A visible column in a GtkTreeView widget

The GtkTreeViewColumn 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][TreeWidget] 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

Creates a new TreeViewColumn.

Returns

A newly created 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.

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.

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, may be None

width

return location for the width of cell, may be None

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

y_offset

location to return y offset of a cell relative to cell_area, or None

width

location to return width needed to render a cell, or None

height

location to return height needed to render a cell, or None

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 cell_set_cell_data()

Returns

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

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

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

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

cell

A CellRenderer

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

Returns

The current alignent of self.

Returns the button used in the treeview column header

Returns

The button for the column header.

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

Returns

true if user can click the column header.

Returns true if the column expands to fill available space.

Returns

true if the column expands to fill available space.

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

Returns

The fixed width of the column.

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

Returns

The maximum width of the self.

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

Returns

The minimum width of the self.

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

Returns

true if the self can be reordered by the user.

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

Returns

true, if the self can be resized.

Returns the current type of self.

Returns

The type of self.

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.

Gets the value set by set_sort_indicator().

Returns

whether the sort indicator arrow is displayed

Gets the value set by set_sort_order().

Returns

the sort order the sort indicator is indicating

Returns the spacing of self.

Returns

the spacing of self.

Returns the title of the widget.

Returns

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

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 if any, None otherwise.

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.

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

Returns the current size of self in pixels.

Returns

The current width of self.

Returns the current X offset of self in pixels.

Returns

The current X offset of self.

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

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.

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.

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.

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.

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.

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.

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.

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.

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

Sets the growth behavior of self to type_.

type_

The TreeViewColumnSizing.

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.

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

setting

true to display an indicator that the column is sorted

Changes the appearance of the sort indicator.

This does not actually sort the model. Use 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 TreeSortableExtManual::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 set_sort_indicator().

order

sort order that the sort indicator should indicate

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.

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

title

The title of the self.

Sets the visibility of self.

visible

true if the self is visible.

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

The CellArea used to layout cell renderers for this column.

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

Emitted when the column’s header has been clicked.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Formats the value using the given formatter. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

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

This method tests for !=.

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

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

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

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

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

Returns the type identifier of Self.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Upcasts an object to a superclass or interface T. Read more

Upcasts an object to a reference of its superclass or interface T. Read more

Tries to downcast to a subclass or interface implementor T. Read more

Tries to downcast to a reference of its subclass or interface implementor T. Read more

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

Casts to T unconditionally. Read more

Casts to &T unconditionally. Read more

Performs the conversion.

Performs the conversion.

Returns true if the object is an instance of (can be cast to) T.

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Same as connect but takes a SignalId instead of a signal name.

Same as connect_local but takes a SignalId instead of a signal name.

Same as connect_unsafe but takes a SignalId instead of a signal name.

Emit signal by signal id.

Same as emit but takes Value for the arguments.

Emit signal by its name.

Same as emit_by_name but takes Value for the arguments.

Emit signal with details by signal id.

Same as emit_with_details but takes Value for the arguments.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

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

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

Returns a SendValue clone of self.

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.