Class CellArea

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.gobject.TypeInstance
org.gnome.gobject.GObject
org.gnome.gobject.InitiallyUnowned
org.gnome.gtk.CellArea
All Implemented Interfaces:
Buildable, CellLayout, Proxy
Direct Known Subclasses:
CellArea.CellArea$Impl, CellAreaBox
@Generated("org.javagi.JavaGI") @Deprecated public abstract class CellArea extends InitiallyUnowned implements Buildable, CellLayout
Deprecated.
List views use widgets for displaying their contents

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 createContext()).

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#timeoutAdd) and when the widget is requested its actual width in Widget.measure(Orientation, int, Out, Out, Out, Out) 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(Orientation, int, Out, Out, Out, Out). 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(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 Gtk.distributeNaturalAllocation(int, RequestedSize[]).

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 event(CellAreaContext, Widget, Event, Rectangle, Set) 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 Gtk.CellArea::focus-changed signal to fire; as well as Gtk.CellArea::add-editable in the case that an editable cell was clicked and needs to start editing. You can call stopEditing(boolean) 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(DirectionType) virtual method. The layouting widget is always responsible for knowing where GtkTreeModel rows are rendered inside the widget, so at Widget.focus(DirectionType) time the layouting widget should use the GtkCellArea 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 Widget.focus(DirectionType) 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.installCellProperty to install cell properties for a cell area class and CellAreaClass.findCellProperty or CellAreaClass.listCellProperties to get information about existing cell properties.

To set the value of a cell property, use cellSetProperty(CellRenderer, String, Value), cellSet(CellRenderer, String, Object...) or CellArea.cellSetValist. To obtain the value of a cell property, use cellGetProperty(CellRenderer, String, Value) cellGet(CellRenderer, String, Object...) or CellArea.cellGetValist.

  • Constructor Details

    • CellArea

      public CellArea(MemorySegment address)
      Deprecated.
      Create a CellArea instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • CellArea

      public CellArea()
      Deprecated.
      Create a new CellArea.

  • Method Details

    • getType

      public static @Nullable Type getType()
      Deprecated.
      Get the GType of the CellArea class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      Deprecated.
      The memory layout of the native struct.
      Returns:
      the memory layout

    • asParent

      protected CellArea asParent()
      Deprecated.
      Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.
      Overrides:
      asParent in class InitiallyUnowned
      Returns:
      the instance as if it were its parent type

    • activate

      @Deprecated public boolean activate(CellAreaContext context, Widget widget, Rectangle cellArea, Set<CellRendererState> flags, boolean editOnly)
      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 this CellArea is rendering on
      cellArea - the size and location of this CellArea relative to widget’s allocation
      flags - the GtkCellRendererState flags for this CellArea for this row of data.
      editOnly - if true then only cell renderers that are CellRendererMode.EDITABLE will be activated.
      Returns:
      Whether this CellArea was successfully activated.

    • activate

      @Deprecated public boolean activate(CellAreaContext context, Widget widget, Rectangle cellArea, CellRendererState flags, boolean editOnly)
      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 this CellArea is rendering on
      cellArea - the size and location of this CellArea relative to widget’s allocation
      flags - the GtkCellRendererState flags for this CellArea for this row of data.
      editOnly - if true then only cell renderers that are CellRendererMode.EDITABLE will be activated.
      Returns:
      Whether this CellArea was successfully activated.

    • activateCell

      @Deprecated public boolean activateCell(Widget widget, CellRenderer renderer, Event event, Rectangle cellArea, Set<CellRendererState> flags)
      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 this CellArea is rendering onto
      renderer - the GtkCellRenderer in this CellArea to activate
      event - the GdkEvent for which cell activation should occur
      cellArea - the GdkRectangle in widget relative coordinates of renderer for the current row.
      flags - the GtkCellRendererState for renderer
      Returns:
      whether cell activation was successful

    • activateCell

      @Deprecated public boolean activateCell(Widget widget, CellRenderer renderer, Event event, Rectangle cellArea, CellRendererState... flags)
      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 this CellArea is rendering onto
      renderer - the GtkCellRenderer in this CellArea to activate
      event - the GdkEvent for which cell activation should occur
      cellArea - the GdkRectangle in widget relative coordinates of renderer for the current row.
      flags - the GtkCellRendererState for renderer
      Returns:
      whether cell activation was successful

    • add

      @Deprecated public void add(CellRenderer renderer)
      Deprecated.
      Adds renderer to this CellArea with the default child cell properties.
      Parameters:
      renderer - the GtkCellRenderer to add to this CellArea

    • addFocusSibling

      @Deprecated public void addFocusSibling(CellRenderer renderer, CellRenderer sibling)
      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

    • addWithProperties

      @Deprecated public void addWithProperties(CellRenderer renderer, String firstPropName, Object... varargs)
      Deprecated.
      Adds renderer to area, setting cell properties at the same time. See gtk_cell_area_add() and gtk_cell_area_cell_set() for more details.
      Parameters:
      renderer - a GtkCellRenderer to be placed inside this CellArea
      firstPropName - the name of the first cell property to set
      varargs - a null-terminated list of property names and values, starting with firstPropName

    • applyAttributes

      @Deprecated public void applyAttributes(TreeModel treeModel, TreeIter iter, boolean isExpander, boolean isExpanded)
      Deprecated.
      Applies any connected attributes to the renderers in this CellArea by pulling the values from treeModel.
      Parameters:
      treeModel - the GtkTreeModel to pull values from
      iter - the GtkTreeIter in treeModel to apply values for
      isExpander - whether iter has children
      isExpanded - whether iter is expanded in the view and children are visible

    • attributeConnect

      @Deprecated public void attributeConnect(CellRenderer renderer, String attribute, int column)
      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

    • attributeDisconnect

      @Deprecated public void attributeDisconnect(CellRenderer renderer, String attribute)
      Deprecated.
      Disconnects attribute for the renderer in this CellArea 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

    • attributeGetColumn

      @Deprecated public int attributeGetColumn(CellRenderer renderer, String attribute)
      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
      Returns:
      the model column, or -1

    • cellGet

      @Deprecated public void cellGet(CellRenderer renderer, String firstPropName, Object... varargs)
      Deprecated.
      Gets the values of one or more cell properties for renderer in area.
      Parameters:
      renderer - a GtkCellRenderer which is inside this CellArea
      firstPropName - the name of the first cell property to get
      varargs - return location for the first cell property, followed optionally by more name/return location pairs, followed by null

    • cellGetProperty

      @Deprecated public void cellGetProperty(CellRenderer renderer, String propertyName, Value value)
      Deprecated.
      Gets the value of a cell property for renderer in area.
      Parameters:
      renderer - a GtkCellRenderer inside this CellArea
      propertyName - the name of the property to get
      value - a location to return the value

    • cellSet

      @Deprecated public void cellSet(CellRenderer renderer, String firstPropName, Object... varargs)
      Deprecated.
      Sets one or more cell properties for cell in area.
      Parameters:
      renderer - a GtkCellRenderer which is a cell inside this CellArea
      firstPropName - the name of the first cell property to set
      varargs - a null-terminated list of property names and values, starting with firstPropName

    • cellSetProperty

      @Deprecated public void cellSetProperty(CellRenderer renderer, String propertyName, Value value)
      Deprecated.
      Sets a cell property for renderer in area.
      Parameters:
      renderer - a GtkCellRenderer inside this CellArea
      propertyName - the name of the cell property to set
      value - the value to set the cell property to

    • copyContext

      @Deprecated public CellAreaContext copyContext(CellAreaContext context)
      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
      Returns:
      a newly created GtkCellAreaContext copy of context.

    • createContext

      @Deprecated public CellAreaContext createContext()
      Deprecated.
      Creates a GtkCellAreaContext to be used with this CellArea 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).
      Returns:
      a newly created GtkCellAreaContext which can be used with area.

    • event

      @Deprecated public int event(CellAreaContext context, Widget widget, Event event, Rectangle cellArea, Set<CellRendererState> flags)
      Deprecated.
      Delegates event handling to a GtkCellArea.
      Parameters:
      context - the GtkCellAreaContext for this row of data.
      widget - the GtkWidget that this CellArea is rendering to
      event - the GdkEvent to handle
      cellArea - the widget relative coordinates for this CellArea
      flags - the GtkCellRendererState for this CellArea in this row.
      Returns:
      true if the event was handled by area.

    • event

      @Deprecated public int event(CellAreaContext context, Widget widget, Event event, Rectangle cellArea, CellRendererState... flags)
      Deprecated.
      Delegates event handling to a GtkCellArea.
      Parameters:
      context - the GtkCellAreaContext for this row of data.
      widget - the GtkWidget that this CellArea is rendering to
      event - the GdkEvent to handle
      cellArea - the widget relative coordinates for this CellArea
      flags - the GtkCellRendererState for this CellArea in this row.
      Returns:
      true if the event was handled by area.

    • focus

      @Deprecated public boolean focus(DirectionType direction)
      Deprecated.

      This should be called by the area’s owning layout widget when focus is to be passed to area, or moved within this CellArea 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
      Returns:
      true if focus remains inside this CellArea as a result of this call.

    • foreach

      @Deprecated public void foreach(@Nullable CellCallback callback)
      Deprecated.
      Calls callback for every GtkCellRenderer in area.
      Parameters:
      callback - the GtkCellCallback to call

    • foreachAlloc

      public void foreachAlloc(CellAreaContext context, Widget widget, Rectangle cellArea, Rectangle backgroundArea, @Nullable CellAllocCallback callback)
      Deprecated.
      Calls callback for every GtkCellRenderer in this CellArea with the allocated rectangle inside cellArea.
      Parameters:
      context - the GtkCellAreaContext for this row of data.
      widget - the GtkWidget that this CellArea is rendering to
      cellArea - the widget relative coordinates and size for this CellArea
      backgroundArea - the widget relative coordinates of the background area
      callback - the GtkCellAllocCallback to call

    • getCellAllocation

      @Deprecated public void getCellAllocation(CellAreaContext context, Widget widget, CellRenderer renderer, Rectangle cellArea, Rectangle allocation)
      Deprecated.
      Derives the allocation of renderer inside this CellArea if this CellArea were to be rendered in cellArea.
      Parameters:
      context - the GtkCellAreaContext used to hold sizes for area.
      widget - the GtkWidget that this CellArea is rendering on
      renderer - the GtkCellRenderer to get the allocation for
      cellArea - the whole allocated area for this CellArea in widget for this row
      allocation - where to store the allocation for renderer

    • getCellAtPosition

      @Deprecated public CellRenderer getCellAtPosition(CellAreaContext context, Widget widget, Rectangle cellArea, int x, int y, @Nullable Rectangle allocArea)
      Deprecated.
      Gets the GtkCellRenderer at x and y coordinates inside this CellArea and optionally returns the full cell allocation for it inside cellArea.
      Parameters:
      context - the GtkCellAreaContext used to hold sizes for area.
      widget - the GtkWidget that this CellArea is rendering on
      cellArea - the whole allocated area for this CellArea in widget for this row
      x - the x position
      y - the y position
      allocArea - where to store the inner allocated area of the returned cell renderer
      Returns:
      the GtkCellRenderer at x and y.

    • getCurrentPathString

      public String getCurrentPathString()
      Deprecated.
      Gets the current GtkTreePath string for the currently applied GtkTreeIter, this is implicitly updated when gtk_cell_area_apply_attributes() is called and can be used to interact with renderers from GtkCellArea subclasses.
      Returns:
      The current GtkTreePath string for the current attributes applied to area. This string belongs to the area and should not be freed.

    • getEditWidget

      @Deprecated public @Nullable CellEditable getEditWidget()
      Deprecated.
      Gets the GtkCellEditable widget currently used to edit the currently edited cell.
      Returns:
      The currently active GtkCellEditable widget

    • getEditedCell

      @Deprecated public @Nullable CellRenderer getEditedCell()
      Deprecated.
      Gets the GtkCellRenderer in this CellArea that is currently being edited.
      Returns:
      The currently edited GtkCellRenderer

    • getFocusCell

      @Deprecated public @Nullable CellRenderer getFocusCell()
      Deprecated.
      Retrieves the currently focused cell for this CellArea
      Returns:
      the currently focused cell in area.

    • getFocusFromSibling

      @Deprecated public @Nullable CellRenderer getFocusFromSibling(CellRenderer renderer)
      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
      Returns:
      the GtkCellRenderer for which renderer is a sibling

    • getFocusSiblings

      @Deprecated public List<CellRenderer> getFocusSiblings(CellRenderer renderer)
      Deprecated.
      Gets the focus sibling cell renderers for renderer.
      Parameters:
      renderer - the GtkCellRenderer expected to have focus
      Returns:
      A GList of GtkCellRenderers. The returned list is internal and should not be freed.

    • getPreferredHeight

      @Deprecated public void getPreferredHeight(CellAreaContext context, Widget widget, @Nullable Out<Integer> minimumHeight, @Nullable Out<Integer> naturalHeight)
      Deprecated.

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

      this CellArea 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 minimumHeight and naturalHeight of this call but rather to consult gtk_cell_area_context_get_preferred_height() after a series of requests.

      Parameters:
      context - the GtkCellAreaContext to perform this request with
      widget - the GtkWidget where this CellArea will be rendering
      minimumHeight - location to store the minimum height
      naturalHeight - location to store the natural height

    • getPreferredHeightForWidth

      @Deprecated public void getPreferredHeightForWidth(CellAreaContext context, Widget widget, int width, @Nullable Out<Integer> minimumHeight, @Nullable Out<Integer> naturalHeight)
      Deprecated.

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

      this CellArea stores some geometrical information in context along the way while calling gtk_cell_area_get_preferred_width(). It’s important to perform a series of gtk_cell_area_get_preferred_width() requests with context first and then call gtk_cell_area_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 gtk_cell_area_get_preferred_width() again and then the full width of the requested rows checked again with gtk_cell_area_context_get_preferred_width().

      Parameters:
      context - the GtkCellAreaContext which has already been requested for widths.
      widget - the GtkWidget where this CellArea will be rendering
      width - the width for which to check the height of this area
      minimumHeight - location to store the minimum height
      naturalHeight - location to store the natural height

    • getPreferredWidth

      @Deprecated public void getPreferredWidth(CellAreaContext context, Widget widget, @Nullable Out<Integer> minimumWidth, @Nullable Out<Integer> naturalWidth)
      Deprecated.

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

      this CellArea 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 minimumWidth and naturalWidth of this call but rather to consult gtk_cell_area_context_get_preferred_width() after a series of requests.

      Parameters:
      context - the GtkCellAreaContext to perform this request with
      widget - the GtkWidget where this CellArea will be rendering
      minimumWidth - location to store the minimum width
      naturalWidth - location to store the natural width

    • getPreferredWidthForHeight

      @Deprecated public void getPreferredWidthForHeight(CellAreaContext context, Widget widget, int height, @Nullable Out<Integer> minimumWidth, @Nullable Out<Integer> naturalWidth)
      Deprecated.

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

      this CellArea stores some geometrical information in context along the way while calling gtk_cell_area_get_preferred_height(). It’s important to perform a series of gtk_cell_area_get_preferred_height() requests with context first and then call gtk_cell_area_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 gtk_cell_area_get_preferred_height() again and then the full height of the requested rows checked again with gtk_cell_area_context_get_preferred_height().

      Parameters:
      context - the GtkCellAreaContext which has already been requested for widths.
      widget - the GtkWidget where this CellArea will be rendering
      height - the height for which to check the width of this area
      minimumWidth - location to store the minimum width
      naturalWidth - location to store the natural width

    • getRequestMode

      public SizeRequestMode getRequestMode()
      Deprecated.
      Gets whether the area prefers a height-for-width layout or a width-for-height layout.
      Returns:
      The GtkSizeRequestMode preferred by area.

    • hasRenderer

      @Deprecated public boolean hasRenderer(CellRenderer renderer)
      Deprecated.
      Checks if this CellArea contains renderer.
      Parameters:
      renderer - the GtkCellRenderer to check
      Returns:
      true if renderer is in the area.

    • innerCellArea

      @Deprecated public void innerCellArea(Widget widget, Rectangle cellArea, Rectangle innerArea)
      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 gtk_cell_area_request_renderer().
      Parameters:
      widget - the GtkWidget that this CellArea is rendering onto
      cellArea - the widget relative coordinates where one of area’s cells is to be placed
      innerArea - the return location for the inner cell area

    • isActivatable

      @Deprecated public boolean isActivatable()
      Deprecated.
      Returns whether the area can do anything when activated, after applying new attributes to area.
      Returns:
      whether this CellArea can do anything when activated.

    • isFocusSibling

      @Deprecated public boolean isFocusSibling(CellRenderer renderer, CellRenderer sibling)
      Deprecated.
      Returns whether sibling is one of renderer’s focus siblings (see gtk_cell_area_add_focus_sibling()).
      Parameters:
      renderer - the GtkCellRenderer expected to have focus
      sibling - the GtkCellRenderer to check against renderer’s sibling list
      Returns:
      true if sibling is a focus sibling of renderer

    • remove

      @Deprecated public void remove(CellRenderer renderer)
      Deprecated.
      Removes renderer from area.
      Parameters:
      renderer - the GtkCellRenderer to remove from this CellArea

    • removeFocusSibling

      @Deprecated public void removeFocusSibling(CellRenderer renderer, CellRenderer sibling)
      Deprecated.
      Removes sibling from renderer’s focus sibling list (see gtk_cell_area_add_focus_sibling()).
      Parameters:
      renderer - the GtkCellRenderer expected to have focus
      sibling - the GtkCellRenderer to remove from renderer’s focus area

    • requestRenderer

      @Deprecated public void requestRenderer(CellRenderer renderer, Orientation orientation, Widget widget, int forSize, @Nullable Out<Integer> minimumSize, @Nullable Out<Integer> naturalSize)
      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 gtk_cell_area_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 this CellArea is rendering onto
      forSize - the allocation contextual size to request for, or -1 if the base request for the orientation is to be returned.
      minimumSize - location to store the minimum size
      naturalSize - location to store the natural size

    • setFocusCell

      @Deprecated public void setFocusCell(@Nullable CellRenderer renderer)
      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 gtk_tree_view_set_cursor_on_cell().

      Parameters:
      renderer - the GtkCellRenderer to give focus to

    • snapshot

      @Deprecated public void snapshot(CellAreaContext context, Widget widget, Snapshot snapshot, Rectangle backgroundArea, Rectangle cellArea, Set<CellRendererState> flags, boolean paintFocus)
      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 this CellArea is rendering to
      snapshot - the GtkSnapshot to draw to
      backgroundArea - the widget relative coordinates for area’s background
      cellArea - the widget relative coordinates for this CellArea
      flags - the GtkCellRendererState for this CellArea in this row.
      paintFocus - whether this CellArea should paint focus on focused cells for focused rows or not.

    • snapshot

      @Deprecated public void snapshot(CellAreaContext context, Widget widget, Snapshot snapshot, Rectangle backgroundArea, Rectangle cellArea, CellRendererState flags, boolean paintFocus)
      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 this CellArea is rendering to
      snapshot - the GtkSnapshot to draw to
      backgroundArea - the widget relative coordinates for area’s background
      cellArea - the widget relative coordinates for this CellArea
      flags - the GtkCellRendererState for this CellArea in this row.
      paintFocus - whether this CellArea should paint focus on focused cells for focused rows or not.

    • stopEditing

      @Deprecated public void stopEditing(boolean canceled)
      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 gtk_cell_area_get_edited_cell() and gtk_cell_area_get_edit_widget().

      Parameters:
      canceled - whether editing was canceled.

    • getCellProperty

      protected void getCellProperty(CellRenderer renderer, int propertyId, Value value, ParamSpec pspec)
      Deprecated.
      This should be implemented to report the values of child cell properties for a given child GtkCellRenderer.

    • setCellProperty

      protected void setCellProperty(CellRenderer renderer, int propertyId, Value value, ParamSpec pspec)
      Deprecated.
      This should be implemented to handle changes in child cell properties for a given GtkCellRenderer that were previously installed on the GtkCellAreaClass with gtk_cell_area_class_install_cell_property().

    • onAddEditable

      public SignalConnection<CellArea.AddEditableCallback> onAddEditable(CellArea.AddEditableCallback handler)
      Deprecated.
      Indicates that editing has started on renderer and that editable should be added to the owning cell-layouting widget at cellArea.
      Parameters:
      handler - the signal handler
      Returns:
      a signal handler ID to keep track of the signal connection
      See Also:

    • emitAddEditable

      public void emitAddEditable(@Nullable CellRenderer renderer, @Nullable CellEditable editable, @Nullable Rectangle cellArea, String path)
      Deprecated.
      Emits the "add-editable" signal. See onAddEditable(CellArea.AddEditableCallback).

    • onApplyAttributes

      public SignalConnection<CellArea.ApplyAttributesCallback> onApplyAttributes(CellArea.ApplyAttributesCallback handler)
      Deprecated.
      This signal is emitted whenever applying attributes to area from model
      Parameters:
      handler - the signal handler
      Returns:
      a signal handler ID to keep track of the signal connection
      See Also:

    • emitApplyAttributes

      public void emitApplyAttributes(@Nullable TreeModel model, @Nullable TreeIter iter, boolean isExpander, boolean isExpanded)
      Deprecated.
      Emits the "apply-attributes" signal. See onApplyAttributes(CellArea.ApplyAttributesCallback).

    • onFocusChanged

      public SignalConnection<CellArea.FocusChangedCallback> onFocusChanged(CellArea.FocusChangedCallback handler)
      Deprecated.

      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.

      Parameters:
      handler - the signal handler
      Returns:
      a signal handler ID to keep track of the signal connection
      See Also:

    • emitFocusChanged

      public void emitFocusChanged(@Nullable CellRenderer renderer, String path)
      Deprecated.
      Emits the "focus-changed" signal. See onFocusChanged(CellArea.FocusChangedCallback).

    • onRemoveEditable

      public SignalConnection<CellArea.RemoveEditableCallback> onRemoveEditable(CellArea.RemoveEditableCallback handler)
      Deprecated.
      Indicates that editing finished on renderer and that editable should be removed from the owning cell-layouting widget.
      Parameters:
      handler - the signal handler
      Returns:
      a signal handler ID to keep track of the signal connection
      See Also:

    • emitRemoveEditable

      public void emitRemoveEditable(@Nullable CellRenderer renderer, @Nullable CellEditable editable)
      Deprecated.
      Emits the "remove-editable" signal. See onRemoveEditable(CellArea.RemoveEditableCallback).