Gtk.CellArea¶

class — extends GObject.InitiallyUnowned, Buildable, CellLayout

:::warning Deprecated since 4.10 This API is deprecated. :::

An abstract class for laying out GtkCellRenderers

The GtkCellArea is an abstract class for CellLayout widgets (also referred to as "layouting widgets") to interface with an arbitrary number of CellRenderers and interact with the user for a given TreeModel row.

The cell area handles events, focus navigation, drawing and size requests and allocations for a given row of data.

Usually users dont have to interact with the GtkCellArea directly unless they are implementing a cell-layouting widget themselves.

Requesting area sizes¶

As outlined in GtkWidget’s geometry management section, GTK uses a height-for-width geometry management system to compute the sizes of widgets and user interfaces. GtkCellArea uses the same semantics to calculate the size of an area for an arbitrary number of GtkTreeModel rows.

When requesting the size of a cell area one needs to calculate the size for a handful of rows, and this will be done differently by different layouting widgets. For instance a TreeViewColumn always lines up the areas from top to bottom while a IconView on the other hand might enforce that all areas received the same width and wrap the areas around, requesting height for more cell areas when allocated less width.

It’s also important for areas to maintain some cell alignments with areas rendered for adjacent rows (cells can appear “columnized” inside an area even when the size of cells are different in each row). For this reason the GtkCellArea uses a CellAreaContext object to store the alignments and sizes along the way (as well as the overall largest minimum and natural size for all the rows which have been calculated with the said context).

The CellAreaContext is an opaque object specific to the GtkCellArea which created it (see CellArea.create_context).

The owning cell-layouting widget can create as many contexts as it wishes to calculate sizes of rows which should receive the same size in at least one orientation (horizontally or vertically), However, it’s important that the same CellAreaContext which was used to request the sizes for a given GtkTreeModel row be used when rendering or processing events for that row.

In order to request the width of all the rows at the root level of a GtkTreeModel one would do the following:

GtkTreeIter iter;
int minimum_width;
int natural_width;

valid = gtk_tree_model_get_iter_first (model, &iter);
while (valid)
  {
    gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
    gtk_cell_area_get_preferred_width (area, context, widget, NULL, NULL);

    valid = gtk_tree_model_iter_next (model, &iter);
  }

gtk_cell_area_context_get_preferred_width (context, &minimum_width, &natural_width);

Note that in this example it’s not important to observe the returned minimum and natural width of the area for each row unless the cell-layouting object is actually interested in the widths of individual rows. The overall width is however stored in the accompanying GtkCellAreaContext object and can be consulted at any time.

This can be useful since GtkCellLayout widgets usually have to support requesting and rendering rows in treemodels with an exceedingly large amount of rows. The GtkCellLayout widget in that case would calculate the required width of the rows in an idle or timeout source (see GLib.timeout_add) and when the widget is requested its actual width in Widget.measure it can simply consult the width accumulated so far in the GtkCellAreaContext object.

A simple example where rows are rendered from top to bottom and take up the full width of the layouting widget would look like:

static void
foo_get_preferred_width (GtkWidget *widget,
                         int       *minimum_size,
                         int       *natural_size)
{
  Foo *self = FOO (widget);
  FooPrivate *priv = foo_get_instance_private (self);

  foo_ensure_at_least_one_handfull_of_rows_have_been_requested (self);

  gtk_cell_area_context_get_preferred_width (priv->context, minimum_size, natural_size);
}

In the above example the Foo widget has to make sure that some row sizes have been calculated (the amount of rows that Foo judged was appropriate to request space for in a single timeout iteration) before simply returning the amount of space required by the area via the GtkCellAreaContext.

Requesting the height for width (or width for height) of an area is a similar task except in this case the GtkCellAreaContext does not store the data (actually, it does not know how much space the layouting widget plans to allocate it for every row. It’s up to the layouting widget to render each row of data with the appropriate height and width which was requested by the GtkCellArea).

In order to request the height for width of all the rows at the root level of a GtkTreeModel one would do the following:

GtkTreeIter iter;
int minimum_height;
int natural_height;
int full_minimum_height = 0;
int full_natural_height = 0;

valid = gtk_tree_model_get_iter_first (model, &iter);
while (valid)
  {
    gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
    gtk_cell_area_get_preferred_height_for_width (area, context, widget,
                                                  width, &minimum_height, &natural_height);

    if (width_is_for_allocation)
       cache_row_height (&iter, minimum_height, natural_height);

    full_minimum_height += minimum_height;
    full_natural_height += natural_height;

    valid = gtk_tree_model_iter_next (model, &iter);
  }

Note that in the above example we would need to cache the heights returned for each row so that we would know what sizes to render the areas for each row. However we would only want to really cache the heights if the request is intended for the layouting widgets real allocation.

In some cases the layouting widget is requested the height for an arbitrary for_width, this is a special case for layouting widgets who need to request size for tens of thousands of rows. For this case it’s only important that the layouting widget calculate one reasonably sized chunk of rows and return that height synchronously. The reasoning here is that any layouting widget is at least capable of synchronously calculating enough height to fill the screen height (or scrolled window height) in response to a single call to Widget.measure. Returning a perfect height for width that is larger than the screen area is inconsequential since after the layouting receives an allocation from a scrolled window it simply continues to drive the scrollbar values while more and more height is required for the row heights that are calculated in the background.

Rendering Areas¶

Once area sizes have been acquired at least for the rows in the visible area of the layouting widget they can be rendered at Widget.snapshot time.

A crude example of how to render all the rows at the root level runs as follows:

GtkAllocation allocation;
GdkRectangle cell_area = { 0, };
GtkTreeIter iter;
int minimum_width;
int natural_width;

gtk_widget_get_allocation (widget, &allocation);
cell_area.width = allocation.width;

valid = gtk_tree_model_get_iter_first (model, &iter);
while (valid)
  {
    cell_area.height = get_cached_height_for_row (&iter);

    gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
    gtk_cell_area_render (area, context, widget, cr,
                          &cell_area, &cell_area, state_flags, FALSE);

    cell_area.y += cell_area.height;

    valid = gtk_tree_model_iter_next (model, &iter);
  }

Note that the cached height in this example really depends on how the layouting widget works. The layouting widget might decide to give every row its minimum or natural height or, if the model content is expected to fit inside the layouting widget without scrolling, it would make sense to calculate the allocation for each row at the time the widget is allocated using distribute_natural_allocation.

Handling Events and Driving Keyboard Focus¶

Passing events to the area is as simple as handling events on any normal widget and then passing them to the CellArea.event API as they come in. Usually GtkCellArea is only interested in button events, however some customized derived areas can be implemented who are interested in handling other events. Handling an event can trigger the CellArea.focus-changed signal to fire; as well as CellArea.add-editable in the case that an editable cell was clicked and needs to start editing. You can call CellArea.stop_editing at any time to cancel any cell editing that is currently in progress.

The GtkCellArea drives keyboard focus from cell to cell in a way similar to GtkWidget. For layouting widgets that support giving focus to cells it’s important to remember to pass GTK_CELL_RENDERER_FOCUSED to the area functions for the row that has focus and to tell the area to paint the focus at render time.

Layouting widgets that accept focus on cells should implement the Widget.focus virtual method. The layouting widget is always responsible for knowing where GtkTreeModel rows are rendered inside the widget, so at Widget.focus time the layouting widget should use the GtkCellArea methods to navigate focus inside the area and then observe the DirectionType to pass the focus to adjacent rows and areas.

A basic example of how the Widget.focus virtual method should be implemented:

static gboolean
foo_focus (GtkWidget       *widget,
           GtkDirectionType direction)
{
  Foo *self = FOO (widget);
  FooPrivate *priv = foo_get_instance_private (self);
  int focus_row = priv->focus_row;
  gboolean have_focus = FALSE;

  if (!gtk_widget_has_focus (widget))
    gtk_widget_grab_focus (widget);

  valid = gtk_tree_model_iter_nth_child (priv->model, &iter, NULL, priv->focus_row);
  while (valid)
    {
      gtk_cell_area_apply_attributes (priv->area, priv->model, &iter, FALSE, FALSE);

      if (gtk_cell_area_focus (priv->area, direction))
        {
           priv->focus_row = focus_row;
           have_focus = TRUE;
           break;
        }
      else
        {
          if (direction == GTK_DIR_RIGHT ||
              direction == GTK_DIR_LEFT)
            break;
          else if (direction == GTK_DIR_UP ||
                   direction == GTK_DIR_TAB_BACKWARD)
           {
              if (focus_row == 0)
                break;
              else
               {
                  focus_row--;
                  valid = gtk_tree_model_iter_nth_child (priv->model, &iter, NULL, focus_row);
               }
            }
          else
            {
              if (focus_row == last_row)
                break;
              else
                {
                  focus_row++;
                  valid = gtk_tree_model_iter_next (priv->model, &iter);
                }
            }
        }
    }
    return have_focus;
}

Note that the layouting widget is responsible for matching the GtkDirectionType values to the way it lays out its cells.

Cell Properties¶

The GtkCellArea introduces cell properties for GtkCellRenderers. This provides some general interfaces for defining the relationship cell areas have with their cells. For instance in a CellAreaBox a cell might “expand” and receive extra space when the area is allocated more than its full natural request, or a cell might be configured to “align” with adjacent rows which were requested and rendered with the same GtkCellAreaContext.

Use CellAreaClass.install_cell_property to install cell properties for a cell area class and CellAreaClass.find_cell_property or CellAreaClass.list_cell_properties to get information about existing cell properties.

To set the value of a cell property, use CellArea.cell_set_property, CellArea.cell_set or CellArea.cell_set_valist. To obtain the value of a cell property, use CellArea.cell_get_property CellArea.cell_get or CellArea.cell_get_valist.

Methods¶

activate¶

def activate(self, context: CellAreaContext, widget: Widget, cell_area: Gdk.Rectangle, flags: CellRendererState | int, edit_only: bool) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

Activates area, usually by activating the currently focused cell, however some subclasses which embed widgets in the area can also activate a widget if it currently has the focus.

Parameters:

context — the GtkCellAreaContext in context with the current row data
widget — the GtkWidget that area is rendering on
cell_area — the size and location of area relative to widget’s allocation
flags — the GtkCellRendererState flags for area for this row of data.
edit_only — if True then only cell renderers that are CellRendererMode.EDITABLE will be activated.

activate_cell¶

def activate_cell(self, widget: Widget, renderer: CellRenderer, event: Gdk.Event, cell_area: Gdk.Rectangle, flags: CellRendererState | int) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

This is used by GtkCellArea subclasses when handling events to activate cells, the base GtkCellArea class activates cells for keyboard events for free in its own GtkCellArea->activate() implementation.

Parameters:

widget — the GtkWidget that area is rendering onto
renderer — the GtkCellRenderer in area to activate
event — the GdkEvent for which cell activation should occur
cell_area — the GdkRectangle in widget relative coordinates of renderer for the current row.
flags — the GtkCellRendererState for renderer

add¶

def add(self, renderer: CellRenderer) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Adds renderer to area with the default child cell properties.

Parameters:

renderer — the GtkCellRenderer to add to area

add_focus_sibling¶

def add_focus_sibling(self, renderer: CellRenderer, sibling: CellRenderer) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Adds sibling to renderer’s focusable area, focus will be drawn around renderer and all of its siblings if renderer can focus for a given row.

Events handled by focus siblings can also activate the given focusable renderer.

Parameters:

renderer — the GtkCellRenderer expected to have focus
sibling — the GtkCellRenderer to add to renderer’s focus area

apply_attributes¶

def apply_attributes(self, tree_model: TreeModel, iter: TreeIter, is_expander: bool, is_expanded: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Applies any connected attributes to the renderers in area by pulling the values from tree_model.

Parameters:

tree_model — the GtkTreeModel to pull values from
iter — the GtkTreeIter in tree_model to apply values for
is_expander — whether iter has children
is_expanded — whether iter is expanded in the view and children are visible

attribute_connect¶

def attribute_connect(self, renderer: CellRenderer, attribute: str, column: int) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Connects an attribute to apply values from column for the GtkTreeModel in use.

Parameters:

renderer — the GtkCellRenderer to connect an attribute for
attribute — the attribute name
column — the GtkTreeModel column to fetch attribute values from

attribute_disconnect¶

def attribute_disconnect(self, renderer: CellRenderer, attribute: str) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Disconnects attribute for the renderer in area so that attribute will no longer be updated with values from the model.

Parameters:

renderer — the GtkCellRenderer to disconnect an attribute for
attribute — the attribute name

attribute_get_column¶

def attribute_get_column(self, renderer: CellRenderer, attribute: str) -> int

:::warning Deprecated since 4.10 This API is deprecated. :::

Returns the model column that an attribute has been mapped to, or -1 if the attribute is not mapped.

Parameters:

renderer — a GtkCellRenderer
attribute — an attribute on the renderer

cell_get_property¶

def cell_get_property(self, renderer: CellRenderer, property_name: str, value: GObject.Value) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Gets the value of a cell property for renderer in area.

Parameters:

renderer — a GtkCellRenderer inside area
property_name — the name of the property to get
value — a location to return the value

cell_set_property¶

def cell_set_property(self, renderer: CellRenderer, property_name: str, value: GObject.Value) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Sets a cell property for renderer in area.

Parameters:

renderer — a GtkCellRenderer inside area
property_name — the name of the cell property to set
value — the value to set the cell property to

copy_context¶

def copy_context(self, context: CellAreaContext) -> CellAreaContext

:::warning Deprecated since 4.10 This API is deprecated. :::

This is sometimes needed for cases where rows need to share alignments in one orientation but may be separately grouped in the opposing orientation.

For instance, GtkIconView creates all icons (rows) to have the same width and the cells theirin to have the same horizontal alignments. However each row of icons may have a separate collective height. GtkIconView uses this to request the heights of each row based on a context which was already used to request all the row widths that are to be displayed.

Parameters:

context — the GtkCellAreaContext to copy

create_context¶

def create_context(self) -> CellAreaContext

:::warning Deprecated since 4.10 This API is deprecated. :::

Creates a GtkCellAreaContext to be used with area for all purposes. GtkCellAreaContext stores geometry information for rows for which it was operated on, it is important to use the same context for the same row of data at all times (i.e. one should render and handle events with the same GtkCellAreaContext which was used to request the size of those rows of data).

event¶

def event(self, context: CellAreaContext, widget: Widget, event: Gdk.Event, cell_area: Gdk.Rectangle, flags: CellRendererState | int) -> int

:::warning Deprecated since 4.10 This API is deprecated. :::

Delegates event handling to a GtkCellArea.

Parameters:

context — the GtkCellAreaContext for this row of data.
widget — the GtkWidget that area is rendering to
event — the GdkEvent to handle
cell_area — the widget relative coordinates for area
flags — the GtkCellRendererState for area in this row.

focus¶

def focus(self, direction: DirectionType | int) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

This should be called by the area’s owning layout widget when focus is to be passed to area, or moved within area for a given direction and row data.

Implementing GtkCellArea classes should implement this method to receive and navigate focus in its own way particular to how it lays out cells.

Parameters:

direction — the GtkDirectionType

foreach¶

def foreach(self, callback: CellCallback) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Calls callback for every GtkCellRenderer in area.

Parameters:

callback — the GtkCellCallback to call

foreach_alloc¶

def foreach_alloc(self, context: CellAreaContext, widget: Widget, cell_area: Gdk.Rectangle, background_area: Gdk.Rectangle, callback: CellAllocCallback) -> None

Calls callback for every GtkCellRenderer in area with the allocated rectangle inside cell_area.

Parameters:

context — the GtkCellAreaContext for this row of data.
widget — the GtkWidget that area is rendering to
cell_area — the widget relative coordinates and size for area
background_area — the widget relative coordinates of the background area
callback — the GtkCellAllocCallback to call

get_cell_allocation¶

def get_cell_allocation(self, context: CellAreaContext, widget: Widget, renderer: CellRenderer, cell_area: Gdk.Rectangle) -> Gdk.Rectangle

:::warning Deprecated since 4.10 This API is deprecated. :::

Derives the allocation of renderer inside area if area were to be rendered in cell_area.

Parameters:

context — the GtkCellAreaContext used to hold sizes for area.
widget — the GtkWidget that area is rendering on
renderer — the GtkCellRenderer to get the allocation for
cell_area — the whole allocated area for area in widget for this row

get_cell_at_position¶

def get_cell_at_position(self, context: CellAreaContext, widget: Widget, cell_area: Gdk.Rectangle, x: int, y: int) -> tuple[CellRenderer, Gdk.Rectangle]

:::warning Deprecated since 4.10 This API is deprecated. :::

Gets the GtkCellRenderer at x and y coordinates inside area and optionally returns the full cell allocation for it inside cell_area.

Parameters:

context — the GtkCellAreaContext used to hold sizes for area.
widget — the GtkWidget that area is rendering on
cell_area — the whole allocated area for area in widget for this row
x — the x position
y — the y position

get_current_path_string¶

def get_current_path_string(self) -> str

Gets the current GtkTreePath string for the currently applied GtkTreeIter, this is implicitly updated when CellArea.apply_attributes is called and can be used to interact with renderers from GtkCellArea subclasses.

get_edit_widget¶

def get_edit_widget(self) -> CellEditable | None

:::warning Deprecated since 4.10 This API is deprecated. :::

Gets the GtkCellEditable widget currently used to edit the currently edited cell.

get_edited_cell¶

def get_edited_cell(self) -> CellRenderer | None

:::warning Deprecated since 4.10 This API is deprecated. :::

Gets the GtkCellRenderer in area that is currently being edited.

get_focus_cell¶

def get_focus_cell(self) -> CellRenderer | None

:::warning Deprecated since 4.10 This API is deprecated. :::

Retrieves the currently focused cell for area

get_focus_from_sibling¶

def get_focus_from_sibling(self, renderer: CellRenderer) -> CellRenderer | None

:::warning Deprecated since 4.10 This API is deprecated. :::

Gets the GtkCellRenderer which is expected to be focusable for which renderer is, or may be a sibling.

This is handy for GtkCellArea subclasses when handling events, after determining the renderer at the event location it can then chose to activate the focus cell for which the event cell may have been a sibling.

Parameters:

renderer — the GtkCellRenderer

get_focus_siblings¶

def get_focus_siblings(self, renderer: CellRenderer) -> list[CellRenderer]

:::warning Deprecated since 4.10 This API is deprecated. :::

Gets the focus sibling cell renderers for renderer.

Parameters:

renderer — the GtkCellRenderer expected to have focus

get_preferred_height¶

def get_preferred_height(self, context: CellAreaContext, widget: Widget) -> tuple[int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

Retrieves a cell area’s initial minimum and natural height.

area will store some geometrical information in context along the way; when requesting sizes over an arbitrary number of rows, it’s not important to check the minimum_height and natural_height of this call but rather to consult CellAreaContext.get_preferred_height after a series of requests.

Parameters:

context — the GtkCellAreaContext to perform this request with
widget — the GtkWidget where area will be rendering

get_preferred_height_for_width¶

def get_preferred_height_for_width(self, context: CellAreaContext, widget: Widget, width: int) -> tuple[int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

Retrieves a cell area’s minimum and natural height if it would be given the specified width.

area stores some geometrical information in context along the way while calling CellArea.get_preferred_width. It’s important to perform a series of CellArea.get_preferred_width requests with context first and then call CellArea.get_preferred_height_for_width on each cell area individually to get the height for width of each fully requested row.

If at some point, the width of a single row changes, it should be requested with CellArea.get_preferred_width again and then the full width of the requested rows checked again with CellAreaContext.get_preferred_width.

Parameters:

context — the GtkCellAreaContext which has already been requested for widths.
widget — the GtkWidget where area will be rendering
width — the width for which to check the height of this area

get_preferred_width¶

def get_preferred_width(self, context: CellAreaContext, widget: Widget) -> tuple[int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

Retrieves a cell area’s initial minimum and natural width.

area will store some geometrical information in context along the way; when requesting sizes over an arbitrary number of rows, it’s not important to check the minimum_width and natural_width of this call but rather to consult CellAreaContext.get_preferred_width after a series of requests.

Parameters:

context — the GtkCellAreaContext to perform this request with
widget — the GtkWidget where area will be rendering

get_preferred_width_for_height¶

def get_preferred_width_for_height(self, context: CellAreaContext, widget: Widget, height: int) -> tuple[int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

Retrieves a cell area’s minimum and natural width if it would be given the specified height.

area stores some geometrical information in context along the way while calling CellArea.get_preferred_height. It’s important to perform a series of CellArea.get_preferred_height requests with context first and then call CellArea.get_preferred_width_for_height on each cell area individually to get the height for width of each fully requested row.

If at some point, the height of a single row changes, it should be requested with CellArea.get_preferred_height again and then the full height of the requested rows checked again with CellAreaContext.get_preferred_height.

Parameters:

context — the GtkCellAreaContext which has already been requested for widths.
widget — the GtkWidget where area will be rendering
height — the height for which to check the width of this area

get_request_mode¶

def get_request_mode(self) -> SizeRequestMode

Gets whether the area prefers a height-for-width layout or a width-for-height layout.

has_renderer¶

def has_renderer(self, renderer: CellRenderer) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

Checks if area contains renderer.

Parameters:

renderer — the GtkCellRenderer to check

inner_cell_area¶

def inner_cell_area(self, widget: Widget, cell_area: Gdk.Rectangle) -> Gdk.Rectangle

:::warning Deprecated since 4.10 This API is deprecated. :::

This is a convenience function for GtkCellArea implementations to get the inner area where a given GtkCellRenderer will be rendered. It removes any padding previously added by CellArea.request_renderer.

Parameters:

widget — the GtkWidget that area is rendering onto
cell_area — the widget relative coordinates where one of area’s cells is to be placed

is_activatable¶

def is_activatable(self) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

Returns whether the area can do anything when activated, after applying new attributes to area.

is_focus_sibling¶

def is_focus_sibling(self, renderer: CellRenderer, sibling: CellRenderer) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

Returns whether sibling is one of renderer’s focus siblings (see CellArea.add_focus_sibling).

Parameters:

renderer — the GtkCellRenderer expected to have focus
sibling — the GtkCellRenderer to check against renderer’s sibling list

remove¶

def remove(self, renderer: CellRenderer) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Removes renderer from area.

Parameters:

renderer — the GtkCellRenderer to remove from area

remove_focus_sibling¶

def remove_focus_sibling(self, renderer: CellRenderer, sibling: CellRenderer) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Removes sibling from renderer’s focus sibling list (see CellArea.add_focus_sibling).

Parameters:

renderer — the GtkCellRenderer expected to have focus
sibling — the GtkCellRenderer to remove from renderer’s focus area

request_renderer¶

def request_renderer(self, renderer: CellRenderer, orientation: Orientation | int, widget: Widget, for_size: int) -> tuple[int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

This is a convenience function for GtkCellArea implementations to request size for cell renderers. It’s important to use this function to request size and then use CellArea.inner_cell_area at render and event time since this function will add padding around the cell for focus painting.

Parameters:

renderer — the GtkCellRenderer to request size for
orientation — the GtkOrientation in which to request size
widget — the GtkWidget that area is rendering onto
for_size — the allocation contextual size to request for, or -1 if the base request for the orientation is to be returned.

set_focus_cell¶

def set_focus_cell(self, renderer: CellRenderer | None = ...) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Explicitly sets the currently focused cell to renderer.

This is generally called by implementations of GtkCellAreaClass.focus() or GtkCellAreaClass.event(), however it can also be used to implement functions such as TreeView.set_cursor_on_cell.

Parameters:

renderer — the GtkCellRenderer to give focus to

snapshot¶

def snapshot(self, context: CellAreaContext, widget: Widget, snapshot: Snapshot, background_area: Gdk.Rectangle, cell_area: Gdk.Rectangle, flags: CellRendererState | int, paint_focus: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Snapshots area’s cells according to area’s layout onto at the given coordinates.

Parameters:

context — the GtkCellAreaContext for this row of data.
widget — the GtkWidget that area is rendering to
snapshot — the GtkSnapshot to draw to
background_area — the widget relative coordinates for area’s background
cell_area — the widget relative coordinates for area
flags — the GtkCellRendererState for area in this row.
paint_focus — whether area should paint focus on focused cells for focused rows or not.

stop_editing¶

def stop_editing(self, canceled: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Explicitly stops the editing of the currently edited cell.

If canceled is True, the currently edited cell renderer will emit the ::editing-canceled signal, otherwise the the ::editing-done signal will be emitted on the current edit widget.

See CellArea.get_edited_cell and CellArea.get_edit_widget.

Parameters:

canceled — whether editing was canceled.

Virtual methods¶

do_activate¶

def do_activate(self, context: CellAreaContext, widget: Widget, cell_area: Gdk.Rectangle, flags: CellRendererState | int, edit_only: bool) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

Activates area, usually by activating the currently focused cell, however some subclasses which embed widgets in the area can also activate a widget if it currently has the focus.

Parameters:

context — the GtkCellAreaContext in context with the current row data
widget — the GtkWidget that area is rendering on
cell_area — the size and location of area relative to widget’s allocation
flags — the GtkCellRendererState flags for area for this row of data.
edit_only — if True then only cell renderers that are CellRendererMode.EDITABLE will be activated.

do_add¶

def do_add(self, renderer: CellRenderer) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Adds renderer to area with the default child cell properties.

Parameters:

renderer — the GtkCellRenderer to add to area

do_apply_attributes¶

def do_apply_attributes(self, tree_model: TreeModel, iter: TreeIter, is_expander: bool, is_expanded: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Applies any connected attributes to the renderers in area by pulling the values from tree_model.

Parameters:

tree_model — the GtkTreeModel to pull values from
iter — the GtkTreeIter in tree_model to apply values for
is_expander — whether iter has children
is_expanded — whether iter is expanded in the view and children are visible

do_copy_context¶

def do_copy_context(self, context: CellAreaContext) -> CellAreaContext

:::warning Deprecated since 4.10 This API is deprecated. :::

This is sometimes needed for cases where rows need to share alignments in one orientation but may be separately grouped in the opposing orientation.

For instance, GtkIconView creates all icons (rows) to have the same width and the cells theirin to have the same horizontal alignments. However each row of icons may have a separate collective height. GtkIconView uses this to request the heights of each row based on a context which was already used to request all the row widths that are to be displayed.

Parameters:

context — the GtkCellAreaContext to copy

do_create_context¶

def do_create_context(self) -> CellAreaContext

:::warning Deprecated since 4.10 This API is deprecated. :::

Creates a GtkCellAreaContext to be used with area for all purposes. GtkCellAreaContext stores geometry information for rows for which it was operated on, it is important to use the same context for the same row of data at all times (i.e. one should render and handle events with the same GtkCellAreaContext which was used to request the size of those rows of data).

do_event¶

def do_event(self, context: CellAreaContext, widget: Widget, event: Gdk.Event, cell_area: Gdk.Rectangle, flags: CellRendererState | int) -> int

:::warning Deprecated since 4.10 This API is deprecated. :::

Delegates event handling to a GtkCellArea.

Parameters:

context — the GtkCellAreaContext for this row of data.
widget — the GtkWidget that area is rendering to
event — the GdkEvent to handle
cell_area — the widget relative coordinates for area
flags — the GtkCellRendererState for area in this row.

do_focus¶

def do_focus(self, direction: DirectionType | int) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

This should be called by the area’s owning layout widget when focus is to be passed to area, or moved within area for a given direction and row data.

Implementing GtkCellArea classes should implement this method to receive and navigate focus in its own way particular to how it lays out cells.

Parameters:

direction — the GtkDirectionType

do_foreach¶

def do_foreach(self, callback: CellCallback) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Calls callback for every GtkCellRenderer in area.

Parameters:

callback — the GtkCellCallback to call

do_foreach_alloc¶

def do_foreach_alloc(self, context: CellAreaContext, widget: Widget, cell_area: Gdk.Rectangle, background_area: Gdk.Rectangle, callback: CellAllocCallback) -> None

Calls callback for every GtkCellRenderer in area with the allocated rectangle inside cell_area.

Parameters:

context — the GtkCellAreaContext for this row of data.
widget — the GtkWidget that area is rendering to
cell_area — the widget relative coordinates and size for area
background_area — the widget relative coordinates of the background area
callback — the GtkCellAllocCallback to call

do_get_cell_property¶

def do_get_cell_property(self, renderer: CellRenderer, property_id: int, value: GObject.Value, pspec: GObject.ParamSpec) -> None

This should be implemented to report the values of child cell properties for a given child GtkCellRenderer.

do_get_preferred_height¶

def do_get_preferred_height(self, context: CellAreaContext, widget: Widget) -> tuple[int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

Retrieves a cell area’s initial minimum and natural height.

area will store some geometrical information in context along the way; when requesting sizes over an arbitrary number of rows, it’s not important to check the minimum_height and natural_height of this call but rather to consult CellAreaContext.get_preferred_height after a series of requests.

Parameters:

context — the GtkCellAreaContext to perform this request with
widget — the GtkWidget where area will be rendering

do_get_preferred_height_for_width¶

def do_get_preferred_height_for_width(self, context: CellAreaContext, widget: Widget, width: int) -> tuple[int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

Retrieves a cell area’s minimum and natural height if it would be given the specified width.

area stores some geometrical information in context along the way while calling CellArea.get_preferred_width. It’s important to perform a series of CellArea.get_preferred_width requests with context first and then call CellArea.get_preferred_height_for_width on each cell area individually to get the height for width of each fully requested row.

If at some point, the width of a single row changes, it should be requested with CellArea.get_preferred_width again and then the full width of the requested rows checked again with CellAreaContext.get_preferred_width.

Parameters:

context — the GtkCellAreaContext which has already been requested for widths.
widget — the GtkWidget where area will be rendering
width — the width for which to check the height of this area

do_get_preferred_width¶

def do_get_preferred_width(self, context: CellAreaContext, widget: Widget) -> tuple[int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

Retrieves a cell area’s initial minimum and natural width.

area will store some geometrical information in context along the way; when requesting sizes over an arbitrary number of rows, it’s not important to check the minimum_width and natural_width of this call but rather to consult CellAreaContext.get_preferred_width after a series of requests.

Parameters:

context — the GtkCellAreaContext to perform this request with
widget — the GtkWidget where area will be rendering

do_get_preferred_width_for_height¶

def do_get_preferred_width_for_height(self, context: CellAreaContext, widget: Widget, height: int) -> tuple[int, int]

:::warning Deprecated since 4.10 This API is deprecated. :::

Retrieves a cell area’s minimum and natural width if it would be given the specified height.

area stores some geometrical information in context along the way while calling CellArea.get_preferred_height. It’s important to perform a series of CellArea.get_preferred_height requests with context first and then call CellArea.get_preferred_width_for_height on each cell area individually to get the height for width of each fully requested row.

If at some point, the height of a single row changes, it should be requested with CellArea.get_preferred_height again and then the full height of the requested rows checked again with CellAreaContext.get_preferred_height.

Parameters:

context — the GtkCellAreaContext which has already been requested for widths.
widget — the GtkWidget where area will be rendering
height — the height for which to check the width of this area

do_get_request_mode¶

def do_get_request_mode(self) -> SizeRequestMode

Gets whether the area prefers a height-for-width layout or a width-for-height layout.

do_is_activatable¶

def do_is_activatable(self) -> bool

:::warning Deprecated since 4.10 This API is deprecated. :::

Returns whether the area can do anything when activated, after applying new attributes to area.

do_remove¶

def do_remove(self, renderer: CellRenderer) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Removes renderer from area.

Parameters:

renderer — the GtkCellRenderer to remove from area

do_set_cell_property¶

def do_set_cell_property(self, renderer: CellRenderer, property_id: int, value: GObject.Value, pspec: GObject.ParamSpec) -> None

This should be implemented to handle changes in child cell properties for a given GtkCellRenderer that were previously installed on the GtkCellAreaClass with CellAreaClass.install_cell_property.

do_snapshot¶

def do_snapshot(self, context: CellAreaContext, widget: Widget, snapshot: Snapshot, background_area: Gdk.Rectangle, cell_area: Gdk.Rectangle, flags: CellRendererState | int, paint_focus: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

Snapshots area’s cells according to area’s layout onto at the given coordinates.

Parameters:

context — the GtkCellAreaContext for this row of data.
widget — the GtkWidget that area is rendering to
snapshot — the GtkSnapshot to draw to
background_area — the widget relative coordinates for area’s background
cell_area — the widget relative coordinates for area
flags — the GtkCellRendererState for area in this row.
paint_focus — whether area should paint focus on focused cells for focused rows or not.

Properties¶

edit_widget¶

edit_widget: CellEditable  # read-only

The widget currently editing the edited cell

This property is read-only and only changes as a result of a call CellArea.activate_cell.

edited_cell¶

edited_cell: CellRenderer  # read-only

The cell in the area that is currently edited

This property is read-only and only changes as a result of a call CellArea.activate_cell.

focus_cell¶

focus_cell: CellRenderer  # read/write

The cell in the area that currently has focus

Signals¶

add-editable¶

def on_add_editable(self, renderer: CellRenderer, editable: CellEditable, cell_area: Gdk.Rectangle, path: str) -> None: ...

Indicates that editing has started on renderer and that editable should be added to the owning cell-layouting widget at cell_area.

apply-attributes¶

def on_apply_attributes(self, model: TreeModel, iter: TreeIter, is_expander: bool, is_expanded: bool) -> None: ...

This signal is emitted whenever applying attributes to area from model

focus-changed¶

def on_focus_changed(self, renderer: CellRenderer, path: str) -> None: ...

Indicates that focus changed on this area. This signal is emitted either as a result of focus handling or event handling.

It's possible that the signal is emitted even if the currently focused renderer did not change, this is because focus may change to the same renderer in the same cell area for a different row of data.

remove-editable¶

def on_remove_editable(self, renderer: CellRenderer, editable: CellEditable) -> None: ...

Indicates that editing finished on renderer and that editable should be removed from the owning cell-layouting widget.