]> Pileus Git - ~andy/gtk/blob - gtk/gtkcellarea.c
Make GtkCellArea use GtkStyleContext
[~andy/gtk] / gtk / gtkcellarea.c
1 /* gtkcellarea.c
2  *
3  * Copyright (C) 2010 Openismus GmbH
4  *
5  * Authors:
6  *      Tristan Van Berkom <tristanvb@openismus.com>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23
24 /**
25  * SECTION:gtkcellarea
26  * @Short_Description: An abstract class for laying out GtkCellRenderers
27  * @Title: GtkCellArea
28  *
29  * The #GtkCellArea is an abstract class for #GtkCellLayout widgets
30  * (also referred to as "layouting widgets") to interface with an
31  * arbitrary number of #GtkCellRenderers and interact with the user
32  * for a given #GtkTreeModel row.
33  *
34  * The cell area handles events, focus navigation, drawing and
35  * size requests and allocations for a given row of data.
36  *
37  * Usually users dont have to interact with the #GtkCellArea directly
38  * unless they are implementing a cell layouting widget themselves.
39  *
40  * <refsect2 id="cell-area-geometry-management">
41  * <title>Requesting area sizes</title>
42  * <para>
43  * As outlined in <link linkend="geometry-management">GtkWidget's
44  * geometry management section</link>, GTK+ uses a height-for-width
45  * geometry management system to compute the sizes of widgets and user
46  * interfaces. #GtkCellArea uses the same semantics to calculate the
47  * size of an area for an arbitrary number of #GtkTreeModel rows.
48  *
49  * When requesting the size of a cell area one needs to calculate
50  * the size for a handful of rows, this will be done differently by
51  * different layouting widgets. For instance a #GtkTreeViewColumn
52  * always lines up the areas from top to bottom while a #GtkIconView
53  * on the other hand might enforce that all areas received the same
54  * width and wrap the areas around, requesting height for more cell
55  * areas when allocated less width.
56  *
57  * It's also important for areas to maintain some cell
58  * alignments with areas rendered for adjacent rows (cells can
59  * appear "columnized" inside an area even when the size of
60  * cells are different in each row). For this reason the #GtkCellArea
61  * uses a #GtkCellAreaContext object to store the alignments
62  * and sizes along the way (as well as the overall largest minimum
63  * and natural size for all the rows which have been calculated
64  * with the said context).
65  *
66  * The #GtkCellAreaContext is an opaque object specific to the
67  * #GtkCellArea which created it (see gtk_cell_area_create_context()).
68  * The owning cell layouting widget can create as many contexts as
69  * it wishes to calculate sizes of rows which should receive the
70  * same size in at least one orientation (horizontally or vertically),
71  * however it's important that the same #GtkCellAreaContext which
72  * was used to request the sizes for a given #GtkTreeModel row be
73  * used when rendering or processing events for that row.
74  *
75  * In order to request the width of all the rows at the root level
76  * of a #GtkTreeModel one would do the following:
77  * <example>
78  *   <title>Requesting the width of a handful of GtkTreeModel rows</title>
79  *   <programlisting>
80  * GtkTreeIter iter;
81  * gint        minimum_width;
82  * gint        natural_width;
83  *
84  * valid = gtk_tree_model_get_iter_first (model, &iter);
85  * while (valid)
86  *   {
87  *     gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
88  *     gtk_cell_area_get_preferred_width (area, context, widget, NULL, NULL);
89  *
90  *     valid = gtk_tree_model_iter_next (model, &iter);
91  *   }
92  * gtk_cell_area_context_get_preferred_width (context, &minimum_width, &natural_width);
93  *   </programlisting>
94  * </example>
95  * Note that in this example it's not important to observe the
96  * returned minimum and natural width of the area for each row
97  * unless the cell layouting object is actually interested in the
98  * widths of individual rows. The overall width is however stored
99  * in the accompanying #GtkCellAreaContext object and can be consulted
100  * at any time.
101  *
102  * This can be useful since #GtkCellLayout widgets usually have to
103  * support requesting and rendering rows in treemodels with an
104  * exceedingly large amount of rows. The #GtkCellLayout widget in
105  * that case would calculate the required width of the rows in an
106  * idle or timeout source (see g_timeout_add()) and when the widget
107  * is requested its actual width in #GtkWidgetClass.get_preferred_width()
108  * it can simply consult the width accumulated so far in the
109  * #GtkCellAreaContext object.
110  *
111  * A simple example where rows are rendered from top to bottom and
112  * take up the full width of the layouting widget would look like:
113  * <example>
114  *   <title>A typical get_preferred_width() implementation</title>
115  *   <programlisting>
116  * static void
117  * foo_get_preferred_width (GtkWidget       *widget,
118  *                          gint            *minimum_size,
119  *                          gint            *natural_size)
120  * {
121  *   Foo        *foo  = FOO (widget);
122  *   FooPrivate *priv = foo->priv;
123  *
124  *   foo_ensure_at_least_one_handfull_of_rows_have_been_requested (foo);
125  *
126  *   gtk_cell_area_context_get_preferred_width (priv->context, minimum_size, natural_size);
127  * }
128  *   </programlisting>
129  * </example>
130  * In the above example the Foo widget has to make sure that some
131  * row sizes have been calculated (the amount of rows that Foo judged
132  * was appropriate to request space for in a single timeout iteration)
133  * before simply returning the amount of space required by the area via
134  * the #GtkCellAreaContext.
135  *
136  * Requesting the height for width (or width for height) of an area is
137  * a similar task except in this case the #GtkCellAreaContext does not
138  * store the data (actually, it does not know how much space the layouting
139  * widget plans to allocate it for every row, it's up to the layouting
140  * widget to render each row of data with the appropriate height and
141  * width which was requested by the #GtkCellArea).
142  *
143  * In order to request the height for width of all the rows at the
144  * root level of a #GtkTreeModel one would do the following:
145  * <example>
146  *   <title>Requesting the height for width of a handful of GtkTreeModel rows</title>
147  *   <programlisting>
148  * GtkTreeIter iter;
149  * gint        minimum_height;
150  * gint        natural_height;
151  * gint        full_minimum_height = 0;
152  * gint        full_natural_height = 0;
153  *
154  * valid = gtk_tree_model_get_iter_first (model, &iter);
155  * while (valid)
156  *   {
157  *     gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
158  *     gtk_cell_area_get_preferred_height_for_width (area, context, widget,
159  *                                                   width, &minimum_height, &natural_height);
160  *
161  *     if (width_is_for_allocation)
162  *        cache_row_height (&iter, minimum_height, natural_height);
163  *
164  *     full_minimum_height += minimum_height;
165  *     full_natural_height += natural_height;
166  *
167  *     valid = gtk_tree_model_iter_next (model, &iter);
168  *   }
169  *   </programlisting>
170  * </example>
171  * Note that in the above example we would need to cache the heights
172  * returned for each row so that we would know what sizes to render the
173  * areas for each row. However we would only want to really cache the
174  * heights if the request is intended for the layouting widgets real
175  * allocation.
176  *
177  * In some cases the layouting widget is requested the height for an
178  * arbitrary for_width, this is a special case for layouting widgets
179  * who need to request size for tens of thousands  of rows. For this
180  * case it's only important that the layouting widget calculate
181  * one reasonably sized chunk of rows and return that height
182  * synchronously. The reasoning here is that any layouting widget is
183  * at least capable of synchronously calculating enough height to fill
184  * the screen height (or scrolled window height) in response to a single
185  * call to #GtkWidgetClass.get_preferred_height_for_width(). Returning
186  * a perfect height for width that is larger than the screen area is
187  * inconsequential since after the layouting receives an allocation
188  * from a scrolled window it simply continues to drive the the scrollbar
189  * values while more and more height is required for the row heights
190  * that are calculated in the background.
191  * </para>
192  * </refsect2>
193  * <refsect2 id="cell-area-rendering">
194  * <title>Rendering Areas</title>
195  * <para>
196  * Once area sizes have been aquired at least for the rows in the
197  * visible area of the layouting widget they can be rendered at
198  * #GtkWidgetClass.draw() time.
199  *
200  * A crude example of how to render all the rows at the root level
201  * runs as follows:
202  * <example>
203  *   <title>Requesting the width of a handful of GtkTreeModel rows</title>
204  *   <programlisting>
205  * GtkAllocation allocation;
206  * GdkRectangle  cell_area = { 0, };
207  * GtkTreeIter   iter;
208  * gint          minimum_width;
209  * gint          natural_width;
210  *
211  * gtk_widget_get_allocation (widget, &allocation);
212  * cell_area.width = allocation.width;
213  *
214  * valid = gtk_tree_model_get_iter_first (model, &iter);
215  * while (valid)
216  *   {
217  *     cell_area.height = get_cached_height_for_row (&iter);
218  *
219  *     gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
220  *     gtk_cell_area_render (area, context, widget, cr,
221  *                           &cell_area, &cell_area, state_flags, FALSE);
222  *
223  *     cell_area.y += cell_area.height;
224  *
225  *     valid = gtk_tree_model_iter_next (model, &iter);
226  *   }
227  *   </programlisting>
228  * </example>
229  * Note that the cached height in this example really depends on how
230  * the layouting widget works. The layouting widget might decide to
231  * give every row it's minimum or natural height or, if the model content
232  * is expected to fit inside the layouting widget without scrolling, it
233  * would make sense to calculate the allocation for each row at
234  * #GtkWidget::size-allocate time using gtk_distribute_natural_allocation().
235  * </para>
236  * </refsect2>
237  * <refsect2 id="cell-area-events-and-focus">
238  * <title>Handling Events and Driving Keyboard Focus</title>
239  * <para>
240  * Passing events to the area is as simple as handling events on any
241  * normal widget and then passing them to the gtk_cell_area_event()
242  * API as they come in. Usually #GtkCellArea is only interested in
243  * button events, however some customized derived areas can be implemented
244  * who are interested in handling other events. Handling an event can
245  * trigger the #GtkCellArea::focus-changed signal to fire; as well as
246  * #GtkCellArea::add-editable in the case that an editable cell was
247  * clicked and needs to start editing. You can call
248  * gtk_cell_area_stop_editing() at any time to cancel any cell editing
249  * that is currently in progress.
250  *
251  * The #GtkCellArea drives keyboard focus from cell to cell in a way
252  * similar to #GtkWidget. For layouting widgets that support giving
253  * focus to cells it's important to remember to pass %GTK_CELL_RENDERER_FOCUSED
254  * to the area functions for the row that has focus and to tell the
255  * area to paint the focus at render time.
256  *
257  * Layouting widgets that accept focus on cells should implement the
258  * #GtkWidgetClass.focus() virtual method. The layouting widget is always
259  * responsible for knowing where #GtkTreeModel rows are rendered inside
260  * the widget, so at #GtkWidgetClass.focus() time the layouting widget
261  * should use the #GtkCellArea methods to navigate focus inside the area
262  * and then observe the GtkDirectionType to pass the focus to adjacent
263  * rows and areas.
264  *
265  * A basic example of how the #GtkWidgetClass.focus() virtual method
266  * should be implemented:
267  * <example>
268  *   <title>Implementing keyboard focus navigation</title>
269  *   <programlisting>
270  * static gboolean
271  * foo_focus (GtkWidget       *widget,
272  *            GtkDirectionType direction)
273  * {
274  *   Foo        *foo  = FOO (widget);
275  *   FooPrivate *priv = foo->priv;
276  *   gint        focus_row;
277  *   gboolean    have_focus = FALSE;
278  *
279  *   focus_row = priv->focus_row;
280  *
281  *   if (!gtk_widget_has_focus (widget))
282  *     gtk_widget_grab_focus (widget);
283  *
284  *   valid = gtk_tree_model_iter_nth_child (priv->model, &iter, NULL, priv->focus_row);
285  *   while (valid)
286  *     {
287  *       gtk_cell_area_apply_attributes (priv->area, priv->model, &iter, FALSE, FALSE);
288  *
289  *       if (gtk_cell_area_focus (priv->area, direction))
290  *         {
291  *            priv->focus_row = focus_row;
292  *            have_focus = TRUE;
293  *            break;
294  *         }
295  *       else
296  *         {
297  *           if (direction == GTK_DIR_RIGHT ||
298  *               direction == GTK_DIR_LEFT)
299  *             break;
300  *           else if (direction == GTK_DIR_UP ||
301  *                    direction == GTK_DIR_TAB_BACKWARD)
302  *            {
303  *               if (focus_row == 0)
304  *                 break;
305  *               else
306  *                {
307  *                   focus_row--;
308  *                   valid = gtk_tree_model_iter_nth_child (priv->model, &iter, NULL, focus_row);
309  *                }
310  *             }
311  *           else
312  *             {
313  *               if (focus_row == last_row)
314  *                 break;
315  *               else
316  *                 {
317  *                   focus_row++;
318  *                   valid = gtk_tree_model_iter_next (priv->model, &iter);
319  *                 }
320  *             }
321  *         }
322  *     }
323  *     return have_focus;
324  * }
325  *   </programlisting>
326  * </example>
327  * Note that the layouting widget is responsible for matching the
328  * GtkDirectionType values to the way it lays out its cells.
329  * </para>
330  * </refsect2>
331  * <refsect2 id="cell-properties">
332  * <title>Cell Properties</title>
333  * <para>
334  * The #GtkCellArea introduces <emphasis>cell properties</emphasis>
335  * for #GtkCellRenderers in very much the same way that #GtkContainer
336  * introduces <link linkend="child-properties">child properties</link>
337  * for #GtkWidgets. This provides some general interfaces for defining
338  * the relationship cell areas have with their cells. For instance in a
339  * #GtkCellAreaBox a cell might "expand" and receive extra space when
340  * the area is allocated more than it's full natural request, or a cell
341  * might be configured to "align" with adjacent rows which were requested
342  * and rendered with the same #GtkCellAreaContext.
343  *
344  * Use gtk_cell_area_class_install_cell_property() to install cell
345  * properties for a cell area class and gtk_cell_area_class_find_cell_property()
346  * or gtk_cell_area_class_list_cell_properties() to get information about
347  * existing cell properties.
348  *
349  * To set the value of a cell property, use gtk_cell_area_cell_set_property(),
350  * gtk_cell_area_cell_set() or gtk_cell_area_cell_set_valist(). To obtain
351  * the value of a cell property, use gtk_cell_area_cell_get_property(),
352  * gtk_cell_area_cell_get() or gtk_cell_area_cell_get_valist().
353  * </para>
354  * </refsect2>
355  */
356
357 #include "config.h"
358
359 #include <stdarg.h>
360 #include <string.h>
361 #include <stdlib.h>
362
363 #include "gtkintl.h"
364 #include "gtkcelllayout.h"
365 #include "gtkcellarea.h"
366 #include "gtkcellareacontext.h"
367 #include "gtkmarshalers.h"
368 #include "gtkprivate.h"
369
370 #include <gobject/gvaluecollector.h>
371
372
373 /* GObjectClass */
374 static void      gtk_cell_area_dispose                             (GObject            *object);
375 static void      gtk_cell_area_finalize                            (GObject            *object);
376 static void      gtk_cell_area_set_property                        (GObject            *object,
377                                                                     guint               prop_id,
378                                                                     const GValue       *value,
379                                                                     GParamSpec         *pspec);
380 static void      gtk_cell_area_get_property                        (GObject            *object,
381                                                                     guint               prop_id,
382                                                                     GValue             *value,
383                                                                     GParamSpec         *pspec);
384
385 /* GtkCellAreaClass */
386 static gint      gtk_cell_area_real_event                          (GtkCellArea          *area,
387                                                                     GtkCellAreaContext   *context,
388                                                                     GtkWidget            *widget,
389                                                                     GdkEvent             *event,
390                                                                     const GdkRectangle   *cell_area,
391                                                                     GtkCellRendererState  flags);
392 static void      gtk_cell_area_real_render                         (GtkCellArea          *area,
393                                                                     GtkCellAreaContext   *context,
394                                                                     GtkWidget            *widget,
395                                                                     cairo_t              *cr,
396                                                                     const GdkRectangle   *background_area,
397                                                                     const GdkRectangle   *cell_area,
398                                                                     GtkCellRendererState  flags,
399                                                                     gboolean              paint_focus);
400 static void      gtk_cell_area_real_apply_attributes               (GtkCellArea           *area,
401                                                                     GtkTreeModel          *tree_model,
402                                                                     GtkTreeIter           *iter,
403                                                                     gboolean               is_expander,
404                                                                     gboolean               is_expanded);
405 static void      gtk_cell_area_real_get_preferred_height_for_width (GtkCellArea           *area,
406                                                                     GtkCellAreaContext    *context,
407                                                                     GtkWidget             *widget,
408                                                                     gint                   width,
409                                                                     gint                  *minimum_height,
410                                                                     gint                  *natural_height);
411 static void      gtk_cell_area_real_get_preferred_width_for_height (GtkCellArea           *area,
412                                                                     GtkCellAreaContext    *context,
413                                                                     GtkWidget             *widget,
414                                                                     gint                   height,
415                                                                     gint                  *minimum_width,
416                                                                     gint                  *natural_width);
417 static gboolean  gtk_cell_area_real_is_activatable                 (GtkCellArea           *area);
418 static gboolean  gtk_cell_area_real_activate                       (GtkCellArea           *area,
419                                                                     GtkCellAreaContext    *context,
420                                                                     GtkWidget             *widget,
421                                                                     const GdkRectangle    *cell_area,
422                                                                     GtkCellRendererState   flags,
423                                                                     gboolean               edit_only);
424
425 /* GtkCellLayoutIface */
426 static void      gtk_cell_area_cell_layout_init              (GtkCellLayoutIface    *iface);
427 static void      gtk_cell_area_pack_default                  (GtkCellLayout         *cell_layout,
428                                                               GtkCellRenderer       *renderer,
429                                                               gboolean               expand);
430 static void      gtk_cell_area_clear                         (GtkCellLayout         *cell_layout);
431 static void      gtk_cell_area_add_attribute                 (GtkCellLayout         *cell_layout,
432                                                               GtkCellRenderer       *renderer,
433                                                               const gchar           *attribute,
434                                                               gint                   column);
435 static void      gtk_cell_area_set_cell_data_func            (GtkCellLayout         *cell_layout,
436                                                               GtkCellRenderer       *cell,
437                                                               GtkCellLayoutDataFunc  func,
438                                                               gpointer               func_data,
439                                                               GDestroyNotify         destroy);
440 static void      gtk_cell_area_clear_attributes              (GtkCellLayout         *cell_layout,
441                                                               GtkCellRenderer       *renderer);
442 static void      gtk_cell_area_reorder                       (GtkCellLayout         *cell_layout,
443                                                               GtkCellRenderer       *cell,
444                                                               gint                   position);
445 static GList    *gtk_cell_area_get_cells                     (GtkCellLayout         *cell_layout);
446 static GtkCellArea *gtk_cell_area_get_area                   (GtkCellLayout         *cell_layout);
447
448 /* GtkBuildableIface */
449 static void      gtk_cell_area_buildable_init                (GtkBuildableIface     *iface);
450 static void      gtk_cell_area_buildable_custom_tag_end      (GtkBuildable          *buildable,
451                                                               GtkBuilder            *builder,
452                                                               GObject               *child,
453                                                               const gchar           *tagname,
454                                                               gpointer              *data);
455
456 /* Used in foreach loop to check if a child renderer is present */
457 typedef struct {
458   GtkCellRenderer *renderer;
459   gboolean         has_renderer;
460 } HasRendererCheck;
461
462 /* Used in foreach loop to get a cell's allocation */
463 typedef struct {
464   GtkCellRenderer *renderer;
465   GdkRectangle     allocation;
466 } RendererAllocationData;
467
468 /* Used in foreach loop to render cells */
469 typedef struct {
470   GtkCellArea         *area;
471   GtkWidget           *widget;
472   cairo_t             *cr;
473   GdkRectangle         focus_rect;
474   GtkCellRendererState render_flags;
475   guint                paint_focus : 1;
476   guint                focus_all   : 1;
477   guint                first_focus : 1;
478 } CellRenderData;
479
480 /* Used in foreach loop to get a cell by position */
481 typedef struct {
482   gint             x;
483   gint             y;
484   GtkCellRenderer *renderer;
485   GdkRectangle     cell_area;
486 } CellByPositionData;
487
488 /* Attribute/Cell metadata */
489 typedef struct {
490   const gchar *attribute;
491   gint         column;
492 } CellAttribute;
493
494 typedef struct {
495   GSList          *attributes;
496
497   GtkCellLayoutDataFunc  func;
498   gpointer               data;
499   GDestroyNotify         destroy;
500   GtkCellLayout         *proxy;
501 } CellInfo;
502
503 static CellInfo       *cell_info_new       (GtkCellLayoutDataFunc  func,
504                                             gpointer               data,
505                                             GDestroyNotify         destroy);
506 static void            cell_info_free      (CellInfo              *info);
507 static CellAttribute  *cell_attribute_new  (GtkCellRenderer       *renderer,
508                                             const gchar           *attribute,
509                                             gint                   column);
510 static void            cell_attribute_free (CellAttribute         *attribute);
511 static gint            cell_attribute_find (CellAttribute         *cell_attribute,
512                                             const gchar           *attribute);
513
514 /* Internal functions/signal emissions */
515 static void            gtk_cell_area_add_editable     (GtkCellArea        *area,
516                                                        GtkCellRenderer    *renderer,
517                                                        GtkCellEditable    *editable,
518                                                        const GdkRectangle *cell_area);
519 static void            gtk_cell_area_remove_editable  (GtkCellArea        *area,
520                                                        GtkCellRenderer    *renderer,
521                                                        GtkCellEditable    *editable);
522 static void            gtk_cell_area_set_edit_widget  (GtkCellArea        *area,
523                                                        GtkCellEditable    *editable);
524 static void            gtk_cell_area_set_edited_cell  (GtkCellArea        *area,
525                                                        GtkCellRenderer    *renderer);
526
527
528 /* Struct to pass data along while looping over
529  * cell renderers to apply attributes
530  */
531 typedef struct {
532   GtkCellArea  *area;
533   GtkTreeModel *model;
534   GtkTreeIter  *iter;
535   gboolean      is_expander;
536   gboolean      is_expanded;
537 } AttributeData;
538
539 struct _GtkCellAreaPrivate
540 {
541   /* The GtkCellArea bookkeeps any connected
542    * attributes in this hash table.
543    */
544   GHashTable      *cell_info;
545
546   /* Current path is saved as a side-effect
547    * of gtk_cell_area_apply_attributes()
548    */
549   gchar           *current_path;
550
551   /* Current cell being edited and editable widget used */
552   GtkCellEditable *edit_widget;
553   GtkCellRenderer *edited_cell;
554
555   /* Signal connections to the editable widget */
556   gulong           remove_widget_id;
557
558   /* Currently focused cell */
559   GtkCellRenderer *focus_cell;
560
561   /* Tracking which cells are focus siblings of focusable cells */
562   GHashTable      *focus_siblings;
563 };
564
565 enum {
566   PROP_0,
567   PROP_FOCUS_CELL,
568   PROP_EDITED_CELL,
569   PROP_EDIT_WIDGET
570 };
571
572 enum {
573   SIGNAL_APPLY_ATTRIBUTES,
574   SIGNAL_ADD_EDITABLE,
575   SIGNAL_REMOVE_EDITABLE,
576   SIGNAL_FOCUS_CHANGED,
577   LAST_SIGNAL
578 };
579
580 /* Keep the paramspec pool internal, no need to deliver notifications
581  * on cells. at least no perceived need for now
582  */
583 static GParamSpecPool *cell_property_pool = NULL;
584 static guint           cell_area_signals[LAST_SIGNAL] = { 0 };
585
586 #define PARAM_SPEC_PARAM_ID(pspec)              ((pspec)->param_id)
587 #define PARAM_SPEC_SET_PARAM_ID(pspec, id)      ((pspec)->param_id = (id))
588
589 G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GtkCellArea, gtk_cell_area, G_TYPE_INITIALLY_UNOWNED,
590                                   G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
591                                                          gtk_cell_area_cell_layout_init)
592                                   G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
593                                                          gtk_cell_area_buildable_init))
594
595 static void
596 gtk_cell_area_init (GtkCellArea *area)
597 {
598   GtkCellAreaPrivate *priv;
599
600   area->priv = G_TYPE_INSTANCE_GET_PRIVATE (area,
601                                             GTK_TYPE_CELL_AREA,
602                                             GtkCellAreaPrivate);
603   priv = area->priv;
604
605   priv->cell_info = g_hash_table_new_full (g_direct_hash,
606                                            g_direct_equal,
607                                            NULL,
608                                            (GDestroyNotify)cell_info_free);
609
610   priv->focus_siblings = g_hash_table_new_full (g_direct_hash,
611                                                 g_direct_equal,
612                                                 NULL,
613                                                 (GDestroyNotify)g_list_free);
614
615   priv->focus_cell         = NULL;
616   priv->edited_cell        = NULL;
617   priv->edit_widget        = NULL;
618
619   priv->remove_widget_id   = 0;
620 }
621
622 static void
623 gtk_cell_area_class_init (GtkCellAreaClass *class)
624 {
625   GObjectClass *object_class = G_OBJECT_CLASS (class);
626
627   /* GObjectClass */
628   object_class->dispose      = gtk_cell_area_dispose;
629   object_class->finalize     = gtk_cell_area_finalize;
630   object_class->get_property = gtk_cell_area_get_property;
631   object_class->set_property = gtk_cell_area_set_property;
632
633   /* general */
634   class->add              = NULL;
635   class->remove           = NULL;
636   class->foreach          = NULL;
637   class->event            = gtk_cell_area_real_event;
638   class->render           = gtk_cell_area_real_render;
639   class->apply_attributes = gtk_cell_area_real_apply_attributes;
640
641   /* geometry */
642   class->create_context                 = NULL;
643   class->get_request_mode               = NULL;
644   class->get_preferred_width            = NULL;
645   class->get_preferred_height           = NULL;
646   class->get_preferred_height_for_width = gtk_cell_area_real_get_preferred_height_for_width;
647   class->get_preferred_width_for_height = gtk_cell_area_real_get_preferred_width_for_height;
648
649   /* focus */
650   class->is_activatable = gtk_cell_area_real_is_activatable;
651   class->activate       = gtk_cell_area_real_activate;
652   class->focus          = NULL;
653
654   /* Signals */
655   /**
656    * GtkCellArea::apply-attributes:
657    * @area: the #GtkCellArea to apply the attributes to
658    * @model: the #GtkTreeModel to apply the attributes from
659    * @iter: the #GtkTreeIter indicating which row to apply the attributes of
660    * @is_expander: whether the view shows children for this row
661    * @is_expanded: whether the view is currently showing the children of this row
662    *
663    * This signal is emitted whenever applying attributes to @area from @model
664    *
665    * Since: 3.0
666    */
667   cell_area_signals[SIGNAL_APPLY_ATTRIBUTES] =
668     g_signal_new (I_("apply-attributes"),
669                   G_OBJECT_CLASS_TYPE (object_class),
670                   G_SIGNAL_RUN_FIRST,
671                   G_STRUCT_OFFSET (GtkCellAreaClass, apply_attributes),
672                   NULL, NULL,
673                   _gtk_marshal_VOID__OBJECT_BOXED_BOOLEAN_BOOLEAN,
674                   G_TYPE_NONE, 4,
675                   GTK_TYPE_TREE_MODEL,
676                   GTK_TYPE_TREE_ITER,
677                   G_TYPE_BOOLEAN,
678                   G_TYPE_BOOLEAN);
679
680   /**
681    * GtkCellArea::add-editable:
682    * @area: the #GtkCellArea where editing started
683    * @renderer: the #GtkCellRenderer that started the edited
684    * @editable: the #GtkCellEditable widget to add
685    * @cell_area: the #GtkWidget relative #GdkRectangle coordinates
686    *             where @editable should be added
687    * @path: the #GtkTreePath string this edit was initiated for
688    *
689    * Indicates that editing has started on @renderer and that @editable
690    * should be added to the owning cell layouting widget at @cell_area.
691    *
692    * Since: 3.0
693    */
694   cell_area_signals[SIGNAL_ADD_EDITABLE] =
695     g_signal_new (I_("add-editable"),
696                   G_OBJECT_CLASS_TYPE (object_class),
697                   G_SIGNAL_RUN_FIRST,
698                   0, /* No class closure here */
699                   NULL, NULL,
700                   _gtk_marshal_VOID__OBJECT_OBJECT_BOXED_STRING,
701                   G_TYPE_NONE, 4,
702                   GTK_TYPE_CELL_RENDERER,
703                   GTK_TYPE_CELL_EDITABLE,
704                   GDK_TYPE_RECTANGLE,
705                   G_TYPE_STRING);
706
707
708   /**
709    * GtkCellArea::remove-editable:
710    * @area: the #GtkCellArea where editing finished
711    * @renderer: the #GtkCellRenderer that finished editeding
712    * @editable: the #GtkCellEditable widget to remove
713    *
714    * Indicates that editing finished on @renderer and that @editable
715    * should be removed from the owning cell layouting widget.
716    *
717    * Since: 3.0
718    */
719   cell_area_signals[SIGNAL_REMOVE_EDITABLE] =
720     g_signal_new (I_("remove-editable"),
721                   G_OBJECT_CLASS_TYPE (object_class),
722                   G_SIGNAL_RUN_FIRST,
723                   0, /* No class closure here */
724                   NULL, NULL,
725                   _gtk_marshal_VOID__OBJECT_OBJECT,
726                   G_TYPE_NONE, 2,
727                   GTK_TYPE_CELL_RENDERER,
728                   GTK_TYPE_CELL_EDITABLE);
729
730   /**
731    * GtkCellArea::focus-changed:
732    * @area: the #GtkCellArea where focus changed
733    * @renderer: the #GtkCellRenderer that has focus
734    * @path: the current #GtkTreePath string set for @area
735    *
736    * Indicates that focus changed on this @area. This signal
737    * is emitted either as a result of focus handling or event
738    * handling.
739    *
740    * It's possible that the signal is emitted even if the
741    * currently focused renderer did not change, this is
742    * because focus may change to the same renderer in the
743    * same cell area for a different row of data.
744    *
745    * Since: 3.0
746    */
747   cell_area_signals[SIGNAL_FOCUS_CHANGED] =
748     g_signal_new (I_("focus-changed"),
749                   G_OBJECT_CLASS_TYPE (object_class),
750                   G_SIGNAL_RUN_FIRST,
751                   0, /* No class closure here */
752                   NULL, NULL,
753                   _gtk_marshal_VOID__OBJECT_STRING,
754                   G_TYPE_NONE, 2,
755                   GTK_TYPE_CELL_RENDERER,
756                   G_TYPE_STRING);
757
758   /* Properties */
759   /**
760    * GtkCellArea:focus-cell:
761    *
762    * The cell in the area that currently has focus
763    *
764    * Since: 3.0
765    */
766   g_object_class_install_property (object_class,
767                                    PROP_FOCUS_CELL,
768                                    g_param_spec_object
769                                    ("focus-cell",
770                                     P_("Focus Cell"),
771                                     P_("The cell which currently has focus"),
772                                     GTK_TYPE_CELL_RENDERER,
773                                     GTK_PARAM_READWRITE));
774
775   /**
776    * GtkCellArea:edited-cell:
777    *
778    * The cell in the area that is currently edited
779    *
780    * This property is read-only and only changes as
781    * a result of a call gtk_cell_area_activate_cell().
782    *
783    * Since: 3.0
784    */
785   g_object_class_install_property (object_class,
786                                    PROP_EDITED_CELL,
787                                    g_param_spec_object
788                                    ("edited-cell",
789                                     P_("Edited Cell"),
790                                     P_("The cell which is currently being edited"),
791                                     GTK_TYPE_CELL_RENDERER,
792                                     G_PARAM_READABLE));
793
794   /**
795    * GtkCellArea:edit-widget:
796    *
797    * The widget currently editing the edited cell
798    *
799    * This property is read-only and only changes as
800    * a result of a call gtk_cell_area_activate_cell().
801    *
802    * Since: 3.0
803    */
804   g_object_class_install_property (object_class,
805                                    PROP_EDIT_WIDGET,
806                                    g_param_spec_object
807                                    ("edit-widget",
808                                     P_("Edit Widget"),
809                                     P_("The widget currently editing the edited cell"),
810                                     GTK_TYPE_CELL_EDITABLE,
811                                     G_PARAM_READABLE));
812
813   /* Pool for Cell Properties */
814   if (!cell_property_pool)
815     cell_property_pool = g_param_spec_pool_new (FALSE);
816
817   g_type_class_add_private (object_class, sizeof (GtkCellAreaPrivate));
818 }
819
820 /*************************************************************
821  *                    CellInfo Basics                        *
822  *************************************************************/
823 static CellInfo *
824 cell_info_new (GtkCellLayoutDataFunc  func,
825                gpointer               data,
826                GDestroyNotify         destroy)
827 {
828   CellInfo *info = g_slice_new0 (CellInfo);
829
830   info->func     = func;
831   info->data     = data;
832   info->destroy  = destroy;
833
834   return info;
835 }
836
837 static void
838 cell_info_free (CellInfo *info)
839 {
840   if (info->destroy)
841     info->destroy (info->data);
842
843   g_slist_foreach (info->attributes, (GFunc)cell_attribute_free, NULL);
844   g_slist_free (info->attributes);
845
846   g_slice_free (CellInfo, info);
847 }
848
849 static CellAttribute  *
850 cell_attribute_new  (GtkCellRenderer       *renderer,
851                      const gchar           *attribute,
852                      gint                   column)
853 {
854   GParamSpec *pspec;
855
856   /* Check if the attribute really exists and point to
857    * the property string installed on the cell renderer
858    * class (dont dup the string)
859    */
860   pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (renderer), attribute);
861
862   if (pspec)
863     {
864       CellAttribute *cell_attribute = g_slice_new (CellAttribute);
865
866       cell_attribute->attribute = pspec->name;
867       cell_attribute->column    = column;
868
869       return cell_attribute;
870     }
871
872   return NULL;
873 }
874
875 static void
876 cell_attribute_free (CellAttribute *attribute)
877 {
878   g_slice_free (CellAttribute, attribute);
879 }
880
881 /* GCompareFunc for g_slist_find_custom() */
882 static gint
883 cell_attribute_find (CellAttribute *cell_attribute,
884                      const gchar   *attribute)
885 {
886   return g_strcmp0 (cell_attribute->attribute, attribute);
887 }
888
889 /*************************************************************
890  *                      GObjectClass                         *
891  *************************************************************/
892 static void
893 gtk_cell_area_finalize (GObject *object)
894 {
895   GtkCellArea        *area   = GTK_CELL_AREA (object);
896   GtkCellAreaPrivate *priv   = area->priv;
897
898   /* All cell renderers should already be removed at this point,
899    * just kill our (empty) hash tables here.
900    */
901   g_hash_table_destroy (priv->cell_info);
902   g_hash_table_destroy (priv->focus_siblings);
903
904   g_free (priv->current_path);
905
906   G_OBJECT_CLASS (gtk_cell_area_parent_class)->finalize (object);
907 }
908
909
910 static void
911 gtk_cell_area_dispose (GObject *object)
912 {
913   /* This removes every cell renderer that may be added to the GtkCellArea,
914    * subclasses should be breaking references to the GtkCellRenderers
915    * at this point.
916    */
917   gtk_cell_layout_clear (GTK_CELL_LAYOUT (object));
918
919   /* Remove any ref to a focused/edited cell */
920   gtk_cell_area_set_focus_cell (GTK_CELL_AREA (object), NULL);
921   gtk_cell_area_set_edited_cell (GTK_CELL_AREA (object), NULL);
922   gtk_cell_area_set_edit_widget (GTK_CELL_AREA (object), NULL);
923
924   G_OBJECT_CLASS (gtk_cell_area_parent_class)->dispose (object);
925 }
926
927 static void
928 gtk_cell_area_set_property (GObject       *object,
929                             guint          prop_id,
930                             const GValue  *value,
931                             GParamSpec    *pspec)
932 {
933   GtkCellArea *area = GTK_CELL_AREA (object);
934
935   switch (prop_id)
936     {
937     case PROP_FOCUS_CELL:
938       gtk_cell_area_set_focus_cell (area, (GtkCellRenderer *)g_value_get_object (value));
939       break;
940     default:
941       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
942       break;
943     }
944 }
945
946 static void
947 gtk_cell_area_get_property (GObject     *object,
948                             guint        prop_id,
949                             GValue      *value,
950                             GParamSpec  *pspec)
951 {
952   GtkCellArea        *area = GTK_CELL_AREA (object);
953   GtkCellAreaPrivate *priv = area->priv;
954
955   switch (prop_id)
956     {
957     case PROP_FOCUS_CELL:
958       g_value_set_object (value, priv->focus_cell);
959       break;
960     case PROP_EDITED_CELL:
961       g_value_set_object (value, priv->edited_cell);
962       break;
963     case PROP_EDIT_WIDGET:
964       g_value_set_object (value, priv->edit_widget);
965       break;
966     default:
967       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
968       break;
969     }
970 }
971
972 /*************************************************************
973  *                    GtkCellAreaClass                       *
974  *************************************************************/
975 static gint
976 gtk_cell_area_real_event (GtkCellArea          *area,
977                           GtkCellAreaContext   *context,
978                           GtkWidget            *widget,
979                           GdkEvent             *event,
980                           const GdkRectangle   *cell_area,
981                           GtkCellRendererState  flags)
982 {
983   GtkCellAreaPrivate *priv = area->priv;
984   gboolean            retval = FALSE;
985
986   if (event->type == GDK_KEY_PRESS && (flags & GTK_CELL_RENDERER_FOCUSED) != 0)
987     {
988       GdkEventKey *key_event = (GdkEventKey *)event;
989
990       /* Cancel any edits in progress */
991       if (priv->edited_cell && (key_event->keyval == GDK_KEY_Escape))
992         {
993           gtk_cell_area_stop_editing (area, TRUE);
994           retval = TRUE;
995         }
996     }
997   else if (event->type == GDK_BUTTON_PRESS)
998     {
999       GdkEventButton *button_event = (GdkEventButton *)event;
1000
1001       if (button_event->button == 1)
1002         {
1003           GtkCellRenderer *renderer = NULL;
1004           GtkCellRenderer *focus_renderer;
1005           GdkRectangle     alloc_area;
1006           gint             event_x, event_y;
1007
1008           /* We may need some semantics to tell us the offset of the event
1009            * window we are handling events for (i.e. GtkTreeView has a bin_window) */
1010           event_x = button_event->x;
1011           event_y = button_event->y;
1012
1013           /* Dont try to search for an event coordinate that is not in the area, that will
1014            * trigger a runtime warning.
1015            */
1016           if (event_x >= cell_area->x && event_x <= cell_area->x + cell_area->width &&
1017               event_y >= cell_area->y && event_y <= cell_area->y + cell_area->height)
1018             renderer =
1019               gtk_cell_area_get_cell_at_position (area, context, widget,
1020                                                   cell_area, event_x, event_y,
1021                                                   &alloc_area);
1022
1023           if (renderer)
1024             {
1025               focus_renderer = gtk_cell_area_get_focus_from_sibling (area, renderer);
1026               if (!focus_renderer)
1027                 focus_renderer = renderer;
1028
1029               /* If we're already editing, cancel it and set focus */
1030               if (gtk_cell_area_get_edited_cell (area))
1031                 {
1032                   /* XXX Was it really canceled in this case ? */
1033                   gtk_cell_area_stop_editing (area, TRUE);
1034                   gtk_cell_area_set_focus_cell (area, focus_renderer);
1035                   retval = TRUE;
1036                 }
1037               else
1038                 {
1039                   /* If we are activating via a focus sibling,
1040                    * we need to fetch the right cell area for the real event renderer */
1041                   if (focus_renderer != renderer)
1042                     gtk_cell_area_get_cell_allocation (area, context, widget, focus_renderer,
1043                                                        cell_area, &alloc_area);
1044
1045                   gtk_cell_area_set_focus_cell (area, focus_renderer);
1046                   retval = gtk_cell_area_activate_cell (area, widget, focus_renderer,
1047                                                         event, &alloc_area, flags);
1048                 }
1049             }
1050         }
1051     }
1052
1053   return retval;
1054 }
1055
1056 static gboolean
1057 render_cell (GtkCellRenderer        *renderer,
1058              const GdkRectangle     *cell_area,
1059              const GdkRectangle     *cell_background,
1060              CellRenderData         *data)
1061 {
1062   GtkCellRenderer      *focus_cell;
1063   GtkCellRendererState  flags;
1064   GdkRectangle          inner_area;
1065
1066   focus_cell = gtk_cell_area_get_focus_cell (data->area);
1067   flags      = data->render_flags;
1068
1069   gtk_cell_area_inner_cell_area (data->area, data->widget, cell_area, &inner_area);
1070
1071   if ((flags & GTK_CELL_RENDERER_FOCUSED) &&
1072       (data->focus_all ||
1073        (focus_cell &&
1074         (renderer == focus_cell ||
1075          gtk_cell_area_is_focus_sibling (data->area, focus_cell, renderer)))))
1076     {
1077       gint focus_line_width;
1078       GdkRectangle cell_focus;
1079
1080       gtk_cell_renderer_get_aligned_area (renderer, data->widget, flags, &inner_area, &cell_focus);
1081
1082       gtk_widget_style_get (data->widget,
1083                             "focus-line-width", &focus_line_width,
1084                             NULL);
1085
1086       /* The focus rectangle is located around the aligned area of the cell */
1087       cell_focus.x -= focus_line_width;
1088       cell_focus.y -= focus_line_width;
1089       cell_focus.width += 2 * focus_line_width;
1090       cell_focus.height += 2 * focus_line_width;
1091
1092       if (data->first_focus)
1093         {
1094           data->first_focus = FALSE;
1095           data->focus_rect  = cell_focus;
1096         }
1097       else
1098         {
1099           gdk_rectangle_union (&data->focus_rect, &cell_focus, &data->focus_rect);
1100         }
1101     }
1102
1103   gtk_cell_renderer_render (renderer, data->cr, data->widget,
1104                             cell_background, &inner_area, flags);
1105
1106   return FALSE;
1107 }
1108
1109 static void
1110 gtk_cell_area_real_render (GtkCellArea          *area,
1111                            GtkCellAreaContext   *context,
1112                            GtkWidget            *widget,
1113                            cairo_t              *cr,
1114                            const GdkRectangle   *background_area,
1115                            const GdkRectangle   *cell_area,
1116                            GtkCellRendererState  flags,
1117                            gboolean              paint_focus)
1118 {
1119   CellRenderData render_data =
1120     {
1121       area,
1122       widget,
1123       cr,
1124       { 0, },
1125       flags,
1126       paint_focus,
1127       FALSE, TRUE
1128     };
1129
1130   /* Make sure we dont paint a focus rectangle while there
1131    * is an editable widget in play
1132    */
1133   if (gtk_cell_area_get_edited_cell (area))
1134     render_data.paint_focus = FALSE;
1135
1136   /* If no cell can activate but the caller wants focus painted,
1137    * then we paint focus around all cells */
1138   if ((flags & GTK_CELL_RENDERER_FOCUSED) != 0 && paint_focus &&
1139       !gtk_cell_area_is_activatable (area))
1140     render_data.focus_all = TRUE;
1141
1142   gtk_cell_area_foreach_alloc (area, context, widget, cell_area, background_area,
1143                                (GtkCellAllocCallback)render_cell, &render_data);
1144
1145   if (render_data.paint_focus &&
1146       render_data.focus_rect.width != 0 &&
1147       render_data.focus_rect.height != 0)
1148     {
1149       GtkStyleContext *style_context;
1150       GtkStateFlags renderer_state = 0;
1151
1152       style_context = gtk_widget_get_style_context (widget);
1153       gtk_style_context_save (style_context);
1154
1155       renderer_state = gtk_cell_renderer_get_state (NULL, widget, flags);
1156       gtk_style_context_set_state (style_context, renderer_state);
1157
1158       cairo_save (cr);
1159
1160       gdk_cairo_rectangle (cr, background_area);
1161       cairo_clip (cr);
1162
1163       gtk_render_focus (style_context, cr,
1164                         render_data.focus_rect.x,     render_data.focus_rect.y,
1165                         render_data.focus_rect.width, render_data.focus_rect.height);
1166
1167       gtk_style_context_restore (style_context);
1168       cairo_restore (cr);
1169     }
1170 }
1171
1172 static void
1173 apply_cell_attributes (GtkCellRenderer *renderer,
1174                        CellInfo        *info,
1175                        AttributeData   *data)
1176 {
1177   CellAttribute *attribute;
1178   GSList        *list;
1179   GValue         value = { 0, };
1180   gboolean       is_expander;
1181   gboolean       is_expanded;
1182
1183   g_object_freeze_notify (G_OBJECT (renderer));
1184
1185   /* Whether a row expands or is presently expanded can only be
1186    * provided by the view (as these states can vary across views
1187    * accessing the same model).
1188    */
1189   g_object_get (renderer, "is-expander", &is_expander, NULL);
1190   if (is_expander != data->is_expander)
1191     g_object_set (renderer, "is-expander", data->is_expander, NULL);
1192
1193   g_object_get (renderer, "is-expanded", &is_expanded, NULL);
1194   if (is_expanded != data->is_expanded)
1195     g_object_set (renderer, "is-expanded", data->is_expanded, NULL);
1196
1197   /* Apply the attributes directly to the renderer */
1198   for (list = info->attributes; list; list = list->next)
1199     {
1200       attribute = list->data;
1201
1202       gtk_tree_model_get_value (data->model, data->iter, attribute->column, &value);
1203       g_object_set_property (G_OBJECT (renderer), attribute->attribute, &value);
1204       g_value_unset (&value);
1205     }
1206
1207   /* Call any GtkCellLayoutDataFunc that may have been set by the user
1208    */
1209   if (info->func)
1210     info->func (info->proxy ? info->proxy : GTK_CELL_LAYOUT (data->area), renderer,
1211                 data->model, data->iter, info->data);
1212
1213   g_object_thaw_notify (G_OBJECT (renderer));
1214 }
1215
1216 static void
1217 gtk_cell_area_real_apply_attributes (GtkCellArea           *area,
1218                                      GtkTreeModel          *tree_model,
1219                                      GtkTreeIter           *iter,
1220                                      gboolean               is_expander,
1221                                      gboolean               is_expanded)
1222 {
1223
1224   GtkCellAreaPrivate *priv;
1225   AttributeData       data;
1226   GtkTreePath        *path;
1227
1228   priv = area->priv;
1229
1230   /* Feed in data needed to apply to every renderer */
1231   data.area        = area;
1232   data.model       = tree_model;
1233   data.iter        = iter;
1234   data.is_expander = is_expander;
1235   data.is_expanded = is_expanded;
1236
1237   /* Go over any cells that have attributes or custom GtkCellLayoutDataFuncs and
1238    * apply the data from the treemodel */
1239   g_hash_table_foreach (priv->cell_info, (GHFunc)apply_cell_attributes, &data);
1240
1241   /* Update the currently applied path */
1242   g_free (priv->current_path);
1243   path               = gtk_tree_model_get_path (tree_model, iter);
1244   priv->current_path = gtk_tree_path_to_string (path);
1245   gtk_tree_path_free (path);
1246 }
1247
1248 static void
1249 gtk_cell_area_real_get_preferred_height_for_width (GtkCellArea        *area,
1250                                                    GtkCellAreaContext *context,
1251                                                    GtkWidget          *widget,
1252                                                    gint                width,
1253                                                    gint               *minimum_height,
1254                                                    gint               *natural_height)
1255 {
1256   /* If the area doesnt do height-for-width, fallback on base preferred height */
1257   GTK_CELL_AREA_GET_CLASS (area)->get_preferred_width (area, context, widget, minimum_height, natural_height);
1258 }
1259
1260 static void
1261 gtk_cell_area_real_get_preferred_width_for_height (GtkCellArea        *area,
1262                                                    GtkCellAreaContext *context,
1263                                                    GtkWidget          *widget,
1264                                                    gint                height,
1265                                                    gint               *minimum_width,
1266                                                    gint               *natural_width)
1267 {
1268   /* If the area doesnt do width-for-height, fallback on base preferred width */
1269   GTK_CELL_AREA_GET_CLASS (area)->get_preferred_width (area, context, widget, minimum_width, natural_width);
1270 }
1271
1272 static gboolean
1273 get_is_activatable (GtkCellRenderer *renderer,
1274                     gboolean        *activatable)
1275 {
1276
1277   if (gtk_cell_renderer_is_activatable (renderer))
1278     *activatable = TRUE;
1279
1280   return *activatable;
1281 }
1282
1283 static gboolean
1284 gtk_cell_area_real_is_activatable (GtkCellArea *area)
1285 {
1286   gboolean activatable = FALSE;
1287
1288   /* Checks if any renderer can focus for the currently applied
1289    * attributes.
1290    *
1291    * Subclasses can override this in the case that they are also
1292    * rendering widgets as well as renderers.
1293    */
1294   gtk_cell_area_foreach (area, (GtkCellCallback)get_is_activatable, &activatable);
1295
1296   return activatable;
1297 }
1298
1299 static gboolean
1300 gtk_cell_area_real_activate (GtkCellArea         *area,
1301                              GtkCellAreaContext  *context,
1302                              GtkWidget           *widget,
1303                              const GdkRectangle  *cell_area,
1304                              GtkCellRendererState flags,
1305                              gboolean             edit_only)
1306 {
1307   GtkCellAreaPrivate *priv = area->priv;
1308   GdkRectangle        renderer_area;
1309   GtkCellRenderer    *activate_cell = NULL;
1310   GtkCellRendererMode mode;
1311
1312   if (priv->focus_cell)
1313     {
1314       g_object_get (priv->focus_cell, "mode", &mode, NULL);
1315
1316       if (gtk_cell_renderer_get_visible (priv->focus_cell) &&
1317           (edit_only ? mode == GTK_CELL_RENDERER_MODE_EDITABLE :
1318            mode != GTK_CELL_RENDERER_MODE_INERT))
1319         activate_cell = priv->focus_cell;
1320     }
1321   else
1322     {
1323       GList *cells, *l;
1324
1325       /* GtkTreeView sometimes wants to activate a cell when no
1326        * cells are in focus.
1327        */
1328       cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (area));
1329       for (l = cells; l && !activate_cell; l = l->next)
1330         {
1331           GtkCellRenderer *renderer = l->data;
1332
1333           g_object_get (renderer, "mode", &mode, NULL);
1334
1335           if (gtk_cell_renderer_get_visible (renderer) &&
1336               (edit_only ? mode == GTK_CELL_RENDERER_MODE_EDITABLE :
1337                mode != GTK_CELL_RENDERER_MODE_INERT))
1338             activate_cell = renderer;
1339         }
1340       g_list_free (cells);
1341     }
1342
1343   if (activate_cell)
1344     {
1345       /* Get the allocation of the focused cell.
1346        */
1347       gtk_cell_area_get_cell_allocation (area, context, widget, activate_cell,
1348                                          cell_area, &renderer_area);
1349
1350       /* Activate or Edit the cell
1351        *
1352        * Currently just not sending an event, renderers afaics dont use
1353        * the event argument anyway, worst case is we can synthesize one.
1354        */
1355       if (gtk_cell_area_activate_cell (area, widget, activate_cell, NULL,
1356                                        &renderer_area, flags))
1357         return TRUE;
1358     }
1359
1360   return FALSE;
1361 }
1362
1363 /*************************************************************
1364  *                   GtkCellLayoutIface                      *
1365  *************************************************************/
1366 static void
1367 gtk_cell_area_cell_layout_init (GtkCellLayoutIface *iface)
1368 {
1369   iface->pack_start         = gtk_cell_area_pack_default;
1370   iface->pack_end           = gtk_cell_area_pack_default;
1371   iface->clear              = gtk_cell_area_clear;
1372   iface->add_attribute      = gtk_cell_area_add_attribute;
1373   iface->set_cell_data_func = gtk_cell_area_set_cell_data_func;
1374   iface->clear_attributes   = gtk_cell_area_clear_attributes;
1375   iface->reorder            = gtk_cell_area_reorder;
1376   iface->get_cells          = gtk_cell_area_get_cells;
1377   iface->get_area           = gtk_cell_area_get_area;
1378 }
1379
1380 static void
1381 gtk_cell_area_pack_default (GtkCellLayout         *cell_layout,
1382                             GtkCellRenderer       *renderer,
1383                             gboolean               expand)
1384 {
1385   gtk_cell_area_add (GTK_CELL_AREA (cell_layout), renderer);
1386 }
1387
1388 static void
1389 gtk_cell_area_clear (GtkCellLayout *cell_layout)
1390 {
1391   GtkCellArea *area = GTK_CELL_AREA (cell_layout);
1392   GList *l, *cells  =
1393     gtk_cell_layout_get_cells (cell_layout);
1394
1395   for (l = cells; l; l = l->next)
1396     {
1397       GtkCellRenderer *renderer = l->data;
1398       gtk_cell_area_remove (area, renderer);
1399     }
1400
1401   g_list_free (cells);
1402 }
1403
1404 static void
1405 gtk_cell_area_add_attribute (GtkCellLayout         *cell_layout,
1406                              GtkCellRenderer       *renderer,
1407                              const gchar           *attribute,
1408                              gint                   column)
1409 {
1410   gtk_cell_area_attribute_connect (GTK_CELL_AREA (cell_layout),
1411                                    renderer, attribute, column);
1412 }
1413
1414 static void
1415 gtk_cell_area_set_cell_data_func (GtkCellLayout         *cell_layout,
1416                                   GtkCellRenderer       *renderer,
1417                                   GtkCellLayoutDataFunc  func,
1418                                   gpointer               func_data,
1419                                   GDestroyNotify         destroy)
1420 {
1421   GtkCellArea *area   = GTK_CELL_AREA (cell_layout);
1422
1423   _gtk_cell_area_set_cell_data_func_with_proxy (area, renderer, (GFunc)func, func_data, destroy, NULL);
1424 }
1425
1426 static void
1427 gtk_cell_area_clear_attributes (GtkCellLayout         *cell_layout,
1428                                 GtkCellRenderer       *renderer)
1429 {
1430   GtkCellArea        *area = GTK_CELL_AREA (cell_layout);
1431   GtkCellAreaPrivate *priv = area->priv;
1432   CellInfo           *info;
1433
1434   info = g_hash_table_lookup (priv->cell_info, renderer);
1435
1436   if (info)
1437     {
1438       g_slist_foreach (info->attributes, (GFunc)cell_attribute_free, NULL);
1439       g_slist_free (info->attributes);
1440
1441       info->attributes = NULL;
1442     }
1443 }
1444
1445 static void
1446 gtk_cell_area_reorder (GtkCellLayout   *cell_layout,
1447                        GtkCellRenderer *cell,
1448                        gint             position)
1449 {
1450   g_warning ("GtkCellLayout::reorder not implemented for `%s'",
1451              g_type_name (G_TYPE_FROM_INSTANCE (cell_layout)));
1452 }
1453
1454 static gboolean
1455 accum_cells (GtkCellRenderer *renderer,
1456              GList          **accum)
1457 {
1458   *accum = g_list_prepend (*accum, renderer);
1459
1460   return FALSE;
1461 }
1462
1463 static GList *
1464 gtk_cell_area_get_cells (GtkCellLayout *cell_layout)
1465 {
1466   GList *cells = NULL;
1467
1468   gtk_cell_area_foreach (GTK_CELL_AREA (cell_layout),
1469                          (GtkCellCallback)accum_cells,
1470                          &cells);
1471
1472   return g_list_reverse (cells);
1473 }
1474
1475 static GtkCellArea *
1476 gtk_cell_area_get_area (GtkCellLayout *cell_layout)
1477 {
1478   return GTK_CELL_AREA (cell_layout);
1479 }
1480
1481 /*************************************************************
1482  *                   GtkBuildableIface                       *
1483  *************************************************************/
1484 static void
1485 gtk_cell_area_buildable_init (GtkBuildableIface *iface)
1486 {
1487   iface->add_child = _gtk_cell_layout_buildable_add_child;
1488   iface->custom_tag_start = _gtk_cell_layout_buildable_custom_tag_start;
1489   iface->custom_tag_end = gtk_cell_area_buildable_custom_tag_end;
1490 }
1491
1492 static void
1493 gtk_cell_area_buildable_custom_tag_end (GtkBuildable *buildable,
1494                                         GtkBuilder   *builder,
1495                                         GObject      *child,
1496                                         const gchar  *tagname,
1497                                         gpointer     *data)
1498 {
1499   /* Just ignore the boolean return from here */
1500   _gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname, data);
1501 }
1502
1503 /*************************************************************
1504  *                            API                            *
1505  *************************************************************/
1506
1507 /**
1508  * gtk_cell_area_add:
1509  * @area: a #GtkCellArea
1510  * @renderer: the #GtkCellRenderer to add to @area
1511  *
1512  * Adds @renderer to @area with the default child cell properties.
1513  *
1514  * Since: 3.0
1515  */
1516 void
1517 gtk_cell_area_add (GtkCellArea        *area,
1518                    GtkCellRenderer    *renderer)
1519 {
1520   GtkCellAreaClass *class;
1521
1522   g_return_if_fail (GTK_IS_CELL_AREA (area));
1523   g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
1524
1525   class = GTK_CELL_AREA_GET_CLASS (area);
1526
1527   if (class->add)
1528     class->add (area, renderer);
1529   else
1530     g_warning ("GtkCellAreaClass::add not implemented for `%s'",
1531                g_type_name (G_TYPE_FROM_INSTANCE (area)));
1532 }
1533
1534 /**
1535  * gtk_cell_area_remove:
1536  * @area: a #GtkCellArea
1537  * @renderer: the #GtkCellRenderer to remove from @area
1538  *
1539  * Removes @renderer from @area.
1540  *
1541  * Since: 3.0
1542  */
1543 void
1544 gtk_cell_area_remove (GtkCellArea        *area,
1545                       GtkCellRenderer    *renderer)
1546 {
1547   GtkCellAreaClass   *class;
1548   GtkCellAreaPrivate *priv;
1549   GList              *renderers, *l;
1550
1551   g_return_if_fail (GTK_IS_CELL_AREA (area));
1552   g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
1553
1554   class = GTK_CELL_AREA_GET_CLASS (area);
1555   priv  = area->priv;
1556
1557   /* Remove any custom attributes and custom cell data func here first */
1558   g_hash_table_remove (priv->cell_info, renderer);
1559
1560   /* Remove focus siblings of this renderer */
1561   g_hash_table_remove (priv->focus_siblings, renderer);
1562
1563   /* Remove this renderer from any focus renderer's sibling list */
1564   renderers = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (area));
1565
1566   for (l = renderers; l; l = l->next)
1567     {
1568       GtkCellRenderer *focus_renderer = l->data;
1569
1570       if (gtk_cell_area_is_focus_sibling (area, focus_renderer, renderer))
1571         {
1572           gtk_cell_area_remove_focus_sibling (area, focus_renderer, renderer);
1573           break;
1574         }
1575     }
1576
1577   g_list_free (renderers);
1578
1579   if (class->remove)
1580     class->remove (area, renderer);
1581   else
1582     g_warning ("GtkCellAreaClass::remove not implemented for `%s'",
1583                g_type_name (G_TYPE_FROM_INSTANCE (area)));
1584 }
1585
1586 static gboolean
1587 get_has_renderer (GtkCellRenderer  *renderer,
1588                   HasRendererCheck *check)
1589 {
1590   if (renderer == check->renderer)
1591     check->has_renderer = TRUE;
1592
1593   return check->has_renderer;
1594 }
1595
1596 /**
1597  * gtk_cell_area_has_renderer:
1598  * @area: a #GtkCellArea
1599  * @renderer: the #GtkCellRenderer to check
1600  *
1601  * Checks if @area contains @renderer.
1602  *
1603  * Return value: %TRUE if @renderer is in the @area.
1604  *
1605  * Since: 3.0
1606  */
1607 gboolean
1608 gtk_cell_area_has_renderer (GtkCellArea     *area,
1609                             GtkCellRenderer *renderer)
1610 {
1611   HasRendererCheck check = { renderer, FALSE };
1612
1613   g_return_val_if_fail (GTK_IS_CELL_AREA (area), FALSE);
1614   g_return_val_if_fail (GTK_IS_CELL_RENDERER (renderer), FALSE);
1615
1616   gtk_cell_area_foreach (area, (GtkCellCallback)get_has_renderer, &check);
1617
1618   return check.has_renderer;
1619 }
1620
1621 /**
1622  * gtk_cell_area_foreach:
1623  * @area: a #GtkCellArea
1624  * @callback: (scope call): the #GtkCellCallback to call
1625  * @callback_data: user provided data pointer
1626  *
1627  * Calls @callback for every #GtkCellRenderer in @area.
1628  *
1629  * Since: 3.0
1630  */
1631 void
1632 gtk_cell_area_foreach (GtkCellArea        *area,
1633                        GtkCellCallback     callback,
1634                        gpointer            callback_data)
1635 {
1636   GtkCellAreaClass *class;
1637
1638   g_return_if_fail (GTK_IS_CELL_AREA (area));
1639   g_return_if_fail (callback != NULL);
1640
1641   class = GTK_CELL_AREA_GET_CLASS (area);
1642
1643   if (class->foreach)
1644     class->foreach (area, callback, callback_data);
1645   else
1646     g_warning ("GtkCellAreaClass::foreach not implemented for `%s'",
1647                g_type_name (G_TYPE_FROM_INSTANCE (area)));
1648 }
1649
1650 /**
1651  * gtk_cell_area_foreach_alloc:
1652  * @area: a #GtkCellArea
1653  * @context: the #GtkCellAreaContext for this row of data.
1654  * @widget: the #GtkWidget that @area is rendering to
1655  * @cell_area: the @widget relative coordinates and size for @area
1656  * @background_area: the @widget relative coordinates of the background area
1657  * @callback: (scope call): the #GtkCellAllocCallback to call
1658  * @callback_data: user provided data pointer
1659  *
1660  * Calls @callback for every #GtkCellRenderer in @area with the
1661  * allocated rectangle inside @cell_area.
1662  *
1663  * Since: 3.0
1664  */
1665 void
1666 gtk_cell_area_foreach_alloc (GtkCellArea          *area,
1667                              GtkCellAreaContext   *context,
1668                              GtkWidget            *widget,
1669                              const GdkRectangle   *cell_area,
1670                              const GdkRectangle   *background_area,
1671                              GtkCellAllocCallback  callback,
1672                              gpointer              callback_data)
1673 {
1674   GtkCellAreaClass *class;
1675
1676   g_return_if_fail (GTK_IS_CELL_AREA (area));
1677   g_return_if_fail (GTK_IS_CELL_AREA_CONTEXT (context));
1678   g_return_if_fail (GTK_IS_WIDGET (widget));
1679   g_return_if_fail (cell_area != NULL);
1680   g_return_if_fail (callback != NULL);
1681
1682   class = GTK_CELL_AREA_GET_CLASS (area);
1683
1684   if (class->foreach_alloc)
1685     class->foreach_alloc (area, context, widget, cell_area, background_area, callback, callback_data);
1686   else
1687     g_warning ("GtkCellAreaClass::foreach_alloc not implemented for `%s'",
1688                g_type_name (G_TYPE_FROM_INSTANCE (area)));
1689 }
1690
1691 /**
1692  * gtk_cell_area_event:
1693  * @area: a #GtkCellArea
1694  * @context: the #GtkCellAreaContext for this row of data.
1695  * @widget: the #GtkWidget that @area is rendering to
1696  * @event: the #GdkEvent to handle
1697  * @cell_area: the @widget relative coordinates for @area
1698  * @flags: the #GtkCellRendererState for @area in this row.
1699  *
1700  * Delegates event handling to a #GtkCellArea.
1701  *
1702  * Return value: %TRUE if the event was handled by @area.
1703  *
1704  * Since: 3.0
1705  */
1706 gint
1707 gtk_cell_area_event (GtkCellArea          *area,
1708                      GtkCellAreaContext   *context,
1709                      GtkWidget            *widget,
1710                      GdkEvent             *event,
1711                      const GdkRectangle   *cell_area,
1712                      GtkCellRendererState  flags)
1713 {
1714   GtkCellAreaClass *class;
1715
1716   g_return_val_if_fail (GTK_IS_CELL_AREA (area), 0);
1717   g_return_val_if_fail (GTK_IS_CELL_AREA_CONTEXT (context), 0);
1718   g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
1719   g_return_val_if_fail (event != NULL, 0);
1720   g_return_val_if_fail (cell_area != NULL, 0);
1721
1722   class = GTK_CELL_AREA_GET_CLASS (area);
1723
1724   if (class->event)
1725     return class->event (area, context, widget, event, cell_area, flags);
1726
1727   g_warning ("GtkCellAreaClass::event not implemented for `%s'",
1728              g_type_name (G_TYPE_FROM_INSTANCE (area)));
1729   return 0;
1730 }
1731
1732 /**
1733  * gtk_cell_area_render:
1734  * @area: a #GtkCellArea
1735  * @context: the #GtkCellAreaContext for this row of data.
1736  * @widget: the #GtkWidget that @area is rendering to
1737  * @cr: the #cairo_t to render with
1738  * @background_area: the @widget relative coordinates for @area's background
1739  * @cell_area: the @widget relative coordinates for @area
1740  * @flags: the #GtkCellRendererState for @area in this row.
1741  * @paint_focus: whether @area should paint focus on focused cells for focused rows or not.
1742  *
1743  * Renders @area's cells according to @area's layout onto @widget at
1744  * the given coordinates.
1745  *
1746  * Since: 3.0
1747  */
1748 void
1749 gtk_cell_area_render (GtkCellArea          *area,
1750                       GtkCellAreaContext   *context,
1751                       GtkWidget            *widget,
1752                       cairo_t              *cr,
1753                       const GdkRectangle   *background_area,
1754                       const GdkRectangle   *cell_area,
1755                       GtkCellRendererState  flags,
1756                       gboolean              paint_focus)
1757 {
1758   GtkCellAreaClass *class;
1759
1760   g_return_if_fail (GTK_IS_CELL_AREA (area));
1761   g_return_if_fail (GTK_IS_CELL_AREA_CONTEXT (context));
1762   g_return_if_fail (GTK_IS_WIDGET (widget));
1763   g_return_if_fail (cr != NULL);
1764   g_return_if_fail (background_area != NULL);
1765   g_return_if_fail (cell_area != NULL);
1766
1767   class = GTK_CELL_AREA_GET_CLASS (area);
1768
1769   if (class->render)
1770     class->render (area, context, widget, cr, background_area, cell_area, flags, paint_focus);
1771   else
1772     g_warning ("GtkCellAreaClass::render not implemented for `%s'",
1773                g_type_name (G_TYPE_FROM_INSTANCE (area)));
1774 }
1775
1776 static gboolean
1777 get_cell_allocation (GtkCellRenderer        *renderer,
1778                      const GdkRectangle     *cell_area,
1779                      const GdkRectangle     *cell_background,
1780                      RendererAllocationData *data)
1781 {
1782   if (data->renderer == renderer)
1783     data->allocation = *cell_area;
1784
1785   return (data->renderer == renderer);
1786 }
1787
1788 /**
1789  * gtk_cell_area_get_cell_allocation:
1790  * @area: a #GtkCellArea
1791  * @context: the #GtkCellAreaContext used to hold sizes for @area.
1792  * @widget: the #GtkWidget that @area is rendering on
1793  * @renderer: the #GtkCellRenderer to get the allocation for
1794  * @cell_area: the whole allocated area for @area in @widget
1795  *             for this row
1796  * @allocation: (out): where to store the allocation for @renderer
1797  *
1798  * Derives the allocation of @renderer inside @area if @area
1799  * were to be renderered in @cell_area.
1800  *
1801  * Since: 3.0
1802  */
1803 void
1804 gtk_cell_area_get_cell_allocation (GtkCellArea          *area,
1805                                    GtkCellAreaContext   *context,
1806                                    GtkWidget            *widget,
1807                                    GtkCellRenderer      *renderer,
1808                                    const GdkRectangle   *cell_area,
1809                                    GdkRectangle         *allocation)
1810 {
1811   RendererAllocationData data = { renderer, { 0, } };
1812
1813   g_return_if_fail (GTK_IS_CELL_AREA (area));
1814   g_return_if_fail (GTK_IS_CELL_AREA_CONTEXT (context));
1815   g_return_if_fail (GTK_IS_WIDGET (widget));
1816   g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
1817   g_return_if_fail (cell_area != NULL);
1818   g_return_if_fail (allocation != NULL);
1819
1820   gtk_cell_area_foreach_alloc (area, context, widget, cell_area, cell_area,
1821                                (GtkCellAllocCallback)get_cell_allocation, &data);
1822
1823   *allocation = data.allocation;
1824 }
1825
1826 static gboolean
1827 get_cell_by_position (GtkCellRenderer     *renderer,
1828                       const GdkRectangle  *cell_area,
1829                       const GdkRectangle  *cell_background,
1830                       CellByPositionData  *data)
1831 {
1832   if (data->x >= cell_area->x && data->x < cell_area->x + cell_area->width &&
1833       data->y >= cell_area->y && data->y < cell_area->y + cell_area->height)
1834     {
1835       data->renderer  = renderer;
1836       data->cell_area = *cell_area;
1837     }
1838
1839   return (data->renderer != NULL);
1840 }
1841
1842 /**
1843  * gtk_cell_area_get_cell_at_position:
1844  * @area: a #GtkCellArea
1845  * @context: the #GtkCellAreaContext used to hold sizes for @area.
1846  * @widget: the #GtkWidget that @area is rendering on
1847  * @cell_area: the whole allocated area for @area in @widget
1848  *             for this row
1849  * @x: the x position
1850  * @y: the y position
1851  * @alloc_area: (out) (allow-none): where to store the inner allocated area of the
1852  *                                  returned cell renderer, or %NULL.
1853  *
1854  * Gets the #GtkCellRenderer at @x and @y coordinates inside @area and optionally
1855  * returns the full cell allocation for it inside @cell_area.
1856  *
1857  * Return value: (transfer none): the #GtkCellRenderer at @x and @y.
1858  *
1859  * Since: 3.0
1860  */
1861 GtkCellRenderer *
1862 gtk_cell_area_get_cell_at_position (GtkCellArea          *area,
1863                                     GtkCellAreaContext   *context,
1864                                     GtkWidget            *widget,
1865                                     const GdkRectangle   *cell_area,
1866                                     gint                  x,
1867                                     gint                  y,
1868                                     GdkRectangle         *alloc_area)
1869 {
1870   CellByPositionData data = { x, y, NULL, { 0, } };
1871
1872   g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
1873   g_return_val_if_fail (GTK_IS_CELL_AREA_CONTEXT (context), NULL);
1874   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
1875   g_return_val_if_fail (cell_area != NULL, NULL);
1876   g_return_val_if_fail (x >= cell_area->x && x <= cell_area->x + cell_area->width, NULL);
1877   g_return_val_if_fail (y >= cell_area->y && y <= cell_area->y + cell_area->height, NULL);
1878
1879   gtk_cell_area_foreach_alloc (area, context, widget, cell_area, cell_area,
1880                                (GtkCellAllocCallback)get_cell_by_position, &data);
1881
1882   if (alloc_area)
1883     *alloc_area = data.cell_area;
1884
1885   return data.renderer;
1886 }
1887
1888 /*************************************************************
1889  *                      API: Geometry                        *
1890  *************************************************************/
1891 /**
1892  * gtk_cell_area_create_context:
1893  * @area: a #GtkCellArea
1894  *
1895  * Creates a #GtkCellAreaContext to be used with @area for
1896  * all purposes. #GtkCellAreaContext stores geometry information
1897  * for rows for which it was operated on, it is important to use
1898  * the same context for the same row of data at all times (i.e.
1899  * one should render and handle events with the same #GtkCellAreaContext
1900  * which was used to request the size of those rows of data).
1901  *
1902  * Return value: (transfer full): a newly created #GtkCellAreaContext which can be used with @area.
1903  *
1904  * Since: 3.0
1905  */
1906 GtkCellAreaContext *
1907 gtk_cell_area_create_context (GtkCellArea *area)
1908 {
1909   GtkCellAreaClass *class;
1910
1911   g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
1912
1913   class = GTK_CELL_AREA_GET_CLASS (area);
1914
1915   if (class->create_context)
1916     return class->create_context (area);
1917
1918   g_warning ("GtkCellAreaClass::create_context not implemented for `%s'",
1919              g_type_name (G_TYPE_FROM_INSTANCE (area)));
1920
1921   return NULL;
1922 }
1923
1924 /**
1925  * gtk_cell_area_copy_context:
1926  * @area: a #GtkCellArea
1927  * @context: the #GtkCellAreaContext to copy
1928  *
1929  * This is sometimes needed for cases where rows need to share
1930  * alignments in one orientation but may be separately grouped
1931  * in the opposing orientation.
1932  *
1933  * For instance, #GtkIconView creates all icons (rows) to have
1934  * the same width and the cells theirin to have the same
1935  * horizontal alignments. However each row of icons may have
1936  * a separate collective height. #GtkIconView uses this to
1937  * request the heights of each row based on a context which
1938  * was already used to request all the row widths that are
1939  * to be displayed.
1940  *
1941  * Return value: (transfer full): a newly created #GtkCellAreaContext copy of @context.
1942  *
1943  * Since: 3.0
1944  */
1945 GtkCellAreaContext *
1946 gtk_cell_area_copy_context (GtkCellArea        *area,
1947                             GtkCellAreaContext *context)
1948 {
1949   GtkCellAreaClass *class;
1950
1951   g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
1952   g_return_val_if_fail (GTK_IS_CELL_AREA_CONTEXT (context), NULL);
1953
1954   class = GTK_CELL_AREA_GET_CLASS (area);
1955
1956   if (class->copy_context)
1957     return class->copy_context (area, context);
1958
1959   g_warning ("GtkCellAreaClass::copy_context not implemented for `%s'",
1960              g_type_name (G_TYPE_FROM_INSTANCE (area)));
1961
1962   return NULL;
1963 }
1964
1965 /**
1966  * gtk_cell_area_get_request_mode:
1967  * @area: a #GtkCellArea
1968  *
1969  * Gets whether the area prefers a height-for-width layout
1970  * or a width-for-height layout.
1971  *
1972  * Return value: The #GtkSizeRequestMode preferred by @area.
1973  *
1974  * Since: 3.0
1975  */
1976 GtkSizeRequestMode
1977 gtk_cell_area_get_request_mode (GtkCellArea *area)
1978 {
1979   GtkCellAreaClass *class;
1980
1981   g_return_val_if_fail (GTK_IS_CELL_AREA (area),
1982                         GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH);
1983
1984   class = GTK_CELL_AREA_GET_CLASS (area);
1985
1986   if (class->get_request_mode)
1987     return class->get_request_mode (area);
1988
1989   g_warning ("GtkCellAreaClass::get_request_mode not implemented for `%s'",
1990              g_type_name (G_TYPE_FROM_INSTANCE (area)));
1991
1992   return GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH;
1993 }
1994
1995 /**
1996  * gtk_cell_area_get_preferred_width:
1997  * @area: a #GtkCellArea
1998  * @context: the #GtkCellAreaContext to perform this request with
1999  * @widget: the #GtkWidget where @area will be rendering
2000  * @minimum_width: (out) (allow-none): location to store the minimum width, or %NULL
2001  * @natural_width: (out) (allow-none): location to store the natural width, or %NULL
2002  *
2003  * Retrieves a cell area's initial minimum and natural width.
2004  *
2005  * @area will store some geometrical information in @context along the way,
2006  * when requesting sizes over an arbitrary number of rows, its not important
2007  * to check the @minimum_width and @natural_width of this call but rather to
2008  * consult gtk_cell_area_context_get_preferred_width() after a series of
2009  * requests.
2010  *
2011  * Since: 3.0
2012  */
2013 void
2014 gtk_cell_area_get_preferred_width (GtkCellArea        *area,
2015                                    GtkCellAreaContext *context,
2016                                    GtkWidget          *widget,
2017                                    gint               *minimum_width,
2018                                    gint               *natural_width)
2019 {
2020   GtkCellAreaClass *class;
2021
2022   g_return_if_fail (GTK_IS_CELL_AREA (area));
2023   g_return_if_fail (GTK_IS_WIDGET (widget));
2024
2025   class = GTK_CELL_AREA_GET_CLASS (area);
2026
2027   if (class->get_preferred_width)
2028     class->get_preferred_width (area, context, widget, minimum_width, natural_width);
2029   else
2030     g_warning ("GtkCellAreaClass::get_preferred_width not implemented for `%s'",
2031                g_type_name (G_TYPE_FROM_INSTANCE (area)));
2032 }
2033
2034 /**
2035  * gtk_cell_area_get_preferred_height_for_width:
2036  * @area: a #GtkCellArea
2037  * @context: the #GtkCellAreaContext which has already been requested for widths.
2038  * @widget: the #GtkWidget where @area will be rendering
2039  * @width: the width for which to check the height of this area
2040  * @minimum_height: (out) (allow-none): location to store the minimum height, or %NULL
2041  * @natural_height: (out) (allow-none): location to store the natural height, or %NULL
2042  *
2043  * Retrieves a cell area's minimum and natural height if it would be given
2044  * the specified @width.
2045  *
2046  * @area stores some geometrical information in @context along the way
2047  * while calling gtk_cell_area_get_preferred_width(), it's important to
2048  * perform a series of gtk_cell_area_get_preferred_width() requests with
2049  * @context first and then call gtk_cell_area_get_preferred_height_for_width()
2050  * on each cell area individually to get the height for width of each
2051  * fully requested row.
2052  *
2053  * If at some point, the width of a single row changes, it should be
2054  * requested with gtk_cell_area_get_preferred_width() again and then
2055  * the full width of the requested rows checked again with
2056  * gtk_cell_area_context_get_preferred_width().
2057  *
2058  * Since: 3.0
2059  */
2060 void
2061 gtk_cell_area_get_preferred_height_for_width (GtkCellArea        *area,
2062                                               GtkCellAreaContext *context,
2063                                               GtkWidget          *widget,
2064                                               gint                width,
2065                                               gint               *minimum_height,
2066                                               gint               *natural_height)
2067 {
2068   GtkCellAreaClass *class;
2069
2070   g_return_if_fail (GTK_IS_CELL_AREA (area));
2071   g_return_if_fail (GTK_IS_WIDGET (widget));
2072
2073   class = GTK_CELL_AREA_GET_CLASS (area);
2074   class->get_preferred_height_for_width (area, context, widget, width, minimum_height, natural_height);
2075 }
2076
2077
2078 /**
2079  * gtk_cell_area_get_preferred_height:
2080  * @area: a #GtkCellArea
2081  * @context: the #GtkCellAreaContext to perform this request with
2082  * @widget: the #GtkWidget where @area will be rendering
2083  * @minimum_height: (out) (allow-none): location to store the minimum height, or %NULL
2084  * @natural_height: (out) (allow-none): location to store the natural height, or %NULL
2085  *
2086  * Retrieves a cell area's initial minimum and natural height.
2087  *
2088  * @area will store some geometrical information in @context along the way,
2089  * when requesting sizes over an arbitrary number of rows, its not important
2090  * to check the @minimum_height and @natural_height of this call but rather to
2091  * consult gtk_cell_area_context_get_preferred_height() after a series of
2092  * requests.
2093  *
2094  * Since: 3.0
2095  */
2096 void
2097 gtk_cell_area_get_preferred_height (GtkCellArea        *area,
2098                                     GtkCellAreaContext *context,
2099                                     GtkWidget          *widget,
2100                                     gint               *minimum_height,
2101                                     gint               *natural_height)
2102 {
2103   GtkCellAreaClass *class;
2104
2105   g_return_if_fail (GTK_IS_CELL_AREA (area));
2106   g_return_if_fail (GTK_IS_WIDGET (widget));
2107
2108   class = GTK_CELL_AREA_GET_CLASS (area);
2109
2110   if (class->get_preferred_height)
2111     class->get_preferred_height (area, context, widget, minimum_height, natural_height);
2112   else
2113     g_warning ("GtkCellAreaClass::get_preferred_height not implemented for `%s'",
2114                g_type_name (G_TYPE_FROM_INSTANCE (area)));
2115 }
2116
2117 /**
2118  * gtk_cell_area_get_preferred_width_for_height:
2119  * @area: a #GtkCellArea
2120  * @context: the #GtkCellAreaContext which has already been requested for widths.
2121  * @widget: the #GtkWidget where @area will be rendering
2122  * @height: the height for which to check the width of this area
2123  * @minimum_width: (out) (allow-none): location to store the minimum width, or %NULL
2124  * @natural_width: (out) (allow-none): location to store the natural width, or %NULL
2125  *
2126  * Retrieves a cell area's minimum and natural width if it would be given
2127  * the specified @height.
2128  *
2129  * @area stores some geometrical information in @context along the way
2130  * while calling gtk_cell_area_get_preferred_height(), it's important to
2131  * perform a series of gtk_cell_area_get_preferred_height() requests with
2132  * @context first and then call gtk_cell_area_get_preferred_width_for_height()
2133  * on each cell area individually to get the height for width of each
2134  * fully requested row.
2135  *
2136  * If at some point, the height of a single row changes, it should be
2137  * requested with gtk_cell_area_get_preferred_height() again and then
2138  * the full height of the requested rows checked again with
2139  * gtk_cell_area_context_get_preferred_height().
2140  *
2141  * Since: 3.0
2142  */
2143 void
2144 gtk_cell_area_get_preferred_width_for_height (GtkCellArea        *area,
2145                                               GtkCellAreaContext *context,
2146                                               GtkWidget          *widget,
2147                                               gint                height,
2148                                               gint               *minimum_width,
2149                                               gint               *natural_width)
2150 {
2151   GtkCellAreaClass *class;
2152
2153   g_return_if_fail (GTK_IS_CELL_AREA (area));
2154   g_return_if_fail (GTK_IS_WIDGET (widget));
2155
2156   class = GTK_CELL_AREA_GET_CLASS (area);
2157   class->get_preferred_width_for_height (area, context, widget, height, minimum_width, natural_width);
2158 }
2159
2160 /*************************************************************
2161  *                      API: Attributes                      *
2162  *************************************************************/
2163
2164 /**
2165  * gtk_cell_area_attribute_connect:
2166  * @area: a #GtkCellArea
2167  * @renderer: the #GtkCellRenderer to connect an attribute for
2168  * @attribute: the attribute name
2169  * @column: the #GtkTreeModel column to fetch attribute values from
2170  *
2171  * Connects an @attribute to apply values from @column for the
2172  * #GtkTreeModel in use.
2173  *
2174  * Since: 3.0
2175  */
2176 void
2177 gtk_cell_area_attribute_connect (GtkCellArea        *area,
2178                                  GtkCellRenderer    *renderer,
2179                                  const gchar        *attribute,
2180                                  gint                column)
2181 {
2182   GtkCellAreaPrivate *priv;
2183   CellInfo           *info;
2184   CellAttribute      *cell_attribute;
2185
2186   g_return_if_fail (GTK_IS_CELL_AREA (area));
2187   g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2188   g_return_if_fail (attribute != NULL);
2189   g_return_if_fail (gtk_cell_area_has_renderer (area, renderer));
2190
2191   priv = area->priv;
2192   info = g_hash_table_lookup (priv->cell_info, renderer);
2193
2194   if (!info)
2195     {
2196       info = cell_info_new (NULL, NULL, NULL);
2197
2198       g_hash_table_insert (priv->cell_info, renderer, info);
2199     }
2200   else
2201     {
2202       GSList *node;
2203
2204       /* Check we are not adding the same attribute twice */
2205       if ((node = g_slist_find_custom (info->attributes, attribute,
2206                                        (GCompareFunc)cell_attribute_find)) != NULL)
2207         {
2208           cell_attribute = node->data;
2209
2210           g_warning ("Cannot connect attribute `%s' for cell renderer class `%s' "
2211                      "since `%s' is already attributed to column %d",
2212                      attribute,
2213                      g_type_name (G_TYPE_FROM_INSTANCE (area)),
2214                      attribute, cell_attribute->column);
2215           return;
2216         }
2217     }
2218
2219   cell_attribute = cell_attribute_new (renderer, attribute, column);
2220
2221   if (!cell_attribute)
2222     {
2223       g_warning ("Cannot connect attribute `%s' for cell renderer class `%s' "
2224                  "since attribute does not exist",
2225                  attribute,
2226                  g_type_name (G_TYPE_FROM_INSTANCE (area)));
2227       return;
2228     }
2229
2230   info->attributes = g_slist_prepend (info->attributes, cell_attribute);
2231 }
2232
2233 /**
2234  * gtk_cell_area_attribute_disconnect:
2235  * @area: a #GtkCellArea
2236  * @renderer: the #GtkCellRenderer to disconnect an attribute for
2237  * @attribute: the attribute name
2238  *
2239  * Disconnects @attribute for the @renderer in @area so that
2240  * attribute will no longer be updated with values from the
2241  * model.
2242  *
2243  * Since: 3.0
2244  */
2245 void
2246 gtk_cell_area_attribute_disconnect (GtkCellArea        *area,
2247                                     GtkCellRenderer    *renderer,
2248                                     const gchar        *attribute)
2249 {
2250   GtkCellAreaPrivate *priv;
2251   CellInfo           *info;
2252   CellAttribute      *cell_attribute;
2253   GSList             *node;
2254
2255   g_return_if_fail (GTK_IS_CELL_AREA (area));
2256   g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2257   g_return_if_fail (attribute != NULL);
2258   g_return_if_fail (gtk_cell_area_has_renderer (area, renderer));
2259
2260   priv = area->priv;
2261   info = g_hash_table_lookup (priv->cell_info, renderer);
2262
2263   if (info)
2264     {
2265       node = g_slist_find_custom (info->attributes, attribute,
2266                                   (GCompareFunc)cell_attribute_find);
2267       if (node)
2268         {
2269           cell_attribute = node->data;
2270
2271           cell_attribute_free (cell_attribute);
2272
2273           info->attributes = g_slist_delete_link (info->attributes, node);
2274         }
2275     }
2276 }
2277
2278 /**
2279  * gtk_cell_area_apply_attributes
2280  * @area: a #GtkCellArea
2281  * @tree_model: the #GtkTreeModel to pull values from
2282  * @iter: the #GtkTreeIter in @tree_model to apply values for
2283  * @is_expander: whether @iter has children
2284  * @is_expanded: whether @iter is expanded in the view and
2285  *               children are visible
2286  *
2287  * Applies any connected attributes to the renderers in
2288  * @area by pulling the values from @tree_model.
2289  *
2290  * Since: 3.0
2291  */
2292 void
2293 gtk_cell_area_apply_attributes (GtkCellArea  *area,
2294                                 GtkTreeModel *tree_model,
2295                                 GtkTreeIter  *iter,
2296                                 gboolean      is_expander,
2297                                 gboolean      is_expanded)
2298 {
2299   g_return_if_fail (GTK_IS_CELL_AREA (area));
2300   g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
2301   g_return_if_fail (iter != NULL);
2302
2303   g_signal_emit (area, cell_area_signals[SIGNAL_APPLY_ATTRIBUTES], 0,
2304                  tree_model, iter, is_expander, is_expanded);
2305 }
2306
2307 /**
2308  * gtk_cell_area_get_current_path_string:
2309  * @area: a #GtkCellArea
2310  *
2311  * Gets the current #GtkTreePath string for the currently
2312  * applied #GtkTreeIter, this is implicitly updated when
2313  * gtk_cell_area_apply_attributes() is called and can be
2314  * used to interact with renderers from #GtkCellArea
2315  * subclasses.
2316  *
2317  * Return value: The current #GtkTreePath string for the current
2318  * attributes applied to @area. This string belongs to the area and
2319  * should not be freed.
2320  *
2321  * Since: 3.0
2322  */
2323 G_CONST_RETURN gchar *
2324 gtk_cell_area_get_current_path_string (GtkCellArea *area)
2325 {
2326   GtkCellAreaPrivate *priv;
2327
2328   g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
2329
2330   priv = area->priv;
2331
2332   return priv->current_path;
2333 }
2334
2335
2336 /*************************************************************
2337  *                    API: Cell Properties                   *
2338  *************************************************************/
2339 /**
2340  * gtk_cell_area_class_install_cell_property:
2341  * @aclass: a #GtkCellAreaClass
2342  * @property_id: the id for the property
2343  * @pspec: the #GParamSpec for the property
2344  *
2345  * Installs a cell property on a cell area class.
2346  *
2347  * Since: 3.0
2348  */
2349 void
2350 gtk_cell_area_class_install_cell_property (GtkCellAreaClass   *aclass,
2351                                            guint               property_id,
2352                                            GParamSpec         *pspec)
2353 {
2354   g_return_if_fail (GTK_IS_CELL_AREA_CLASS (aclass));
2355   g_return_if_fail (G_IS_PARAM_SPEC (pspec));
2356   if (pspec->flags & G_PARAM_WRITABLE)
2357     g_return_if_fail (aclass->set_cell_property != NULL);
2358   if (pspec->flags & G_PARAM_READABLE)
2359     g_return_if_fail (aclass->get_cell_property != NULL);
2360   g_return_if_fail (property_id > 0);
2361   g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0);  /* paranoid */
2362   g_return_if_fail ((pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY)) == 0);
2363
2364   if (g_param_spec_pool_lookup (cell_property_pool, pspec->name, G_OBJECT_CLASS_TYPE (aclass), TRUE))
2365     {
2366       g_warning (G_STRLOC ": class `%s' already contains a cell property named `%s'",
2367                  G_OBJECT_CLASS_NAME (aclass), pspec->name);
2368       return;
2369     }
2370   g_param_spec_ref (pspec);
2371   g_param_spec_sink (pspec);
2372   PARAM_SPEC_SET_PARAM_ID (pspec, property_id);
2373   g_param_spec_pool_insert (cell_property_pool, pspec, G_OBJECT_CLASS_TYPE (aclass));
2374 }
2375
2376 /**
2377  * gtk_cell_area_class_find_cell_property:
2378  * @aclass: a #GtkCellAreaClass
2379  * @property_name: the name of the child property to find
2380  *
2381  * Finds a cell property of a cell area class by name.
2382  *
2383  * Return value: (transfer none): the #GParamSpec of the child property
2384  *   or %NULL if @aclass has no child property with that name.
2385  *
2386  * Since: 3.0
2387  */
2388 GParamSpec*
2389 gtk_cell_area_class_find_cell_property (GtkCellAreaClass   *aclass,
2390                                         const gchar        *property_name)
2391 {
2392   g_return_val_if_fail (GTK_IS_CELL_AREA_CLASS (aclass), NULL);
2393   g_return_val_if_fail (property_name != NULL, NULL);
2394
2395   return g_param_spec_pool_lookup (cell_property_pool,
2396                                    property_name,
2397                                    G_OBJECT_CLASS_TYPE (aclass),
2398                                    TRUE);
2399 }
2400
2401 /**
2402  * gtk_cell_area_class_list_cell_properties:
2403  * @aclass: a #GtkCellAreaClass
2404  * @n_properties: location to return the number of cell properties found
2405  *
2406  * Returns all cell properties of a cell area class.
2407  *
2408  * Return value: (array length=n_properties) (transfer container): a newly
2409  *     allocated %NULL-terminated array of #GParamSpec*.  The array
2410  *     must be freed with g_free().
2411  *
2412  * Since: 3.0
2413  */
2414 GParamSpec**
2415 gtk_cell_area_class_list_cell_properties (GtkCellAreaClass  *aclass,
2416                                           guint             *n_properties)
2417 {
2418   GParamSpec **pspecs;
2419   guint n;
2420
2421   g_return_val_if_fail (GTK_IS_CELL_AREA_CLASS (aclass), NULL);
2422
2423   pspecs = g_param_spec_pool_list (cell_property_pool,
2424                                    G_OBJECT_CLASS_TYPE (aclass),
2425                                    &n);
2426   if (n_properties)
2427     *n_properties = n;
2428
2429   return pspecs;
2430 }
2431
2432 /**
2433  * gtk_cell_area_add_with_properties:
2434  * @area: a #GtkCellArea
2435  * @renderer: a #GtkCellRenderer to be placed inside @area
2436  * @first_prop_name: the name of the first cell property to set
2437  * @Varargs: a %NULL-terminated list of property names and values, starting
2438  *           with @first_prop_name
2439  *
2440  * Adds @renderer to @area, setting cell properties at the same time.
2441  * See gtk_cell_area_add() and gtk_cell_area_cell_set() for more details.
2442  *
2443  * Since: 3.0
2444  */
2445 void
2446 gtk_cell_area_add_with_properties (GtkCellArea        *area,
2447                                    GtkCellRenderer    *renderer,
2448                                    const gchar        *first_prop_name,
2449                                    ...)
2450 {
2451   GtkCellAreaClass *class;
2452
2453   g_return_if_fail (GTK_IS_CELL_AREA (area));
2454   g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2455
2456   class = GTK_CELL_AREA_GET_CLASS (area);
2457
2458   if (class->add)
2459     {
2460       va_list var_args;
2461
2462       class->add (area, renderer);
2463
2464       va_start (var_args, first_prop_name);
2465       gtk_cell_area_cell_set_valist (area, renderer, first_prop_name, var_args);
2466       va_end (var_args);
2467     }
2468   else
2469     g_warning ("GtkCellAreaClass::add not implemented for `%s'",
2470                g_type_name (G_TYPE_FROM_INSTANCE (area)));
2471 }
2472
2473 /**
2474  * gtk_cell_area_cell_set:
2475  * @area: a #GtkCellArea
2476  * @renderer: a #GtkCellRenderer which is a cell inside @area
2477  * @first_prop_name: the name of the first cell property to set
2478  * @Varargs: a %NULL-terminated list of property names and values, starting
2479  *           with @first_prop_name
2480  *
2481  * Sets one or more cell properties for @cell in @area.
2482  *
2483  * Since: 3.0
2484  */
2485 void
2486 gtk_cell_area_cell_set (GtkCellArea        *area,
2487                         GtkCellRenderer    *renderer,
2488                         const gchar        *first_prop_name,
2489                         ...)
2490 {
2491   va_list var_args;
2492
2493   g_return_if_fail (GTK_IS_CELL_AREA (area));
2494   g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2495
2496   va_start (var_args, first_prop_name);
2497   gtk_cell_area_cell_set_valist (area, renderer, first_prop_name, var_args);
2498   va_end (var_args);
2499 }
2500
2501 /**
2502  * gtk_cell_area_cell_get:
2503  * @area: a #GtkCellArea
2504  * @renderer: a #GtkCellRenderer which is inside @area
2505  * @first_prop_name: the name of the first cell property to get
2506  * @Varargs: return location for the first cell property, followed
2507  *     optionally by more name/return location pairs, followed by %NULL
2508  *
2509  * Gets the values of one or more cell properties for @renderer in @area.
2510  *
2511  * Since: 3.0
2512  */
2513 void
2514 gtk_cell_area_cell_get (GtkCellArea        *area,
2515                         GtkCellRenderer    *renderer,
2516                         const gchar        *first_prop_name,
2517                         ...)
2518 {
2519   va_list var_args;
2520
2521   g_return_if_fail (GTK_IS_CELL_AREA (area));
2522   g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2523
2524   va_start (var_args, first_prop_name);
2525   gtk_cell_area_cell_get_valist (area, renderer, first_prop_name, var_args);
2526   va_end (var_args);
2527 }
2528
2529 static inline void
2530 area_get_cell_property (GtkCellArea     *area,
2531                         GtkCellRenderer *renderer,
2532                         GParamSpec      *pspec,
2533                         GValue          *value)
2534 {
2535   GtkCellAreaClass *class = g_type_class_peek (pspec->owner_type);
2536
2537   class->get_cell_property (area, renderer, PARAM_SPEC_PARAM_ID (pspec), value, pspec);
2538 }
2539
2540 static inline void
2541 area_set_cell_property (GtkCellArea     *area,
2542                         GtkCellRenderer *renderer,
2543                         GParamSpec      *pspec,
2544                         const GValue    *value)
2545 {
2546   GValue tmp_value = { 0, };
2547   GtkCellAreaClass *class = g_type_class_peek (pspec->owner_type);
2548
2549   /* provide a copy to work from, convert (if necessary) and validate */
2550   g_value_init (&tmp_value, G_PARAM_SPEC_VALUE_TYPE (pspec));
2551   if (!g_value_transform (value, &tmp_value))
2552     g_warning ("unable to set cell property `%s' of type `%s' from value of type `%s'",
2553                pspec->name,
2554                g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
2555                G_VALUE_TYPE_NAME (value));
2556   else if (g_param_value_validate (pspec, &tmp_value) && !(pspec->flags & G_PARAM_LAX_VALIDATION))
2557     {
2558       gchar *contents = g_strdup_value_contents (value);
2559
2560       g_warning ("value \"%s\" of type `%s' is invalid for property `%s' of type `%s'",
2561                  contents,
2562                  G_VALUE_TYPE_NAME (value),
2563                  pspec->name,
2564                  g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)));
2565       g_free (contents);
2566     }
2567   else
2568     {
2569       class->set_cell_property (area, renderer, PARAM_SPEC_PARAM_ID (pspec), &tmp_value, pspec);
2570     }
2571   g_value_unset (&tmp_value);
2572 }
2573
2574 /**
2575  * gtk_cell_area_cell_set_valist:
2576  * @area: a #GtkCellArea
2577  * @renderer: a #GtkCellRenderer which inside @area
2578  * @first_property_name: the name of the first cell property to set
2579  * @var_args: a %NULL-terminated list of property names and values, starting
2580  *           with @first_prop_name
2581  *
2582  * Sets one or more cell properties for @renderer in @area.
2583  *
2584  * Since: 3.0
2585  */
2586 void
2587 gtk_cell_area_cell_set_valist (GtkCellArea        *area,
2588                                GtkCellRenderer    *renderer,
2589                                const gchar        *first_property_name,
2590                                va_list             var_args)
2591 {
2592   const gchar *name;
2593
2594   g_return_if_fail (GTK_IS_CELL_AREA (area));
2595   g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2596
2597   name = first_property_name;
2598   while (name)
2599     {
2600       GValue value = { 0, };
2601       gchar *error = NULL;
2602       GParamSpec *pspec =
2603         g_param_spec_pool_lookup (cell_property_pool, name,
2604                                   G_OBJECT_TYPE (area), TRUE);
2605       if (!pspec)
2606         {
2607           g_warning ("%s: cell area class `%s' has no cell property named `%s'",
2608                      G_STRLOC, G_OBJECT_TYPE_NAME (area), name);
2609           break;
2610         }
2611       if (!(pspec->flags & G_PARAM_WRITABLE))
2612         {
2613           g_warning ("%s: cell property `%s' of cell area class `%s' is not writable",
2614                      G_STRLOC, pspec->name, G_OBJECT_TYPE_NAME (area));
2615           break;
2616         }
2617
2618       g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (pspec));
2619       G_VALUE_COLLECT (&value, var_args, 0, &error);
2620       if (error)
2621         {
2622           g_warning ("%s: %s", G_STRLOC, error);
2623           g_free (error);
2624
2625           /* we purposely leak the value here, it might not be
2626            * in a sane state if an error condition occoured
2627            */
2628           break;
2629         }
2630       area_set_cell_property (area, renderer, pspec, &value);
2631       g_value_unset (&value);
2632       name = va_arg (var_args, gchar*);
2633     }
2634 }
2635
2636 /**
2637  * gtk_cell_area_cell_get_valist:
2638  * @area: a #GtkCellArea
2639  * @renderer: a #GtkCellRenderer inside @area
2640  * @first_property_name: the name of the first property to get
2641  * @var_args: return location for the first property, followed
2642  *     optionally by more name/return location pairs, followed by %NULL
2643  *
2644  * Gets the values of one or more cell properties for @renderer in @area.
2645  *
2646  * Since: 3.0
2647  */
2648 void
2649 gtk_cell_area_cell_get_valist (GtkCellArea        *area,
2650                                GtkCellRenderer    *renderer,
2651                                const gchar        *first_property_name,
2652                                va_list             var_args)
2653 {
2654   const gchar *name;
2655
2656   g_return_if_fail (GTK_IS_CELL_AREA (area));
2657   g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2658
2659   name = first_property_name;
2660   while (name)
2661     {
2662       GValue value = { 0, };
2663       GParamSpec *pspec;
2664       gchar *error;
2665
2666       pspec = g_param_spec_pool_lookup (cell_property_pool, name,
2667                                         G_OBJECT_TYPE (area), TRUE);
2668       if (!pspec)
2669         {
2670           g_warning ("%s: cell area class `%s' has no cell property named `%s'",
2671                      G_STRLOC, G_OBJECT_TYPE_NAME (area), name);
2672           break;
2673         }
2674       if (!(pspec->flags & G_PARAM_READABLE))
2675         {
2676           g_warning ("%s: cell property `%s' of cell area class `%s' is not readable",
2677                      G_STRLOC, pspec->name, G_OBJECT_TYPE_NAME (area));
2678           break;
2679         }
2680
2681       g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (pspec));
2682       area_get_cell_property (area, renderer, pspec, &value);
2683       G_VALUE_LCOPY (&value, var_args, 0, &error);
2684       if (error)
2685         {
2686           g_warning ("%s: %s", G_STRLOC, error);
2687           g_free (error);
2688           g_value_unset (&value);
2689           break;
2690         }
2691       g_value_unset (&value);
2692       name = va_arg (var_args, gchar*);
2693     }
2694 }
2695
2696 /**
2697  * gtk_cell_area_cell_set_property:
2698  * @area: a #GtkCellArea
2699  * @renderer: a #GtkCellRenderer inside @area
2700  * @property_name: the name of the cell property to set
2701  * @value: the value to set the cell property to
2702  *
2703  * Sets a cell property for @renderer in @area.
2704  *
2705  * Since: 3.0
2706  */
2707 void
2708 gtk_cell_area_cell_set_property (GtkCellArea        *area,
2709                                  GtkCellRenderer    *renderer,
2710                                  const gchar        *property_name,
2711                                  const GValue       *value)
2712 {
2713   GParamSpec *pspec;
2714
2715   g_return_if_fail (GTK_IS_CELL_AREA (area));
2716   g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2717   g_return_if_fail (property_name != NULL);
2718   g_return_if_fail (G_IS_VALUE (value));
2719
2720   pspec = g_param_spec_pool_lookup (cell_property_pool, property_name,
2721                                     G_OBJECT_TYPE (area), TRUE);
2722   if (!pspec)
2723     g_warning ("%s: cell area class `%s' has no cell property named `%s'",
2724                G_STRLOC, G_OBJECT_TYPE_NAME (area), property_name);
2725   else if (!(pspec->flags & G_PARAM_WRITABLE))
2726     g_warning ("%s: cell property `%s' of cell area class `%s' is not writable",
2727                G_STRLOC, pspec->name, G_OBJECT_TYPE_NAME (area));
2728   else
2729     {
2730       area_set_cell_property (area, renderer, pspec, value);
2731     }
2732 }
2733
2734 /**
2735  * gtk_cell_area_cell_get_property:
2736  * @area: a #GtkCellArea
2737  * @renderer: a #GtkCellRenderer inside @area
2738  * @property_name: the name of the property to get
2739  * @value: a location to return the value
2740  *
2741  * Gets the value of a cell property for @renderer in @area.
2742  *
2743  * Since: 3.0
2744  */
2745 void
2746 gtk_cell_area_cell_get_property (GtkCellArea        *area,
2747                                  GtkCellRenderer    *renderer,
2748                                  const gchar        *property_name,
2749                                  GValue             *value)
2750 {
2751   GParamSpec *pspec;
2752
2753   g_return_if_fail (GTK_IS_CELL_AREA (area));
2754   g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2755   g_return_if_fail (property_name != NULL);
2756   g_return_if_fail (G_IS_VALUE (value));
2757
2758   pspec = g_param_spec_pool_lookup (cell_property_pool, property_name,
2759                                     G_OBJECT_TYPE (area), TRUE);
2760   if (!pspec)
2761     g_warning ("%s: cell area class `%s' has no cell property named `%s'",
2762                G_STRLOC, G_OBJECT_TYPE_NAME (area), property_name);
2763   else if (!(pspec->flags & G_PARAM_READABLE))
2764     g_warning ("%s: cell property `%s' of cell area class `%s' is not readable",
2765                G_STRLOC, pspec->name, G_OBJECT_TYPE_NAME (area));
2766   else
2767     {
2768       GValue *prop_value, tmp_value = { 0, };
2769
2770       /* auto-conversion of the callers value type
2771        */
2772       if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
2773         {
2774           g_value_reset (value);
2775           prop_value = value;
2776         }
2777       else if (!g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
2778         {
2779           g_warning ("can't retrieve cell property `%s' of type `%s' as value of type `%s'",
2780                      pspec->name,
2781                      g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
2782                      G_VALUE_TYPE_NAME (value));
2783           return;
2784         }
2785       else
2786         {
2787           g_value_init (&tmp_value, G_PARAM_SPEC_VALUE_TYPE (pspec));
2788           prop_value = &tmp_value;
2789         }
2790
2791       area_get_cell_property (area, renderer, pspec, prop_value);
2792
2793       if (prop_value != value)
2794         {
2795           g_value_transform (prop_value, value);
2796           g_value_unset (&tmp_value);
2797         }
2798     }
2799 }
2800
2801 /*************************************************************
2802  *                         API: Focus                        *
2803  *************************************************************/
2804
2805 /**
2806  * gtk_cell_area_is_activatable:
2807  * @area: a #GtkCellArea
2808  *
2809  * Returns whether the area can do anything when activated,
2810  * after applying new attributes to @area.
2811  *
2812  * Return value: whether @area can do anything when activated.
2813  *
2814  * Since: 3.0
2815  */
2816 gboolean
2817 gtk_cell_area_is_activatable (GtkCellArea *area)
2818 {
2819   g_return_val_if_fail (GTK_IS_CELL_AREA (area), FALSE);
2820
2821   return GTK_CELL_AREA_GET_CLASS (area)->is_activatable (area);
2822 }
2823
2824 /**
2825  * gtk_cell_area_focus:
2826  * @area: a #GtkCellArea
2827  * @direction: the #GtkDirectionType
2828  *
2829  * This should be called by the @area's owning layout widget
2830  * when focus is to be passed to @area, or moved within @area
2831  * for a given @direction and row data.
2832  *
2833  * Implementing #GtkCellArea classes should implement this
2834  * method to receive and navigate focus in it's own way particular
2835  * to how it lays out cells.
2836  *
2837  * Return value: %TRUE if focus remains inside @area as a result of this call.
2838  *
2839  * Since: 3.0
2840  */
2841 gboolean
2842 gtk_cell_area_focus (GtkCellArea      *area,
2843                      GtkDirectionType  direction)
2844 {
2845   GtkCellAreaClass *class;
2846
2847   g_return_val_if_fail (GTK_IS_CELL_AREA (area), FALSE);
2848
2849   class = GTK_CELL_AREA_GET_CLASS (area);
2850
2851   if (class->focus)
2852     return class->focus (area, direction);
2853
2854   g_warning ("GtkCellAreaClass::focus not implemented for `%s'",
2855              g_type_name (G_TYPE_FROM_INSTANCE (area)));
2856
2857   return FALSE;
2858 }
2859
2860 /**
2861  * gtk_cell_area_activate:
2862  * @area: a #GtkCellArea
2863  * @context: the #GtkCellAreaContext in context with the current row data
2864  * @widget: the #GtkWidget that @area is rendering on
2865  * @cell_area: the size and location of @area relative to @widget's allocation
2866  * @flags: the #GtkCellRendererState flags for @area for this row of data.
2867  * @edit_only: if %TRUE then only cell renderers that are %GTK_CELL_RENDERER_MODE_EDITABLE
2868  *             will be activated.
2869  *
2870  * Activates @area, usually by activating the currently focused
2871  * cell, however some subclasses which embed widgets in the area
2872  * can also activate a widget if it currently has the focus.
2873  *
2874  * Return value: Whether @area was successfully activated.
2875  *
2876  * Since: 3.0
2877  */
2878 gboolean
2879 gtk_cell_area_activate (GtkCellArea         *area,
2880                         GtkCellAreaContext  *context,
2881                         GtkWidget           *widget,
2882                         const GdkRectangle  *cell_area,
2883                         GtkCellRendererState flags,
2884                         gboolean             edit_only)
2885 {
2886   g_return_val_if_fail (GTK_IS_CELL_AREA (area), FALSE);
2887
2888   return GTK_CELL_AREA_GET_CLASS (area)->activate (area, context, widget, cell_area, flags, edit_only);
2889 }
2890
2891
2892 /**
2893  * gtk_cell_area_set_focus_cell:
2894  * @area: a #GtkCellArea
2895  * @renderer: the #GtkCellRenderer to give focus to
2896  *
2897  * Explicitly sets the currently focused cell to @renderer.
2898  *
2899  * This is generally called by implementations of
2900  * #GtkCellAreaClass.focus() or #GtkCellAreaClass.event(),
2901  * however it can also be used to implement functions such
2902  * as gtk_tree_view_set_cursor_on_cell().
2903  *
2904  * Since: 3.0
2905  */
2906 void
2907 gtk_cell_area_set_focus_cell (GtkCellArea     *area,
2908                               GtkCellRenderer *renderer)
2909 {
2910   GtkCellAreaPrivate *priv;
2911
2912   g_return_if_fail (GTK_IS_CELL_AREA (area));
2913   g_return_if_fail (renderer == NULL || GTK_IS_CELL_RENDERER (renderer));
2914
2915   priv = area->priv;
2916
2917   if (priv->focus_cell != renderer)
2918     {
2919       if (priv->focus_cell)
2920         g_object_unref (priv->focus_cell);
2921
2922       priv->focus_cell = renderer;
2923
2924       if (priv->focus_cell)
2925         g_object_ref (priv->focus_cell);
2926
2927       g_object_notify (G_OBJECT (area), "focus-cell");
2928     }
2929
2930   /* Signal that the current focus renderer for this path changed
2931    * (it may be that the focus cell did not change, but the row
2932    * may have changed so we need to signal it) */
2933   g_signal_emit (area, cell_area_signals[SIGNAL_FOCUS_CHANGED], 0,
2934                  priv->focus_cell, priv->current_path);
2935
2936 }
2937
2938 /**
2939  * gtk_cell_area_get_focus_cell:
2940  * @area: a #GtkCellArea
2941  *
2942  * Retrieves the currently focused cell for @area
2943  *
2944  * Return value: (transfer none): the currently focused cell in @area.
2945  *
2946  * Since: 3.0
2947  */
2948 GtkCellRenderer *
2949 gtk_cell_area_get_focus_cell (GtkCellArea *area)
2950 {
2951   GtkCellAreaPrivate *priv;
2952
2953   g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
2954
2955   priv = area->priv;
2956
2957   return priv->focus_cell;
2958 }
2959
2960
2961 /*************************************************************
2962  *                    API: Focus Siblings                    *
2963  *************************************************************/
2964
2965 /**
2966  * gtk_cell_area_add_focus_sibling:
2967  * @area: a #GtkCellArea
2968  * @renderer: the #GtkCellRenderer expected to have focus
2969  * @sibling: the #GtkCellRenderer to add to @renderer's focus area
2970  *
2971  * Adds @sibling to @renderer's focusable area, focus will be drawn
2972  * around @renderer and all of it's siblings if @renderer can
2973  * focus for a given row.
2974  *
2975  * Events handled by focus siblings can also activate the given
2976  * focusable @renderer.
2977  *
2978  * Since: 3.0
2979  */
2980 void
2981 gtk_cell_area_add_focus_sibling (GtkCellArea     *area,
2982                                  GtkCellRenderer *renderer,
2983                                  GtkCellRenderer *sibling)
2984 {
2985   GtkCellAreaPrivate *priv;
2986   GList              *siblings;
2987
2988   g_return_if_fail (GTK_IS_CELL_AREA (area));
2989   g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2990   g_return_if_fail (GTK_IS_CELL_RENDERER (sibling));
2991   g_return_if_fail (renderer != sibling);
2992   g_return_if_fail (gtk_cell_area_has_renderer (area, renderer));
2993   g_return_if_fail (gtk_cell_area_has_renderer (area, sibling));
2994   g_return_if_fail (!gtk_cell_area_is_focus_sibling (area, renderer, sibling));
2995
2996   /* XXX We should also check that sibling is not in any other renderer's sibling
2997    * list already, a renderer can be sibling of only one focusable renderer
2998    * at a time.
2999    */
3000
3001   priv = area->priv;
3002
3003   siblings = g_hash_table_lookup (priv->focus_siblings, renderer);
3004
3005   if (siblings)
3006     siblings = g_list_append (siblings, sibling);
3007   else
3008     {
3009       siblings = g_list_append (siblings, sibling);
3010       g_hash_table_insert (priv->focus_siblings, renderer, siblings);
3011     }
3012 }
3013
3014 /**
3015  * gtk_cell_area_remove_focus_sibling:
3016  * @area: a #GtkCellArea
3017  * @renderer: the #GtkCellRenderer expected to have focus
3018  * @sibling: the #GtkCellRenderer to remove from @renderer's focus area
3019  *
3020  * Removes @sibling from @renderer's focus sibling list
3021  * (see gtk_cell_area_add_focus_sibling()).
3022  *
3023  * Since: 3.0
3024  */
3025 void
3026 gtk_cell_area_remove_focus_sibling (GtkCellArea     *area,
3027                                     GtkCellRenderer *renderer,
3028                                     GtkCellRenderer *sibling)
3029 {
3030   GtkCellAreaPrivate *priv;
3031   GList              *siblings;
3032
3033   g_return_if_fail (GTK_IS_CELL_AREA (area));
3034   g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
3035   g_return_if_fail (GTK_IS_CELL_RENDERER (sibling));
3036   g_return_if_fail (gtk_cell_area_is_focus_sibling (area, renderer, sibling));
3037
3038   priv = area->priv;
3039
3040   siblings = g_hash_table_lookup (priv->focus_siblings, renderer);
3041
3042   siblings = g_list_copy (siblings);
3043   siblings = g_list_remove (siblings, sibling);
3044
3045   if (!siblings)
3046     g_hash_table_remove (priv->focus_siblings, renderer);
3047   else
3048     g_hash_table_insert (priv->focus_siblings, renderer, siblings);
3049 }
3050
3051 /**
3052  * gtk_cell_area_is_focus_sibling:
3053  * @area: a #GtkCellArea
3054  * @renderer: the #GtkCellRenderer expected to have focus
3055  * @sibling: the #GtkCellRenderer to check against @renderer's sibling list
3056  *
3057  * Returns %TRUE if @sibling is one of @renderer's focus siblings
3058  * (see gtk_cell_area_add_focus_sibling()).
3059  *
3060  * Since: 3.0
3061  */
3062 gboolean
3063 gtk_cell_area_is_focus_sibling (GtkCellArea     *area,
3064                                 GtkCellRenderer *renderer,
3065                                 GtkCellRenderer *sibling)
3066 {
3067   GtkCellAreaPrivate *priv;
3068   GList              *siblings, *l;
3069
3070   g_return_val_if_fail (GTK_IS_CELL_AREA (area), FALSE);
3071   g_return_val_if_fail (GTK_IS_CELL_RENDERER (renderer), FALSE);
3072   g_return_val_if_fail (GTK_IS_CELL_RENDERER (sibling), FALSE);
3073
3074   priv = area->priv;
3075
3076   siblings = g_hash_table_lookup (priv->focus_siblings, renderer);
3077
3078   for (l = siblings; l; l = l->next)
3079     {
3080       GtkCellRenderer *a_sibling = l->data;
3081
3082       if (a_sibling == sibling)
3083         return TRUE;
3084     }
3085
3086   return FALSE;
3087 }
3088
3089 /**
3090  * gtk_cell_area_get_focus_siblings:
3091  * @area: a #GtkCellArea
3092  * @renderer: the #GtkCellRenderer expected to have focus
3093  *
3094  * Gets the focus sibling cell renderers for @renderer.
3095  *
3096  * Return value: (element-type GtkCellRenderer) (transfer none): A #GList of #GtkCellRenderers.
3097  *       The returned list is internal and should not be freed.
3098  *
3099  * Since: 3.0
3100  */
3101 const GList *
3102 gtk_cell_area_get_focus_siblings (GtkCellArea     *area,
3103                                   GtkCellRenderer *renderer)
3104 {
3105   GtkCellAreaPrivate *priv;
3106
3107   g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
3108   g_return_val_if_fail (GTK_IS_CELL_RENDERER (renderer), NULL);
3109
3110   priv = area->priv;
3111
3112   return g_hash_table_lookup (priv->focus_siblings, renderer);
3113 }
3114
3115 /**
3116  * gtk_cell_area_get_focus_from_sibling:
3117  * @area: a #GtkCellArea
3118  * @renderer: the #GtkCellRenderer
3119  *
3120  * Gets the #GtkCellRenderer which is expected to be focusable
3121  * for which @renderer is, or may be a sibling.
3122  *
3123  * This is handy for #GtkCellArea subclasses when handling events,
3124  * after determining the renderer at the event location it can
3125  * then chose to activate the focus cell for which the event
3126  * cell may have been a sibling.
3127  *
3128  * Return value: (transfer none): the #GtkCellRenderer for which @renderer
3129  *    is a sibling, or %NULL.
3130  *
3131  * Since: 3.0
3132  */
3133 GtkCellRenderer *
3134 gtk_cell_area_get_focus_from_sibling (GtkCellArea          *area,
3135                                       GtkCellRenderer      *renderer)
3136 {
3137   GtkCellRenderer *ret_renderer = NULL;
3138   GList           *renderers, *l;
3139
3140   g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
3141   g_return_val_if_fail (GTK_IS_CELL_RENDERER (renderer), NULL);
3142
3143   renderers = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (area));
3144
3145   for (l = renderers; l; l = l->next)
3146     {
3147       GtkCellRenderer *a_renderer = l->data;
3148       const GList     *list;
3149
3150       for (list = gtk_cell_area_get_focus_siblings (area, a_renderer);
3151            list; list = list->next)
3152         {
3153           GtkCellRenderer *sibling_renderer = list->data;
3154
3155           if (sibling_renderer == renderer)
3156             {
3157               ret_renderer = a_renderer;
3158               break;
3159             }
3160         }
3161     }
3162   g_list_free (renderers);
3163
3164   return ret_renderer;
3165 }
3166
3167 /*************************************************************
3168  *              API: Cell Activation/Editing                 *
3169  *************************************************************/
3170 static void
3171 gtk_cell_area_add_editable (GtkCellArea        *area,
3172                             GtkCellRenderer    *renderer,
3173                             GtkCellEditable    *editable,
3174                             const GdkRectangle *cell_area)
3175 {
3176   g_signal_emit (area, cell_area_signals[SIGNAL_ADD_EDITABLE], 0,
3177                  renderer, editable, cell_area, area->priv->current_path);
3178 }
3179
3180 static void
3181 gtk_cell_area_remove_editable  (GtkCellArea        *area,
3182                                 GtkCellRenderer    *renderer,
3183                                 GtkCellEditable    *editable)
3184 {
3185   g_signal_emit (area, cell_area_signals[SIGNAL_REMOVE_EDITABLE], 0, renderer, editable);
3186 }
3187
3188 static void
3189 cell_area_remove_widget_cb (GtkCellEditable *editable,
3190                             GtkCellArea     *area)
3191 {
3192   GtkCellAreaPrivate *priv = area->priv;
3193
3194   g_assert (priv->edit_widget == editable);
3195   g_assert (priv->edited_cell != NULL);
3196
3197   gtk_cell_area_remove_editable (area, priv->edited_cell, priv->edit_widget);
3198
3199   /* Now that we're done with editing the widget and it can be removed,
3200    * remove our references to the widget and disconnect handlers */
3201   gtk_cell_area_set_edited_cell (area, NULL);
3202   gtk_cell_area_set_edit_widget (area, NULL);
3203 }
3204
3205 static void
3206 gtk_cell_area_set_edited_cell (GtkCellArea     *area,
3207                                GtkCellRenderer *renderer)
3208 {
3209   GtkCellAreaPrivate *priv;
3210
3211   g_return_if_fail (GTK_IS_CELL_AREA (area));
3212   g_return_if_fail (renderer == NULL || GTK_IS_CELL_RENDERER (renderer));
3213
3214   priv = area->priv;
3215
3216   if (priv->edited_cell != renderer)
3217     {
3218       if (priv->edited_cell)
3219         g_object_unref (priv->edited_cell);
3220
3221       priv->edited_cell = renderer;
3222
3223       if (priv->edited_cell)
3224         g_object_ref (priv->edited_cell);
3225
3226       g_object_notify (G_OBJECT (area), "edited-cell");
3227     }
3228 }
3229
3230 static void
3231 gtk_cell_area_set_edit_widget (GtkCellArea     *area,
3232                                GtkCellEditable *editable)
3233 {
3234   GtkCellAreaPrivate *priv;
3235
3236   g_return_if_fail (GTK_IS_CELL_AREA (area));
3237   g_return_if_fail (editable == NULL || GTK_IS_CELL_EDITABLE (editable));
3238
3239   priv = area->priv;
3240
3241   if (priv->edit_widget != editable)
3242     {
3243       if (priv->edit_widget)
3244         {
3245           g_signal_handler_disconnect (priv->edit_widget, priv->remove_widget_id);
3246
3247           g_object_unref (priv->edit_widget);
3248         }
3249
3250       priv->edit_widget = editable;
3251
3252       if (priv->edit_widget)
3253         {
3254           priv->remove_widget_id =
3255             g_signal_connect (priv->edit_widget, "remove-widget",
3256                               G_CALLBACK (cell_area_remove_widget_cb), area);
3257
3258           g_object_ref (priv->edit_widget);
3259         }
3260
3261       g_object_notify (G_OBJECT (area), "edit-widget");
3262     }
3263 }
3264
3265 /**
3266  * gtk_cell_area_get_edited_cell:
3267  * @area: a #GtkCellArea
3268  *
3269  * Gets the #GtkCellRenderer in @area that is currently
3270  * being edited.
3271  *
3272  * Return value: (transfer none): The currently edited #GtkCellRenderer
3273  *
3274  * Since: 3.0
3275  */
3276 GtkCellRenderer   *
3277 gtk_cell_area_get_edited_cell (GtkCellArea *area)
3278 {
3279   GtkCellAreaPrivate *priv;
3280
3281   g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
3282
3283   priv = area->priv;
3284
3285   return priv->edited_cell;
3286 }
3287
3288 /**
3289  * gtk_cell_area_get_edit_widget:
3290  * @area: a #GtkCellArea
3291  *
3292  * Gets the #GtkCellEditable widget currently used
3293  * to edit the currently edited cell.
3294  *
3295  * Return value: (transfer none): The currently active #GtkCellEditable widget
3296  *
3297  * Since: 3.0
3298  */
3299 GtkCellEditable *
3300 gtk_cell_area_get_edit_widget (GtkCellArea *area)
3301 {
3302   GtkCellAreaPrivate *priv;
3303
3304   g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
3305
3306   priv = area->priv;
3307
3308   return priv->edit_widget;
3309 }
3310
3311 /**
3312  * gtk_cell_area_activate_cell:
3313  * @area: a #GtkCellArea
3314  * @widget: the #GtkWidget that @area is rendering onto
3315  * @renderer: the #GtkCellRenderer in @area to activate
3316  * @event: the #GdkEvent for which cell activation should occur
3317  * @cell_area: the #GdkRectangle in @widget relative coordinates
3318  *             of @renderer for the current row.
3319  * @flags: the #GtkCellRendererState for @renderer
3320  *
3321  * This is used by #GtkCellArea subclasses when handling events
3322  * to activate cells, the base #GtkCellArea class activates cells
3323  * for keyboard events for free in it's own GtkCellArea->activate()
3324  * implementation.
3325  *
3326  * Return value: whether cell activation was successful
3327  *
3328  * Since: 3.0
3329  */
3330 gboolean
3331 gtk_cell_area_activate_cell (GtkCellArea          *area,
3332                              GtkWidget            *widget,
3333                              GtkCellRenderer      *renderer,
3334                              GdkEvent             *event,
3335                              const GdkRectangle   *cell_area,
3336                              GtkCellRendererState  flags)
3337 {
3338   GtkCellRendererMode mode;
3339   GtkCellAreaPrivate *priv;
3340
3341   g_return_val_if_fail (GTK_IS_CELL_AREA (area), FALSE);
3342   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3343   g_return_val_if_fail (GTK_IS_CELL_RENDERER (renderer), FALSE);
3344   g_return_val_if_fail (cell_area != NULL, FALSE);
3345
3346   priv = area->priv;
3347
3348   if (!gtk_cell_renderer_get_sensitive (renderer))
3349     return FALSE;
3350
3351   g_object_get (renderer, "mode", &mode, NULL);
3352
3353   if (mode == GTK_CELL_RENDERER_MODE_ACTIVATABLE)
3354     {
3355       if (gtk_cell_renderer_activate (renderer,
3356                                       event, widget,
3357                                       priv->current_path,
3358                                       cell_area,
3359                                       cell_area,
3360                                       flags))
3361         return TRUE;
3362     }
3363   else if (mode == GTK_CELL_RENDERER_MODE_EDITABLE)
3364     {
3365       GtkCellEditable *editable_widget;
3366       GdkRectangle inner_area;
3367
3368       gtk_cell_area_inner_cell_area (area, widget, cell_area, &inner_area);
3369
3370       editable_widget =
3371         gtk_cell_renderer_start_editing (renderer,
3372                                          event, widget,
3373                                          priv->current_path,
3374                                          &inner_area,
3375                                          &inner_area,
3376                                          flags);
3377
3378       if (editable_widget != NULL)
3379         {
3380           g_return_val_if_fail (GTK_IS_CELL_EDITABLE (editable_widget), FALSE);
3381
3382           gtk_cell_area_set_edited_cell (area, renderer);
3383           gtk_cell_area_set_edit_widget (area, editable_widget);
3384
3385           /* Signal that editing started so that callers can get
3386            * a handle on the editable_widget */
3387           gtk_cell_area_add_editable (area, priv->focus_cell, editable_widget, cell_area);
3388
3389           /* If the signal was successfully handled start the editing */
3390           if (gtk_widget_get_parent (GTK_WIDGET (editable_widget)))
3391             {
3392               gtk_cell_editable_start_editing (editable_widget, NULL);
3393               gtk_widget_grab_focus (GTK_WIDGET (editable_widget));
3394             }
3395           else
3396             {
3397               /* Otherwise clear the editing state and fire a warning */
3398               gtk_cell_area_set_edited_cell (area, NULL);
3399               gtk_cell_area_set_edit_widget (area, NULL);
3400
3401               g_warning ("GtkCellArea::add-editable fired in the dark, no cell editing was started.");
3402             }
3403
3404           return TRUE;
3405         }
3406     }
3407
3408   return FALSE;
3409 }
3410
3411 /**
3412  * gtk_cell_area_stop_editing:
3413  * @area: a #GtkCellArea
3414  * @canceled: whether editing was canceled.
3415  *
3416  * Explicitly stops the editing of the currently
3417  * edited cell (see gtk_cell_area_get_edited_cell()).
3418  *
3419  * If @canceled is %TRUE, the cell renderer will emit
3420  * the ::editing-canceled signal.
3421  *
3422  * Since: 3.0
3423  */
3424 void
3425 gtk_cell_area_stop_editing (GtkCellArea *area,
3426                             gboolean     canceled)
3427 {
3428   GtkCellAreaPrivate *priv;
3429
3430   g_return_if_fail (GTK_IS_CELL_AREA (area));
3431
3432   priv = area->priv;
3433
3434   if (priv->edited_cell)
3435     {
3436       GtkCellEditable *edit_widget = g_object_ref (priv->edit_widget);
3437       GtkCellRenderer *edit_cell   = g_object_ref (priv->edited_cell);
3438
3439       /* Stop editing of the cell renderer */
3440       gtk_cell_renderer_stop_editing (priv->edited_cell, canceled);
3441
3442       /* Remove any references to the editable widget */
3443       gtk_cell_area_set_edited_cell (area, NULL);
3444       gtk_cell_area_set_edit_widget (area, NULL);
3445
3446       /* Send the remove-widget signal explicitly (this is done after setting
3447        * the edit cell/widget NULL to avoid feedback)
3448        */
3449       gtk_cell_area_remove_editable (area, edit_cell, edit_widget);
3450       g_object_unref (edit_cell);
3451       g_object_unref (edit_widget);
3452     }
3453 }
3454
3455 /*************************************************************
3456  *         API: Convenience for area implementations         *
3457  *************************************************************/
3458
3459 /**
3460  * gtk_cell_area_inner_cell_area:
3461  * @area: a #GtkCellArea
3462  * @widget: the #GtkWidget that @area is rendering onto
3463  * @cell_area: the @widget relative coordinates where one of @area's cells
3464  *             is to be placed
3465  * @inner_area: (out): the return location for the inner cell area
3466  *
3467  * This is a convenience function for #GtkCellArea implementations
3468  * to get the inner area where a given #GtkCellRenderer will be
3469  * rendered. It removes any padding previously added by gtk_cell_area_request_renderer().
3470  *
3471  * Since: 3.0
3472  */
3473 void
3474 gtk_cell_area_inner_cell_area (GtkCellArea        *area,
3475                                GtkWidget          *widget,
3476                                const GdkRectangle *cell_area,
3477                                GdkRectangle       *inner_area)
3478 {
3479   gint focus_line_width;
3480
3481   g_return_if_fail (GTK_IS_CELL_AREA (area));
3482   g_return_if_fail (GTK_IS_WIDGET (widget));
3483   g_return_if_fail (cell_area != NULL);
3484   g_return_if_fail (inner_area != NULL);
3485
3486   gtk_widget_style_get (widget, "focus-line-width", &focus_line_width, NULL);
3487
3488   *inner_area = *cell_area;
3489
3490   inner_area->x      += focus_line_width;
3491   inner_area->width  -= focus_line_width * 2;
3492   inner_area->y      += focus_line_width;
3493   inner_area->height -= focus_line_width * 2;
3494 }
3495
3496 /**
3497  * gtk_cell_area_request_renderer:
3498  * @area: a #GtkCellArea
3499  * @renderer: the #GtkCellRenderer to request size for
3500  * @orientation: the #GtkOrientation in which to request size
3501  * @widget: the #GtkWidget that @area is rendering onto
3502  * @for_size: the allocation contextual size to request for, or -1 if
3503  * the base request for the orientation is to be returned.
3504  * @minimum_size: (out) (allow-none): location to store the minimum size, or %NULL
3505  * @natural_size: (out) (allow-none): location to store the natural size, or %NULL
3506  *
3507  * This is a convenience function for #GtkCellArea implementations
3508  * to request size for cell renderers. It's important to use this
3509  * function to request size and then use gtk_cell_area_inner_cell_area()
3510  * at render and event time since this function will add padding
3511  * around the cell for focus painting.
3512  *
3513  * Since: 3.0
3514  */
3515 void
3516 gtk_cell_area_request_renderer (GtkCellArea        *area,
3517                                 GtkCellRenderer    *renderer,
3518                                 GtkOrientation      orientation,
3519                                 GtkWidget          *widget,
3520                                 gint                for_size,
3521                                 gint               *minimum_size,
3522                                 gint               *natural_size)
3523 {
3524   gint focus_line_width;
3525
3526   g_return_if_fail (GTK_IS_CELL_AREA (area));
3527   g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
3528   g_return_if_fail (GTK_IS_WIDGET (widget));
3529   g_return_if_fail (minimum_size != NULL);
3530   g_return_if_fail (natural_size != NULL);
3531
3532   gtk_widget_style_get (widget, "focus-line-width", &focus_line_width, NULL);
3533
3534   focus_line_width *= 2;
3535
3536   if (orientation == GTK_ORIENTATION_HORIZONTAL)
3537     {
3538       if (for_size < 0)
3539           gtk_cell_renderer_get_preferred_width (renderer, widget, minimum_size, natural_size);
3540       else
3541         {
3542           for_size = MAX (0, for_size - focus_line_width);
3543
3544           gtk_cell_renderer_get_preferred_width_for_height (renderer, widget, for_size,
3545                                                             minimum_size, natural_size);
3546         }
3547     }
3548   else /* GTK_ORIENTATION_VERTICAL */
3549     {
3550       if (for_size < 0)
3551         gtk_cell_renderer_get_preferred_height (renderer, widget, minimum_size, natural_size);
3552       else
3553         {
3554           for_size = MAX (0, for_size - focus_line_width);
3555
3556           gtk_cell_renderer_get_preferred_height_for_width (renderer, widget, for_size,
3557                                                             minimum_size, natural_size);
3558         }
3559     }
3560
3561   *minimum_size += focus_line_width;
3562   *natural_size += focus_line_width;
3563 }
3564
3565 void
3566 _gtk_cell_area_set_cell_data_func_with_proxy (GtkCellArea           *area,
3567                                               GtkCellRenderer       *cell,
3568                                               GFunc                  func,
3569                                               gpointer               func_data,
3570                                               GDestroyNotify         destroy,
3571                                               gpointer               proxy)
3572 {
3573   GtkCellAreaPrivate *priv;
3574   CellInfo           *info;
3575
3576   g_return_if_fail (GTK_IS_CELL_AREA (area));
3577   g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
3578
3579   priv = area->priv;
3580
3581   info = g_hash_table_lookup (priv->cell_info, cell);
3582
3583   /* Note we do not take a reference to the proxy, the proxy is a GtkCellLayout
3584    * that is forwarding it's implementation to a delegate GtkCellArea therefore
3585    * it's life-cycle is longer than the area's life cycle. 
3586    */
3587   if (info)
3588     {
3589       if (info->destroy && info->data)
3590         info->destroy (info->data);
3591
3592       if (func)
3593         {
3594           info->func    = (GtkCellLayoutDataFunc)func;
3595           info->data    = func_data;
3596           info->destroy = destroy;
3597           info->proxy   = proxy;
3598         }
3599       else
3600         {
3601           info->func    = NULL;
3602           info->data    = NULL;
3603           info->destroy = NULL;
3604           info->proxy   = NULL;
3605         }
3606     }
3607   else
3608     {
3609       info = cell_info_new ((GtkCellLayoutDataFunc)func, func_data, destroy);
3610       info->proxy = proxy;
3611
3612       g_hash_table_insert (priv->cell_info, cell, info);
3613     }
3614 }