:right-sidebar: True CellArea =================================================================== .. currentmodule:: gi.repository.Gtk .. deprecated:: 4.10 List views use widgets for displaying their contents .. class:: CellArea(**properties: ~typing.Any) :no-contents-entry: Superclasses: :class:`~gi.repository.GObject.InitiallyUnowned`, :class:`~gi.repository.GObject.Object` Subclasses: :class:`~gi.repository.Gtk.CellAreaBox` Implemented Interfaces: :class:`~gi.repository.Gtk.Buildable`, :class:`~gi.repository.Gtk.CellLayout` An abstract class for laying out ``GtkCellRenderer``'s The ``GtkCellArea`` is an abstract class for :obj:`~gi.repository.Gtk.CellLayout` widgets (also referred to as "layouting widgets") to interface with an arbitrary number of :obj:`~gi.repository.Gtk.CellRenderer`'s and interact with the user for a given :obj:`~gi.repository.Gtk.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 :obj:`~gi.repository.Gtk.TreeViewColumn` always lines up the areas from top to bottom while a :obj:`~gi.repository.Gtk.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 :obj:`~gi.repository.Gtk.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 :obj:`~gi.repository.Gtk.CellAreaContext` is an opaque object specific to the ``GtkCellArea`` which created it (see :obj:`~gi.repository.Gtk.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 :obj:`~gi.repository.Gtk.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: .. code-block:: :dedent: 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 :obj:`~gi.repository.GLib.timeout_add`) and when the widget is requested its actual width in :obj:`~gi.repository.Gtk.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: .. code-block:: :dedent: 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: .. code-block:: :dedent: 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 :obj:`~gi.repository.Gtk.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 :obj:`~gi.repository.Gtk.Widget.snapshot` time. A crude example of how to render all the rows at the root level runs as follows: .. code-block:: :dedent: 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 :obj:`~gi.repository.Gtk.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 :obj:`~gi.repository.Gtk.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 :obj:`~gi.repository.Gtk.CellArea.signals.focus_changed` signal to fire; as well as :obj:`~gi.repository.Gtk.CellArea.signals.add_editable` in the case that an editable cell was clicked and needs to start editing. You can call :obj:`~gi.repository.Gtk.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 :obj:`~gi.repository.Gtk.Widget.focus` virtual method. The layouting widget is always responsible for knowing where ``GtkTreeModel`` rows are rendered inside the widget, so at :obj:`~gi.repository.Gtk.Widget.focus` time the layouting widget should use the ``GtkCellArea`` methods to navigate focus inside the area and then observe the :obj:`~gi.repository.Gtk.DirectionType` to pass the focus to adjacent rows and areas. A basic example of how the :obj:`~gi.repository.Gtk.Widget.focus` virtual method should be implemented: .. code-block:: :dedent: 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 ``GtkCellRenderer``'s. This provides some general interfaces for defining the relationship cell areas have with their cells. For instance in a :obj:`~gi.repository.Gtk.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 :obj:`~gi.repository.Gtk.CellAreaClass.install_cell_property` to install cell properties for a cell area class and :obj:`~gi.repository.Gtk.CellAreaClass.find_cell_property` or :obj:`~gi.repository.Gtk.CellAreaClass.list_cell_properties` to get information about existing cell properties. To set the value of a cell property, use :obj:`~gi.repository.Gtk.CellArea.cell_set_property`, :obj:`~gi.repository.Gtk.CellArea.cell_set` or :obj:`~gi.repository.Gtk.CellArea.cell_set_valist`. To obtain the value of a cell property, use :obj:`~gi.repository.Gtk.CellArea.cell_get_property` :obj:`~gi.repository.Gtk.CellArea.cell_get` or :obj:`~gi.repository.Gtk.CellArea.cell_get_valist`. Methods ------- .. rst-class:: interim-class .. class:: CellArea :no-index: .. method:: activate(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget, cell_area: ~gi.repository.Gdk.Rectangle, flags: ~gi.repository.Gtk.CellRendererState, edit_only: bool) -> bool 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. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context in context with the current row data :param widget: the ``GtkWidget`` that ``area`` is rendering on :param cell_area: the size and location of ``area`` relative to ``widget``’s allocation :param flags: the ``GtkCellRenderer``State flags for ``area`` for this row of data. :param edit_only: if :const:`True` then only cell renderers that are :const:`~gi.repository.Gtk.CellRendererMode.EDITABLE` will be activated. .. method:: activate_cell(widget: ~gi.repository.Gtk.Widget, renderer: ~gi.repository.Gtk.CellRenderer, event: ~gi.repository.Gdk.Event, cell_area: ~gi.repository.Gdk.Rectangle, flags: ~gi.repository.Gtk.CellRendererState) -> bool 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. .. deprecated:: 4.10 Please do not use it in newly written code :param widget: the ``GtkWidget`` that ``area`` is rendering onto :param renderer: the ``GtkCellRenderer`` in ``area`` to activate :param event: the ``GdkEvent`` for which cell activation should occur :param cell_area: the ``GdkRectangle`` in ``widget`` relative coordinates of ``renderer`` for the current row. :param flags: the ``GtkCellRenderer``State for ``renderer`` .. method:: add(renderer: ~gi.repository.Gtk.CellRenderer) -> None Adds ``renderer`` to ``area`` with the default child cell properties. .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: the ``GtkCellRenderer`` to add to ``area`` .. method:: add_focus_sibling(renderer: ~gi.repository.Gtk.CellRenderer, sibling: ~gi.repository.Gtk.CellRenderer) -> None 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``. .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: the ``GtkCellRenderer`` expected to have focus :param sibling: the ``GtkCellRenderer`` to add to ``renderer``’s focus area .. method:: apply_attributes(tree_model: ~gi.repository.Gtk.TreeModel, iter: ~gi.repository.Gtk.TreeIter, is_expander: bool, is_expanded: bool) -> None Applies any connected attributes to the renderers in ``area`` by pulling the values from ``tree_model``. .. deprecated:: 4.10 Please do not use it in newly written code :param tree_model: the ``GtkTreeModel`` to pull values from :param iter: the ``GtkTreeIter`` in ``tree_model`` to apply values for :param is_expander: whether ``iter`` has children :param is_expanded: whether ``iter`` is expanded in the view and children are visible .. method:: attribute_connect(renderer: ~gi.repository.Gtk.CellRenderer, attribute: str, column: int) -> None Connects an ``attribute`` to apply values from ``column`` for the ``GtkTreeModel`` in use. .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: the ``GtkCellRenderer`` to connect an attribute for :param attribute: the attribute name :param column: the ``GtkTreeModel`` column to fetch attribute values from .. method:: attribute_disconnect(renderer: ~gi.repository.Gtk.CellRenderer, attribute: str) -> None Disconnects ``attribute`` for the ``renderer`` in ``area`` so that attribute will no longer be updated with values from the model. .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: the ``GtkCellRenderer`` to disconnect an attribute for :param attribute: the attribute name .. method:: attribute_get_column(renderer: ~gi.repository.Gtk.CellRenderer, attribute: str) -> int Returns the model column that an attribute has been mapped to, or -1 if the attribute is not mapped. .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: a ``GtkCellRenderer`` :param attribute: an attribute on the renderer .. method:: cell_get_property(renderer: ~gi.repository.Gtk.CellRenderer, property_name: str, value: ~typing.Any) -> None Gets the value of a cell property for ``renderer`` in ``area``. .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: a ``GtkCellRenderer`` inside ``area`` :param property_name: the name of the property to get :param value: a location to return the value .. method:: cell_set_property(renderer: ~gi.repository.Gtk.CellRenderer, property_name: str, value: ~typing.Any) -> None Sets a cell property for ``renderer`` in ``area``. .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: a ``GtkCellRenderer`` inside ``area`` :param property_name: the name of the cell property to set :param value: the value to set the cell property to .. method:: create_context() -> ~gi.repository.Gtk.CellAreaContext Creates a ``GtkCellArea``Context to be used with ``area`` for all purposes. ``GtkCellArea``Context 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 ``GtkCellArea``Context which was used to request the size of those rows of data). .. deprecated:: 4.10 Please do not use it in newly written code .. method:: event(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget, event: ~gi.repository.Gdk.Event, cell_area: ~gi.repository.Gdk.Rectangle, flags: ~gi.repository.Gtk.CellRendererState) -> int Delegates event handling to a ``GtkCellArea``. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context for this row of data. :param widget: the ``GtkWidget`` that ``area`` is rendering to :param event: the ``GdkEvent`` to handle :param cell_area: the ``widget`` relative coordinates for ``area`` :param flags: the ``GtkCellRenderer``State for ``area`` in this row. .. classmethod:: find_cell_property(property_name: str) -> ~gi.repository.GObject.ParamSpec :param property_name: .. method:: focus(direction: ~gi.repository.Gtk.DirectionType) -> bool 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. .. deprecated:: 4.10 Please do not use it in newly written code :param direction: the ``GtkDirectionType`` .. method:: foreach(callback: ~typing.Callable[[...], bool], *callback_data: ~typing.Any) -> None Calls ``callback`` for every ``GtkCellRenderer`` in ``area``. .. deprecated:: 4.10 Please do not use it in newly written code :param callback: the ``GtkCellCallback`` to call :param callback_data: user provided data pointer .. method:: foreach_alloc(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget, cell_area: ~gi.repository.Gdk.Rectangle, background_area: ~gi.repository.Gdk.Rectangle, callback: ~typing.Callable[[...], bool], *callback_data: ~typing.Any) -> None Calls ``callback`` for every ``GtkCellRenderer`` in ``area`` with the allocated rectangle inside ``cell_area``. :param context: the ``GtkCellArea``Context for this row of data. :param widget: the ``GtkWidget`` that ``area`` is rendering to :param cell_area: the ``widget`` relative coordinates and size for ``area`` :param background_area: the ``widget`` relative coordinates of the background area :param callback: the ``GtkCellAllocCallback`` to call :param callback_data: user provided data pointer .. method:: get_cell_allocation(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget, renderer: ~gi.repository.Gtk.CellRenderer, cell_area: ~gi.repository.Gdk.Rectangle) -> ~gi.repository.Gdk.Rectangle Derives the allocation of ``renderer`` inside ``area`` if ``area`` were to be rendered in ``cell_area``. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context used to hold sizes for ``area``. :param widget: the ``GtkWidget`` that ``area`` is rendering on :param renderer: the ``GtkCellRenderer`` to get the allocation for :param cell_area: the whole allocated area for ``area`` in ``widget`` for this row .. method:: get_cell_at_position(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget, cell_area: ~gi.repository.Gdk.Rectangle, x: int, y: int) -> tuple[~gi.repository.Gtk.CellRenderer, ~gi.repository.Gdk.Rectangle] Gets the ``GtkCellRenderer`` at ``x`` and ``y`` coordinates inside ``area`` and optionally returns the full cell allocation for it inside ``cell_area``. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context used to hold sizes for ``area``. :param widget: the ``GtkWidget`` that ``area`` is rendering on :param cell_area: the whole allocated area for ``area`` in ``widget`` for this row :param x: the x position :param y: the y position .. method:: get_current_path_string() -> str Gets the current ``GtkTreePath`` string for the currently applied ``GtkTreeIter``, this is implicitly updated when :func:`~gi.repository.Gtk.CellArea.apply_attributes` is called and can be used to interact with renderers from ``GtkCellArea`` subclasses. .. method:: get_edit_widget() -> ~gi.repository.Gtk.CellEditable | None Gets the ``GtkCellEditable`` widget currently used to edit the currently edited cell. .. deprecated:: 4.10 Please do not use it in newly written code .. method:: get_edited_cell() -> ~gi.repository.Gtk.CellRenderer | None Gets the ``GtkCellRenderer`` in ``area`` that is currently being edited. .. deprecated:: 4.10 Please do not use it in newly written code .. method:: get_focus_cell() -> ~gi.repository.Gtk.CellRenderer | None Retrieves the currently focused cell for ``area`` .. deprecated:: 4.10 Please do not use it in newly written code .. method:: get_focus_from_sibling(renderer: ~gi.repository.Gtk.CellRenderer) -> ~gi.repository.Gtk.CellRenderer | None 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. .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: the ``GtkCellRenderer`` .. method:: get_focus_siblings(renderer: ~gi.repository.Gtk.CellRenderer) -> list[~gi.repository.Gtk.CellRenderer] Gets the focus sibling cell renderers for ``renderer``. .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: the ``GtkCellRenderer`` expected to have focus .. method:: get_preferred_height(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget) -> tuple[int, int] 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 :func:`~gi.repository.Gtk.CellAreaContext.get_preferred_height` after a series of requests. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context to perform this request with :param widget: the ``GtkWidget`` where ``area`` will be rendering .. method:: get_preferred_height_for_width(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget, width: int) -> tuple[int, int] 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 :func:`~gi.repository.Gtk.CellArea.get_preferred_width`. It’s important to perform a series of :func:`~gi.repository.Gtk.CellArea.get_preferred_width` requests with ``context`` first and then call :func:`~gi.repository.Gtk.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 :func:`~gi.repository.Gtk.CellArea.get_preferred_width` again and then the full width of the requested rows checked again with :func:`~gi.repository.Gtk.CellAreaContext.get_preferred_width`. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context which has already been requested for widths. :param widget: the ``GtkWidget`` where ``area`` will be rendering :param width: the width for which to check the height of this area .. method:: get_preferred_width(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget) -> tuple[int, int] 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 :func:`~gi.repository.Gtk.CellAreaContext.get_preferred_width` after a series of requests. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context to perform this request with :param widget: the ``GtkWidget`` where ``area`` will be rendering .. method:: get_preferred_width_for_height(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget, height: int) -> tuple[int, int] 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 :func:`~gi.repository.Gtk.CellArea.get_preferred_height`. It’s important to perform a series of :func:`~gi.repository.Gtk.CellArea.get_preferred_height` requests with ``context`` first and then call :func:`~gi.repository.Gtk.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 :func:`~gi.repository.Gtk.CellArea.get_preferred_height` again and then the full height of the requested rows checked again with :func:`~gi.repository.Gtk.CellAreaContext.get_preferred_height`. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context which has already been requested for widths. :param widget: the ``GtkWidget`` where ``area`` will be rendering :param height: the height for which to check the width of this area .. method:: get_request_mode() -> ~gi.repository.Gtk.SizeRequestMode Gets whether the area prefers a height-for-width layout or a width-for-height layout. .. method:: has_renderer(renderer: ~gi.repository.Gtk.CellRenderer) -> bool Checks if ``area`` contains ``renderer``. .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: the ``GtkCellRenderer`` to check .. method:: inner_cell_area(widget: ~gi.repository.Gtk.Widget, cell_area: ~gi.repository.Gdk.Rectangle) -> ~gi.repository.Gdk.Rectangle 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 :func:`~gi.repository.Gtk.CellArea.request_renderer`. .. deprecated:: 4.10 Please do not use it in newly written code :param widget: the ``GtkWidget`` that ``area`` is rendering onto :param cell_area: the ``widget`` relative coordinates where one of ``area``’s cells is to be placed .. classmethod:: install_cell_property(property_id: int, pspec: ~gi.repository.GObject.ParamSpec) -> None :param property_id: :param pspec: .. method:: is_activatable() -> bool Returns whether the area can do anything when activated, after applying new attributes to ``area``. .. deprecated:: 4.10 Please do not use it in newly written code .. method:: is_focus_sibling(renderer: ~gi.repository.Gtk.CellRenderer, sibling: ~gi.repository.Gtk.CellRenderer) -> bool Returns whether ``sibling`` is one of ``renderer``’s focus siblings (see :func:`~gi.repository.Gtk.CellArea.add_focus_sibling`). .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: the ``GtkCellRenderer`` expected to have focus :param sibling: the ``GtkCellRenderer`` to check against ``renderer``’s sibling list .. classmethod:: list_cell_properties() -> list[~gi.repository.GObject.ParamSpec] .. method:: remove(renderer: ~gi.repository.Gtk.CellRenderer) -> None Removes ``renderer`` from ``area``. .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: the ``GtkCellRenderer`` to remove from ``area`` .. method:: remove_focus_sibling(renderer: ~gi.repository.Gtk.CellRenderer, sibling: ~gi.repository.Gtk.CellRenderer) -> None Removes ``sibling`` from ``renderer``’s focus sibling list (see :func:`~gi.repository.Gtk.CellArea.add_focus_sibling`). .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: the ``GtkCellRenderer`` expected to have focus :param sibling: the ``GtkCellRenderer`` to remove from ``renderer``’s focus area .. method:: request_renderer(renderer: ~gi.repository.Gtk.CellRenderer, orientation: ~gi.repository.Gtk.Orientation, widget: ~gi.repository.Gtk.Widget, for_size: int) -> tuple[int, int] 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 :func:`~gi.repository.Gtk.CellArea.inner_cell_area` at render and event time since this function will add padding around the cell for focus painting. .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: the ``GtkCellRenderer`` to request size for :param orientation: the ``GtkOrientation`` in which to request size :param widget: the ``GtkWidget`` that ``area`` is rendering onto :param for_size: the allocation contextual size to request for, or -1 if the base request for the orientation is to be returned. .. method:: set_focus_cell(renderer: ~gi.repository.Gtk.CellRenderer | None = None) -> None 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 :func:`~gi.repository.Gtk.TreeView.set_cursor_on_cell`. .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: the ``GtkCellRenderer`` to give focus to .. method:: snapshot(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget, snapshot: ~gi.repository.Gtk.Snapshot, background_area: ~gi.repository.Gdk.Rectangle, cell_area: ~gi.repository.Gdk.Rectangle, flags: ~gi.repository.Gtk.CellRendererState, paint_focus: bool) -> None Snapshots ``area``’s cells according to ``area``’s layout onto at the given coordinates. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context for this row of data. :param widget: the ``GtkWidget`` that ``area`` is rendering to :param snapshot: the ``GtkSnapshot`` to draw to :param background_area: the ``widget`` relative coordinates for ``area``’s background :param cell_area: the ``widget`` relative coordinates for ``area`` :param flags: the ``GtkCellRenderer``State for ``area`` in this row. :param paint_focus: whether ``area`` should paint focus on focused cells for focused rows or not. .. method:: stop_editing(canceled: bool) -> None Explicitly stops the editing of the currently edited cell. If ``canceled`` is :const:`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 :func:`~gi.repository.Gtk.CellArea.get_edited_cell` and :func:`~gi.repository.Gtk.CellArea.get_edit_widget`. .. deprecated:: 4.10 Please do not use it in newly written code :param canceled: whether editing was canceled. Properties ---------- .. rst-class:: interim-class .. class:: CellArea :no-index: .. attribute:: props.edit_widget :type: ~gi.repository.Gtk.CellEditable The widget currently editing the edited cell This property is read-only and only changes as a result of a call :func:`~gi.repository.Gtk.CellArea.activate_cell`. .. attribute:: props.edited_cell :type: ~gi.repository.Gtk.CellRenderer The cell in the area that is currently edited This property is read-only and only changes as a result of a call :func:`~gi.repository.Gtk.CellArea.activate_cell`. .. attribute:: props.focus_cell :type: ~gi.repository.Gtk.CellRenderer The cell in the area that currently has focus Signals ------- .. rst-class:: interim-class .. class:: CellArea.signals :no-index: .. method:: add_editable(renderer: ~gi.repository.Gtk.CellRenderer, editable: ~gi.repository.Gtk.CellEditable, cell_area: ~gi.repository.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``. :param renderer: the ``GtkCellRenderer`` that started the edited :param editable: the ``GtkCellEditable`` widget to add :param cell_area: the ``GtkWidget`` relative ``GdkRectangle`` coordinates where ``editable`` should be added :param path: the ``GtkTreePath`` string this edit was initiated for .. method:: apply_attributes(model: ~gi.repository.Gtk.TreeModel, iter: ~gi.repository.Gtk.TreeIter, is_expander: bool, is_expanded: bool) -> None This signal is emitted whenever applying attributes to ``area`` from ``model`` :param model: the ``GtkTreeModel`` to apply the attributes from :param iter: the ``GtkTreeIter`` indicating which row to apply the attributes of :param is_expander: whether the view shows children for this row :param is_expanded: whether the view is currently showing the children of this row .. method:: focus_changed(renderer: ~gi.repository.Gtk.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. :param renderer: the ``GtkCellRenderer`` that has focus :param path: the current ``GtkTreePath`` string set for ``area`` .. method:: remove_editable(renderer: ~gi.repository.Gtk.CellRenderer, editable: ~gi.repository.Gtk.CellEditable) -> None Indicates that editing finished on ``renderer`` and that ``editable`` should be removed from the owning cell-layouting widget. :param renderer: the ``GtkCellRenderer`` that finished editeding :param editable: the ``GtkCellEditable`` widget to remove Virtual Methods --------------- .. rst-class:: interim-class .. class:: CellArea :no-index: .. method:: do_activate(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget, cell_area: ~gi.repository.Gdk.Rectangle, flags: ~gi.repository.Gtk.CellRendererState, edit_only: bool) -> bool 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. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context in context with the current row data :param widget: the ``GtkWidget`` that ``area`` is rendering on :param cell_area: the size and location of ``area`` relative to ``widget``’s allocation :param flags: the ``GtkCellRenderer``State flags for ``area`` for this row of data. :param edit_only: if :const:`True` then only cell renderers that are :const:`~gi.repository.Gtk.CellRendererMode.EDITABLE` will be activated. .. method:: do_add(renderer: ~gi.repository.Gtk.CellRenderer) -> None Adds ``renderer`` to ``area`` with the default child cell properties. .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: the ``GtkCellRenderer`` to add to ``area`` .. method:: do_apply_attributes(tree_model: ~gi.repository.Gtk.TreeModel, iter: ~gi.repository.Gtk.TreeIter, is_expander: bool, is_expanded: bool) -> None Applies any connected attributes to the renderers in ``area`` by pulling the values from ``tree_model``. .. deprecated:: 4.10 Please do not use it in newly written code :param tree_model: the ``GtkTreeModel`` to pull values from :param iter: the ``GtkTreeIter`` in ``tree_model`` to apply values for :param is_expander: whether ``iter`` has children :param is_expanded: whether ``iter`` is expanded in the view and children are visible .. method:: do_copy_context(context: ~gi.repository.Gtk.CellAreaContext) -> ~gi.repository.Gtk.CellAreaContext 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. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context to copy .. method:: do_create_context() -> ~gi.repository.Gtk.CellAreaContext Creates a ``GtkCellArea``Context to be used with ``area`` for all purposes. ``GtkCellArea``Context 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 ``GtkCellArea``Context which was used to request the size of those rows of data). .. deprecated:: 4.10 Please do not use it in newly written code .. method:: do_event(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget, event: ~gi.repository.Gdk.Event, cell_area: ~gi.repository.Gdk.Rectangle, flags: ~gi.repository.Gtk.CellRendererState) -> int Delegates event handling to a ``GtkCellArea``. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context for this row of data. :param widget: the ``GtkWidget`` that ``area`` is rendering to :param event: the ``GdkEvent`` to handle :param cell_area: the ``widget`` relative coordinates for ``area`` :param flags: the ``GtkCellRenderer``State for ``area`` in this row. .. method:: do_focus(direction: ~gi.repository.Gtk.DirectionType) -> bool 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. .. deprecated:: 4.10 Please do not use it in newly written code :param direction: the ``GtkDirectionType`` .. method:: do_foreach(callback: ~typing.Callable[[...], bool], *callback_data: ~typing.Any) -> None Calls ``callback`` for every ``GtkCellRenderer`` in ``area``. .. deprecated:: 4.10 Please do not use it in newly written code :param callback: the ``GtkCellCallback`` to call :param callback_data: user provided data pointer .. method:: do_foreach_alloc(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget, cell_area: ~gi.repository.Gdk.Rectangle, background_area: ~gi.repository.Gdk.Rectangle, callback: ~typing.Callable[[...], bool], *callback_data: ~typing.Any) -> None Calls ``callback`` for every ``GtkCellRenderer`` in ``area`` with the allocated rectangle inside ``cell_area``. :param context: the ``GtkCellArea``Context for this row of data. :param widget: the ``GtkWidget`` that ``area`` is rendering to :param cell_area: the ``widget`` relative coordinates and size for ``area`` :param background_area: the ``widget`` relative coordinates of the background area :param callback: the ``GtkCellAllocCallback`` to call :param callback_data: user provided data pointer .. method:: do_get_cell_property(renderer: ~gi.repository.Gtk.CellRenderer, property_id: int, value: ~typing.Any, pspec: ~gi.repository.GObject.ParamSpec) -> None This should be implemented to report the values of child cell properties for a given child ``GtkCellRenderer``. :param renderer: :param property_id: :param value: :param pspec: .. method:: do_get_preferred_height(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget) -> tuple[int, int] 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 :func:`~gi.repository.Gtk.CellAreaContext.get_preferred_height` after a series of requests. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context to perform this request with :param widget: the ``GtkWidget`` where ``area`` will be rendering .. method:: do_get_preferred_height_for_width(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget, width: int) -> tuple[int, int] 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 :func:`~gi.repository.Gtk.CellArea.get_preferred_width`. It’s important to perform a series of :func:`~gi.repository.Gtk.CellArea.get_preferred_width` requests with ``context`` first and then call :func:`~gi.repository.Gtk.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 :func:`~gi.repository.Gtk.CellArea.get_preferred_width` again and then the full width of the requested rows checked again with :func:`~gi.repository.Gtk.CellAreaContext.get_preferred_width`. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context which has already been requested for widths. :param widget: the ``GtkWidget`` where ``area`` will be rendering :param width: the width for which to check the height of this area .. method:: do_get_preferred_width(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget) -> tuple[int, int] 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 :func:`~gi.repository.Gtk.CellAreaContext.get_preferred_width` after a series of requests. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context to perform this request with :param widget: the ``GtkWidget`` where ``area`` will be rendering .. method:: do_get_preferred_width_for_height(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget, height: int) -> tuple[int, int] 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 :func:`~gi.repository.Gtk.CellArea.get_preferred_height`. It’s important to perform a series of :func:`~gi.repository.Gtk.CellArea.get_preferred_height` requests with ``context`` first and then call :func:`~gi.repository.Gtk.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 :func:`~gi.repository.Gtk.CellArea.get_preferred_height` again and then the full height of the requested rows checked again with :func:`~gi.repository.Gtk.CellAreaContext.get_preferred_height`. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context which has already been requested for widths. :param widget: the ``GtkWidget`` where ``area`` will be rendering :param height: the height for which to check the width of this area .. method:: do_get_request_mode() -> ~gi.repository.Gtk.SizeRequestMode Gets whether the area prefers a height-for-width layout or a width-for-height layout. .. method:: do_is_activatable() -> bool Returns whether the area can do anything when activated, after applying new attributes to ``area``. .. deprecated:: 4.10 Please do not use it in newly written code .. method:: do_remove(renderer: ~gi.repository.Gtk.CellRenderer) -> None Removes ``renderer`` from ``area``. .. deprecated:: 4.10 Please do not use it in newly written code :param renderer: the ``GtkCellRenderer`` to remove from ``area`` .. method:: do_set_cell_property(renderer: ~gi.repository.Gtk.CellRenderer, property_id: int, value: ~typing.Any, pspec: ~gi.repository.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 :func:`~gi.repository.Gtk.CellAreaClass.install_cell_property`. :param renderer: :param property_id: :param value: :param pspec: .. method:: do_snapshot(context: ~gi.repository.Gtk.CellAreaContext, widget: ~gi.repository.Gtk.Widget, snapshot: ~gi.repository.Gtk.Snapshot, background_area: ~gi.repository.Gdk.Rectangle, cell_area: ~gi.repository.Gdk.Rectangle, flags: ~gi.repository.Gtk.CellRendererState, paint_focus: bool) -> None Snapshots ``area``’s cells according to ``area``’s layout onto at the given coordinates. .. deprecated:: 4.10 Please do not use it in newly written code :param context: the ``GtkCellArea``Context for this row of data. :param widget: the ``GtkWidget`` that ``area`` is rendering to :param snapshot: the ``GtkSnapshot`` to draw to :param background_area: the ``widget`` relative coordinates for ``area``’s background :param cell_area: the ``widget`` relative coordinates for ``area`` :param flags: the ``GtkCellRenderer``State for ``area`` in this row. :param paint_focus: whether ``area`` should paint focus on focused cells for focused rows or not. Fields ------ .. rst-class:: interim-class .. class:: CellArea :no-index: .. attribute:: parent_instance