Gtk.CellArea

Gtk.CellArea — An abstract class for laying out Gtk.CellRenderers

Object Hierarchy:

    GObject
    ╰── GInitiallyUnowned
        ╰── Gtk.CellArea
            ╰── Gtk.CellAreaBox

Functions:

  • add (self, renderer:Gtk.CellRenderer)
  • remove (self, renderer:Gtk.CellRenderer)
  • has_renderer (self, renderer:Gtk.CellRenderer) -> bool
  • foreach (self, callback:Gtk.CellCallback, callback_data=None)
  • foreach_alloc (self, context:Gtk.CellAreaContext, widget:Gtk.Widget, cell_area:Gdk.Rectangle, background_area:Gdk.Rectangle, callback:Gtk.CellAllocCallback, callback_data=None)
  • event (self, context:Gtk.CellAreaContext, widget:Gtk.Widget, event:Gdk.Event, cell_area:Gdk.Rectangle, flags:Gtk.CellRendererState) -> int
  • render (self, context:Gtk.CellAreaContext, widget:Gtk.Widget, cr:cairo.Context, background_area:Gdk.Rectangle, cell_area:Gdk.Rectangle, flags:Gtk.CellRendererState, paint_focus:bool)
  • get_cell_allocation (self, context:Gtk.CellAreaContext, widget:Gtk.Widget, renderer:Gtk.CellRenderer, cell_area:Gdk.Rectangle) -> allocation:Gdk.Rectangle
  • get_cell_at_position (self, context:Gtk.CellAreaContext, widget:Gtk.Widget, cell_area:Gdk.Rectangle, x:int, y:int) -> Gtk.CellRenderer, alloc_area:Gdk.Rectangle
  • create_context (self) -> Gtk.CellAreaContext
  • copy_context (self, context:Gtk.CellAreaContext) -> Gtk.CellAreaContext
  • get_request_mode (self) -> Gtk.SizeRequestMode
  • get_preferred_width (self, context:Gtk.CellAreaContext, widget:Gtk.Widget) -> minimum_width:int, natural_width:int
  • get_preferred_height_for_width (self, context:Gtk.CellAreaContext, widget:Gtk.Widget, width:int) -> minimum_height:int, natural_height:int
  • get_preferred_height (self, context:Gtk.CellAreaContext, widget:Gtk.Widget) -> minimum_height:int, natural_height:int
  • get_preferred_width_for_height (self, context:Gtk.CellAreaContext, widget:Gtk.Widget, height:int) -> minimum_width:int, natural_width:int
  • get_current_path_string (self) -> str
  • apply_attributes (self, tree_model:Gtk.TreeModel, iter:Gtk.TreeIter, is_expander:bool, is_expanded:bool)
  • attribute_connect (self, renderer:Gtk.CellRenderer, attribute:str, column:int)
  • attribute_disconnect (self, renderer:Gtk.CellRenderer, attribute:str)
  • attribute_get_column (self, renderer:Gtk.CellRenderer, attribute:str) -> int
  • cell_set_property (self, renderer:Gtk.CellRenderer, property_name:str, value:GObject.Value)
  • cell_get_property (self, renderer:Gtk.CellRenderer, property_name:str, value:GObject.Value)
  • is_activatable (self) -> bool
  • activate (self, context:Gtk.CellAreaContext, widget:Gtk.Widget, cell_area:Gdk.Rectangle, flags:Gtk.CellRendererState, edit_only:bool) -> bool
  • focus (self, direction:Gtk.DirectionType) -> bool
  • set_focus_cell (self, renderer:Gtk.CellRenderer)
  • get_focus_cell (self) -> Gtk.CellRenderer
  • add_focus_sibling (self, renderer:Gtk.CellRenderer, sibling:Gtk.CellRenderer)
  • remove_focus_sibling (self, renderer:Gtk.CellRenderer, sibling:Gtk.CellRenderer)
  • is_focus_sibling (self, renderer:Gtk.CellRenderer, sibling:Gtk.CellRenderer) -> bool
  • get_focus_siblings (self, renderer:Gtk.CellRenderer) -> list
  • get_focus_from_sibling (self, renderer:Gtk.CellRenderer) -> Gtk.CellRenderer
  • get_edited_cell (self) -> Gtk.CellRenderer
  • get_edit_widget (self) -> Gtk.CellEditable
  • activate_cell (self, widget:Gtk.Widget, renderer:Gtk.CellRenderer, event:Gdk.Event, cell_area:Gdk.Rectangle, flags:Gtk.CellRendererState) -> bool
  • stop_editing (self, canceled:bool)
  • inner_cell_area (self, widget:Gtk.Widget, cell_area:Gdk.Rectangle) -> inner_area:Gdk.Rectangle
  • request_renderer (self, renderer:Gtk.CellRenderer, orientation:Gtk.Orientation, widget:Gtk.Widget, for_size:int) -> minimum_size:int, natural_size:int

Signals:

  • “add-editable” (area, renderer, editable, cell_area, path, user_data)
  • “apply-attributes” (area, model, iter, is_expander, is_expanded, user_data)
  • “focus-changed” (area, renderer, path, user_data)
  • “remove-editable” (area, renderer, editable, user_data)

Description:

The Gtk.CellArea is an abstract class for Gtk.CellLayout widgets (also referred to as "layouting widgets") to interface with an arbitrary number of Gtk.CellRenderers and interact with the user for a given 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 Gtk.CellArea directly unless they are implementing a cell-layouting widget themselves.

Requesting area sizes

As outlined in [Gtk.Widget’s geometry management section][geometry-management], GTK+ uses a height-for-width geometry management system to compute the sizes of widgets and user interfaces. Gtk.CellArea uses the same semantics to calculate the size of an area for an arbitrary number of Gtk.TreeModel 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 Gtk.TreeViewColumn always lines up the areas from top to bottom while a 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 Gtk.CellArea uses a 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 Gtk.CellAreaContext is an opaque object specific to the Gtk.CellArea which created it (see 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 Gtk.CellAreaContext which was used to request the sizes for a given Gtk.TreeModel 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 Gtk.TreeModel one would do the following:

GtkTreeIter iter;
gint        minimum_width;
gint        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 Gtk.CellAreaContext object and can be consulted at any time.

This can be useful since Gtk.CellLayout widgets usually have to support requesting and rendering rows in treemodels with an exceedingly large amount of rows. The Gtk.CellLayout widget in that case would calculate the required width of the rows in an idle or timeout source (see g_timeout_add()) and when the widget is requested its actual width in Gtk.WidgetClass.get_preferred_width() it can simply consult the width accumulated so far in the Gtk.CellAreaContext 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,
                         gint            *minimum_size,
                         gint            *natural_size)
{
  Foo        *foo  = FOO (widget);
  FooPrivate *priv = foo->priv;

  foo_ensure_at_least_one_handfull_of_rows_have_been_requested (foo);

  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 Gtk.CellAreaContext.

Requesting the height for width (or width for height) of an area is a similar task except in this case the Gtk.CellAreaContext 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 Gtk.CellArea).

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

GtkTreeIter iter;
gint        minimum_height;
gint        natural_height;
gint        full_minimum_height = 0;
gint        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 Gtk.WidgetClass.get_preferred_height_for_width(). 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 aquired at least for the rows in the visible area of the layouting widget they can be rendered at Gtk.WidgetClass.draw() time.

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

GtkAllocation allocation;
GdkRectangle  cell_area = { 0, };
GtkTreeIter   iter;
gint          minimum_width;
gint          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 [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 Gtk.CellArea::event() API as they come in. Usually Gtk.CellArea 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 Gtk.CellArea::focus-changed signal to fire; as well as clicked and needs to start editing. You can call Gtk.CellArea::stop_editing() at any time to cancel any cell editing that is currently in progress.

The Gtk.CellArea drives keyboard focus from cell to cell in a way similar to Gtk.Widget. 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 Gtk.WidgetClass.focus() virtual method. The layouting widget is always responsible for knowing where Gtk.TreeModel rows are rendered inside the widget, so at Gtk.WidgetClass.focus() time the layouting widget should use the Gtk.CellArea methods to navigate focus inside the area and then observe the Gtk.DirectionType to pass the focus to adjacent rows and areas.

A basic example of how the Gtk.WidgetClass.focus() virtual method should be implemented:

GtkAllocation allocation;
GdkRectangle  cell_area = { 0, };
GtkTreeIter   iter;
gint          minimum_width;
gint          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 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 Gtk.CellRenderers in very much the same way that Gtk.Container introduces [child properties][child-properties] for Gtk.Widgets. This provides some general interfaces for defining the relationship cell areas have with their cells. For instance in a 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 Gtk.CellAreaContext.

Use Gtk.CellArea::class_install_cell_property() to install cell properties for a cell area class and Gtk.CellArea::class_find_cell_property() or Gtk.CellArea::class_list_cell_properties() to get information about existing cell properties.

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

Function Details:

add()

add (self, renderer:Gtk.CellRenderer)

Adds renderer to area with the default child cell properties.

  • Since: 3.0

remove()

remove (self, renderer:Gtk.CellRenderer)

Removes renderer from area.

  • Since: 3.0

has_renderer()

has_renderer (self, renderer:Gtk.CellRenderer) -> bool

Checks if area contains renderer.

  • Returns: True if rendereris in the area.

  • Since: 3.0

foreach()

foreach (self, callback:Gtk.CellCallback, callback_data=None)

Calls callback for every Gtk.CellRenderer in area.

  • Since: 3.0

foreach_alloc()

foreach_alloc (self, context:Gtk.CellAreaContext, widget:Gtk.Widget, cell_area:Gdk.Rectangle, background_area:Gdk.Rectangle, callback:Gtk.CellAllocCallback, callback_data=None)

Calls callback for every Gtk.CellRenderer in area with theallocated rectangle inside cell_area.

  • Since: 3.0

event()

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

Delegates event handling to a Gtk.CellArea.

  • Returns: True if the event was handled by area.

  • Since: 3.0

render()

render (self, context:Gtk.CellAreaContext, widget:Gtk.Widget, cr:cairo.Context, background_area:Gdk.Rectangle, cell_area:Gdk.Rectangle, flags:Gtk.CellRendererState, paint_focus:bool)

Renders area’s cells according to area’s layout onto widget atthe given coordinates.

  • Since: 3.0

get_cell_allocation()

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

Derives the allocation of renderer inside area if areawere to be renderered in cell_area.

  • Since: 3.0

get_cell_at_position()

get_cell_at_position (self, context:Gtk.CellAreaContext, widget:Gtk.Widget, cell_area:Gdk.Rectangle, x:int, y:int) -> Gtk.CellRenderer, alloc_area:Gdk.Rectangle

Gets the Gtk.CellRenderer at x and y coordinates inside area and optionallyreturns the full cell allocation for it inside cell_area.

  • Returns: the Gtk.CellRenderer at xand y.

  • Since: 3.0

create_context()

create_context (self) -> Gtk.CellAreaContext

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

  • Returns: a newly created Gtk.CellAreaContext which can be used with area.

  • Since: 3.0

copy_context()

copy_context (self, context:Gtk.CellAreaContext) -> Gtk.CellAreaContext

This is sometimes needed for cases where rows need to sharealignments in one orientation but may be separately groupedin the opposing orientation. For instance, Gtk.IconView creates all icons (rows) to havethe same width and the cells theirin to have the samehorizontal alignments. However each row of icons may havea separate collective height. Gtk.IconView uses this torequest the heights of each row based on a context whichwas already used to request all the row widths that areto be displayed.

  • Returns: a newly created Gtk.CellAreaContext copy of context.

  • Since: 3.0

get_request_mode()

get_request_mode (self) -> Gtk.SizeRequestMode

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

  • Returns: The Gtk.SizeRequestMode preferred by area.

  • Since: 3.0

get_preferred_width()

get_preferred_width (self, context:Gtk.CellAreaContext, widget:Gtk.Widget) -> minimum_width:int, natural_width: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 importantto check the minimum_width and natural_width of this call but rather toconsult Gtk.CellArea:context_get_preferred_width() after a series ofrequests.

  • Since: 3.0

get_preferred_height_for_width()

get_preferred_height_for_width (self, context:Gtk.CellAreaContext, widget:Gtk.Widget, width:int) -> minimum_height:int, natural_height:int

Retrieves a cell area’s minimum and natural height if it would be giventhe specified width. area stores some geometrical information in context along the waywhile calling Gtk.CellArea:get_preferred_width(). It’s important toperform a series of Gtk.CellArea:get_preferred_width() requests withcontext first and then call Gtk.CellArea:get_preferred_height_for_width()on each cell area individually to get the height for width of eachfully requested row. If at some point, the width of a single row changes, it should berequested with Gtk.CellArea:get_preferred_width() again and thenthe full width of the requested rows checked again withGtk.CellArea:context_get_preferred_width().

  • Since: 3.0

get_preferred_height()

get_preferred_height (self, context:Gtk.CellAreaContext, widget:Gtk.Widget) -> minimum_height:int, natural_height: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 importantto check the minimum_height and natural_height of this call but rather toconsult Gtk.CellArea:context_get_preferred_height() after a series ofrequests.

  • Since: 3.0

get_preferred_width_for_height()

get_preferred_width_for_height (self, context:Gtk.CellAreaContext, widget:Gtk.Widget, height:int) -> minimum_width:int, natural_width:int

Retrieves a cell area’s minimum and natural width if it would be giventhe specified height. area stores some geometrical information in context along the waywhile calling Gtk.CellArea:get_preferred_height(). It’s important toperform a series of Gtk.CellArea:get_preferred_height() requests withcontext first and then call Gtk.CellArea:get_preferred_width_for_height()on each cell area individually to get the height for width of eachfully requested row. If at some point, the height of a single row changes, it should berequested with Gtk.CellArea:get_preferred_height() again and thenthe full height of the requested rows checked again withGtk.CellArea:context_get_preferred_height().

  • Since: 3.0

get_current_path_string()

get_current_path_string (self) -> str

Gets the current Gtk.TreePath string for the currentlyapplied Gtk.TreeIter, this is implicitly updated whenGtk.CellArea:apply_attributes() is called and can beused to interact with renderers from Gtk.CellAreasubclasses.

  • Returns: The current Gtk.TreePath string for the currentattributes applied to area. This string belongs to the area andshould not be freed.

  • Since: 3.0

apply_attributes()

apply_attributes (self, tree_model:Gtk.TreeModel, iter:Gtk.TreeIter, is_expander:bool, is_expanded:bool)

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

  • Since: 3.0

attribute_connect()

attribute_connect (self, renderer:Gtk.CellRenderer, attribute:str, column:int)

Connects an attribute to apply values from column for theGtk.TreeModel in use.

  • Since: 3.0

attribute_disconnect()

attribute_disconnect (self, renderer:Gtk.CellRenderer, attribute:str)

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

  • Since: 3.0

attribute_get_column()

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

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

  • Returns: the model column, or -1

  • Since: 3.14

cell_set_property()

cell_set_property (self, renderer:Gtk.CellRenderer, property_name:str, value:GObject.Value)

Sets a cell property for renderer in area.

  • Since: 3.0

cell_get_property()

cell_get_property (self, renderer:Gtk.CellRenderer, property_name:str, value:GObject.Value)

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

  • Since: 3.0

is_activatable()

is_activatable (self) -> bool

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

  • Returns: whether areacan do anything when activated.

  • Since: 3.0

activate()

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

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

  • Returns: Whether areawas successfully activated.

  • Since: 3.0

focus()

focus (self, direction:Gtk.DirectionType) -> bool

This should be called by the area’s owning layout widgetwhen focus is to be passed to area, or moved within areafor a given direction and row data. Implementing Gtk.CellArea classes should implement thismethod to receive and navigate focus in its own way particularto how it lays out cells.

  • Returns: True if focus remains inside areaas a result of this call.

  • Since: 3.0

set_focus_cell()

set_focus_cell (self, renderer:Gtk.CellRenderer)

Explicitly sets the currently focused cell to renderer. This is generally called by implementations ofGtk.CellAreaClass`.focus()` orGtk.CellAreaClass.event(),however it can also be used to implement functions suchas `Gtk.TreeView:set_cursor_on_cell()`.

  • Since: 3.0

get_focus_cell()

get_focus_cell (self) -> Gtk.CellRenderer

Retrieves the currently focused cell for area

  • Returns: the currently focused cell in area.

  • Since: 3.0

add_focus_sibling()

add_focus_sibling (self, renderer:Gtk.CellRenderer, sibling:Gtk.CellRenderer)

Adds sibling to renderer’s focusable area, focus will be drawnaround renderer and all of its siblings if renderer canfocus for a given row. Events handled by focus siblings can also activate the givenfocusable renderer.

  • Since: 3.0

remove_focus_sibling()

remove_focus_sibling (self, renderer:Gtk.CellRenderer, sibling:Gtk.CellRenderer)

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

  • Since: 3.0

is_focus_sibling()

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

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

  • Returns: True if siblingis a focus sibling of renderer

  • Since: 3.0

get_focus_siblings()

get_focus_siblings (self, renderer:Gtk.CellRenderer) -> list

Gets the focus sibling cell renderers for renderer.

  • Returns: A GList of Gtk.CellRenderers.The returned list is internal and should not be freed.

  • Since: 3.0

get_focus_from_sibling()

get_focus_from_sibling (self, renderer:Gtk.CellRenderer) -> Gtk.CellRenderer

Gets the Gtk.CellRenderer which is expected to be focusablefor which renderer is, or may be a sibling. This is handy for Gtk.CellArea subclasses when handling events,after determining the renderer at the event location it canthen chose to activate the focus cell for which the eventcell may have been a sibling.

  • Returns: the Gtk.CellRenderer for which rendereris a sibling, or None.

  • Since: 3.0

get_edited_cell()

get_edited_cell (self) -> Gtk.CellRenderer

Gets the Gtk.CellRenderer in area that is currentlybeing edited.

  • Returns: The currently edited Gtk.CellRenderer.

  • Since: 3.0

get_edit_widget()

get_edit_widget (self) -> Gtk.CellEditable

Gets the Gtk.CellEditable widget currently usedto edit the currently edited cell.

  • Returns: The currently active Gtk.CellEditable widget.

  • Since: 3.0

activate_cell()

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

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

  • Returns: whether cell activation was successful

  • Since: 3.0

stop_editing()

stop_editing (self, canceled:bool)

Explicitly stops the editing of the currently edited cell. If canceled is True, the currently edited cell rendererwill emit the ::editing-canceled signal, otherwise thethe ::editing-done signal will be emitted on the currentedit widget. See Gtk.CellArea:get_edited_cell() and Gtk.CellArea:get_edit_widget().

  • Since: 3.0

inner_cell_area()

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

This is a convenience function for Gtk.CellArea implementationsto get the inner area where a given Gtk.CellRenderer will berendered. It removes any padding previously added by Gtk.CellArea:request_renderer().

  • Since: 3.0

request_renderer()

request_renderer (self, renderer:Gtk.CellRenderer, orientation:Gtk.Orientation, widget:Gtk.Widget, for_size:int) -> minimum_size:int, natural_size:int

This is a convenience function for Gtk.CellArea implementationsto request size for cell renderers. It’s important to use thisfunction to request size and then use Gtk.CellArea:inner_cell_area()at render and event time since this function will add paddingaround the cell for focus painting.

  • Since: 3.0

results matching ""

    No results matching ""