Gtk.CellView

Subclasses:

None

Methods

Inherited:

Gtk.Widget (181), GObject.Object (37), Gtk.Accessible (15), Gtk.Buildable (1), Gtk.CellLayout (9), Gtk.Orientable (2)

Structs:

Gtk.WidgetClass (18), GObject.ObjectClass (5)

class	new ()
class	new_with_context (area, context)
class	new_with_markup (markup)
class	new_with_text (text)
class	new_with_texture (texture)
	get_displayed_row ()
	get_draw_sensitive ()
	get_fit_model ()
	get_model ()
	set_displayed_row (path)
	set_draw_sensitive (draw_sensitive)
	set_fit_model (fit_model)
	set_model (model)

Virtual Methods

Inherited:

Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9), Gtk.CellLayout (9)

Properties

Inherited:

Gtk.Widget (34), Gtk.Accessible (1), Gtk.Orientable (1)

Name	Type	Flags	Short Description
cell-area	Gtk.CellArea	r/w/co
cell-area-context	Gtk.CellAreaContext	r/w/co
draw-sensitive	bool	r/w/en
fit-model	bool	r/w/en
model	Gtk.TreeModel	r/w

Signals

Inherited:

Gtk.Widget (13), GObject.Object (1)

Fields

Inherited:

Gtk.Widget (13), GObject.Object (1)

Class Details

class Gtk.CellView(**kwargs)

Bases:

Gtk.Widget, Gtk.CellLayout, Gtk.Orientable

Abstract:

No

A widget displaying a single row of a Gtk.TreeModel

A GtkCellView displays a single row of a GtkTreeModel using a GtkCellArea and GtkCellAreaContext. A GtkCellAreaContext can be provided to the GtkCellView 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 GtkComboBox).

GtkCellView is GtkOrientable in order to decide in which orientation the underlying GtkCellAreaContext should be allocated. Taking the GtkComboBox 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

Gtk.CellView has a single CSS node with name cellview.

Deprecated since version 4.10: List views use widgets to display their contents. You can use [class`Gtk`.Box] instead

classmethod new()

Returns:

A newly created GtkCellView widget.

Return type:

Gtk.Widget

Creates a new GtkCellView widget.

Deprecated since version 4.10.

classmethod new_with_context(area, context)

Parameters:

• area (Gtk.CellArea) – the GtkCellArea to layout cells

• context (Gtk.CellAreaContext) – the GtkCellAreaContext in which to calculate cell geometry

Returns:

A newly created GtkCellView widget.

Return type:

Gtk.Widget

Creates a new GtkCellView widget with a specific GtkCellArea to layout cells and a specific GtkCellAreaContext.

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 version 4.10.

classmethod new_with_markup(markup)

Parameters:

markup (str) – the text to display in the cell view

Returns:

A newly created GtkCellView widget.

Return type:

Gtk.Widget

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

Deprecated since version 4.10.

classmethod new_with_text(text)

Parameters:

text (str) – the text to display in the cell view

Returns:

A newly created GtkCellView widget.

Return type:

Gtk.Widget

Creates a new GtkCellView widget, adds a GtkCellRendererText to it, and makes it show text.

Deprecated since version 4.10.

classmethod new_with_texture(texture)

Parameters:

texture (Gdk.Texture) – the image to display in the cell view

Returns:

A newly created GtkCellView widget.

Return type:

Gtk.Widget

Creates a new GtkCellView widget, adds a GtkCellRendererPixbuf to it, and makes it show texture.

Deprecated since version 4.10.

get_displayed_row()

Returns:

the currently displayed row

Return type:

Gtk.TreePath or None

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

Deprecated since version 4.10.

get_draw_sensitive()

Returns:

whether self draws all of its cells in a sensitive state

Return type:

bool

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

Deprecated since version 4.10.

get_fit_model()

Returns:

whether self requests space to fit the entire GtkTreeModel.

Return type:

bool

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

Deprecated since version 4.10.

get_model()

Returns:

a GtkTreeModel used

Return type:

Gtk.TreeModel or None

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

Deprecated since version 4.10.

set_displayed_row(path)

Parameters:

path (Gtk.TreePath or None) – a GtkTreePath or None to unset.

Sets the row of the model that is currently displayed by the GtkCellView. 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 GtkCellView becomes temporarily empty.

Deprecated since version 4.10.

set_draw_sensitive(draw_sensitive)

Parameters:

draw_sensitive (bool) – whether to draw all cells in a sensitive state.

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

Deprecated since version 4.10.

set_fit_model(fit_model)

Parameters:

fit_model (bool) – whether self should request space for the whole model.

Sets whether self should request space to fit the entire GtkTreeModel.

This is used by GtkComboBox 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 version 4.10.

set_model(model)

Parameters:

model (Gtk.TreeModel or None) – a GtkTreeModel

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 version 4.10.

Property Details

Gtk.CellView.props.cell_area

Name:

cell-area

Type:

Gtk.CellArea

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The GtkCellArea rendering cells

If no area is specified when creating the cell view with Gtk.CellView.new_with_context() a horizontally oriented ``GtkCellArea``Box will be used.

since 3.0

Gtk.CellView.props.cell_area_context

Name:

cell-area-context

Type:

Gtk.CellAreaContext

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The GtkCellAreaContext 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.

GtkComboBox 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

Gtk.CellView.props.draw_sensitive

Name:

draw-sensitive

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Gtk.CellView.props.fit_model

Name:

fit-model

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Gtk.CellView.props.model

Name:

model

Type:

Gtk.TreeModel

Default Value:

None

Flags:

READABLE, WRITABLE

The model for cell view

since 2.10