Struct ColumnViewColumn

pub struct ColumnViewColumn { /* private fields */ }

ColumnViewColumn represents the columns being added to a ColumnView.

The main ingredient for a ColumnViewColumn is the ListItemFactory that tells the columnview how to create cells for this column from items in the model.

Columns have a title, and can optionally have a header menu set with set_header_menu().

A sorter can be associated with a column using set_sorter(), to let users influence sorting by clicking on the column header.

Properties

column-view

The ColumnView this column is a part of.

Readable

expand

Column gets share of extra width allocated to the view.

Readable | Writeable

factory

Factory for populating list items.

The factory must be for configuring ColumnViewCell objects.

Readable | Writeable

fixed-width

If not -1, this is the width that the column is allocated, regardless of the size of its content.

Readable | Writeable

header-menu

Menu model used to create the context menu for the column header.

Readable | Writeable

id

An ID for the column.

GTK is not currently using the ID for anything, but it can be used by applications when saving column view configurations.

It is up to applications to ensure uniqueness of IDs.

Readable | Writeable

resizable

Whether this column is resizable.

Readable | Writeable

sorter

Sorter for sorting items according to this column.

Readable | Writeable

title

Title displayed in the header.

Readable | Writeable

visible

Whether this column is visible.

Readable | Writeable

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl ColumnViewColumn

pub fn new( title: Option<&str>, factory: Option<impl IsA<ListItemFactory>>, ) -> ColumnViewColumn

Creates a new ColumnViewColumn that uses the given @factory for mapping items to widgets.

You most likely want to call ColumnView::append_column() next.

The function takes ownership of the argument, so you can write code like:

⚠️ The following code is in c ⚠️

column = gtk_column_view_column_new (_("Name"),
  gtk_builder_list_item_factory_new_from_resource ("/name.ui"));

title

Title to use for this column

factory

The factory to populate items with

Returns

a new ColumnViewColumn using the given @factory

pub fn builder() -> ColumnViewColumnBuilder

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

This method returns an instance of ColumnViewColumnBuilder which can be used to create ColumnViewColumn objects.

pub fn column_view(&self) -> Option<ColumnView>

Gets the column view that’s currently displaying this column.

If @self has not been added to a column view yet, None is returned.

Returns

The column view displaying @self.

pub fn expands(&self) -> bool

Returns whether this column should expand.

Returns

true if this column expands

pub fn factory(&self) -> Option<ListItemFactory>

Gets the factory that’s currently used to populate list items for this column.

Returns

The factory in use

pub fn fixed_width(&self) -> i32

Gets the fixed width of the column.

Returns

the fixed with of the column

pub fn header_menu(&self) -> Option<MenuModel>

Gets the menu model that is used to create the context menu for the column header.

Returns

the GMenuModel

pub fn id(&self) -> Option<GString>

Available on crate feature v4_10 only.

Returns the ID set with gtk_column_view_column_set_id().

Returns

The column’s ID

pub fn is_resizable(&self) -> bool

Returns whether this column is resizable.

Returns

true if this column is resizable

pub fn sorter(&self) -> Option<Sorter>

Returns the sorter that is associated with the column.

Returns

the Sorter of @self

pub fn title(&self) -> Option<GString>

Returns the title set with gtk_column_view_column_set_title().

Returns

The column’s title

pub fn is_visible(&self) -> bool

Returns whether this column is visible.

Returns

true if this column is visible

pub fn set_expand(&self, expand: bool)

Sets the column to take available extra space.

The extra space is shared equally amongst all columns that have the expand set to true.

expand

true if this column should expand to fill available sace

pub fn set_factory(&self, factory: Option<&impl IsA<ListItemFactory>>)

Sets the ListItemFactory to use for populating list items for this column.

factory

the factory to use

pub fn set_fixed_width(&self, fixed_width: i32)

If @fixed_width is not -1, sets the fixed width of @column; otherwise unsets it.

Setting a fixed width overrides the automatically calculated width. Interactive resizing also sets the “fixed-width” property.

fixed_width

the new fixed width, or -1

pub fn set_header_menu(&self, menu: Option<&impl IsA<MenuModel>>)

Sets the menu model that is used to create the context menu for the column header.

menu

a GMenuModel

pub fn set_id(&self, id: Option<&str>)

Available on crate feature v4_10 only.

Sets the id of this column.

GTK makes no use of this, but applications can use it when storing column view configuration.

It is up to callers to ensure uniqueness of IDs.

id

ID to use for this column

pub fn set_resizable(&self, resizable: bool)

Sets whether this column should be resizable by dragging.

resizable

whether this column should be resizable

pub fn set_sorter(&self, sorter: Option<&impl IsA<Sorter>>)

Associates a sorter with the column.

If @sorter is None, the column will not let users change the sorting by clicking on its header.

This sorter can be made active by clicking on the column header, or by calling ColumnView::sort_by_column().

See ColumnView::sorter() for the necessary steps for setting up customizable sorting for ColumnView.

sorter

the Sorter to associate with @column

pub fn set_title(&self, title: Option<&str>)

Sets the title of this column.

The title is displayed in the header of a ColumnView for this column and is therefore user-facing text that should be translated.

title

Title to use for this column

pub fn set_visible(&self, visible: bool)

Sets whether this column should be visible in views.

visible

whether this column should be visible

pub fn connect_column_view_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_factory_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_header_menu_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

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

Available on crate feature v4_10 only.

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

pub fn connect_sorter_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

Trait Implementations

impl Clone for ColumnViewColumn

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for ColumnViewColumn

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

Formats the value using the given formatter.

impl Default for ColumnViewColumn

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for ColumnViewColumn

type ParamSpec = ParamSpecObject

type SetValue = ColumnViewColumn

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, ColumnViewColumn>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ColumnViewColumn

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

where H: Hasher,

Hashes the memory address of this object.

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 Ord for ColumnViewColumn

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for ColumnViewColumn

type Parent = Object

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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<OT: ObjectType> PartialOrd<OT> for ColumnViewColumn

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ColumnViewColumn

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ColumnViewColumn