3 * Copyright (C) 2010 Openismus GmbH
6 * Tristan Van Berkom <tristanvb@openismus.com>
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.
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.
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.
26 * @Short_Description: An abstract class for laying out GtkCellRenderers
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.
34 * The cell area handles events, focus navigation, drawing and
35 * size requests and allocations for a given row of data.
37 * Usually users dont have to interact with the #GtkCellArea directly
38 * unless they are implementing a cell layouting widget themselves.
40 * <refsect2 id="cell-area-geometry-management">
41 * <title>Requesting area sizes</title>
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.
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.
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).
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.
75 * In order to request the width of all the rows at the root level
76 * of a #GtkTreeModel one would do the following:
78 * <title>Requesting the width of a handful of GtkTreeModel rows</title>
84 * valid = gtk_tree_model_get_iter_first (model, &iter);
87 * gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
88 * gtk_cell_area_get_preferred_width (area, context, widget, NULL, NULL);
90 * valid = gtk_tree_model_iter_next (model, &iter);
92 * gtk_cell_area_context_get_preferred_width (context, &minimum_width, &natural_width);
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
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.
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:
114 * <title>A typical get_preferred_width() implementation</title>
117 * foo_get_preferred_width (GtkWidget *widget,
118 * gint *minimum_size,
119 * gint *natural_size)
121 * Foo *foo = FOO (widget);
122 * FooPrivate *priv = foo->priv;
124 * foo_ensure_at_least_one_handfull_of_rows_have_been_requested (foo);
126 * gtk_cell_area_context_get_preferred_width (priv->context, minimum_size, natural_size);
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.
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).
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:
146 * <title>Requesting the height for width of a handful of GtkTreeModel rows</title>
149 * gint minimum_height;
150 * gint natural_height;
151 * gint full_minimum_height = 0;
152 * gint full_natural_height = 0;
154 * valid = gtk_tree_model_get_iter_first (model, &iter);
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);
161 * if (width_is_for_allocation)
162 * cache_row_height (&iter, minimum_height, natural_height);
164 * full_minimum_height += minimum_height;
165 * full_natural_height += natural_height;
167 * valid = gtk_tree_model_iter_next (model, &iter);
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
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.
193 * <refsect2 id="cell-area-rendering">
194 * <title>Rendering Areas</title>
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.
200 * A crude example of how to render all the rows at the root level
203 * <title>Requesting the width of a handful of GtkTreeModel rows</title>
205 * GtkAllocation allocation;
206 * GdkRectangle cell_area = { 0, };
208 * gint minimum_width;
209 * gint natural_width;
211 * gtk_widget_get_allocation (widget, &allocation);
212 * cell_area.width = allocation.width;
214 * valid = gtk_tree_model_get_iter_first (model, &iter);
217 * cell_area.height = get_cached_height_for_row (&iter);
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);
223 * cell_area.y += cell_area.height;
225 * valid = gtk_tree_model_iter_next (model, &iter);
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().
237 * <refsect2 id="cell-area-events-and-focus">
238 * <title>Handling Events and Driving Keyboard Focus</title>
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.
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.
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
265 * A basic example of how the #GtkWidgetClass.focus() virtual method
266 * should be implemented:
268 * <title>Implementing keyboard focus navigation</title>
271 * foo_focus (GtkWidget *widget,
272 * GtkDirectionType direction)
274 * Foo *foo = FOO (widget);
275 * FooPrivate *priv = foo->priv;
277 * gboolean have_focus = FALSE;
279 * focus_row = priv->focus_row;
281 * if (!gtk_widget_has_focus (widget))
282 * gtk_widget_grab_focus (widget);
284 * valid = gtk_tree_model_iter_nth_child (priv->model, &iter, NULL, priv->focus_row);
287 * gtk_cell_area_apply_attributes (priv->area, priv->model, &iter, FALSE, FALSE);
289 * if (gtk_cell_area_focus (priv->area, direction))
291 * priv->focus_row = focus_row;
297 * if (direction == GTK_DIR_RIGHT ||
298 * direction == GTK_DIR_LEFT)
300 * else if (direction == GTK_DIR_UP ||
301 * direction == GTK_DIR_TAB_BACKWARD)
303 * if (focus_row == 0)
308 * valid = gtk_tree_model_iter_nth_child (priv->model, &iter, NULL, focus_row);
313 * if (focus_row == last_row)
318 * valid = gtk_tree_model_iter_next (priv->model, &iter);
327 * Note that the layouting widget is responsible for matching the
328 * GtkDirectionType values to the way it lays out its cells.
331 * <refsect2 id="cell-properties">
332 * <title>Cell Properties</title>
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.
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.
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().
364 #include "gtkcelllayout.h"
365 #include "gtkcellarea.h"
366 #include "gtkcellareacontext.h"
367 #include "gtkmarshalers.h"
368 #include "gtkprivate.h"
370 #include <gobject/gvaluecollector.h>
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,
380 static void gtk_cell_area_get_property (GObject *object,
385 /* GtkCellAreaClass */
386 static gint gtk_cell_area_real_event (GtkCellArea *area,
387 GtkCellAreaContext *context,
390 const GdkRectangle *cell_area,
391 GtkCellRendererState flags);
392 static void gtk_cell_area_real_render (GtkCellArea *area,
393 GtkCellAreaContext *context,
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,
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,
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,
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,
421 const GdkRectangle *cell_area,
422 GtkCellRendererState flags,
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,
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,
435 static void gtk_cell_area_set_cell_data_func (GtkCellLayout *cell_layout,
436 GtkCellRenderer *cell,
437 GtkCellLayoutDataFunc func,
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,
445 static GList *gtk_cell_area_get_cells (GtkCellLayout *cell_layout);
446 static GtkCellArea *gtk_cell_area_get_area (GtkCellLayout *cell_layout);
448 /* GtkBuildableIface */
449 static void gtk_cell_area_buildable_init (GtkBuildableIface *iface);
450 static void gtk_cell_area_buildable_custom_tag_end (GtkBuildable *buildable,
453 const gchar *tagname,
456 /* Used in foreach loop to check if a child renderer is present */
458 GtkCellRenderer *renderer;
459 gboolean has_renderer;
462 /* Used in foreach loop to get a cell's allocation */
464 GtkCellRenderer *renderer;
465 GdkRectangle allocation;
466 } RendererAllocationData;
468 /* Used in foreach loop to render cells */
473 GdkRectangle focus_rect;
474 GtkCellRendererState render_flags;
475 guint paint_focus : 1;
477 guint first_focus : 1;
480 /* Used in foreach loop to get a cell by position */
484 GtkCellRenderer *renderer;
485 GdkRectangle cell_area;
486 } CellByPositionData;
488 /* Attribute/Cell metadata */
490 const gchar *attribute;
497 GtkCellLayoutDataFunc func;
499 GDestroyNotify destroy;
502 static CellInfo *cell_info_new (GtkCellLayoutDataFunc func,
504 GDestroyNotify destroy);
505 static void cell_info_free (CellInfo *info);
506 static CellAttribute *cell_attribute_new (GtkCellRenderer *renderer,
507 const gchar *attribute,
509 static void cell_attribute_free (CellAttribute *attribute);
510 static gint cell_attribute_find (CellAttribute *cell_attribute,
511 const gchar *attribute);
513 /* Internal functions/signal emissions */
514 static void gtk_cell_area_add_editable (GtkCellArea *area,
515 GtkCellRenderer *renderer,
516 GtkCellEditable *editable,
517 const GdkRectangle *cell_area);
518 static void gtk_cell_area_remove_editable (GtkCellArea *area,
519 GtkCellRenderer *renderer,
520 GtkCellEditable *editable);
521 static void gtk_cell_area_set_edit_widget (GtkCellArea *area,
522 GtkCellEditable *editable);
523 static void gtk_cell_area_set_edited_cell (GtkCellArea *area,
524 GtkCellRenderer *renderer);
527 /* Struct to pass data along while looping over
528 * cell renderers to apply attributes
534 gboolean is_expander;
535 gboolean is_expanded;
538 struct _GtkCellAreaPrivate
540 /* The GtkCellArea bookkeeps any connected
541 * attributes in this hash table.
543 GHashTable *cell_info;
545 /* Current path is saved as a side-effect
546 * of gtk_cell_area_apply_attributes()
550 /* Current cell being edited and editable widget used */
551 GtkCellEditable *edit_widget;
552 GtkCellRenderer *edited_cell;
554 /* Signal connections to the editable widget */
555 gulong remove_widget_id;
557 /* Currently focused cell */
558 GtkCellRenderer *focus_cell;
560 /* Tracking which cells are focus siblings of focusable cells */
561 GHashTable *focus_siblings;
563 /* Detail string to pass to gtk_paint_*() functions */
575 SIGNAL_APPLY_ATTRIBUTES,
577 SIGNAL_REMOVE_EDITABLE,
578 SIGNAL_FOCUS_CHANGED,
582 /* Keep the paramspec pool internal, no need to deliver notifications
583 * on cells. at least no perceived need for now
585 static GParamSpecPool *cell_property_pool = NULL;
586 static guint cell_area_signals[LAST_SIGNAL] = { 0 };
588 #define PARAM_SPEC_PARAM_ID(pspec) ((pspec)->param_id)
589 #define PARAM_SPEC_SET_PARAM_ID(pspec, id) ((pspec)->param_id = (id))
591 G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GtkCellArea, gtk_cell_area, G_TYPE_INITIALLY_UNOWNED,
592 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
593 gtk_cell_area_cell_layout_init)
594 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
595 gtk_cell_area_buildable_init))
598 gtk_cell_area_init (GtkCellArea *area)
600 GtkCellAreaPrivate *priv;
602 area->priv = G_TYPE_INSTANCE_GET_PRIVATE (area,
607 priv->cell_info = g_hash_table_new_full (g_direct_hash,
610 (GDestroyNotify)cell_info_free);
612 priv->focus_siblings = g_hash_table_new_full (g_direct_hash,
615 (GDestroyNotify)g_list_free);
617 priv->focus_cell = NULL;
618 priv->edited_cell = NULL;
619 priv->edit_widget = NULL;
621 priv->remove_widget_id = 0;
625 gtk_cell_area_class_init (GtkCellAreaClass *class)
627 GObjectClass *object_class = G_OBJECT_CLASS (class);
630 object_class->dispose = gtk_cell_area_dispose;
631 object_class->finalize = gtk_cell_area_finalize;
632 object_class->get_property = gtk_cell_area_get_property;
633 object_class->set_property = gtk_cell_area_set_property;
637 class->remove = NULL;
638 class->foreach = NULL;
639 class->event = gtk_cell_area_real_event;
640 class->render = gtk_cell_area_real_render;
641 class->apply_attributes = gtk_cell_area_real_apply_attributes;
644 class->create_context = NULL;
645 class->get_request_mode = NULL;
646 class->get_preferred_width = NULL;
647 class->get_preferred_height = NULL;
648 class->get_preferred_height_for_width = gtk_cell_area_real_get_preferred_height_for_width;
649 class->get_preferred_width_for_height = gtk_cell_area_real_get_preferred_width_for_height;
652 class->is_activatable = gtk_cell_area_real_is_activatable;
653 class->activate = gtk_cell_area_real_activate;
658 * GtkCellArea::apply-attributes:
659 * @area: the #GtkCellArea to apply the attributes to
660 * @model: the #GtkTreeModel to apply the attributes from
661 * @iter: the #GtkTreeIter indicating which row to apply the attributes of
662 * @is_expander: whether the view shows children for this row
663 * @is_expanded: whether the view is currently showing the children of this row
665 * This signal is emitted whenever applying attributes to @area from @model
669 cell_area_signals[SIGNAL_APPLY_ATTRIBUTES] =
670 g_signal_new (I_("apply-attributes"),
671 G_OBJECT_CLASS_TYPE (object_class),
673 G_STRUCT_OFFSET (GtkCellAreaClass, apply_attributes),
675 _gtk_marshal_VOID__OBJECT_BOXED_BOOLEAN_BOOLEAN,
683 * GtkCellArea::add-editable:
684 * @area: the #GtkCellArea where editing started
685 * @renderer: the #GtkCellRenderer that started the edited
686 * @editable: the #GtkCellEditable widget to add
687 * @cell_area: the #GtkWidget relative #GdkRectangle coordinates
688 * where @editable should be added
689 * @path: the #GtkTreePath string this edit was initiated for
691 * Indicates that editing has started on @renderer and that @editable
692 * should be added to the owning cell layouting widget at @cell_area.
696 cell_area_signals[SIGNAL_ADD_EDITABLE] =
697 g_signal_new (I_("add-editable"),
698 G_OBJECT_CLASS_TYPE (object_class),
700 0, /* No class closure here */
702 _gtk_marshal_VOID__OBJECT_OBJECT_BOXED_STRING,
704 GTK_TYPE_CELL_RENDERER,
705 GTK_TYPE_CELL_EDITABLE,
711 * GtkCellArea::remove-editable:
712 * @area: the #GtkCellArea where editing finished
713 * @renderer: the #GtkCellRenderer that finished editeding
714 * @editable: the #GtkCellEditable widget to remove
716 * Indicates that editing finished on @renderer and that @editable
717 * should be removed from the owning cell layouting widget.
721 cell_area_signals[SIGNAL_REMOVE_EDITABLE] =
722 g_signal_new (I_("remove-editable"),
723 G_OBJECT_CLASS_TYPE (object_class),
725 0, /* No class closure here */
727 _gtk_marshal_VOID__OBJECT_OBJECT,
729 GTK_TYPE_CELL_RENDERER,
730 GTK_TYPE_CELL_EDITABLE);
733 * GtkCellArea::focus-changed:
734 * @area: the #GtkCellArea where focus changed
735 * @renderer: the #GtkCellRenderer that has focus
736 * @path: the current #GtkTreePath string set for @area
738 * Indicates that focus changed on this @area. This signal
739 * is emitted either as a result of focus handling or event
742 * It's possible that the signal is emitted even if the
743 * currently focused renderer did not change, this is
744 * because focus may change to the same renderer in the
745 * same cell area for a different row of data.
749 cell_area_signals[SIGNAL_FOCUS_CHANGED] =
750 g_signal_new (I_("focus-changed"),
751 G_OBJECT_CLASS_TYPE (object_class),
753 0, /* No class closure here */
755 _gtk_marshal_VOID__OBJECT_STRING,
757 GTK_TYPE_CELL_RENDERER,
762 * GtkCellArea:focus-cell:
764 * The cell in the area that currently has focus
768 g_object_class_install_property (object_class,
773 P_("The cell which currently has focus"),
774 GTK_TYPE_CELL_RENDERER,
775 GTK_PARAM_READWRITE));
778 * GtkCellArea:edited-cell:
780 * The cell in the area that is currently edited
782 * This property is read-only and only changes as
783 * a result of a call gtk_cell_area_activate_cell().
787 g_object_class_install_property (object_class,
792 P_("The cell which is currently being edited"),
793 GTK_TYPE_CELL_RENDERER,
797 * GtkCellArea:edit-widget:
799 * The widget currently editing the edited cell
801 * This property is read-only and only changes as
802 * a result of a call gtk_cell_area_activate_cell().
806 g_object_class_install_property (object_class,
811 P_("The widget currently editing the edited cell"),
812 GTK_TYPE_CELL_RENDERER,
815 /* Pool for Cell Properties */
816 if (!cell_property_pool)
817 cell_property_pool = g_param_spec_pool_new (FALSE);
819 g_type_class_add_private (object_class, sizeof (GtkCellAreaPrivate));
822 /*************************************************************
824 *************************************************************/
826 cell_info_new (GtkCellLayoutDataFunc func,
828 GDestroyNotify destroy)
830 CellInfo *info = g_slice_new0 (CellInfo);
834 info->destroy = destroy;
840 cell_info_free (CellInfo *info)
843 info->destroy (info->data);
845 g_slist_foreach (info->attributes, (GFunc)cell_attribute_free, NULL);
846 g_slist_free (info->attributes);
848 g_slice_free (CellInfo, info);
851 static CellAttribute *
852 cell_attribute_new (GtkCellRenderer *renderer,
853 const gchar *attribute,
858 /* Check if the attribute really exists and point to
859 * the property string installed on the cell renderer
860 * class (dont dup the string)
862 pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (renderer), attribute);
866 CellAttribute *cell_attribute = g_slice_new (CellAttribute);
868 cell_attribute->attribute = pspec->name;
869 cell_attribute->column = column;
871 return cell_attribute;
878 cell_attribute_free (CellAttribute *attribute)
880 g_slice_free (CellAttribute, attribute);
883 /* GCompareFunc for g_slist_find_custom() */
885 cell_attribute_find (CellAttribute *cell_attribute,
886 const gchar *attribute)
888 return g_strcmp0 (cell_attribute->attribute, attribute);
891 /*************************************************************
893 *************************************************************/
895 gtk_cell_area_finalize (GObject *object)
897 GtkCellArea *area = GTK_CELL_AREA (object);
898 GtkCellAreaPrivate *priv = area->priv;
900 /* All cell renderers should already be removed at this point,
901 * just kill our (empty) hash tables here.
903 g_hash_table_destroy (priv->cell_info);
904 g_hash_table_destroy (priv->focus_siblings);
906 g_free (priv->current_path);
908 G_OBJECT_CLASS (gtk_cell_area_parent_class)->finalize (object);
913 gtk_cell_area_dispose (GObject *object)
915 /* This removes every cell renderer that may be added to the GtkCellArea,
916 * subclasses should be breaking references to the GtkCellRenderers
919 gtk_cell_layout_clear (GTK_CELL_LAYOUT (object));
921 /* Remove any ref to a focused/edited cell */
922 gtk_cell_area_set_focus_cell (GTK_CELL_AREA (object), NULL);
923 gtk_cell_area_set_edited_cell (GTK_CELL_AREA (object), NULL);
924 gtk_cell_area_set_edit_widget (GTK_CELL_AREA (object), NULL);
926 G_OBJECT_CLASS (gtk_cell_area_parent_class)->dispose (object);
930 gtk_cell_area_set_property (GObject *object,
935 GtkCellArea *area = GTK_CELL_AREA (object);
939 case PROP_FOCUS_CELL:
940 gtk_cell_area_set_focus_cell (area, (GtkCellRenderer *)g_value_get_object (value));
943 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
949 gtk_cell_area_get_property (GObject *object,
954 GtkCellArea *area = GTK_CELL_AREA (object);
955 GtkCellAreaPrivate *priv = area->priv;
959 case PROP_FOCUS_CELL:
960 g_value_set_object (value, priv->focus_cell);
962 case PROP_EDITED_CELL:
963 g_value_set_object (value, priv->edited_cell);
965 case PROP_EDIT_WIDGET:
966 g_value_set_object (value, priv->edit_widget);
969 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
974 /*************************************************************
976 *************************************************************/
978 gtk_cell_area_real_event (GtkCellArea *area,
979 GtkCellAreaContext *context,
982 const GdkRectangle *cell_area,
983 GtkCellRendererState flags)
985 GtkCellAreaPrivate *priv = area->priv;
986 gboolean retval = FALSE;
988 if (event->type == GDK_KEY_PRESS && (flags & GTK_CELL_RENDERER_FOCUSED) != 0)
990 GdkEventKey *key_event = (GdkEventKey *)event;
992 /* Cancel any edits in progress */
993 if (priv->edited_cell && (key_event->keyval == GDK_KEY_Escape))
995 gtk_cell_area_stop_editing (area, TRUE);
999 else if (event->type == GDK_BUTTON_PRESS)
1001 GdkEventButton *button_event = (GdkEventButton *)event;
1003 if (button_event->button == 1)
1005 GtkCellRenderer *renderer = NULL;
1006 GtkCellRenderer *focus_renderer;
1007 GdkRectangle alloc_area;
1008 gint event_x, event_y;
1010 /* We may need some semantics to tell us the offset of the event
1011 * window we are handling events for (i.e. GtkTreeView has a bin_window) */
1012 event_x = button_event->x;
1013 event_y = button_event->y;
1015 /* Dont try to search for an event coordinate that is not in the area, that will
1016 * trigger a runtime warning.
1018 if (event_x >= cell_area->x && event_x <= cell_area->x + cell_area->width &&
1019 event_y >= cell_area->y && event_y <= cell_area->y + cell_area->height)
1021 gtk_cell_area_get_cell_at_position (area, context, widget,
1022 cell_area, event_x, event_y,
1027 focus_renderer = gtk_cell_area_get_focus_from_sibling (area, renderer);
1028 if (!focus_renderer)
1029 focus_renderer = renderer;
1031 /* If we're already editing, cancel it and set focus */
1032 if (gtk_cell_area_get_edited_cell (area))
1034 /* XXX Was it really canceled in this case ? */
1035 gtk_cell_area_stop_editing (area, TRUE);
1036 gtk_cell_area_set_focus_cell (area, focus_renderer);
1041 /* If we are activating via a focus sibling,
1042 * we need to fetch the right cell area for the real event renderer */
1043 if (focus_renderer != renderer)
1044 gtk_cell_area_get_cell_allocation (area, context, widget, focus_renderer,
1045 cell_area, &alloc_area);
1047 gtk_cell_area_set_focus_cell (area, focus_renderer);
1048 retval = gtk_cell_area_activate_cell (area, widget, focus_renderer,
1049 event, &alloc_area, flags);
1059 render_cell (GtkCellRenderer *renderer,
1060 const GdkRectangle *cell_area,
1061 const GdkRectangle *cell_background,
1062 CellRenderData *data)
1064 GtkCellRenderer *focus_cell;
1065 GtkCellRendererState flags;
1066 GdkRectangle inner_area;
1068 focus_cell = gtk_cell_area_get_focus_cell (data->area);
1069 flags = data->render_flags;
1071 gtk_cell_area_inner_cell_area (data->area, data->widget, cell_area, &inner_area);
1073 if ((flags & GTK_CELL_RENDERER_FOCUSED) &&
1076 (renderer == focus_cell ||
1077 gtk_cell_area_is_focus_sibling (data->area, focus_cell, renderer)))))
1079 gint focus_line_width;
1080 GdkRectangle cell_focus;
1082 gtk_cell_renderer_get_aligned_area (renderer, data->widget, flags, &inner_area, &cell_focus);
1084 gtk_widget_style_get (data->widget,
1085 "focus-line-width", &focus_line_width,
1088 /* The focus rectangle is located around the aligned area of the cell */
1089 cell_focus.x -= focus_line_width;
1090 cell_focus.y -= focus_line_width;
1091 cell_focus.width += 2 * focus_line_width;
1092 cell_focus.height += 2 * focus_line_width;
1094 if (data->first_focus)
1096 data->first_focus = FALSE;
1097 data->focus_rect = cell_focus;
1101 gdk_rectangle_union (&data->focus_rect, &cell_focus, &data->focus_rect);
1105 flags &= ~GTK_CELL_RENDERER_FOCUSED;
1107 gtk_cell_renderer_render (renderer, data->cr, data->widget,
1108 cell_background, &inner_area, flags);
1114 gtk_cell_area_real_render (GtkCellArea *area,
1115 GtkCellAreaContext *context,
1118 const GdkRectangle *background_area,
1119 const GdkRectangle *cell_area,
1120 GtkCellRendererState flags,
1121 gboolean paint_focus)
1123 CellRenderData render_data =
1134 /* Make sure we dont paint a focus rectangle while there
1135 * is an editable widget in play
1137 if (gtk_cell_area_get_edited_cell (area))
1138 render_data.paint_focus = FALSE;
1140 /* If no cell can activate but the caller wants focus painted,
1141 * then we paint focus around all cells */
1142 if ((flags & GTK_CELL_RENDERER_FOCUSED) != 0 && paint_focus &&
1143 !gtk_cell_area_is_activatable (area))
1144 render_data.focus_all = TRUE;
1146 gtk_cell_area_foreach_alloc (area, context, widget, cell_area, background_area,
1147 (GtkCellAllocCallback)render_cell, &render_data);
1149 if (render_data.paint_focus &&
1150 render_data.focus_rect.width != 0 &&
1151 render_data.focus_rect.height != 0)
1153 GtkStateType renderer_state =
1154 flags & GTK_CELL_RENDERER_SELECTED ? GTK_STATE_SELECTED :
1155 (flags & GTK_CELL_RENDERER_PRELIT ? GTK_STATE_PRELIGHT :
1156 (flags & GTK_CELL_RENDERER_INSENSITIVE ? GTK_STATE_INSENSITIVE : GTK_STATE_NORMAL));
1160 gdk_cairo_rectangle (cr, background_area);
1163 gtk_paint_focus (gtk_widget_get_style (widget), cr,
1164 renderer_state, widget,
1165 gtk_cell_area_get_style_detail (area),
1166 render_data.focus_rect.x, render_data.focus_rect.y,
1167 render_data.focus_rect.width, render_data.focus_rect.height);
1174 apply_cell_attributes (GtkCellRenderer *renderer,
1176 AttributeData *data)
1178 CellAttribute *attribute;
1180 GValue value = { 0, };
1181 gboolean is_expander;
1182 gboolean is_expanded;
1184 g_object_freeze_notify (G_OBJECT (renderer));
1186 /* Whether a row expands or is presently expanded can only be
1187 * provided by the view (as these states can vary across views
1188 * accessing the same model).
1190 g_object_get (renderer, "is-expander", &is_expander, NULL);
1191 if (is_expander != data->is_expander)
1192 g_object_set (renderer, "is-expander", data->is_expander, NULL);
1194 g_object_get (renderer, "is-expanded", &is_expanded, NULL);
1195 if (is_expanded != data->is_expanded)
1196 g_object_set (renderer, "is-expanded", data->is_expanded, NULL);
1198 /* Apply the attributes directly to the renderer */
1199 for (list = info->attributes; list; list = list->next)
1201 attribute = list->data;
1203 gtk_tree_model_get_value (data->model, data->iter, attribute->column, &value);
1204 g_object_set_property (G_OBJECT (renderer), attribute->attribute, &value);
1205 g_value_unset (&value);
1208 /* Call any GtkCellLayoutDataFunc that may have been set by the user
1211 info->func (GTK_CELL_LAYOUT (data->area), renderer,
1212 data->model, data->iter, info->data);
1214 g_object_thaw_notify (G_OBJECT (renderer));
1218 gtk_cell_area_real_apply_attributes (GtkCellArea *area,
1219 GtkTreeModel *tree_model,
1221 gboolean is_expander,
1222 gboolean is_expanded)
1225 GtkCellAreaPrivate *priv;
1231 /* Feed in data needed to apply to every renderer */
1233 data.model = tree_model;
1235 data.is_expander = is_expander;
1236 data.is_expanded = is_expanded;
1238 /* Go over any cells that have attributes or custom GtkCellLayoutDataFuncs and
1239 * apply the data from the treemodel */
1240 g_hash_table_foreach (priv->cell_info, (GHFunc)apply_cell_attributes, &data);
1242 /* Update the currently applied path */
1243 g_free (priv->current_path);
1244 path = gtk_tree_model_get_path (tree_model, iter);
1245 priv->current_path = gtk_tree_path_to_string (path);
1246 gtk_tree_path_free (path);
1250 gtk_cell_area_real_get_preferred_height_for_width (GtkCellArea *area,
1251 GtkCellAreaContext *context,
1254 gint *minimum_height,
1255 gint *natural_height)
1257 /* If the area doesnt do height-for-width, fallback on base preferred height */
1258 GTK_CELL_AREA_GET_CLASS (area)->get_preferred_width (area, context, widget, minimum_height, natural_height);
1262 gtk_cell_area_real_get_preferred_width_for_height (GtkCellArea *area,
1263 GtkCellAreaContext *context,
1266 gint *minimum_width,
1267 gint *natural_width)
1269 /* If the area doesnt do width-for-height, fallback on base preferred width */
1270 GTK_CELL_AREA_GET_CLASS (area)->get_preferred_width (area, context, widget, minimum_width, natural_width);
1274 get_is_activatable (GtkCellRenderer *renderer,
1275 gboolean *activatable)
1278 if (gtk_cell_renderer_is_activatable (renderer))
1279 *activatable = TRUE;
1281 return *activatable;
1285 gtk_cell_area_real_is_activatable (GtkCellArea *area)
1287 gboolean activatable = FALSE;
1289 /* Checks if any renderer can focus for the currently applied
1292 * Subclasses can override this in the case that they are also
1293 * rendering widgets as well as renderers.
1295 gtk_cell_area_foreach (area, (GtkCellCallback)get_is_activatable, &activatable);
1301 gtk_cell_area_real_activate (GtkCellArea *area,
1302 GtkCellAreaContext *context,
1304 const GdkRectangle *cell_area,
1305 GtkCellRendererState flags,
1308 GtkCellAreaPrivate *priv = area->priv;
1309 GdkRectangle renderer_area;
1310 GtkCellRenderer *activate_cell = NULL;
1311 GtkCellRendererMode mode;
1313 if (priv->focus_cell)
1315 g_object_get (priv->focus_cell, "mode", &mode, NULL);
1317 if (gtk_cell_renderer_get_visible (priv->focus_cell) &&
1318 (edit_only ? mode == GTK_CELL_RENDERER_MODE_EDITABLE :
1319 mode != GTK_CELL_RENDERER_MODE_INERT))
1320 activate_cell = priv->focus_cell;
1326 /* GtkTreeView sometimes wants to activate a cell when no
1327 * cells are in focus.
1329 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (area));
1330 for (l = cells; l && !activate_cell; l = l->next)
1332 GtkCellRenderer *renderer = l->data;
1334 g_object_get (renderer, "mode", &mode, NULL);
1336 if (gtk_cell_renderer_get_visible (renderer) &&
1337 (edit_only ? mode == GTK_CELL_RENDERER_MODE_EDITABLE :
1338 mode != GTK_CELL_RENDERER_MODE_INERT))
1339 activate_cell = renderer;
1341 g_list_free (cells);
1346 /* Get the allocation of the focused cell.
1348 gtk_cell_area_get_cell_allocation (area, context, widget, activate_cell,
1349 cell_area, &renderer_area);
1351 /* Activate or Edit the cell
1353 * Currently just not sending an event, renderers afaics dont use
1354 * the event argument anyway, worst case is we can synthesize one.
1356 if (gtk_cell_area_activate_cell (area, widget, activate_cell, NULL,
1357 &renderer_area, flags))
1364 /*************************************************************
1365 * GtkCellLayoutIface *
1366 *************************************************************/
1368 gtk_cell_area_cell_layout_init (GtkCellLayoutIface *iface)
1370 iface->pack_start = gtk_cell_area_pack_default;
1371 iface->pack_end = gtk_cell_area_pack_default;
1372 iface->clear = gtk_cell_area_clear;
1373 iface->add_attribute = gtk_cell_area_add_attribute;
1374 iface->set_cell_data_func = gtk_cell_area_set_cell_data_func;
1375 iface->clear_attributes = gtk_cell_area_clear_attributes;
1376 iface->reorder = gtk_cell_area_reorder;
1377 iface->get_cells = gtk_cell_area_get_cells;
1378 iface->get_area = gtk_cell_area_get_area;
1382 gtk_cell_area_pack_default (GtkCellLayout *cell_layout,
1383 GtkCellRenderer *renderer,
1386 gtk_cell_area_add (GTK_CELL_AREA (cell_layout), renderer);
1390 gtk_cell_area_clear (GtkCellLayout *cell_layout)
1392 GtkCellArea *area = GTK_CELL_AREA (cell_layout);
1394 gtk_cell_layout_get_cells (cell_layout);
1396 for (l = cells; l; l = l->next)
1398 GtkCellRenderer *renderer = l->data;
1399 gtk_cell_area_remove (area, renderer);
1402 g_list_free (cells);
1406 gtk_cell_area_add_attribute (GtkCellLayout *cell_layout,
1407 GtkCellRenderer *renderer,
1408 const gchar *attribute,
1411 gtk_cell_area_attribute_connect (GTK_CELL_AREA (cell_layout),
1412 renderer, attribute, column);
1416 gtk_cell_area_set_cell_data_func (GtkCellLayout *cell_layout,
1417 GtkCellRenderer *renderer,
1418 GtkCellLayoutDataFunc func,
1420 GDestroyNotify destroy)
1422 GtkCellArea *area = GTK_CELL_AREA (cell_layout);
1423 GtkCellAreaPrivate *priv = area->priv;
1426 info = g_hash_table_lookup (priv->cell_info, renderer);
1430 if (info->destroy && info->data)
1431 info->destroy (info->data);
1436 info->data = func_data;
1437 info->destroy = destroy;
1443 info->destroy = NULL;
1448 info = cell_info_new (func, func_data, destroy);
1450 g_hash_table_insert (priv->cell_info, renderer, info);
1455 gtk_cell_area_clear_attributes (GtkCellLayout *cell_layout,
1456 GtkCellRenderer *renderer)
1458 GtkCellArea *area = GTK_CELL_AREA (cell_layout);
1459 GtkCellAreaPrivate *priv = area->priv;
1462 info = g_hash_table_lookup (priv->cell_info, renderer);
1466 g_slist_foreach (info->attributes, (GFunc)cell_attribute_free, NULL);
1467 g_slist_free (info->attributes);
1469 info->attributes = NULL;
1474 gtk_cell_area_reorder (GtkCellLayout *cell_layout,
1475 GtkCellRenderer *cell,
1478 g_warning ("GtkCellLayout::reorder not implemented for `%s'",
1479 g_type_name (G_TYPE_FROM_INSTANCE (cell_layout)));
1483 accum_cells (GtkCellRenderer *renderer,
1486 *accum = g_list_prepend (*accum, renderer);
1492 gtk_cell_area_get_cells (GtkCellLayout *cell_layout)
1494 GList *cells = NULL;
1496 gtk_cell_area_foreach (GTK_CELL_AREA (cell_layout),
1497 (GtkCellCallback)accum_cells,
1500 return g_list_reverse (cells);
1503 static GtkCellArea *
1504 gtk_cell_area_get_area (GtkCellLayout *cell_layout)
1506 return GTK_CELL_AREA (cell_layout);
1509 /*************************************************************
1510 * GtkBuildableIface *
1511 *************************************************************/
1513 gtk_cell_area_buildable_init (GtkBuildableIface *iface)
1515 iface->add_child = _gtk_cell_layout_buildable_add_child;
1516 iface->custom_tag_start = _gtk_cell_layout_buildable_custom_tag_start;
1517 iface->custom_tag_end = gtk_cell_area_buildable_custom_tag_end;
1521 gtk_cell_area_buildable_custom_tag_end (GtkBuildable *buildable,
1522 GtkBuilder *builder,
1524 const gchar *tagname,
1527 /* Just ignore the boolean return from here */
1528 _gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname, data);
1531 /*************************************************************
1533 *************************************************************/
1536 * gtk_cell_area_add:
1537 * @area: a #GtkCellArea
1538 * @renderer: the #GtkCellRenderer to add to @area
1540 * Adds @renderer to @area with the default child cell properties.
1545 gtk_cell_area_add (GtkCellArea *area,
1546 GtkCellRenderer *renderer)
1548 GtkCellAreaClass *class;
1550 g_return_if_fail (GTK_IS_CELL_AREA (area));
1551 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
1553 class = GTK_CELL_AREA_GET_CLASS (area);
1556 class->add (area, renderer);
1558 g_warning ("GtkCellAreaClass::add not implemented for `%s'",
1559 g_type_name (G_TYPE_FROM_INSTANCE (area)));
1563 * gtk_cell_area_remove:
1564 * @area: a #GtkCellArea
1565 * @renderer: the #GtkCellRenderer to remove from @area
1567 * Removes @renderer from @area.
1572 gtk_cell_area_remove (GtkCellArea *area,
1573 GtkCellRenderer *renderer)
1575 GtkCellAreaClass *class;
1576 GtkCellAreaPrivate *priv;
1577 GList *renderers, *l;
1579 g_return_if_fail (GTK_IS_CELL_AREA (area));
1580 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
1582 class = GTK_CELL_AREA_GET_CLASS (area);
1585 /* Remove any custom attributes and custom cell data func here first */
1586 g_hash_table_remove (priv->cell_info, renderer);
1588 /* Remove focus siblings of this renderer */
1589 g_hash_table_remove (priv->focus_siblings, renderer);
1591 /* Remove this renderer from any focus renderer's sibling list */
1592 renderers = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (area));
1594 for (l = renderers; l; l = l->next)
1596 GtkCellRenderer *focus_renderer = l->data;
1598 if (gtk_cell_area_is_focus_sibling (area, focus_renderer, renderer))
1600 gtk_cell_area_remove_focus_sibling (area, focus_renderer, renderer);
1605 g_list_free (renderers);
1608 class->remove (area, renderer);
1610 g_warning ("GtkCellAreaClass::remove not implemented for `%s'",
1611 g_type_name (G_TYPE_FROM_INSTANCE (area)));
1615 get_has_renderer (GtkCellRenderer *renderer,
1616 HasRendererCheck *check)
1618 if (renderer == check->renderer)
1619 check->has_renderer = TRUE;
1621 return check->has_renderer;
1625 * gtk_cell_area_has_renderer:
1626 * @area: a #GtkCellArea
1627 * @renderer: the #GtkCellRenderer to check
1629 * Checks if @area contains @renderer.
1631 * Return value: %TRUE if @renderer is in the @area.
1636 gtk_cell_area_has_renderer (GtkCellArea *area,
1637 GtkCellRenderer *renderer)
1639 HasRendererCheck check = { renderer, FALSE };
1641 g_return_val_if_fail (GTK_IS_CELL_AREA (area), FALSE);
1642 g_return_val_if_fail (GTK_IS_CELL_RENDERER (renderer), FALSE);
1644 gtk_cell_area_foreach (area, (GtkCellCallback)get_has_renderer, &check);
1646 return check.has_renderer;
1650 * gtk_cell_area_foreach:
1651 * @area: a #GtkCellArea
1652 * @callback: the #GtkCellCallback to call
1653 * @callback_data: user provided data pointer
1655 * Calls @callback for every #GtkCellRenderer in @area.
1660 gtk_cell_area_foreach (GtkCellArea *area,
1661 GtkCellCallback callback,
1662 gpointer callback_data)
1664 GtkCellAreaClass *class;
1666 g_return_if_fail (GTK_IS_CELL_AREA (area));
1667 g_return_if_fail (callback != NULL);
1669 class = GTK_CELL_AREA_GET_CLASS (area);
1672 class->foreach (area, callback, callback_data);
1674 g_warning ("GtkCellAreaClass::foreach not implemented for `%s'",
1675 g_type_name (G_TYPE_FROM_INSTANCE (area)));
1679 * gtk_cell_area_foreach_alloc:
1680 * @area: a #GtkCellArea
1681 * @context: the #GtkCellAreaContext for this row of data.
1682 * @widget: the #GtkWidget that @area is rendering to
1683 * @cell_area: the @widget relative coordinates and size for @area
1684 * @background_area: the @widget relative coordinates of the background area
1685 * @callback: the #GtkCellAllocCallback to call
1686 * @callback_data: user provided data pointer
1688 * Calls @callback for every #GtkCellRenderer in @area with the
1689 * allocated rectangle inside @cell_area.
1694 gtk_cell_area_foreach_alloc (GtkCellArea *area,
1695 GtkCellAreaContext *context,
1697 const GdkRectangle *cell_area,
1698 const GdkRectangle *background_area,
1699 GtkCellAllocCallback callback,
1700 gpointer callback_data)
1702 GtkCellAreaClass *class;
1704 g_return_if_fail (GTK_IS_CELL_AREA (area));
1705 g_return_if_fail (GTK_IS_CELL_AREA_CONTEXT (context));
1706 g_return_if_fail (GTK_IS_WIDGET (widget));
1707 g_return_if_fail (cell_area != NULL);
1708 g_return_if_fail (callback != NULL);
1710 class = GTK_CELL_AREA_GET_CLASS (area);
1712 if (class->foreach_alloc)
1713 class->foreach_alloc (area, context, widget, cell_area, background_area, callback, callback_data);
1715 g_warning ("GtkCellAreaClass::foreach_alloc not implemented for `%s'",
1716 g_type_name (G_TYPE_FROM_INSTANCE (area)));
1720 * gtk_cell_area_event:
1721 * @area: a #GtkCellArea
1722 * @context: the #GtkCellAreaContext for this row of data.
1723 * @widget: the #GtkWidget that @area is rendering to
1724 * @event: the #GdkEvent to handle
1725 * @cell_area: the @widget relative coordinates for @area
1726 * @flags: the #GtkCellRendererState for @area in this row.
1728 * Delegates event handling to a #GtkCellArea.
1730 * Return value: %TRUE if the event was handled by @area.
1735 gtk_cell_area_event (GtkCellArea *area,
1736 GtkCellAreaContext *context,
1739 const GdkRectangle *cell_area,
1740 GtkCellRendererState flags)
1742 GtkCellAreaClass *class;
1744 g_return_val_if_fail (GTK_IS_CELL_AREA (area), 0);
1745 g_return_val_if_fail (GTK_IS_CELL_AREA_CONTEXT (context), 0);
1746 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
1747 g_return_val_if_fail (event != NULL, 0);
1748 g_return_val_if_fail (cell_area != NULL, 0);
1750 class = GTK_CELL_AREA_GET_CLASS (area);
1753 return class->event (area, context, widget, event, cell_area, flags);
1755 g_warning ("GtkCellAreaClass::event not implemented for `%s'",
1756 g_type_name (G_TYPE_FROM_INSTANCE (area)));
1761 * gtk_cell_area_render:
1762 * @area: a #GtkCellArea
1763 * @context: the #GtkCellAreaContext for this row of data.
1764 * @widget: the #GtkWidget that @area is rendering to
1765 * @cr: the #cairo_t to render with
1766 * @background_area: the @widget relative coordinates for @area's background
1767 * @cell_area: the @widget relative coordinates for @area
1768 * @flags: the #GtkCellRendererState for @area in this row.
1769 * @paint_focus: whether @area should paint focus on focused cells for focused rows or not.
1771 * Renders @area's cells according to @area's layout onto @widget at
1772 * the given coordinates.
1777 gtk_cell_area_render (GtkCellArea *area,
1778 GtkCellAreaContext *context,
1781 const GdkRectangle *background_area,
1782 const GdkRectangle *cell_area,
1783 GtkCellRendererState flags,
1784 gboolean paint_focus)
1786 GtkCellAreaClass *class;
1788 g_return_if_fail (GTK_IS_CELL_AREA (area));
1789 g_return_if_fail (GTK_IS_CELL_AREA_CONTEXT (context));
1790 g_return_if_fail (GTK_IS_WIDGET (widget));
1791 g_return_if_fail (cr != NULL);
1792 g_return_if_fail (background_area != NULL);
1793 g_return_if_fail (cell_area != NULL);
1795 class = GTK_CELL_AREA_GET_CLASS (area);
1798 class->render (area, context, widget, cr, background_area, cell_area, flags, paint_focus);
1800 g_warning ("GtkCellAreaClass::render not implemented for `%s'",
1801 g_type_name (G_TYPE_FROM_INSTANCE (area)));
1805 * gtk_cell_area_set_style_detail:
1806 * @area: a #GtkCellArea
1807 * @detail: the #GtkStyle detail string to set
1809 * Sets the detail string used in any gtk_paint_*() functions
1815 gtk_cell_area_set_style_detail (GtkCellArea *area,
1816 const gchar *detail)
1818 GtkCellAreaPrivate *priv;
1820 g_return_if_fail (GTK_IS_CELL_AREA (area));
1824 if (g_strcmp0 (priv->style_detail, detail) != 0)
1826 g_free (priv->style_detail);
1827 priv->style_detail = g_strdup (detail);
1832 * gtk_cell_area_get_style_detail:
1833 * @area: a #GtkCellArea
1835 * Gets the detail string used in any gtk_paint_*() functions
1838 * Return value: the detail string, the string belongs to the area and should not be freed.
1842 G_CONST_RETURN gchar *
1843 gtk_cell_area_get_style_detail (GtkCellArea *area)
1845 GtkCellAreaPrivate *priv;
1847 g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
1851 return priv->style_detail;
1855 get_cell_allocation (GtkCellRenderer *renderer,
1856 const GdkRectangle *cell_area,
1857 const GdkRectangle *cell_background,
1858 RendererAllocationData *data)
1860 if (data->renderer == renderer)
1861 data->allocation = *cell_area;
1863 return (data->renderer == renderer);
1867 * gtk_cell_area_get_cell_allocation:
1868 * @area: a #GtkCellArea
1869 * @context: the #GtkCellAreaContext used to hold sizes for @area.
1870 * @widget: the #GtkWidget that @area is rendering on
1871 * @renderer: the #GtkCellRenderer to get the allocation for
1872 * @cell_area: the whole allocated area for @area in @widget
1874 * @allocation: (out): where to store the allocation for @renderer
1876 * Derives the allocation of @renderer inside @area if @area
1877 * were to be renderered in @cell_area.
1882 gtk_cell_area_get_cell_allocation (GtkCellArea *area,
1883 GtkCellAreaContext *context,
1885 GtkCellRenderer *renderer,
1886 const GdkRectangle *cell_area,
1887 GdkRectangle *allocation)
1889 RendererAllocationData data = { renderer, { 0, } };
1891 g_return_if_fail (GTK_IS_CELL_AREA (area));
1892 g_return_if_fail (GTK_IS_CELL_AREA_CONTEXT (context));
1893 g_return_if_fail (GTK_IS_WIDGET (widget));
1894 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
1895 g_return_if_fail (cell_area != NULL);
1896 g_return_if_fail (allocation != NULL);
1898 gtk_cell_area_foreach_alloc (area, context, widget, cell_area, cell_area,
1899 (GtkCellAllocCallback)get_cell_allocation, &data);
1901 *allocation = data.allocation;
1905 get_cell_by_position (GtkCellRenderer *renderer,
1906 const GdkRectangle *cell_area,
1907 const GdkRectangle *cell_background,
1908 CellByPositionData *data)
1910 if (data->x >= cell_area->x && data->x < cell_area->x + cell_area->width &&
1911 data->y >= cell_area->y && data->y < cell_area->y + cell_area->height)
1913 data->renderer = renderer;
1914 data->cell_area = *cell_area;
1917 return (data->renderer != NULL);
1921 * gtk_cell_area_get_cell_at_position:
1922 * @area: a #GtkCellArea
1923 * @context: the #GtkCellAreaContext used to hold sizes for @area.
1924 * @widget: the #GtkWidget that @area is rendering on
1925 * @cell_area: the whole allocated area for @area in @widget
1927 * @x: the x position
1928 * @y: the y position
1929 * @alloc_area: (out) (allow-none): where to store the inner allocated area of the
1930 * returned cell renderer, or %NULL.
1932 * Gets the #GtkCellRenderer at @x and @y coordinates inside @area and optionally
1933 * returns the full cell allocation for it inside @cell_area.
1935 * Return value: the #GtkCellRenderer at @x and @y.
1940 gtk_cell_area_get_cell_at_position (GtkCellArea *area,
1941 GtkCellAreaContext *context,
1943 const GdkRectangle *cell_area,
1946 GdkRectangle *alloc_area)
1948 CellByPositionData data = { x, y, NULL, { 0, } };
1950 g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
1951 g_return_val_if_fail (GTK_IS_CELL_AREA_CONTEXT (context), NULL);
1952 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
1953 g_return_val_if_fail (cell_area != NULL, NULL);
1954 g_return_val_if_fail (x >= cell_area->x && x <= cell_area->x + cell_area->width, NULL);
1955 g_return_val_if_fail (y >= cell_area->y && y <= cell_area->y + cell_area->height, NULL);
1957 gtk_cell_area_foreach_alloc (area, context, widget, cell_area, cell_area,
1958 (GtkCellAllocCallback)get_cell_by_position, &data);
1961 *alloc_area = data.cell_area;
1963 return data.renderer;
1966 /*************************************************************
1968 *************************************************************/
1970 * gtk_cell_area_create_context:
1971 * @area: a #GtkCellArea
1973 * Creates a #GtkCellAreaContext to be used with @area for
1974 * all purposes. #GtkCellAreaContext stores geometry information
1975 * for rows for which it was operated on, it is important to use
1976 * the same context for the same row of data at all times (i.e.
1977 * one should render and handle events with the same #GtkCellAreaContext
1978 * which was used to request the size of those rows of data).
1980 * Return value: (transfer full): a newly created #GtkCellAreaContext which can be used with @area.
1984 GtkCellAreaContext *
1985 gtk_cell_area_create_context (GtkCellArea *area)
1987 GtkCellAreaClass *class;
1989 g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
1991 class = GTK_CELL_AREA_GET_CLASS (area);
1993 if (class->create_context)
1994 return class->create_context (area);
1996 g_warning ("GtkCellAreaClass::create_context not implemented for `%s'",
1997 g_type_name (G_TYPE_FROM_INSTANCE (area)));
2003 * gtk_cell_area_copy_context:
2004 * @area: a #GtkCellArea
2005 * @context: the #GtkCellAreaContext to copy
2007 * This is sometimes needed for cases where rows need to share
2008 * alignments in one orientation but may be separately grouped
2009 * in the opposing orientation.
2011 * For instance, #GtkIconView creates all icons (rows) to have
2012 * the same width and the cells theirin to have the same
2013 * horizontal alignments. However each row of icons may have
2014 * a separate collective height. #GtkIconView uses this to
2015 * request the heights of each row based on a context which
2016 * was already used to request all the row widths that are
2019 * Return value: (transfer full): a newly created #GtkCellAreaContext copy of @context.
2023 GtkCellAreaContext *
2024 gtk_cell_area_copy_context (GtkCellArea *area,
2025 GtkCellAreaContext *context)
2027 GtkCellAreaClass *class;
2029 g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
2030 g_return_val_if_fail (GTK_IS_CELL_AREA_CONTEXT (context), NULL);
2032 class = GTK_CELL_AREA_GET_CLASS (area);
2034 if (class->copy_context)
2035 return class->copy_context (area, context);
2037 g_warning ("GtkCellAreaClass::copy_context not implemented for `%s'",
2038 g_type_name (G_TYPE_FROM_INSTANCE (area)));
2044 * gtk_cell_area_get_request_mode:
2045 * @area: a #GtkCellArea
2047 * Gets whether the area prefers a height-for-width layout
2048 * or a width-for-height layout.
2050 * Return value: The #GtkSizeRequestMode preferred by @area.
2055 gtk_cell_area_get_request_mode (GtkCellArea *area)
2057 GtkCellAreaClass *class;
2059 g_return_val_if_fail (GTK_IS_CELL_AREA (area),
2060 GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH);
2062 class = GTK_CELL_AREA_GET_CLASS (area);
2064 if (class->get_request_mode)
2065 return class->get_request_mode (area);
2067 g_warning ("GtkCellAreaClass::get_request_mode not implemented for `%s'",
2068 g_type_name (G_TYPE_FROM_INSTANCE (area)));
2070 return GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH;
2074 * gtk_cell_area_get_preferred_width:
2075 * @area: a #GtkCellArea
2076 * @context: the #GtkCellAreaContext to perform this request with
2077 * @widget: the #GtkWidget where @area will be rendering
2078 * @minimum_width: (out) (allow-none): location to store the minimum width, or %NULL
2079 * @natural_width: (out) (allow-none): location to store the natural width, or %NULL
2081 * Retrieves a cell area's initial minimum and natural width.
2083 * @area will store some geometrical information in @context along the way,
2084 * when requesting sizes over an arbitrary number of rows, its not important
2085 * to check the @minimum_width and @natural_width of this call but rather to
2086 * consult gtk_cell_area_context_get_preferred_width() after a series of
2092 gtk_cell_area_get_preferred_width (GtkCellArea *area,
2093 GtkCellAreaContext *context,
2095 gint *minimum_width,
2096 gint *natural_width)
2098 GtkCellAreaClass *class;
2100 g_return_if_fail (GTK_IS_CELL_AREA (area));
2101 g_return_if_fail (GTK_IS_WIDGET (widget));
2103 class = GTK_CELL_AREA_GET_CLASS (area);
2105 if (class->get_preferred_width)
2106 class->get_preferred_width (area, context, widget, minimum_width, natural_width);
2108 g_warning ("GtkCellAreaClass::get_preferred_width not implemented for `%s'",
2109 g_type_name (G_TYPE_FROM_INSTANCE (area)));
2113 * gtk_cell_area_get_preferred_height_for_width:
2114 * @area: a #GtkCellArea
2115 * @context: the #GtkCellAreaContext which has already been requested for widths.
2116 * @widget: the #GtkWidget where @area will be rendering
2117 * @width: the width for which to check the height of this area
2118 * @minimum_height: (out) (allow-none): location to store the minimum height, or %NULL
2119 * @natural_height: (out) (allow-none): location to store the natural height, or %NULL
2121 * Retrieves a cell area's minimum and natural height if it would be given
2122 * the specified @width.
2124 * @area stores some geometrical information in @context along the way
2125 * while calling gtk_cell_area_get_preferred_width(), it's important to
2126 * perform a series of gtk_cell_area_get_preferred_width() requests with
2127 * @context first and then call gtk_cell_area_get_preferred_height_for_width()
2128 * on each cell area individually to get the height for width of each
2129 * fully requested row.
2131 * If at some point, the width of a single row changes, it should be
2132 * requested with gtk_cell_area_get_preferred_width() again and then
2133 * the full width of the requested rows checked again with
2134 * gtk_cell_area_context_get_preferred_width().
2139 gtk_cell_area_get_preferred_height_for_width (GtkCellArea *area,
2140 GtkCellAreaContext *context,
2143 gint *minimum_height,
2144 gint *natural_height)
2146 GtkCellAreaClass *class;
2148 g_return_if_fail (GTK_IS_CELL_AREA (area));
2149 g_return_if_fail (GTK_IS_WIDGET (widget));
2151 class = GTK_CELL_AREA_GET_CLASS (area);
2152 class->get_preferred_height_for_width (area, context, widget, width, minimum_height, natural_height);
2157 * gtk_cell_area_get_preferred_height:
2158 * @area: a #GtkCellArea
2159 * @context: the #GtkCellAreaContext to perform this request with
2160 * @widget: the #GtkWidget where @area will be rendering
2161 * @minimum_height: (out) (allow-none): location to store the minimum height, or %NULL
2162 * @natural_height: (out) (allow-none): location to store the natural height, or %NULL
2164 * Retrieves a cell area's initial minimum and natural height.
2166 * @area will store some geometrical information in @context along the way,
2167 * when requesting sizes over an arbitrary number of rows, its not important
2168 * to check the @minimum_height and @natural_height of this call but rather to
2169 * consult gtk_cell_area_context_get_preferred_height() after a series of
2175 gtk_cell_area_get_preferred_height (GtkCellArea *area,
2176 GtkCellAreaContext *context,
2178 gint *minimum_height,
2179 gint *natural_height)
2181 GtkCellAreaClass *class;
2183 g_return_if_fail (GTK_IS_CELL_AREA (area));
2184 g_return_if_fail (GTK_IS_WIDGET (widget));
2186 class = GTK_CELL_AREA_GET_CLASS (area);
2188 if (class->get_preferred_height)
2189 class->get_preferred_height (area, context, widget, minimum_height, natural_height);
2191 g_warning ("GtkCellAreaClass::get_preferred_height not implemented for `%s'",
2192 g_type_name (G_TYPE_FROM_INSTANCE (area)));
2196 * gtk_cell_area_get_preferred_width_for_height:
2197 * @area: a #GtkCellArea
2198 * @context: the #GtkCellAreaContext which has already been requested for widths.
2199 * @widget: the #GtkWidget where @area will be rendering
2200 * @height: the height for which to check the width of this area
2201 * @minimum_width: (out) (allow-none): location to store the minimum width, or %NULL
2202 * @natural_width: (out) (allow-none): location to store the natural width, or %NULL
2204 * Retrieves a cell area's minimum and natural width if it would be given
2205 * the specified @height.
2207 * @area stores some geometrical information in @context along the way
2208 * while calling gtk_cell_area_get_preferred_height(), it's important to
2209 * perform a series of gtk_cell_area_get_preferred_height() requests with
2210 * @context first and then call gtk_cell_area_get_preferred_width_for_height()
2211 * on each cell area individually to get the height for width of each
2212 * fully requested row.
2214 * If at some point, the height of a single row changes, it should be
2215 * requested with gtk_cell_area_get_preferred_height() again and then
2216 * the full height of the requested rows checked again with
2217 * gtk_cell_area_context_get_preferred_height().
2222 gtk_cell_area_get_preferred_width_for_height (GtkCellArea *area,
2223 GtkCellAreaContext *context,
2226 gint *minimum_width,
2227 gint *natural_width)
2229 GtkCellAreaClass *class;
2231 g_return_if_fail (GTK_IS_CELL_AREA (area));
2232 g_return_if_fail (GTK_IS_WIDGET (widget));
2234 class = GTK_CELL_AREA_GET_CLASS (area);
2235 class->get_preferred_width_for_height (area, context, widget, height, minimum_width, natural_width);
2238 /*************************************************************
2240 *************************************************************/
2243 * gtk_cell_area_attribute_connect:
2244 * @area: a #GtkCellArea
2245 * @renderer: the #GtkCellRenderer to connect an attribute for
2246 * @attribute: the attribute name
2247 * @column: the #GtkTreeModel column to fetch attribute values from
2249 * Connects an @attribute to apply values from @column for the
2250 * #GtkTreeModel in use.
2255 gtk_cell_area_attribute_connect (GtkCellArea *area,
2256 GtkCellRenderer *renderer,
2257 const gchar *attribute,
2260 GtkCellAreaPrivate *priv;
2262 CellAttribute *cell_attribute;
2264 g_return_if_fail (GTK_IS_CELL_AREA (area));
2265 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2266 g_return_if_fail (attribute != NULL);
2267 g_return_if_fail (gtk_cell_area_has_renderer (area, renderer));
2270 info = g_hash_table_lookup (priv->cell_info, renderer);
2274 info = cell_info_new (NULL, NULL, NULL);
2276 g_hash_table_insert (priv->cell_info, renderer, info);
2282 /* Check we are not adding the same attribute twice */
2283 if ((node = g_slist_find_custom (info->attributes, attribute,
2284 (GCompareFunc)cell_attribute_find)) != NULL)
2286 cell_attribute = node->data;
2288 g_warning ("Cannot connect attribute `%s' for cell renderer class `%s' "
2289 "since `%s' is already attributed to column %d",
2291 g_type_name (G_TYPE_FROM_INSTANCE (area)),
2292 attribute, cell_attribute->column);
2297 cell_attribute = cell_attribute_new (renderer, attribute, column);
2299 if (!cell_attribute)
2301 g_warning ("Cannot connect attribute `%s' for cell renderer class `%s' "
2302 "since attribute does not exist",
2304 g_type_name (G_TYPE_FROM_INSTANCE (area)));
2308 info->attributes = g_slist_prepend (info->attributes, cell_attribute);
2312 * gtk_cell_area_attribute_disconnect:
2313 * @area: a #GtkCellArea
2314 * @renderer: the #GtkCellRenderer to disconnect an attribute for
2315 * @attribute: the attribute name
2317 * Disconnects @attribute for the @renderer in @area so that
2318 * attribute will no longer be updated with values from the
2324 gtk_cell_area_attribute_disconnect (GtkCellArea *area,
2325 GtkCellRenderer *renderer,
2326 const gchar *attribute)
2328 GtkCellAreaPrivate *priv;
2330 CellAttribute *cell_attribute;
2333 g_return_if_fail (GTK_IS_CELL_AREA (area));
2334 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2335 g_return_if_fail (attribute != NULL);
2336 g_return_if_fail (gtk_cell_area_has_renderer (area, renderer));
2339 info = g_hash_table_lookup (priv->cell_info, renderer);
2343 node = g_slist_find_custom (info->attributes, attribute,
2344 (GCompareFunc)cell_attribute_find);
2347 cell_attribute = node->data;
2349 cell_attribute_free (cell_attribute);
2351 info->attributes = g_slist_delete_link (info->attributes, node);
2357 * gtk_cell_area_apply_attributes
2358 * @area: a #GtkCellArea
2359 * @tree_model: the #GtkTreeModel to pull values from
2360 * @iter: the #GtkTreeIter in @tree_model to apply values for
2361 * @is_expander: whether @iter has children
2362 * @is_expanded: whether @iter is expanded in the view and
2363 * children are visible
2365 * Applies any connected attributes to the renderers in
2366 * @area by pulling the values from @tree_model.
2371 gtk_cell_area_apply_attributes (GtkCellArea *area,
2372 GtkTreeModel *tree_model,
2374 gboolean is_expander,
2375 gboolean is_expanded)
2377 g_return_if_fail (GTK_IS_CELL_AREA (area));
2378 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
2379 g_return_if_fail (iter != NULL);
2381 g_signal_emit (area, cell_area_signals[SIGNAL_APPLY_ATTRIBUTES], 0,
2382 tree_model, iter, is_expander, is_expanded);
2386 * gtk_cell_area_get_current_path_string:
2387 * @area: a #GtkCellArea
2389 * Gets the current #GtkTreePath string for the currently
2390 * applied #GtkTreeIter, this is implicitly updated when
2391 * gtk_cell_area_apply_attributes() is called and can be
2392 * used to interact with renderers from #GtkCellArea
2395 * Return value: The current #GtkTreePath string for the current
2396 * attributes applied to @area. This string belongs to the area and
2397 * should not be freed.
2401 G_CONST_RETURN gchar *
2402 gtk_cell_area_get_current_path_string (GtkCellArea *area)
2404 GtkCellAreaPrivate *priv;
2406 g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
2410 return priv->current_path;
2414 /*************************************************************
2415 * API: Cell Properties *
2416 *************************************************************/
2418 * gtk_cell_area_class_install_cell_property:
2419 * @aclass: a #GtkCellAreaClass
2420 * @property_id: the id for the property
2421 * @pspec: the #GParamSpec for the property
2423 * Installs a cell property on a cell area class.
2428 gtk_cell_area_class_install_cell_property (GtkCellAreaClass *aclass,
2432 g_return_if_fail (GTK_IS_CELL_AREA_CLASS (aclass));
2433 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
2434 if (pspec->flags & G_PARAM_WRITABLE)
2435 g_return_if_fail (aclass->set_cell_property != NULL);
2436 if (pspec->flags & G_PARAM_READABLE)
2437 g_return_if_fail (aclass->get_cell_property != NULL);
2438 g_return_if_fail (property_id > 0);
2439 g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0); /* paranoid */
2440 g_return_if_fail ((pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY)) == 0);
2442 if (g_param_spec_pool_lookup (cell_property_pool, pspec->name, G_OBJECT_CLASS_TYPE (aclass), TRUE))
2444 g_warning (G_STRLOC ": class `%s' already contains a cell property named `%s'",
2445 G_OBJECT_CLASS_NAME (aclass), pspec->name);
2448 g_param_spec_ref (pspec);
2449 g_param_spec_sink (pspec);
2450 PARAM_SPEC_SET_PARAM_ID (pspec, property_id);
2451 g_param_spec_pool_insert (cell_property_pool, pspec, G_OBJECT_CLASS_TYPE (aclass));
2455 * gtk_cell_area_class_find_cell_property:
2456 * @aclass: a #GtkCellAreaClass
2457 * @property_name: the name of the child property to find
2459 * Finds a cell property of a cell area class by name.
2461 * Return value: (allow-none): the #GParamSpec of the child property or %NULL if @aclass has no
2462 * child property with that name.
2467 gtk_cell_area_class_find_cell_property (GtkCellAreaClass *aclass,
2468 const gchar *property_name)
2470 g_return_val_if_fail (GTK_IS_CELL_AREA_CLASS (aclass), NULL);
2471 g_return_val_if_fail (property_name != NULL, NULL);
2473 return g_param_spec_pool_lookup (cell_property_pool,
2475 G_OBJECT_CLASS_TYPE (aclass),
2480 * gtk_cell_area_class_list_cell_properties:
2481 * @aclass: a #GtkCellAreaClass
2482 * @n_properties: location to return the number of cell properties found
2484 * Returns all cell properties of a cell area class.
2486 * Return value: a newly allocated %NULL-terminated array of #GParamSpec*.
2487 * The array must be freed with g_free().
2492 gtk_cell_area_class_list_cell_properties (GtkCellAreaClass *aclass,
2493 guint *n_properties)
2495 GParamSpec **pspecs;
2498 g_return_val_if_fail (GTK_IS_CELL_AREA_CLASS (aclass), NULL);
2500 pspecs = g_param_spec_pool_list (cell_property_pool,
2501 G_OBJECT_CLASS_TYPE (aclass),
2510 * gtk_cell_area_add_with_properties:
2511 * @area: a #GtkCellArea
2512 * @renderer: a #GtkCellRenderer to be placed inside @area
2513 * @first_prop_name: the name of the first cell property to set
2514 * @Varargs: a %NULL-terminated list of property names and values, starting
2515 * with @first_prop_name
2517 * Adds @renderer to @area, setting cell properties at the same time.
2518 * See gtk_cell_area_add() and gtk_cell_area_child_set() for more details.
2523 gtk_cell_area_add_with_properties (GtkCellArea *area,
2524 GtkCellRenderer *renderer,
2525 const gchar *first_prop_name,
2528 GtkCellAreaClass *class;
2530 g_return_if_fail (GTK_IS_CELL_AREA (area));
2531 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2533 class = GTK_CELL_AREA_GET_CLASS (area);
2539 class->add (area, renderer);
2541 va_start (var_args, first_prop_name);
2542 gtk_cell_area_cell_set_valist (area, renderer, first_prop_name, var_args);
2546 g_warning ("GtkCellAreaClass::add not implemented for `%s'",
2547 g_type_name (G_TYPE_FROM_INSTANCE (area)));
2551 * gtk_cell_area_cell_set:
2552 * @area: a #GtkCellArea
2553 * @renderer: a #GtkCellRenderer which is a cell inside @area
2554 * @first_prop_name: the name of the first cell property to set
2555 * @Varargs: a %NULL-terminated list of property names and values, starting
2556 * with @first_prop_name
2558 * Sets one or more cell properties for @cell in @area.
2563 gtk_cell_area_cell_set (GtkCellArea *area,
2564 GtkCellRenderer *renderer,
2565 const gchar *first_prop_name,
2570 g_return_if_fail (GTK_IS_CELL_AREA (area));
2571 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2573 va_start (var_args, first_prop_name);
2574 gtk_cell_area_cell_set_valist (area, renderer, first_prop_name, var_args);
2579 * gtk_cell_area_cell_get:
2580 * @area: a #GtkCellArea
2581 * @renderer: a #GtkCellRenderer which is inside @area
2582 * @first_prop_name: the name of the first cell property to get
2583 * @Varargs: return location for the first cell property, followed
2584 * optionally by more name/return location pairs, followed by %NULL
2586 * Gets the values of one or more cell properties for @renderer in @area.
2591 gtk_cell_area_cell_get (GtkCellArea *area,
2592 GtkCellRenderer *renderer,
2593 const gchar *first_prop_name,
2598 g_return_if_fail (GTK_IS_CELL_AREA (area));
2599 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2601 va_start (var_args, first_prop_name);
2602 gtk_cell_area_cell_get_valist (area, renderer, first_prop_name, var_args);
2607 area_get_cell_property (GtkCellArea *area,
2608 GtkCellRenderer *renderer,
2612 GtkCellAreaClass *class = g_type_class_peek (pspec->owner_type);
2614 class->get_cell_property (area, renderer, PARAM_SPEC_PARAM_ID (pspec), value, pspec);
2618 area_set_cell_property (GtkCellArea *area,
2619 GtkCellRenderer *renderer,
2621 const GValue *value)
2623 GValue tmp_value = { 0, };
2624 GtkCellAreaClass *class = g_type_class_peek (pspec->owner_type);
2626 /* provide a copy to work from, convert (if necessary) and validate */
2627 g_value_init (&tmp_value, G_PARAM_SPEC_VALUE_TYPE (pspec));
2628 if (!g_value_transform (value, &tmp_value))
2629 g_warning ("unable to set cell property `%s' of type `%s' from value of type `%s'",
2631 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
2632 G_VALUE_TYPE_NAME (value));
2633 else if (g_param_value_validate (pspec, &tmp_value) && !(pspec->flags & G_PARAM_LAX_VALIDATION))
2635 gchar *contents = g_strdup_value_contents (value);
2637 g_warning ("value \"%s\" of type `%s' is invalid for property `%s' of type `%s'",
2639 G_VALUE_TYPE_NAME (value),
2641 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)));
2646 class->set_cell_property (area, renderer, PARAM_SPEC_PARAM_ID (pspec), &tmp_value, pspec);
2648 g_value_unset (&tmp_value);
2652 * gtk_cell_area_cell_set_valist:
2653 * @area: a #GtkCellArea
2654 * @renderer: a #GtkCellRenderer which inside @area
2655 * @first_property_name: the name of the first cell property to set
2656 * @var_args: a %NULL-terminated list of property names and values, starting
2657 * with @first_prop_name
2659 * Sets one or more cell properties for @renderer in @area.
2664 gtk_cell_area_cell_set_valist (GtkCellArea *area,
2665 GtkCellRenderer *renderer,
2666 const gchar *first_property_name,
2671 g_return_if_fail (GTK_IS_CELL_AREA (area));
2672 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2674 name = first_property_name;
2677 GValue value = { 0, };
2678 gchar *error = NULL;
2680 g_param_spec_pool_lookup (cell_property_pool, name,
2681 G_OBJECT_TYPE (area), TRUE);
2684 g_warning ("%s: cell area class `%s' has no cell property named `%s'",
2685 G_STRLOC, G_OBJECT_TYPE_NAME (area), name);
2688 if (!(pspec->flags & G_PARAM_WRITABLE))
2690 g_warning ("%s: cell property `%s' of cell area class `%s' is not writable",
2691 G_STRLOC, pspec->name, G_OBJECT_TYPE_NAME (area));
2695 g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (pspec));
2696 G_VALUE_COLLECT (&value, var_args, 0, &error);
2699 g_warning ("%s: %s", G_STRLOC, error);
2702 /* we purposely leak the value here, it might not be
2703 * in a sane state if an error condition occoured
2707 area_set_cell_property (area, renderer, pspec, &value);
2708 g_value_unset (&value);
2709 name = va_arg (var_args, gchar*);
2714 * gtk_cell_area_cell_get_valist:
2715 * @area: a #GtkCellArea
2716 * @renderer: a #GtkCellRenderer inside @area
2717 * @first_property_name: the name of the first property to get
2718 * @var_args: return location for the first property, followed
2719 * optionally by more name/return location pairs, followed by %NULL
2721 * Gets the values of one or more cell properties for @renderer in @area.
2726 gtk_cell_area_cell_get_valist (GtkCellArea *area,
2727 GtkCellRenderer *renderer,
2728 const gchar *first_property_name,
2733 g_return_if_fail (GTK_IS_CELL_AREA (area));
2734 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2736 name = first_property_name;
2739 GValue value = { 0, };
2743 pspec = g_param_spec_pool_lookup (cell_property_pool, name,
2744 G_OBJECT_TYPE (area), TRUE);
2747 g_warning ("%s: cell area class `%s' has no cell property named `%s'",
2748 G_STRLOC, G_OBJECT_TYPE_NAME (area), name);
2751 if (!(pspec->flags & G_PARAM_READABLE))
2753 g_warning ("%s: cell property `%s' of cell area class `%s' is not readable",
2754 G_STRLOC, pspec->name, G_OBJECT_TYPE_NAME (area));
2758 g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (pspec));
2759 area_get_cell_property (area, renderer, pspec, &value);
2760 G_VALUE_LCOPY (&value, var_args, 0, &error);
2763 g_warning ("%s: %s", G_STRLOC, error);
2765 g_value_unset (&value);
2768 g_value_unset (&value);
2769 name = va_arg (var_args, gchar*);
2774 * gtk_cell_area_cell_set_property:
2775 * @area: a #GtkCellArea
2776 * @renderer: a #GtkCellRenderer inside @area
2777 * @property_name: the name of the cell property to set
2778 * @value: the value to set the cell property to
2780 * Sets a cell property for @renderer in @area.
2785 gtk_cell_area_cell_set_property (GtkCellArea *area,
2786 GtkCellRenderer *renderer,
2787 const gchar *property_name,
2788 const GValue *value)
2792 g_return_if_fail (GTK_IS_CELL_AREA (area));
2793 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2794 g_return_if_fail (property_name != NULL);
2795 g_return_if_fail (G_IS_VALUE (value));
2797 pspec = g_param_spec_pool_lookup (cell_property_pool, property_name,
2798 G_OBJECT_TYPE (area), TRUE);
2800 g_warning ("%s: cell area class `%s' has no cell property named `%s'",
2801 G_STRLOC, G_OBJECT_TYPE_NAME (area), property_name);
2802 else if (!(pspec->flags & G_PARAM_WRITABLE))
2803 g_warning ("%s: cell property `%s' of cell area class `%s' is not writable",
2804 G_STRLOC, pspec->name, G_OBJECT_TYPE_NAME (area));
2807 area_set_cell_property (area, renderer, pspec, value);
2812 * gtk_cell_area_cell_get_property:
2813 * @area: a #GtkCellArea
2814 * @renderer: a #GtkCellRenderer inside @area
2815 * @property_name: the name of the property to get
2816 * @value: a location to return the value
2818 * Gets the value of a cell property for @renderer in @area.
2823 gtk_cell_area_cell_get_property (GtkCellArea *area,
2824 GtkCellRenderer *renderer,
2825 const gchar *property_name,
2830 g_return_if_fail (GTK_IS_CELL_AREA (area));
2831 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
2832 g_return_if_fail (property_name != NULL);
2833 g_return_if_fail (G_IS_VALUE (value));
2835 pspec = g_param_spec_pool_lookup (cell_property_pool, property_name,
2836 G_OBJECT_TYPE (area), TRUE);
2838 g_warning ("%s: cell area class `%s' has no cell property named `%s'",
2839 G_STRLOC, G_OBJECT_TYPE_NAME (area), property_name);
2840 else if (!(pspec->flags & G_PARAM_READABLE))
2841 g_warning ("%s: cell property `%s' of cell area class `%s' is not readable",
2842 G_STRLOC, pspec->name, G_OBJECT_TYPE_NAME (area));
2845 GValue *prop_value, tmp_value = { 0, };
2847 /* auto-conversion of the callers value type
2849 if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
2851 g_value_reset (value);
2854 else if (!g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
2856 g_warning ("can't retrieve cell property `%s' of type `%s' as value of type `%s'",
2858 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
2859 G_VALUE_TYPE_NAME (value));
2864 g_value_init (&tmp_value, G_PARAM_SPEC_VALUE_TYPE (pspec));
2865 prop_value = &tmp_value;
2868 area_get_cell_property (area, renderer, pspec, prop_value);
2870 if (prop_value != value)
2872 g_value_transform (prop_value, value);
2873 g_value_unset (&tmp_value);
2878 /*************************************************************
2880 *************************************************************/
2883 * gtk_cell_area_is_activatable:
2884 * @area: a #GtkCellArea
2886 * Returns whether the area can do anything when activated,
2887 * after applying new attributes to @area.
2889 * Return value: whether @area can do anything when activated.
2894 gtk_cell_area_is_activatable (GtkCellArea *area)
2896 g_return_val_if_fail (GTK_IS_CELL_AREA (area), FALSE);
2898 return GTK_CELL_AREA_GET_CLASS (area)->is_activatable (area);
2902 * gtk_cell_area_focus:
2903 * @area: a #GtkCellArea
2904 * @direction: the #GtkDirectionType
2906 * This should be called by the @area's owning layout widget
2907 * when focus is to be passed to @area, or moved within @area
2908 * for a given @direction and row data.
2910 * Implementing #GtkCellArea classes should implement this
2911 * method to receive and navigate focus in it's own way particular
2912 * to how it lays out cells.
2914 * Return value: %TRUE if focus remains inside @area as a result of this call.
2919 gtk_cell_area_focus (GtkCellArea *area,
2920 GtkDirectionType direction)
2922 GtkCellAreaClass *class;
2924 g_return_val_if_fail (GTK_IS_CELL_AREA (area), FALSE);
2926 class = GTK_CELL_AREA_GET_CLASS (area);
2929 return class->focus (area, direction);
2931 g_warning ("GtkCellAreaClass::focus not implemented for `%s'",
2932 g_type_name (G_TYPE_FROM_INSTANCE (area)));
2938 * gtk_cell_area_activate:
2939 * @area: a #GtkCellArea
2940 * @context: the #GtkCellAreaContext in context with the current row data
2941 * @widget: the #GtkWidget that @area is rendering on
2942 * @cell_area: the size and location of @area relative to @widget's allocation
2943 * @flags: the #GtkCellRendererState flags for @area for this row of data.
2944 * @edit_only: if %TRUE then only cell renderers that are %GTK_CELL_RENDERER_MODE_EDITABLE
2945 * will be activated.
2947 * Activates @area, usually by activating the currently focused
2948 * cell, however some subclasses which embed widgets in the area
2949 * can also activate a widget if it currently has the focus.
2951 * Return value: Whether @area was successfully activated.
2956 gtk_cell_area_activate (GtkCellArea *area,
2957 GtkCellAreaContext *context,
2959 const GdkRectangle *cell_area,
2960 GtkCellRendererState flags,
2963 g_return_val_if_fail (GTK_IS_CELL_AREA (area), FALSE);
2965 return GTK_CELL_AREA_GET_CLASS (area)->activate (area, context, widget, cell_area, flags, edit_only);
2970 * gtk_cell_area_set_focus_cell:
2971 * @area: a #GtkCellArea
2972 * @focus_cell: the #GtkCellRenderer to give focus to
2974 * This is generally called from #GtkCellArea implementations
2975 * either gtk_cell_area_grab_focus() or gtk_cell_area_update_focus()
2976 * is called. It's also up to the #GtkCellArea implementation
2977 * to update the focused cell when receiving events from
2978 * gtk_cell_area_event() appropriately.
2983 gtk_cell_area_set_focus_cell (GtkCellArea *area,
2984 GtkCellRenderer *renderer)
2986 GtkCellAreaPrivate *priv;
2988 g_return_if_fail (GTK_IS_CELL_AREA (area));
2989 g_return_if_fail (renderer == NULL || GTK_IS_CELL_RENDERER (renderer));
2993 if (priv->focus_cell != renderer)
2995 if (priv->focus_cell)
2996 g_object_unref (priv->focus_cell);
2998 priv->focus_cell = renderer;
3000 if (priv->focus_cell)
3001 g_object_ref (priv->focus_cell);
3003 g_object_notify (G_OBJECT (area), "focus-cell");
3006 /* Signal that the current focus renderer for this path changed
3007 * (it may be that the focus cell did not change, but the row
3008 * may have changed so we need to signal it) */
3009 g_signal_emit (area, cell_area_signals[SIGNAL_FOCUS_CHANGED], 0,
3010 priv->focus_cell, priv->current_path);
3015 * gtk_cell_area_get_focus_cell:
3016 * @area: a #GtkCellArea
3018 * Retrieves the currently focused cell for @area
3020 * Return value: the currently focused cell in @area.
3025 gtk_cell_area_get_focus_cell (GtkCellArea *area)
3027 GtkCellAreaPrivate *priv;
3029 g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
3033 return priv->focus_cell;
3037 /*************************************************************
3038 * API: Focus Siblings *
3039 *************************************************************/
3042 * gtk_cell_area_add_focus_sibling:
3043 * @area: a #GtkCellArea
3044 * @renderer: the #GtkCellRenderer expected to have focus
3045 * @sibling: the #GtkCellRenderer to add to @renderer's focus area
3047 * Adds @sibling to @renderer's focusable area, focus will be drawn
3048 * around @renderer and all of it's siblings if @renderer can
3049 * focus for a given row.
3051 * Events handled by focus siblings can also activate the given
3052 * focusable @renderer.
3057 gtk_cell_area_add_focus_sibling (GtkCellArea *area,
3058 GtkCellRenderer *renderer,
3059 GtkCellRenderer *sibling)
3061 GtkCellAreaPrivate *priv;
3064 g_return_if_fail (GTK_IS_CELL_AREA (area));
3065 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
3066 g_return_if_fail (GTK_IS_CELL_RENDERER (sibling));
3067 g_return_if_fail (renderer != sibling);
3068 g_return_if_fail (gtk_cell_area_has_renderer (area, renderer));
3069 g_return_if_fail (gtk_cell_area_has_renderer (area, sibling));
3070 g_return_if_fail (!gtk_cell_area_is_focus_sibling (area, renderer, sibling));
3072 /* XXX We should also check that sibling is not in any other renderer's sibling
3073 * list already, a renderer can be sibling of only one focusable renderer
3079 siblings = g_hash_table_lookup (priv->focus_siblings, renderer);
3082 siblings = g_list_append (siblings, sibling);
3085 siblings = g_list_append (siblings, sibling);
3086 g_hash_table_insert (priv->focus_siblings, renderer, siblings);
3091 * gtk_cell_area_remove_focus_sibling:
3092 * @area: a #GtkCellArea
3093 * @renderer: the #GtkCellRenderer expected to have focus
3094 * @sibling: the #GtkCellRenderer to remove from @renderer's focus area
3096 * Removes @sibling from @renderer's focus sibling list
3097 * (see gtk_cell_area_add_focus_sibling()).
3102 gtk_cell_area_remove_focus_sibling (GtkCellArea *area,
3103 GtkCellRenderer *renderer,
3104 GtkCellRenderer *sibling)
3106 GtkCellAreaPrivate *priv;
3109 g_return_if_fail (GTK_IS_CELL_AREA (area));
3110 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
3111 g_return_if_fail (GTK_IS_CELL_RENDERER (sibling));
3112 g_return_if_fail (gtk_cell_area_is_focus_sibling (area, renderer, sibling));
3116 siblings = g_hash_table_lookup (priv->focus_siblings, renderer);
3118 siblings = g_list_copy (siblings);
3119 siblings = g_list_remove (siblings, sibling);
3122 g_hash_table_remove (priv->focus_siblings, renderer);
3124 g_hash_table_insert (priv->focus_siblings, renderer, siblings);
3128 * gtk_cell_area_is_focus_sibling:
3129 * @area: a #GtkCellArea
3130 * @renderer: the #GtkCellRenderer expected to have focus
3131 * @sibling: the #GtkCellRenderer to check against @renderer's sibling list
3133 * Returns %TRUE if @sibling is one of @renderer's focus siblings
3134 * (see gtk_cell_area_add_focus_sibling()).
3139 gtk_cell_area_is_focus_sibling (GtkCellArea *area,
3140 GtkCellRenderer *renderer,
3141 GtkCellRenderer *sibling)
3143 GtkCellAreaPrivate *priv;
3144 GList *siblings, *l;
3146 g_return_val_if_fail (GTK_IS_CELL_AREA (area), FALSE);
3147 g_return_val_if_fail (GTK_IS_CELL_RENDERER (renderer), FALSE);
3148 g_return_val_if_fail (GTK_IS_CELL_RENDERER (sibling), FALSE);
3152 siblings = g_hash_table_lookup (priv->focus_siblings, renderer);
3154 for (l = siblings; l; l = l->next)
3156 GtkCellRenderer *a_sibling = l->data;
3158 if (a_sibling == sibling)
3166 * gtk_cell_area_get_focus_siblings:
3167 * @area: a #GtkCellArea
3168 * @renderer: the #GtkCellRenderer expected to have focus
3170 * Gets the focus sibling cell renderers for @renderer.
3172 * Return value: (element-type GtkCellRenderer) (transfer none): A #GList of #GtkCellRenderers.
3173 * The returned list is internal and should not be freed.
3178 gtk_cell_area_get_focus_siblings (GtkCellArea *area,
3179 GtkCellRenderer *renderer)
3181 GtkCellAreaPrivate *priv;
3183 g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
3184 g_return_val_if_fail (GTK_IS_CELL_RENDERER (renderer), NULL);
3188 return g_hash_table_lookup (priv->focus_siblings, renderer);
3192 * gtk_cell_area_get_focus_from_sibling:
3193 * @area: a #GtkCellArea
3194 * @renderer: the #GtkCellRenderer
3196 * Gets the #GtkCellRenderer which is expected to be focusable
3197 * for which @renderer is, or may be a sibling.
3199 * This is handy for #GtkCellArea subclasses when handling events,
3200 * after determining the renderer at the event location it can
3201 * then chose to activate the focus cell for which the event
3202 * cell may have been a sibling.
3204 * Return value: the #GtkCellRenderer for which @renderer is a sibling, or %NULL.
3209 gtk_cell_area_get_focus_from_sibling (GtkCellArea *area,
3210 GtkCellRenderer *renderer)
3212 GtkCellRenderer *ret_renderer = NULL;
3213 GList *renderers, *l;
3215 g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
3216 g_return_val_if_fail (GTK_IS_CELL_RENDERER (renderer), NULL);
3218 renderers = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (area));
3220 for (l = renderers; l; l = l->next)
3222 GtkCellRenderer *a_renderer = l->data;
3225 for (list = gtk_cell_area_get_focus_siblings (area, a_renderer);
3226 list; list = list->next)
3228 GtkCellRenderer *sibling_renderer = list->data;
3230 if (sibling_renderer == renderer)
3232 ret_renderer = a_renderer;
3237 g_list_free (renderers);
3239 return ret_renderer;
3242 /*************************************************************
3243 * API: Cell Activation/Editing *
3244 *************************************************************/
3246 gtk_cell_area_add_editable (GtkCellArea *area,
3247 GtkCellRenderer *renderer,
3248 GtkCellEditable *editable,
3249 const GdkRectangle *cell_area)
3251 g_signal_emit (area, cell_area_signals[SIGNAL_ADD_EDITABLE], 0,
3252 renderer, editable, cell_area, area->priv->current_path);
3256 gtk_cell_area_remove_editable (GtkCellArea *area,
3257 GtkCellRenderer *renderer,
3258 GtkCellEditable *editable)
3260 g_signal_emit (area, cell_area_signals[SIGNAL_REMOVE_EDITABLE], 0, renderer, editable);
3264 cell_area_remove_widget_cb (GtkCellEditable *editable,
3267 GtkCellAreaPrivate *priv = area->priv;
3269 g_assert (priv->edit_widget == editable);
3270 g_assert (priv->edited_cell != NULL);
3272 gtk_cell_area_remove_editable (area, priv->edited_cell, priv->edit_widget);
3274 /* Now that we're done with editing the widget and it can be removed,
3275 * remove our references to the widget and disconnect handlers */
3276 gtk_cell_area_set_edited_cell (area, NULL);
3277 gtk_cell_area_set_edit_widget (area, NULL);
3281 gtk_cell_area_set_edited_cell (GtkCellArea *area,
3282 GtkCellRenderer *renderer)
3284 GtkCellAreaPrivate *priv;
3286 g_return_if_fail (GTK_IS_CELL_AREA (area));
3287 g_return_if_fail (renderer == NULL || GTK_IS_CELL_RENDERER (renderer));
3291 if (priv->edited_cell != renderer)
3293 if (priv->edited_cell)
3294 g_object_unref (priv->edited_cell);
3296 priv->edited_cell = renderer;
3298 if (priv->edited_cell)
3299 g_object_ref (priv->edited_cell);
3301 g_object_notify (G_OBJECT (area), "edited-cell");
3306 gtk_cell_area_set_edit_widget (GtkCellArea *area,
3307 GtkCellEditable *editable)
3309 GtkCellAreaPrivate *priv;
3311 g_return_if_fail (GTK_IS_CELL_AREA (area));
3312 g_return_if_fail (editable == NULL || GTK_IS_CELL_EDITABLE (editable));
3316 if (priv->edit_widget != editable)
3318 if (priv->edit_widget)
3320 g_signal_handler_disconnect (priv->edit_widget, priv->remove_widget_id);
3322 g_object_unref (priv->edit_widget);
3325 priv->edit_widget = editable;
3327 if (priv->edit_widget)
3329 priv->remove_widget_id =
3330 g_signal_connect (priv->edit_widget, "remove-widget",
3331 G_CALLBACK (cell_area_remove_widget_cb), area);
3333 g_object_ref (priv->edit_widget);
3336 g_object_notify (G_OBJECT (area), "edit-widget");
3341 * gtk_cell_area_get_edited_cell:
3342 * @area: a #GtkCellArea
3344 * Gets the #GtkCellRenderer in @area that is currently
3347 * Return value: The currently edited #GtkCellRenderer
3352 gtk_cell_area_get_edited_cell (GtkCellArea *area)
3354 GtkCellAreaPrivate *priv;
3356 g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
3360 return priv->edited_cell;
3364 * gtk_cell_area_get_edit_widget:
3365 * @area: a #GtkCellArea
3367 * Gets the #GtkCellEditable widget currently used
3368 * to edit the currently edited cell.
3370 * Return value: The currently active #GtkCellEditable widget
3375 gtk_cell_area_get_edit_widget (GtkCellArea *area)
3377 GtkCellAreaPrivate *priv;
3379 g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
3383 return priv->edit_widget;
3387 * gtk_cell_area_activate_cell:
3388 * @area: a #GtkCellArea
3389 * @widget: the #GtkWidget that @area is rendering onto
3390 * @renderer: the #GtkCellRenderer in @area to activate
3391 * @event: the #GdkEvent for which cell activation should occur
3392 * @cell_area: the #GdkRectangle in @widget relative coordinates
3393 * of @renderer for the current row.
3394 * @flags: the #GtkCellRendererState for @renderer
3396 * This is used by #GtkCellArea subclasses when handling events
3397 * to activate cells, the base #GtkCellArea class activates cells
3398 * for keyboard events for free in it's own GtkCellArea->activate()
3401 * Return value: whether cell activation was successful
3406 gtk_cell_area_activate_cell (GtkCellArea *area,
3408 GtkCellRenderer *renderer,
3410 const GdkRectangle *cell_area,
3411 GtkCellRendererState flags)
3413 GtkCellRendererMode mode;
3414 GtkCellAreaPrivate *priv;
3416 g_return_val_if_fail (GTK_IS_CELL_AREA (area), FALSE);
3417 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3418 g_return_val_if_fail (GTK_IS_CELL_RENDERER (renderer), FALSE);
3419 g_return_val_if_fail (cell_area != NULL, FALSE);
3423 g_object_get (renderer, "mode", &mode, NULL);
3425 if (mode == GTK_CELL_RENDERER_MODE_ACTIVATABLE)
3427 if (gtk_cell_renderer_activate (renderer,
3435 else if (mode == GTK_CELL_RENDERER_MODE_EDITABLE)
3437 GtkCellEditable *editable_widget;
3438 GdkRectangle inner_area;
3440 gtk_cell_area_inner_cell_area (area, widget, cell_area, &inner_area);
3443 gtk_cell_renderer_start_editing (renderer,
3450 if (editable_widget != NULL)
3452 g_return_val_if_fail (GTK_IS_CELL_EDITABLE (editable_widget), FALSE);
3454 gtk_cell_area_set_edited_cell (area, renderer);
3455 gtk_cell_area_set_edit_widget (area, editable_widget);
3457 /* Signal that editing started so that callers can get
3458 * a handle on the editable_widget */
3459 gtk_cell_area_add_editable (area, priv->focus_cell, editable_widget, cell_area);
3461 /* If the signal was successfully handled start the editing */
3462 if (gtk_widget_get_parent (GTK_WIDGET (editable_widget)))
3464 gtk_cell_editable_start_editing (editable_widget, NULL);
3465 gtk_widget_grab_focus (GTK_WIDGET (editable_widget));
3469 /* Otherwise clear the editing state and fire a warning */
3470 gtk_cell_area_set_edited_cell (area, NULL);
3471 gtk_cell_area_set_edit_widget (area, NULL);
3473 g_warning ("GtkCellArea::add-editable fired in the dark, no cell editing was started.");
3484 * gtk_cell_area_stop_editing:
3485 * @area: a #GtkCellArea
3486 * @canceled: whether editing was canceled.
3488 * Explicitly stops the editing of the currently
3489 * edited cell (see gtk_cell_area_get_edited_cell()).
3491 * If @canceled is %TRUE, the cell renderer will emit
3492 * the ::editing-canceled signal.
3497 gtk_cell_area_stop_editing (GtkCellArea *area,
3500 GtkCellAreaPrivate *priv;
3502 g_return_if_fail (GTK_IS_CELL_AREA (area));
3506 if (priv->edited_cell)
3508 GtkCellEditable *edit_widget = g_object_ref (priv->edit_widget);
3509 GtkCellRenderer *edit_cell = g_object_ref (priv->edited_cell);
3511 /* Stop editing of the cell renderer */
3512 gtk_cell_renderer_stop_editing (priv->edited_cell, canceled);
3514 /* Remove any references to the editable widget */
3515 gtk_cell_area_set_edited_cell (area, NULL);
3516 gtk_cell_area_set_edit_widget (area, NULL);
3518 /* Send the remove-widget signal explicitly (this is done after setting
3519 * the edit cell/widget NULL to avoid feedback)
3521 gtk_cell_area_remove_editable (area, edit_cell, edit_widget);
3522 g_object_unref (edit_cell);
3523 g_object_unref (edit_widget);
3527 /*************************************************************
3528 * API: Convenience for area implementations *
3529 *************************************************************/
3532 * gtk_cell_area_inner_cell_area:
3533 * @area: a #GtkCellArea
3534 * @widget: the #GtkWidget that @area is rendering onto
3535 * @cell_area: the @widget relative coordinates where one of @area's cells
3537 * @inner_area: (out): the return location for the inner cell area
3539 * This is a convenience function for #GtkCellArea implementations
3540 * to get the inner area where a given #GtkCellRenderer will be
3541 * rendered. It removes any padding previously added by gtk_cell_area_request_renderer().
3546 gtk_cell_area_inner_cell_area (GtkCellArea *area,
3548 const GdkRectangle *cell_area,
3549 GdkRectangle *inner_area)
3551 gint focus_line_width;
3553 g_return_if_fail (GTK_IS_CELL_AREA (area));
3554 g_return_if_fail (GTK_IS_WIDGET (widget));
3555 g_return_if_fail (cell_area != NULL);
3556 g_return_if_fail (inner_area != NULL);
3558 gtk_widget_style_get (widget, "focus-line-width", &focus_line_width, NULL);
3560 *inner_area = *cell_area;
3562 inner_area->x += focus_line_width;
3563 inner_area->width -= focus_line_width * 2;
3564 inner_area->y += focus_line_width;
3565 inner_area->height -= focus_line_width * 2;
3569 * gtk_cell_area_request_renderer:
3570 * @area: a #GtkCellArea
3571 * @renderer: the #GtkCellRenderer to request size for
3572 * @orientation: the #GtkOrientation in which to request size
3573 * @widget: the #GtkWidget that @area is rendering onto
3574 * @for_size: the allocation contextual size to request for, or -1 if
3575 * the base request for the orientation is to be returned.
3576 * @minimum_size: (out) (allow-none): location to store the minimum size, or %NULL
3577 * @natural_size: (out) (allow-none): location to store the natural size, or %NULL
3579 * This is a convenience function for #GtkCellArea implementations
3580 * to request size for cell renderers. It's important to use this
3581 * function to request size and then use gtk_cell_area_inner_cell_area()
3582 * at render and event time since this function will add padding
3583 * around the cell for focus painting.
3588 gtk_cell_area_request_renderer (GtkCellArea *area,
3589 GtkCellRenderer *renderer,
3590 GtkOrientation orientation,
3596 GtkCellAreaPrivate *priv;
3597 gint focus_line_width;
3599 g_return_if_fail (GTK_IS_CELL_AREA (area));
3600 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
3601 g_return_if_fail (GTK_IS_WIDGET (widget));
3602 g_return_if_fail (minimum_size != NULL);
3603 g_return_if_fail (natural_size != NULL);
3607 gtk_widget_style_get (widget, "focus-line-width", &focus_line_width, NULL);
3609 focus_line_width *= 2;
3611 if (orientation == GTK_ORIENTATION_HORIZONTAL)
3614 gtk_cell_renderer_get_preferred_width (renderer, widget, minimum_size, natural_size);
3617 for_size = MAX (0, for_size - focus_line_width);
3619 gtk_cell_renderer_get_preferred_width_for_height (renderer, widget, for_size,
3620 minimum_size, natural_size);
3623 else /* GTK_ORIENTATION_VERTICAL */
3626 gtk_cell_renderer_get_preferred_height (renderer, widget, minimum_size, natural_size);
3629 for_size = MAX (0, for_size - focus_line_width);
3631 gtk_cell_renderer_get_preferred_height_for_width (renderer, widget, for_size,
3632 minimum_size, natural_size);
3636 *minimum_size += focus_line_width;
3637 *natural_size += focus_line_width;