Struct gtk4::CellView

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

List views use widgets to display their contents. You can use Box instead A widget displaying a single row of a GtkTreeModel

A CellView displays a single row of a TreeModel using a CellArea and CellAreaContext. A CellAreaContext can be provided to the CellView at construction time in order to keep the cellview in context of a group of cell views, this ensures that the renderers displayed will be properly aligned with each other (like the aligned cells in the menus of ComboBox).

CellView is Orientable in order to decide in which orientation the underlying CellAreaContext should be allocated. Taking the ComboBox menu as an example, cellviews should be oriented horizontally if the menus are listed top-to-bottom and thus all share the same width but may have separate individual heights (left-to-right menus should be allocated vertically since they all share the same height but may have variable widths).

CSS nodes

GtkCellView has a single CSS node with name cellview.

Properties

cell-area

The CellArea rendering cells

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

since 3.0

Readable | Writeable | Construct Only

cell-area-context

The CellAreaContext used to compute the geometry of the cell view.

A group of cell views can be assigned the same context in order to ensure the sizes and cell alignments match across all the views with the same context.

ComboBox menus uses this to assign the same context to all cell views in the menu items for a single menu (each submenu creates its own context since the size of each submenu does not depend on parent or sibling menus).

since 3.0

Readable | Writeable | Construct Only

draw-sensitive

Whether all cells should be draw as sensitive for this view regardless of the actual cell properties (used to make menus with submenus appear sensitive when the items in submenus might be insensitive).

since 3.0

Readable | Writeable

fit-model

Whether the view should request enough space to always fit the size of every row in the model (used by the combo box to ensure the combo box size doesn’t change when different items are selected).

since 3.0

Readable | Writeable

model

The model for cell view

since 2.10

Readable | Writeable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Orientable

orientation

The orientation of the orientable.

Readable | Writeable

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, CellLayoutExt, OrientableExt, WidgetExtManual, AccessibleExtManual, CellLayoutExtManual

Implementations

impl CellView

pub fn new() -> CellView

Creates a new CellView widget.

Deprecated since 4.10

Returns

A newly created CellView widget.

pub fn with_context( area: &impl IsA<CellArea>, context: &impl IsA<CellAreaContext> ) -> CellView

Creates a new CellView widget with a specific CellArea to layout cells and a specific CellAreaContext.

Specifying the same context for a handful of cells lets the underlying area synchronize the geometry for those cells, in this way alignments with cellviews for other rows are possible.

Deprecated since 4.10

area

the CellArea to layout cells

context

the CellAreaContext in which to calculate cell geometry

Returns

A newly created CellView widget.

pub fn with_markup(markup: &str) -> CellView

Creates a new CellView widget, adds a CellRendererText to it, and makes it show @markup. The text can be marked up with the Pango text markup language.

Deprecated since 4.10

markup

the text to display in the cell view

Returns

A newly created CellView widget.

pub fn with_text(text: &str) -> CellView

Creates a new CellView widget, adds a CellRendererText to it, and makes it show @text.

Deprecated since 4.10

text

the text to display in the cell view

Returns

A newly created CellView widget.

pub fn with_texture(texture: &impl IsA<Texture>) -> CellView

Creates a new CellView widget, adds a CellRendererPixbuf to it, and makes it show @texture.

Deprecated since 4.10

texture

the image to display in the cell view

Returns

A newly created CellView widget.

pub fn builder() -> CellViewBuilder

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

This method returns an instance of CellViewBuilder which can be used to create CellView objects.

pub fn displayed_row(&self) -> Option<TreePath>

Returns a TreePath referring to the currently displayed row. If no row is currently displayed, None is returned.

Deprecated since 4.10

Returns

the currently displayed row

pub fn draws_sensitive(&self) -> bool

Gets whether @self is configured to draw all of its cells in a sensitive state.

Deprecated since 4.10

Returns

whether @self draws all of its cells in a sensitive state

pub fn fits_model(&self) -> bool

Gets whether @self is configured to request space to fit the entire TreeModel.

Deprecated since 4.10

Returns

whether @self requests space to fit the entire TreeModel.

pub fn model(&self) -> Option<TreeModel>

Returns the model for @self. If no model is used None is returned.

Deprecated since 4.10

Returns

a TreeModel used

pub fn set_displayed_row(&self, path: Option<&TreePath>)

Sets the row of the model that is currently displayed by the CellView. If the path is unset, then the contents of the cellview “stick” at their last value; this is not normally a desired result, but may be a needed intermediate state if say, the model for the CellView becomes temporarily empty.

Deprecated since 4.10

path

a TreePath or None to unset.

pub fn set_draw_sensitive(&self, draw_sensitive: bool)

Sets whether @self should draw all of its cells in a sensitive state, this is used by ComboBox menus to ensure that rows with insensitive cells that contain children appear sensitive in the parent menu item.

Deprecated since 4.10

draw_sensitive

whether to draw all cells in a sensitive state.

pub fn set_fit_model(&self, fit_model: bool)

Sets whether @self should request space to fit the entire TreeModel.

This is used by ComboBox to ensure that the cell view displayed on the combo box’s button always gets enough space and does not resize when selection changes.

Deprecated since 4.10

fit_model

whether @self should request space for the whole model.

pub fn set_model(&self, model: Option<&impl IsA<TreeModel>>)

Sets the model for @self. If @self already has a model set, it will remove it before setting the new model. If @model is None, then it will unset the old model.

Deprecated since 4.10

model

a TreeModel

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

The CellArea rendering cells

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

since 3.0

pub fn cell_area_context(&self) -> Option<CellAreaContext>

The CellAreaContext used to compute the geometry of the cell view.

A group of cell views can be assigned the same context in order to ensure the sizes and cell alignments match across all the views with the same context.

ComboBox menus uses this to assign the same context to all cell views in the menu items for a single menu (each submenu creates its own context since the size of each submenu does not depend on parent or sibling menus).

since 3.0

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

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

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

Trait Implementations

impl Clone for CellView

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 CellView

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

Formats the value using the given formatter.

impl Default for CellView

fn default() -> Self

Returns the “default value” for a type.

impl Display for CellView

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

Formats the value using the given formatter.

impl HasParamSpec for CellView

type ParamSpec = ParamSpecObject

type SetValue = CellView

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for CellView

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

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 CellView

type Parent = Widget

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

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 CellView

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 CellView

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for CellView

impl IsA<Accessible> for CellView

impl IsA<Buildable> for CellView

impl IsA<CellLayout> for CellView

impl IsA<ConstraintTarget> for CellView

impl IsA<Orientable> for CellView

impl IsA<Widget> for CellView