2 * Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
22 #include "gtktreeviewcolumn.h"
26 #include "gtktreeview.h"
27 #include "gtktreeprivate.h"
28 #include "gtkcelllayout.h"
29 #include "gtkbutton.h"
30 #include "gtkalignment.h"
33 #include "gtkmarshalers.h"
35 #include "gtkcellareacontext.h"
36 #include "gtkcellareabox.h"
37 #include "gtkprivate.h"
42 * SECTION:gtktreeviewcolumn
43 * @Short_description: A visible column in a GtkTreeView widget
44 * @Title: GtkTreeViewColumn
45 * @See_also: #GtkTreeView, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable,
46 * #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable,
47 * #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
49 * The GtkTreeViewColumn object represents a visible column in a #GtkTreeView widget.
50 * It allows to set properties of the column header, and functions as a holding pen for
51 * the cell renderers which determine how the data in the column is displayed.
53 * Please refer to the <link linkend="TreeWidget">tree widget conceptual overview</link>
54 * for an overview of all the objects and data types related to the tree widget and how
89 static void gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface);
92 static void gtk_tree_view_column_set_property (GObject *object,
96 static void gtk_tree_view_column_get_property (GObject *object,
100 static void gtk_tree_view_column_finalize (GObject *object);
101 static void gtk_tree_view_column_dispose (GObject *object);
102 static GObject *gtk_tree_view_column_constructor (GType type,
103 guint n_construct_properties,
104 GObjectConstructParam *construct_properties);
106 /* GtkCellLayout implementation */
107 static GtkCellArea *gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout);
109 /* Button handling code */
110 static void gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column);
111 static void gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column);
113 /* Button signal handlers */
114 static gint gtk_tree_view_column_button_event (GtkWidget *widget,
117 static void gtk_tree_view_column_button_clicked (GtkWidget *widget,
119 static gboolean gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
120 gboolean group_cycling,
123 /* Property handlers */
124 static void gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
125 GtkTreeViewColumn *tree_column);
127 /* GtkCellArea/GtkCellAreaContext callbacks */
128 static void gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
130 GtkTreeViewColumn *tree_column);
131 static void gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
132 GtkCellRenderer *renderer,
133 GtkCellEditable *edit_widget,
134 GdkRectangle *cell_area,
135 const gchar *path_string,
137 static void gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
138 GtkCellRenderer *renderer,
139 GtkCellEditable *edit_widget,
142 /* Internal functions */
143 static void gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
145 static void gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column);
146 static void gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
147 GtkCellRenderer *cell_renderer,
150 /* GtkBuildable implementation */
151 static void gtk_tree_view_column_buildable_init (GtkBuildableIface *iface);
153 static guint tree_column_signals[LAST_SIGNAL] = { 0 };
155 G_DEFINE_TYPE_WITH_CODE (GtkTreeViewColumn, gtk_tree_view_column, G_TYPE_INITIALLY_UNOWNED,
156 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
157 gtk_tree_view_column_cell_layout_init)
158 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
159 gtk_tree_view_column_buildable_init))
163 gtk_tree_view_column_class_init (GtkTreeViewColumnClass *class)
165 GObjectClass *object_class;
167 object_class = (GObjectClass*) class;
169 class->clicked = NULL;
171 object_class->constructor = gtk_tree_view_column_constructor;
172 object_class->finalize = gtk_tree_view_column_finalize;
173 object_class->dispose = gtk_tree_view_column_dispose;
174 object_class->set_property = gtk_tree_view_column_set_property;
175 object_class->get_property = gtk_tree_view_column_get_property;
177 tree_column_signals[CLICKED] =
178 g_signal_new (I_("clicked"),
179 G_OBJECT_CLASS_TYPE (object_class),
181 G_STRUCT_OFFSET (GtkTreeViewColumnClass, clicked),
183 _gtk_marshal_VOID__VOID,
186 g_object_class_install_property (object_class,
188 g_param_spec_boolean ("visible",
190 P_("Whether to display the column"),
192 GTK_PARAM_READWRITE));
194 g_object_class_install_property (object_class,
196 g_param_spec_boolean ("resizable",
198 P_("Column is user-resizable"),
200 GTK_PARAM_READWRITE));
202 g_object_class_install_property (object_class,
204 g_param_spec_int ("width",
206 P_("Current width of the column"),
210 GTK_PARAM_READABLE));
211 g_object_class_install_property (object_class,
213 g_param_spec_int ("spacing",
215 P_("Space which is inserted between cells"),
219 GTK_PARAM_READWRITE));
220 g_object_class_install_property (object_class,
222 g_param_spec_enum ("sizing",
224 P_("Resize mode of the column"),
225 GTK_TYPE_TREE_VIEW_COLUMN_SIZING,
226 GTK_TREE_VIEW_COLUMN_GROW_ONLY,
227 GTK_PARAM_READWRITE));
229 g_object_class_install_property (object_class,
231 g_param_spec_int ("fixed-width",
233 P_("Current fixed width of the column"),
237 GTK_PARAM_READWRITE));
239 g_object_class_install_property (object_class,
241 g_param_spec_int ("min-width",
243 P_("Minimum allowed width of the column"),
247 GTK_PARAM_READWRITE));
249 g_object_class_install_property (object_class,
251 g_param_spec_int ("max-width",
253 P_("Maximum allowed width of the column"),
257 GTK_PARAM_READWRITE));
259 g_object_class_install_property (object_class,
261 g_param_spec_string ("title",
263 P_("Title to appear in column header"),
265 GTK_PARAM_READWRITE));
267 g_object_class_install_property (object_class,
269 g_param_spec_boolean ("expand",
271 P_("Column gets share of extra width allocated to the widget"),
273 GTK_PARAM_READWRITE));
275 g_object_class_install_property (object_class,
277 g_param_spec_boolean ("clickable",
279 P_("Whether the header can be clicked"),
281 GTK_PARAM_READWRITE));
284 g_object_class_install_property (object_class,
286 g_param_spec_object ("widget",
288 P_("Widget to put in column header button instead of column title"),
290 GTK_PARAM_READWRITE));
292 g_object_class_install_property (object_class,
294 g_param_spec_float ("alignment",
296 P_("X Alignment of the column header text or widget"),
300 GTK_PARAM_READWRITE));
302 g_object_class_install_property (object_class,
304 g_param_spec_boolean ("reorderable",
306 P_("Whether the column can be reordered around the headers"),
308 GTK_PARAM_READWRITE));
310 g_object_class_install_property (object_class,
312 g_param_spec_boolean ("sort-indicator",
313 P_("Sort indicator"),
314 P_("Whether to show a sort indicator"),
316 GTK_PARAM_READWRITE));
318 g_object_class_install_property (object_class,
320 g_param_spec_enum ("sort-order",
322 P_("Sort direction the sort indicator should indicate"),
325 GTK_PARAM_READWRITE));
328 * GtkTreeViewColumn:sort-column-id:
330 * Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header
331 * clickable. Set to %-1 to make the column unsortable.
335 g_object_class_install_property (object_class,
337 g_param_spec_int ("sort-column-id",
338 P_("Sort column ID"),
339 P_("Logical sort column ID this column sorts on when selected for sorting"),
343 GTK_PARAM_READWRITE));
346 * GtkTreeViewColumn:cell-area:
348 * The #GtkCellArea used to layout cell renderers for this column.
352 g_object_class_install_property (object_class,
354 g_param_spec_object ("cell-area",
356 P_("The GtkCellArea used to layout cells"),
358 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
363 gtk_tree_view_column_buildable_init (GtkBuildableIface *iface)
365 iface->add_child = _gtk_cell_layout_buildable_add_child;
366 iface->custom_tag_start = _gtk_cell_layout_buildable_custom_tag_start;
367 iface->custom_tag_end = _gtk_cell_layout_buildable_custom_tag_end;
371 gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface)
373 iface->get_area = gtk_tree_view_column_cell_layout_get_area;
377 gtk_tree_view_column_init (GtkTreeViewColumn *tree_column)
379 tree_column->button = NULL;
380 tree_column->xalign = 0.0;
381 tree_column->width = 0;
382 tree_column->requested_width = -1;
383 tree_column->min_width = -1;
384 tree_column->max_width = -1;
385 tree_column->resized_width = 0;
386 tree_column->column_type = GTK_TREE_VIEW_COLUMN_GROW_ONLY;
387 tree_column->visible = TRUE;
388 tree_column->resizable = FALSE;
389 tree_column->expand = FALSE;
390 tree_column->clickable = FALSE;
391 tree_column->dirty = TRUE;
392 tree_column->sort_order = GTK_SORT_ASCENDING;
393 tree_column->show_sort_indicator = FALSE;
394 tree_column->property_changed_signal = 0;
395 tree_column->sort_clicked_signal = 0;
396 tree_column->sort_column_changed_signal = 0;
397 tree_column->sort_column_id = -1;
398 tree_column->reorderable = FALSE;
399 tree_column->maybe_reordered = FALSE;
400 tree_column->fixed_width = 1;
401 tree_column->use_resized_width = FALSE;
402 tree_column->title = g_strdup ("");
406 gtk_tree_view_column_constructor (GType type,
407 guint n_construct_properties,
408 GObjectConstructParam *construct_properties)
410 GtkTreeViewColumn *tree_column;
413 object = G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->constructor
414 (type, n_construct_properties, construct_properties);
416 tree_column = (GtkTreeViewColumn *) object;
418 if (!tree_column->cell_area)
420 tree_column->cell_area = gtk_cell_area_box_new ();
421 g_object_ref_sink (tree_column->cell_area);
424 gtk_cell_area_set_style_detail (tree_column->cell_area, "treeview");
426 tree_column->add_editable_signal =
427 g_signal_connect (tree_column->cell_area, "add-editable",
428 G_CALLBACK (gtk_tree_view_column_add_editable_callback),
430 tree_column->remove_editable_signal =
431 g_signal_connect (tree_column->cell_area, "remove-editable",
432 G_CALLBACK (gtk_tree_view_column_remove_editable_callback),
435 tree_column->cell_area_context = gtk_cell_area_create_context (tree_column->cell_area);
437 tree_column->context_changed_signal =
438 g_signal_connect (tree_column->cell_area_context, "notify",
439 G_CALLBACK (gtk_tree_view_column_context_changed), tree_column);
445 gtk_tree_view_column_dispose (GObject *object)
447 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
449 if (tree_column->cell_area_context)
451 g_signal_handler_disconnect (tree_column->cell_area_context,
452 tree_column->context_changed_signal);
454 g_object_unref (tree_column->cell_area_context);
456 tree_column->cell_area_context = NULL;
457 tree_column->context_changed_signal = 0;
460 if (tree_column->cell_area)
462 g_signal_handler_disconnect (tree_column->cell_area,
463 tree_column->add_editable_signal);
464 g_signal_handler_disconnect (tree_column->cell_area,
465 tree_column->remove_editable_signal);
467 g_object_unref (tree_column->cell_area);
468 tree_column->cell_area = NULL;
469 tree_column->add_editable_signal = 0;
470 tree_column->remove_editable_signal = 0;
473 if (tree_column->child)
475 g_object_unref (tree_column->child);
476 tree_column->child = NULL;
479 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->dispose (object);
483 gtk_tree_view_column_finalize (GObject *object)
485 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
487 g_free (tree_column->title);
489 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->finalize (object);
493 gtk_tree_view_column_set_property (GObject *object,
498 GtkTreeViewColumn *tree_column;
501 tree_column = GTK_TREE_VIEW_COLUMN (object);
506 gtk_tree_view_column_set_visible (tree_column,
507 g_value_get_boolean (value));
511 gtk_tree_view_column_set_resizable (tree_column,
512 g_value_get_boolean (value));
516 gtk_tree_view_column_set_sizing (tree_column,
517 g_value_get_enum (value));
520 case PROP_FIXED_WIDTH:
521 gtk_tree_view_column_set_fixed_width (tree_column,
522 g_value_get_int (value));
526 gtk_tree_view_column_set_min_width (tree_column,
527 g_value_get_int (value));
531 gtk_tree_view_column_set_max_width (tree_column,
532 g_value_get_int (value));
536 gtk_tree_view_column_set_spacing (tree_column,
537 g_value_get_int (value));
541 gtk_tree_view_column_set_title (tree_column,
542 g_value_get_string (value));
546 gtk_tree_view_column_set_expand (tree_column,
547 g_value_get_boolean (value));
551 gtk_tree_view_column_set_clickable (tree_column,
552 g_value_get_boolean (value));
556 gtk_tree_view_column_set_widget (tree_column,
557 (GtkWidget*) g_value_get_object (value));
561 gtk_tree_view_column_set_alignment (tree_column,
562 g_value_get_float (value));
565 case PROP_REORDERABLE:
566 gtk_tree_view_column_set_reorderable (tree_column,
567 g_value_get_boolean (value));
570 case PROP_SORT_INDICATOR:
571 gtk_tree_view_column_set_sort_indicator (tree_column,
572 g_value_get_boolean (value));
575 case PROP_SORT_ORDER:
576 gtk_tree_view_column_set_sort_order (tree_column,
577 g_value_get_enum (value));
580 case PROP_SORT_COLUMN_ID:
581 gtk_tree_view_column_set_sort_column_id (tree_column,
582 g_value_get_int (value));
586 /* Construct-only, can only be assigned once */
587 area = g_value_get_object (value);
590 tree_column->cell_area = g_object_ref_sink (area);
594 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
600 gtk_tree_view_column_get_property (GObject *object,
605 GtkTreeViewColumn *tree_column;
607 tree_column = GTK_TREE_VIEW_COLUMN (object);
612 g_value_set_boolean (value,
613 gtk_tree_view_column_get_visible (tree_column));
617 g_value_set_boolean (value,
618 gtk_tree_view_column_get_resizable (tree_column));
622 g_value_set_int (value,
623 gtk_tree_view_column_get_width (tree_column));
627 g_value_set_int (value,
628 gtk_tree_view_column_get_spacing (tree_column));
632 g_value_set_enum (value,
633 gtk_tree_view_column_get_sizing (tree_column));
636 case PROP_FIXED_WIDTH:
637 g_value_set_int (value,
638 gtk_tree_view_column_get_fixed_width (tree_column));
642 g_value_set_int (value,
643 gtk_tree_view_column_get_min_width (tree_column));
647 g_value_set_int (value,
648 gtk_tree_view_column_get_max_width (tree_column));
652 g_value_set_string (value,
653 gtk_tree_view_column_get_title (tree_column));
657 g_value_set_boolean (value,
658 gtk_tree_view_column_get_expand (tree_column));
662 g_value_set_boolean (value,
663 gtk_tree_view_column_get_clickable (tree_column));
667 g_value_set_object (value,
668 (GObject*) gtk_tree_view_column_get_widget (tree_column));
672 g_value_set_float (value,
673 gtk_tree_view_column_get_alignment (tree_column));
676 case PROP_REORDERABLE:
677 g_value_set_boolean (value,
678 gtk_tree_view_column_get_reorderable (tree_column));
681 case PROP_SORT_INDICATOR:
682 g_value_set_boolean (value,
683 gtk_tree_view_column_get_sort_indicator (tree_column));
686 case PROP_SORT_ORDER:
687 g_value_set_enum (value,
688 gtk_tree_view_column_get_sort_order (tree_column));
691 case PROP_SORT_COLUMN_ID:
692 g_value_set_int (value,
693 gtk_tree_view_column_get_sort_column_id (tree_column));
697 g_value_set_object (value, tree_column->cell_area);
701 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
706 /* Implementation of GtkCellLayout interface
709 gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout)
711 GtkTreeViewColumn *column;
713 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (cell_layout), NULL);
714 column = GTK_TREE_VIEW_COLUMN (cell_layout);
716 return column->cell_area;
719 /* Button handling code
722 gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column)
724 GtkTreeView *tree_view;
728 tree_view = (GtkTreeView *) tree_column->tree_view;
730 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
731 g_return_if_fail (tree_column->button == NULL);
733 gtk_widget_push_composite_child ();
734 tree_column->button = gtk_button_new ();
735 gtk_widget_add_events (tree_column->button, GDK_POINTER_MOTION_MASK);
736 gtk_widget_pop_composite_child ();
738 /* make sure we own a reference to it as well. */
739 if (tree_view->priv->header_window)
740 gtk_widget_set_parent_window (tree_column->button, tree_view->priv->header_window);
741 gtk_widget_set_parent (tree_column->button, GTK_WIDGET (tree_view));
743 g_signal_connect (tree_column->button, "event",
744 G_CALLBACK (gtk_tree_view_column_button_event),
746 g_signal_connect (tree_column->button, "clicked",
747 G_CALLBACK (gtk_tree_view_column_button_clicked),
750 tree_column->alignment = gtk_alignment_new (tree_column->xalign, 0.5, 0.0, 0.0);
752 hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 2);
753 tree_column->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_IN);
755 if (tree_column->child)
756 child = tree_column->child;
759 child = gtk_label_new (tree_column->title);
760 gtk_widget_show (child);
763 g_signal_connect (child, "mnemonic-activate",
764 G_CALLBACK (gtk_tree_view_column_mnemonic_activate),
767 if (tree_column->xalign <= 0.5)
768 gtk_box_pack_end (GTK_BOX (hbox), tree_column->arrow, FALSE, FALSE, 0);
770 gtk_box_pack_start (GTK_BOX (hbox), tree_column->arrow, FALSE, FALSE, 0);
772 gtk_box_pack_start (GTK_BOX (hbox), tree_column->alignment, TRUE, TRUE, 0);
774 gtk_container_add (GTK_CONTAINER (tree_column->alignment), child);
775 gtk_container_add (GTK_CONTAINER (tree_column->button), hbox);
777 gtk_widget_show (hbox);
778 gtk_widget_show (tree_column->alignment);
779 gtk_tree_view_column_update_button (tree_column);
783 gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column)
785 gint sort_column_id = -1;
787 GtkWidget *alignment;
789 GtkWidget *current_child;
790 GtkArrowType arrow_type = GTK_ARROW_NONE;
793 if (tree_column->tree_view)
794 model = gtk_tree_view_get_model (GTK_TREE_VIEW (tree_column->tree_view));
798 /* Create a button if necessary */
799 if (tree_column->visible &&
800 tree_column->button == NULL &&
801 tree_column->tree_view &&
802 gtk_widget_get_realized (tree_column->tree_view))
803 gtk_tree_view_column_create_button (tree_column);
805 if (! tree_column->button)
808 hbox = gtk_bin_get_child (GTK_BIN (tree_column->button));
809 alignment = tree_column->alignment;
810 arrow = tree_column->arrow;
811 current_child = gtk_bin_get_child (GTK_BIN (alignment));
813 /* Set up the actual button */
814 gtk_alignment_set (GTK_ALIGNMENT (alignment), tree_column->xalign,
817 if (tree_column->child)
819 if (current_child != tree_column->child)
821 gtk_container_remove (GTK_CONTAINER (alignment),
823 gtk_container_add (GTK_CONTAINER (alignment),
829 if (current_child == NULL)
831 current_child = gtk_label_new (NULL);
832 gtk_widget_show (current_child);
833 gtk_container_add (GTK_CONTAINER (alignment),
837 g_return_if_fail (GTK_IS_LABEL (current_child));
839 if (tree_column->title)
840 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
843 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
847 if (GTK_IS_TREE_SORTABLE (model))
848 gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
852 if (tree_column->show_sort_indicator)
854 gboolean alternative;
856 g_object_get (gtk_widget_get_settings (tree_column->tree_view),
857 "gtk-alternative-sort-arrows", &alternative,
860 switch (tree_column->sort_order)
862 case GTK_SORT_ASCENDING:
863 arrow_type = alternative ? GTK_ARROW_UP : GTK_ARROW_DOWN;
866 case GTK_SORT_DESCENDING:
867 arrow_type = alternative ? GTK_ARROW_DOWN : GTK_ARROW_UP;
871 g_warning (G_STRLOC": bad sort order");
876 gtk_arrow_set (GTK_ARROW (arrow),
880 /* Put arrow on the right if the text is left-or-center justified, and on the
881 * left otherwise; do this by packing boxes, so flipping text direction will
884 g_object_ref (arrow);
885 gtk_container_remove (GTK_CONTAINER (hbox), arrow);
887 if (tree_column->xalign <= 0.5)
889 gtk_box_pack_end (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
893 gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
894 /* move it to the front */
895 gtk_box_reorder_child (GTK_BOX (hbox), arrow, 0);
897 g_object_unref (arrow);
899 if (tree_column->show_sort_indicator
900 || (GTK_IS_TREE_SORTABLE (model) && tree_column->sort_column_id >= 0))
901 gtk_widget_show (arrow);
903 gtk_widget_hide (arrow);
905 /* It's always safe to hide the button. It isn't always safe to show it, as
906 * if you show it before it's realized, it'll get the wrong window. */
907 if (tree_column->button &&
908 tree_column->tree_view != NULL &&
909 gtk_widget_get_realized (tree_column->tree_view))
911 if (tree_column->visible)
913 gtk_widget_show_now (tree_column->button);
914 if (tree_column->window)
916 if (tree_column->resizable)
918 gdk_window_show (tree_column->window);
919 gdk_window_raise (tree_column->window);
923 gdk_window_hide (tree_column->window);
929 gtk_widget_hide (tree_column->button);
930 if (tree_column->window)
931 gdk_window_hide (tree_column->window);
935 if (tree_column->reorderable || tree_column->clickable)
937 gtk_widget_set_can_focus (tree_column->button, TRUE);
941 gtk_widget_set_can_focus (tree_column->button, FALSE);
942 if (gtk_widget_has_focus (tree_column->button))
944 GtkWidget *toplevel = gtk_widget_get_toplevel (tree_column->tree_view);
945 if (gtk_widget_is_toplevel (toplevel))
947 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
951 /* Queue a resize on the assumption that we always want to catch all changes
952 * and columns don't change all that often.
954 if (gtk_widget_get_realized (tree_column->tree_view))
955 gtk_widget_queue_resize (tree_column->tree_view);
959 /* Button signal handlers
963 gtk_tree_view_column_button_event (GtkWidget *widget,
967 GtkTreeViewColumn *column = (GtkTreeViewColumn *) data;
969 g_return_val_if_fail (event != NULL, FALSE);
971 if (event->type == GDK_BUTTON_PRESS &&
972 column->reorderable &&
973 ((GdkEventButton *)event)->button == 1)
975 column->maybe_reordered = TRUE;
976 gdk_window_get_pointer (gtk_button_get_event_window (GTK_BUTTON (widget)),
980 gtk_widget_grab_focus (widget);
983 if (event->type == GDK_BUTTON_RELEASE ||
984 event->type == GDK_LEAVE_NOTIFY)
985 column->maybe_reordered = FALSE;
987 if (event->type == GDK_MOTION_NOTIFY &&
988 column->maybe_reordered &&
989 (gtk_drag_check_threshold (widget,
992 (gint) ((GdkEventMotion *)event)->x,
993 (gint) ((GdkEventMotion *)event)->y)))
995 column->maybe_reordered = FALSE;
996 _gtk_tree_view_column_start_drag (GTK_TREE_VIEW (column->tree_view), column,
997 event->motion.device);
1000 if (column->clickable == FALSE)
1002 switch (event->type)
1004 case GDK_BUTTON_PRESS:
1005 case GDK_2BUTTON_PRESS:
1006 case GDK_3BUTTON_PRESS:
1007 case GDK_MOTION_NOTIFY:
1008 case GDK_BUTTON_RELEASE:
1009 case GDK_ENTER_NOTIFY:
1010 case GDK_LEAVE_NOTIFY:
1021 gtk_tree_view_column_button_clicked (GtkWidget *widget, gpointer data)
1023 g_signal_emit_by_name (data, "clicked");
1027 gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
1028 gboolean group_cycling,
1031 GtkTreeViewColumn *column = (GtkTreeViewColumn *)data;
1033 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (column), FALSE);
1035 GTK_TREE_VIEW (column->tree_view)->priv->focus_column = column;
1036 if (column->clickable)
1037 gtk_button_clicked (GTK_BUTTON (column->button));
1038 else if (gtk_widget_get_can_focus (column->button))
1039 gtk_widget_grab_focus (column->button);
1041 gtk_widget_grab_focus (column->tree_view);
1047 gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
1048 GtkTreeViewColumn *column)
1050 gint sort_column_id;
1053 if (gtk_tree_sortable_get_sort_column_id (sortable,
1057 if (sort_column_id == column->sort_column_id)
1059 gtk_tree_view_column_set_sort_indicator (column, TRUE);
1060 gtk_tree_view_column_set_sort_order (column, order);
1064 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1069 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1074 gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
1077 gint sort_column_id;
1079 gboolean has_sort_column;
1080 gboolean has_default_sort_func;
1082 g_return_if_fail (tree_column->tree_view != NULL);
1085 gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
1088 has_default_sort_func =
1089 gtk_tree_sortable_has_default_sort_func (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model));
1091 if (has_sort_column &&
1092 sort_column_id == tree_column->sort_column_id)
1094 if (order == GTK_SORT_ASCENDING)
1095 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
1096 tree_column->sort_column_id,
1097 GTK_SORT_DESCENDING);
1098 else if (order == GTK_SORT_DESCENDING && has_default_sort_func)
1099 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
1100 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID,
1101 GTK_SORT_ASCENDING);
1103 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
1104 tree_column->sort_column_id,
1105 GTK_SORT_ASCENDING);
1109 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
1110 tree_column->sort_column_id,
1111 GTK_SORT_ASCENDING);
1117 gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column)
1119 GtkTreeModel *model;
1121 if (tree_column->tree_view == NULL)
1124 model = gtk_tree_view_get_model (GTK_TREE_VIEW (tree_column->tree_view));
1129 if (GTK_IS_TREE_SORTABLE (model) &&
1130 tree_column->sort_column_id != -1)
1132 gint real_sort_column_id;
1133 GtkSortType real_order;
1135 if (tree_column->sort_column_changed_signal == 0)
1136 tree_column->sort_column_changed_signal =
1137 g_signal_connect (model, "sort-column-changed",
1138 G_CALLBACK (gtk_tree_view_model_sort_column_changed),
1141 if (gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
1142 &real_sort_column_id,
1144 (real_sort_column_id == tree_column->sort_column_id))
1146 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
1147 gtk_tree_view_column_set_sort_order (tree_column, real_order);
1151 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
1157 gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
1159 GtkTreeViewColumn *tree_column)
1161 if (!strcmp (pspec->name, "minimum-width") ||
1162 !strcmp (pspec->name, "natural-width") ||
1163 !strcmp (pspec->name, "minimum-height") ||
1164 !strcmp (pspec->name, "natural-height"))
1166 /* XXX We want to do something specific if the size actually got cleared
1167 * or if it just grew a little bit because of a data change and we
1168 * are in GROW_ONLY mode.
1170 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1175 gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
1176 GtkCellRenderer *renderer,
1177 GtkCellEditable *edit_widget,
1178 GdkRectangle *cell_area,
1179 const gchar *path_string,
1183 GtkTreeViewColumn *column = user_data;
1185 if (column->tree_view)
1187 path = gtk_tree_path_new_from_string (path_string);
1189 _gtk_tree_view_add_editable (GTK_TREE_VIEW (column->tree_view),
1195 gtk_tree_path_free (path);
1200 gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
1201 GtkCellRenderer *renderer,
1202 GtkCellEditable *edit_widget,
1205 GtkTreeViewColumn *column = user_data;
1207 if (column->tree_view)
1208 _gtk_tree_view_remove_editable (GTK_TREE_VIEW (column->tree_view),
1213 /* Exported Private Functions.
1214 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
1218 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
1220 GtkAllocation allocation;
1221 GtkTreeView *tree_view;
1223 guint attributes_mask;
1226 tree_view = (GtkTreeView *)column->tree_view;
1227 rtl = (gtk_widget_get_direction (GTK_WIDGET (tree_view)) == GTK_TEXT_DIR_RTL);
1229 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
1230 g_return_if_fail (gtk_widget_get_realized (GTK_WIDGET (tree_view)));
1231 g_return_if_fail (tree_view->priv->header_window != NULL);
1232 g_return_if_fail (column->button != NULL);
1234 gtk_widget_set_parent_window (column->button, tree_view->priv->header_window);
1236 if (column->visible)
1237 gtk_widget_show (column->button);
1239 attr.window_type = GDK_WINDOW_CHILD;
1240 attr.wclass = GDK_INPUT_ONLY;
1241 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
1242 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view)) |
1243 (GDK_BUTTON_PRESS_MASK |
1244 GDK_BUTTON_RELEASE_MASK |
1245 GDK_POINTER_MOTION_MASK |
1246 GDK_POINTER_MOTION_HINT_MASK |
1247 GDK_KEY_PRESS_MASK);
1248 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
1249 attr.cursor = gdk_cursor_new_for_display (gdk_window_get_display (tree_view->priv->header_window),
1250 GDK_SB_H_DOUBLE_ARROW);
1252 attr.width = TREE_VIEW_DRAG_WIDTH;
1253 attr.height = tree_view->priv->header_height;
1255 gtk_widget_get_allocation (column->button, &allocation);
1256 attr.x = (allocation.x + (rtl ? 0 : allocation.width)) - TREE_VIEW_DRAG_WIDTH / 2;
1257 column->window = gdk_window_new (tree_view->priv->header_window,
1258 &attr, attributes_mask);
1259 gdk_window_set_user_data (column->window, tree_view);
1261 gtk_tree_view_column_update_button (column);
1263 gdk_cursor_unref (attr.cursor);
1267 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
1269 g_return_if_fail (column != NULL);
1270 g_return_if_fail (column->window != NULL);
1272 gdk_window_set_user_data (column->window, NULL);
1273 gdk_window_destroy (column->window);
1274 column->window = NULL;
1278 _gtk_tree_view_column_unset_model (GtkTreeViewColumn *column,
1279 GtkTreeModel *old_model)
1281 if (column->sort_column_changed_signal)
1283 g_signal_handler_disconnect (old_model,
1284 column->sort_column_changed_signal);
1285 column->sort_column_changed_signal = 0;
1287 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1291 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
1292 GtkTreeView *tree_view)
1294 g_assert (column->tree_view == NULL);
1296 column->tree_view = GTK_WIDGET (tree_view);
1297 gtk_tree_view_column_create_button (column);
1299 column->property_changed_signal =
1300 g_signal_connect_swapped (tree_view,
1302 G_CALLBACK (gtk_tree_view_column_setup_sort_column_id_callback),
1305 gtk_tree_view_column_setup_sort_column_id_callback (column);
1309 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
1311 if (column->tree_view && column->button)
1313 gtk_container_remove (GTK_CONTAINER (column->tree_view), column->button);
1315 if (column->property_changed_signal)
1317 g_signal_handler_disconnect (column->tree_view, column->property_changed_signal);
1318 column->property_changed_signal = 0;
1321 if (column->sort_column_changed_signal)
1323 g_signal_handler_disconnect (gtk_tree_view_get_model (GTK_TREE_VIEW (column->tree_view)),
1324 column->sort_column_changed_signal);
1325 column->sort_column_changed_signal = 0;
1328 column->tree_view = NULL;
1329 column->button = NULL;
1333 _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column)
1335 gboolean ret = FALSE;
1336 GList *list, *cells;
1338 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (column->cell_area));
1340 for (list = cells; list; list = list->next)
1342 GtkCellRenderer *cell = list->data;
1343 GtkCellRendererMode mode;
1345 g_object_get (cell, "mode", &mode, NULL);
1347 if (mode == GTK_CELL_RENDERER_MODE_EDITABLE)
1354 g_list_free (cells);
1359 /* gets cell being edited */
1361 _gtk_tree_view_column_get_edited_cell (GtkTreeViewColumn *column)
1363 return gtk_cell_area_get_edited_cell (column->cell_area);
1366 /* Public Functions */
1370 * gtk_tree_view_column_new:
1372 * Creates a new #GtkTreeViewColumn.
1374 * Return value: A newly created #GtkTreeViewColumn.
1377 gtk_tree_view_column_new (void)
1379 GtkTreeViewColumn *tree_column;
1381 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, NULL);
1387 * gtk_tree_view_column_new_with_attributes:
1388 * @title: The title to set the header to.
1389 * @cell: The #GtkCellRenderer.
1390 * @Varargs: A %NULL-terminated list of attributes.
1392 * Creates a new #GtkTreeViewColumn with a number of default values. This is
1393 * equivalent to calling gtk_tree_view_column_set_title(),
1394 * gtk_tree_view_column_pack_start(), and
1395 * gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn.
1397 * Here's a simple example:
1399 * enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
1402 * GtkTreeViewColumn *column;
1403 * GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
1405 * column = gtk_tree_view_column_new_with_attributes ("Title",
1407 * "text", TEXT_COLUMN,
1408 * "foreground", COLOR_COLUMN,
1413 * Return value: A newly created #GtkTreeViewColumn.
1416 gtk_tree_view_column_new_with_attributes (const gchar *title,
1417 GtkCellRenderer *cell,
1420 GtkTreeViewColumn *retval;
1423 retval = gtk_tree_view_column_new ();
1425 gtk_tree_view_column_set_title (retval, title);
1426 gtk_tree_view_column_pack_start (retval, cell, TRUE);
1428 va_start (args, cell);
1429 gtk_tree_view_column_set_attributesv (retval, cell, args);
1436 * gtk_tree_view_column_pack_start:
1437 * @tree_column: A #GtkTreeViewColumn.
1438 * @cell: The #GtkCellRenderer.
1439 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1441 * Packs the @cell into the beginning of the column. If @expand is %FALSE, then
1442 * the @cell is allocated no more space than it needs. Any unused space is divided
1443 * evenly between cells for which @expand is %TRUE.
1446 gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
1447 GtkCellRenderer *cell,
1450 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (tree_column), cell, expand);
1454 * gtk_tree_view_column_pack_end:
1455 * @tree_column: A #GtkTreeViewColumn.
1456 * @cell: The #GtkCellRenderer.
1457 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1459 * Adds the @cell to end of the column. If @expand is %FALSE, then the @cell
1460 * is allocated no more space than it needs. Any unused space is divided
1461 * evenly between cells for which @expand is %TRUE.
1464 gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
1465 GtkCellRenderer *cell,
1468 gtk_cell_layout_pack_end (GTK_CELL_LAYOUT (tree_column), cell, expand);
1472 * gtk_tree_view_column_clear:
1473 * @tree_column: A #GtkTreeViewColumn
1475 * Unsets all the mappings on all renderers on the @tree_column.
1478 gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column)
1480 gtk_cell_layout_clear (GTK_CELL_LAYOUT (tree_column));
1484 * gtk_tree_view_column_add_attribute:
1485 * @tree_column: A #GtkTreeViewColumn.
1486 * @cell_renderer: the #GtkCellRenderer to set attributes on
1487 * @attribute: An attribute on the renderer
1488 * @column: The column position on the model to get the attribute from.
1490 * Adds an attribute mapping to the list in @tree_column. The @column is the
1491 * column of the model to get a value from, and the @attribute is the
1492 * parameter on @cell_renderer to be set from the value. So for example
1493 * if column 2 of the model contains strings, you could have the
1494 * "text" attribute of a #GtkCellRendererText get its values from
1498 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1499 GtkCellRenderer *cell_renderer,
1500 const gchar *attribute,
1503 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (tree_column),
1504 cell_renderer, attribute, column);
1508 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1509 GtkCellRenderer *cell_renderer,
1515 attribute = va_arg (args, gchar *);
1517 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (tree_column->cell_area),
1520 while (attribute != NULL)
1522 column = va_arg (args, gint);
1523 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (tree_column->cell_area),
1524 cell_renderer, attribute, column);
1525 attribute = va_arg (args, gchar *);
1530 * gtk_tree_view_column_set_attributes:
1531 * @tree_column: A #GtkTreeViewColumn.
1532 * @cell_renderer: the #GtkCellRenderer we're setting the attributes of
1533 * @Varargs: A %NULL-terminated list of attributes.
1535 * Sets the attributes in the list as the attributes of @tree_column.
1536 * The attributes should be in attribute/column order, as in
1537 * gtk_tree_view_column_add_attribute(). All existing attributes
1538 * are removed, and replaced with the new attributes.
1541 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1542 GtkCellRenderer *cell_renderer,
1547 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1548 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1550 va_start (args, cell_renderer);
1551 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1557 * gtk_tree_view_column_set_cell_data_func:
1558 * @tree_column: A #GtkTreeViewColumn
1559 * @cell_renderer: A #GtkCellRenderer
1560 * @func: The #GtkTreeViewColumnFunc to use.
1561 * @func_data: The user data for @func.
1562 * @destroy: The destroy notification for @func_data
1564 * Sets the #GtkTreeViewColumnFunc to use for the column. This
1565 * function is used instead of the standard attributes mapping for
1566 * setting the column value, and should set the value of @tree_column's
1567 * cell renderer as appropriate. @func may be %NULL to remove an
1571 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1572 GtkCellRenderer *cell_renderer,
1573 GtkTreeCellDataFunc func,
1575 GDestroyNotify destroy)
1577 gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT (tree_column),
1579 (GtkCellLayoutDataFunc)func,
1580 func_data, destroy);
1585 * gtk_tree_view_column_clear_attributes:
1586 * @tree_column: a #GtkTreeViewColumn
1587 * @cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1589 * Clears all existing attributes previously set with
1590 * gtk_tree_view_column_set_attributes().
1593 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1594 GtkCellRenderer *cell_renderer)
1596 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (tree_column),
1601 * gtk_tree_view_column_set_spacing:
1602 * @tree_column: A #GtkTreeViewColumn.
1603 * @spacing: distance between cell renderers in pixels.
1605 * Sets the spacing field of @tree_column, which is the number of pixels to
1606 * place between cell renderers packed into it.
1609 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1612 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1613 g_return_if_fail (spacing >= 0);
1615 gtk_cell_area_box_set_spacing (GTK_CELL_AREA_BOX (tree_column->cell_area),
1617 if (tree_column->tree_view)
1618 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1622 * gtk_tree_view_column_get_spacing:
1623 * @tree_column: A #GtkTreeViewColumn.
1625 * Returns the spacing of @tree_column.
1627 * Return value: the spacing of @tree_column.
1630 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1632 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1634 return gtk_cell_area_box_get_spacing (GTK_CELL_AREA_BOX (tree_column->cell_area));
1637 /* Options for manipulating the columns */
1640 * gtk_tree_view_column_set_visible:
1641 * @tree_column: A #GtkTreeViewColumn.
1642 * @visible: %TRUE if the @tree_column is visible.
1644 * Sets the visibility of @tree_column.
1647 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1650 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1652 visible = !! visible;
1654 if (tree_column->visible == visible)
1657 tree_column->visible = visible;
1659 if (tree_column->visible)
1660 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1662 gtk_tree_view_column_update_button (tree_column);
1663 g_object_notify (G_OBJECT (tree_column), "visible");
1667 * gtk_tree_view_column_get_visible:
1668 * @tree_column: A #GtkTreeViewColumn.
1670 * Returns %TRUE if @tree_column is visible.
1672 * Return value: whether the column is visible or not. If it is visible, then
1673 * the tree will show the column.
1676 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1678 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1680 return tree_column->visible;
1684 * gtk_tree_view_column_set_resizable:
1685 * @tree_column: A #GtkTreeViewColumn
1686 * @resizable: %TRUE, if the column can be resized
1688 * If @resizable is %TRUE, then the user can explicitly resize the column by
1689 * grabbing the outer edge of the column button. If resizable is %TRUE and
1690 * sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing
1691 * mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY.
1694 gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
1697 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1699 resizable = !! resizable;
1701 if (tree_column->resizable == resizable)
1704 tree_column->resizable = resizable;
1706 if (resizable && tree_column->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1707 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_GROW_ONLY);
1709 gtk_tree_view_column_update_button (tree_column);
1711 g_object_notify (G_OBJECT (tree_column), "resizable");
1715 * gtk_tree_view_column_get_resizable:
1716 * @tree_column: A #GtkTreeViewColumn
1718 * Returns %TRUE if the @tree_column can be resized by the end user.
1720 * Return value: %TRUE, if the @tree_column can be resized.
1723 gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column)
1725 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1727 return tree_column->resizable;
1732 * gtk_tree_view_column_set_sizing:
1733 * @tree_column: A #GtkTreeViewColumn.
1734 * @type: The #GtkTreeViewColumnSizing.
1736 * Sets the growth behavior of @tree_column to @type.
1739 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
1740 GtkTreeViewColumnSizing type)
1742 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1744 if (type == tree_column->column_type)
1747 if (type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1748 gtk_tree_view_column_set_resizable (tree_column, FALSE);
1751 /* I was clearly on crack when I wrote this. I'm not sure what's supposed to
1752 * be below so I'll leave it until I figure it out.
1754 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE &&
1755 tree_column->requested_width != -1)
1757 gtk_tree_view_column_set_sizing (tree_column, tree_column->requested_width);
1760 tree_column->column_type = type;
1762 gtk_tree_view_column_update_button (tree_column);
1764 g_object_notify (G_OBJECT (tree_column), "sizing");
1768 * gtk_tree_view_column_get_sizing:
1769 * @tree_column: A #GtkTreeViewColumn.
1771 * Returns the current type of @tree_column.
1773 * Return value: The type of @tree_column.
1775 GtkTreeViewColumnSizing
1776 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
1778 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1780 return tree_column->column_type;
1784 * gtk_tree_view_column_get_width:
1785 * @tree_column: A #GtkTreeViewColumn.
1787 * Returns the current size of @tree_column in pixels.
1789 * Return value: The current width of @tree_column.
1792 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
1794 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1796 return tree_column->width;
1800 _gtk_tree_view_column_set_width (GtkTreeViewColumn *tree_column,
1804 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1806 gtk_cell_area_context_allocate (tree_column->cell_area_context, internal_width, -1);
1807 tree_column->width = width;
1809 g_object_notify (G_OBJECT (tree_column), "width");
1813 * gtk_tree_view_column_set_fixed_width:
1814 * @tree_column: A #GtkTreeViewColumn.
1815 * @fixed_width: The size to set @tree_column to. Must be greater than 0.
1817 * Sets the size of the column in pixels. This is meaningful only if the sizing
1818 * type is #GTK_TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to
1819 * the min/max width for the column. Please note that the min/max width of the
1820 * column doesn't actually affect the "fixed_width" property of the widget, just
1821 * the actual size when displayed.
1824 gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
1827 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1828 g_return_if_fail (fixed_width > 0);
1830 tree_column->fixed_width = fixed_width;
1831 tree_column->use_resized_width = FALSE;
1833 if (tree_column->tree_view &&
1834 gtk_widget_get_realized (tree_column->tree_view) &&
1835 tree_column->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
1837 gtk_widget_queue_resize (tree_column->tree_view);
1840 g_object_notify (G_OBJECT (tree_column), "fixed-width");
1844 * gtk_tree_view_column_get_fixed_width:
1845 * @tree_column: a #GtkTreeViewColumn
1847 * Gets the fixed width of the column. This value is only meaning may not be
1848 * the actual width of the column on the screen, just what is requested.
1850 * Return value: the fixed width of the column
1853 gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
1855 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1857 return tree_column->fixed_width;
1861 * gtk_tree_view_column_set_min_width:
1862 * @tree_column: A #GtkTreeViewColumn.
1863 * @min_width: The minimum width of the column in pixels, or -1.
1865 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
1866 * minimum width is unset.
1869 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
1872 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1873 g_return_if_fail (min_width >= -1);
1875 if (min_width == tree_column->min_width)
1878 if (tree_column->visible &&
1879 tree_column->tree_view != NULL &&
1880 gtk_widget_get_realized (tree_column->tree_view))
1882 if (min_width > tree_column->width)
1883 gtk_widget_queue_resize (tree_column->tree_view);
1886 tree_column->min_width = min_width;
1887 g_object_freeze_notify (G_OBJECT (tree_column));
1888 if (tree_column->max_width != -1 && tree_column->max_width < min_width)
1890 tree_column->max_width = min_width;
1891 g_object_notify (G_OBJECT (tree_column), "max-width");
1893 g_object_notify (G_OBJECT (tree_column), "min-width");
1894 g_object_thaw_notify (G_OBJECT (tree_column));
1896 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1897 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (tree_column->tree_view),
1902 * gtk_tree_view_column_get_min_width:
1903 * @tree_column: A #GtkTreeViewColumn.
1905 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
1908 * Return value: The minimum width of the @tree_column.
1911 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
1913 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
1915 return tree_column->min_width;
1919 * gtk_tree_view_column_set_max_width:
1920 * @tree_column: A #GtkTreeViewColumn.
1921 * @max_width: The maximum width of the column in pixels, or -1.
1923 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
1924 * maximum width is unset. Note, the column can actually be wider than max
1925 * width if it's the last column in a view. In this case, the column expands to
1926 * fill any extra space.
1929 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
1932 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1933 g_return_if_fail (max_width >= -1);
1935 if (max_width == tree_column->max_width)
1938 if (tree_column->visible &&
1939 tree_column->tree_view != NULL &&
1940 gtk_widget_get_realized (tree_column->tree_view))
1942 if (max_width != -1 && max_width < tree_column->width)
1943 gtk_widget_queue_resize (tree_column->tree_view);
1946 tree_column->max_width = max_width;
1947 g_object_freeze_notify (G_OBJECT (tree_column));
1948 if (max_width != -1 && max_width < tree_column->min_width)
1950 tree_column->min_width = max_width;
1951 g_object_notify (G_OBJECT (tree_column), "min-width");
1953 g_object_notify (G_OBJECT (tree_column), "max-width");
1954 g_object_thaw_notify (G_OBJECT (tree_column));
1956 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1957 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (tree_column->tree_view),
1962 * gtk_tree_view_column_get_max_width:
1963 * @tree_column: A #GtkTreeViewColumn.
1965 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
1968 * Return value: The maximum width of the @tree_column.
1971 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
1973 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
1975 return tree_column->max_width;
1979 * gtk_tree_view_column_clicked:
1980 * @tree_column: a #GtkTreeViewColumn
1982 * Emits the "clicked" signal on the column. This function will only work if
1983 * @tree_column is clickable.
1986 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
1988 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1990 if (tree_column->visible &&
1991 tree_column->button &&
1992 tree_column->clickable)
1993 gtk_button_clicked (GTK_BUTTON (tree_column->button));
1997 * gtk_tree_view_column_set_title:
1998 * @tree_column: A #GtkTreeViewColumn.
1999 * @title: The title of the @tree_column.
2001 * Sets the title of the @tree_column. If a custom widget has been set, then
2002 * this value is ignored.
2005 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
2010 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2012 new_title = g_strdup (title);
2013 g_free (tree_column->title);
2014 tree_column->title = new_title;
2016 gtk_tree_view_column_update_button (tree_column);
2017 g_object_notify (G_OBJECT (tree_column), "title");
2021 * gtk_tree_view_column_get_title:
2022 * @tree_column: A #GtkTreeViewColumn.
2024 * Returns the title of the widget.
2026 * Return value: the title of the column. This string should not be
2027 * modified or freed.
2029 G_CONST_RETURN gchar *
2030 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
2032 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2034 return tree_column->title;
2038 * gtk_tree_view_column_set_expand:
2039 * @tree_column: A #GtkTreeViewColumn
2040 * @expand: %TRUE if the column should take available extra space, %FALSE if not
2042 * Sets the column to take available extra space. This space is shared equally
2043 * amongst all columns that have the expand set to %TRUE. If no column has this
2044 * option set, then the last column gets all extra space. By default, every
2045 * column is created with this %FALSE.
2050 gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
2053 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2055 expand = expand?TRUE:FALSE;
2056 if (tree_column->expand == expand)
2058 tree_column->expand = expand;
2060 if (tree_column->visible &&
2061 tree_column->tree_view != NULL &&
2062 gtk_widget_get_realized (tree_column->tree_view))
2064 /* We want to continue using the original width of the
2065 * column that includes additional space added by the user
2066 * resizing the columns and possibly extra (expanded) space, which
2067 * are not included in the resized width.
2069 tree_column->use_resized_width = FALSE;
2071 gtk_widget_queue_resize (tree_column->tree_view);
2074 g_object_notify (G_OBJECT (tree_column), "expand");
2078 * gtk_tree_view_column_get_expand:
2079 * @tree_column: a #GtkTreeViewColumn
2081 * Return %TRUE if the column expands to take any available space.
2083 * Return value: %TRUE, if the column expands
2088 gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column)
2090 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2092 return tree_column->expand;
2096 * gtk_tree_view_column_set_clickable:
2097 * @tree_column: A #GtkTreeViewColumn.
2098 * @clickable: %TRUE if the header is active.
2100 * Sets the header to be active if @active is %TRUE. When the header is active,
2101 * then it can take keyboard focus, and can be clicked.
2104 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
2107 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2109 clickable = !! clickable;
2110 if (tree_column->clickable == clickable)
2113 tree_column->clickable = clickable;
2114 gtk_tree_view_column_update_button (tree_column);
2115 g_object_notify (G_OBJECT (tree_column), "clickable");
2119 * gtk_tree_view_column_get_clickable:
2120 * @tree_column: a #GtkTreeViewColumn
2122 * Returns %TRUE if the user can click on the header for the column.
2124 * Return value: %TRUE if user can click the column header.
2127 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
2129 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2131 return tree_column->clickable;
2135 * gtk_tree_view_column_set_widget:
2136 * @tree_column: A #GtkTreeViewColumn.
2137 * @widget: (allow-none): A child #GtkWidget, or %NULL.
2139 * Sets the widget in the header to be @widget. If widget is %NULL, then the
2140 * header button is set with a #GtkLabel set to the title of @tree_column.
2143 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
2146 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2147 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
2150 g_object_ref_sink (widget);
2152 if (tree_column->child)
2153 g_object_unref (tree_column->child);
2155 tree_column->child = widget;
2156 gtk_tree_view_column_update_button (tree_column);
2157 g_object_notify (G_OBJECT (tree_column), "widget");
2161 * gtk_tree_view_column_get_widget:
2162 * @tree_column: A #GtkTreeViewColumn.
2164 * Returns the #GtkWidget in the button on the column header.
2165 * If a custom widget has not been set then %NULL is returned.
2167 * Return value: (transfer none): The #GtkWidget in the column
2171 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
2173 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2175 return tree_column->child;
2179 * gtk_tree_view_column_set_alignment:
2180 * @tree_column: A #GtkTreeViewColumn.
2181 * @xalign: The alignment, which is between [0.0 and 1.0] inclusive.
2183 * Sets the alignment of the title or custom widget inside the column header.
2184 * The alignment determines its location inside the button -- 0.0 for left, 0.5
2185 * for center, 1.0 for right.
2188 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
2191 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2193 xalign = CLAMP (xalign, 0.0, 1.0);
2195 if (tree_column->xalign == xalign)
2198 tree_column->xalign = xalign;
2199 gtk_tree_view_column_update_button (tree_column);
2200 g_object_notify (G_OBJECT (tree_column), "alignment");
2204 * gtk_tree_view_column_get_alignment:
2205 * @tree_column: A #GtkTreeViewColumn.
2207 * Returns the current x alignment of @tree_column. This value can range
2208 * between 0.0 and 1.0.
2210 * Return value: The current alignent of @tree_column.
2213 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
2215 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
2217 return tree_column->xalign;
2221 * gtk_tree_view_column_set_reorderable:
2222 * @tree_column: A #GtkTreeViewColumn
2223 * @reorderable: %TRUE, if the column can be reordered.
2225 * If @reorderable is %TRUE, then the column can be reordered by the end user
2226 * dragging the header.
2229 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
2230 gboolean reorderable)
2232 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2235 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
2237 if (tree_column->reorderable == (reorderable?TRUE:FALSE))
2240 tree_column->reorderable = (reorderable?TRUE:FALSE);
2241 gtk_tree_view_column_update_button (tree_column);
2242 g_object_notify (G_OBJECT (tree_column), "reorderable");
2246 * gtk_tree_view_column_get_reorderable:
2247 * @tree_column: A #GtkTreeViewColumn
2249 * Returns %TRUE if the @tree_column can be reordered by the user.
2251 * Return value: %TRUE if the @tree_column can be reordered by the user.
2254 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
2256 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2258 return tree_column->reorderable;
2263 * gtk_tree_view_column_set_sort_column_id:
2264 * @tree_column: a #GtkTreeViewColumn
2265 * @sort_column_id: The @sort_column_id of the model to sort on.
2267 * Sets the logical @sort_column_id that this column sorts on when this column
2268 * is selected for sorting. Doing so makes the column header clickable.
2271 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
2272 gint sort_column_id)
2274 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2275 g_return_if_fail (sort_column_id >= -1);
2277 if (tree_column->sort_column_id == sort_column_id)
2280 tree_column->sort_column_id = sort_column_id;
2282 /* Handle unsetting the id */
2283 if (sort_column_id == -1)
2285 GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (tree_column->tree_view));
2287 if (tree_column->sort_clicked_signal)
2289 g_signal_handler_disconnect (tree_column, tree_column->sort_clicked_signal);
2290 tree_column->sort_clicked_signal = 0;
2293 if (tree_column->sort_column_changed_signal)
2295 g_signal_handler_disconnect (model, tree_column->sort_column_changed_signal);
2296 tree_column->sort_column_changed_signal = 0;
2299 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
2300 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
2301 gtk_tree_view_column_set_clickable (tree_column, FALSE);
2302 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2306 gtk_tree_view_column_set_clickable (tree_column, TRUE);
2308 if (! tree_column->sort_clicked_signal)
2309 tree_column->sort_clicked_signal = g_signal_connect (tree_column,
2311 G_CALLBACK (gtk_tree_view_column_sort),
2314 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
2315 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2319 * gtk_tree_view_column_get_sort_column_id:
2320 * @tree_column: a #GtkTreeViewColumn
2322 * Gets the logical @sort_column_id that the model sorts on when this
2323 * column is selected for sorting.
2324 * See gtk_tree_view_column_set_sort_column_id().
2326 * Return value: the current @sort_column_id for this column, or -1 if
2327 * this column can't be used for sorting.
2330 gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column)
2332 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2334 return tree_column->sort_column_id;
2338 * gtk_tree_view_column_set_sort_indicator:
2339 * @tree_column: a #GtkTreeViewColumn
2340 * @setting: %TRUE to display an indicator that the column is sorted
2342 * Call this function with a @setting of %TRUE to display an arrow in
2343 * the header button indicating the column is sorted. Call
2344 * gtk_tree_view_column_set_sort_order() to change the direction of
2349 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
2352 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2354 setting = setting != FALSE;
2356 if (setting == tree_column->show_sort_indicator)
2359 tree_column->show_sort_indicator = setting;
2360 gtk_tree_view_column_update_button (tree_column);
2361 g_object_notify (G_OBJECT (tree_column), "sort-indicator");
2365 * gtk_tree_view_column_get_sort_indicator:
2366 * @tree_column: a #GtkTreeViewColumn
2368 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
2370 * Return value: whether the sort indicator arrow is displayed
2373 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
2375 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2377 return tree_column->show_sort_indicator;
2381 * gtk_tree_view_column_set_sort_order:
2382 * @tree_column: a #GtkTreeViewColumn
2383 * @order: sort order that the sort indicator should indicate
2385 * Changes the appearance of the sort indicator.
2387 * This <emphasis>does not</emphasis> actually sort the model. Use
2388 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
2389 * support. This function is primarily for custom sorting behavior, and should
2390 * be used in conjunction with gtk_tree_sortable_set_sort_column() to do
2391 * that. For custom models, the mechanism will vary.
2393 * The sort indicator changes direction to indicate normal sort or reverse sort.
2394 * Note that you must have the sort indicator enabled to see anything when
2395 * calling this function; see gtk_tree_view_column_set_sort_indicator().
2398 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
2401 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2403 if (order == tree_column->sort_order)
2406 tree_column->sort_order = order;
2407 gtk_tree_view_column_update_button (tree_column);
2408 g_object_notify (G_OBJECT (tree_column), "sort-order");
2412 * gtk_tree_view_column_get_sort_order:
2413 * @tree_column: a #GtkTreeViewColumn
2415 * Gets the value set by gtk_tree_view_column_set_sort_order().
2417 * Return value: the sort order the sort indicator is indicating
2420 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2422 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2424 return tree_column->sort_order;
2428 * gtk_tree_view_column_cell_set_cell_data:
2429 * @tree_column: A #GtkTreeViewColumn.
2430 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2431 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2432 * @is_expander: %TRUE, if the row has children
2433 * @is_expanded: %TRUE, if the row has visible children
2435 * Sets the cell renderer based on the @tree_model and @iter. That is, for
2436 * every attribute mapping in @tree_column, it will get a value from the set
2437 * column on the @iter, and use that value to set the attribute on the cell
2438 * renderer. This is used primarily by the #GtkTreeView.
2441 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2442 GtkTreeModel *tree_model,
2444 gboolean is_expander,
2445 gboolean is_expanded)
2447 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2449 if (tree_model == NULL)
2452 gtk_cell_area_apply_attributes (tree_column->cell_area, tree_model, iter,
2453 is_expander, is_expanded);
2457 * gtk_tree_view_column_cell_get_size:
2458 * @tree_column: A #GtkTreeViewColumn.
2459 * @cell_area: (allow-none): The area a cell in the column will be allocated, or %NULL
2460 * @x_offset: (allow-none): location to return x offset of a cell relative to @cell_area, or %NULL
2461 * @y_offset: (allow-none): location to return y offset of a cell relative to @cell_area, or %NULL
2462 * @width: (allow-none): location to return width needed to render a cell, or %NULL
2463 * @height: (allow-none): location to return height needed to render a cell, or %NULL
2465 * Obtains the width and height needed to render the column. This is used
2466 * primarily by the #GtkTreeView.
2469 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2470 const GdkRectangle *cell_area,
2476 gint min_width = 0, min_height = 0;
2478 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2480 g_signal_handler_block (tree_column->cell_area_context,
2481 tree_column->context_changed_signal);
2483 gtk_cell_area_get_preferred_width (tree_column->cell_area,
2484 tree_column->cell_area_context,
2485 tree_column->tree_view,
2488 gtk_cell_area_context_get_preferred_width (tree_column->cell_area_context, &min_width, NULL);
2490 gtk_cell_area_get_preferred_height_for_width (tree_column->cell_area,
2491 tree_column->cell_area_context,
2492 tree_column->tree_view,
2497 g_signal_handler_unblock (tree_column->cell_area_context,
2498 tree_column->context_changed_signal);
2502 * height = min_height;
2504 * width = min_width;
2509 * gtk_tree_view_column_cell_render:
2510 * @tree_column: A #GtkTreeViewColumn.
2511 * @cr: cairo context to draw to
2512 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2513 * @cell_area: area normally rendered by a cell renderer
2514 * @flags: flags that affect rendering
2516 * Renders the cell contained by #tree_column. This is used primarily by the
2520 _gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2522 const GdkRectangle *background_area,
2523 const GdkRectangle *cell_area,
2525 gboolean draw_focus)
2527 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2528 g_return_if_fail (cr != NULL);
2529 g_return_if_fail (background_area != NULL);
2530 g_return_if_fail (cell_area != NULL);
2534 gtk_cell_area_render (tree_column->cell_area, tree_column->cell_area_context,
2535 tree_column->tree_view, cr,
2536 background_area, cell_area, flags,
2543 _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2544 GtkCellEditable **editable_widget,
2547 const GdkRectangle *background_area,
2548 const GdkRectangle *cell_area,
2551 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2553 /* FIXME: Should we pass background area here as well?
2554 * What will happen to the path_string and editable widget
2557 return gtk_cell_area_event (tree_column->cell_area,
2558 tree_column->cell_area_context,
2559 tree_column->tree_view,
2566 _gtk_tree_view_column_get_focus_area (GtkTreeViewColumn *tree_column,
2567 const GdkRectangle *background_area,
2568 const GdkRectangle *cell_area,
2569 GdkRectangle *focus_area)
2573 gtk_tree_view_column_cell_process_action (tree_column,
2586 _gtk_tree_view_column_cell_focus (GtkTreeViewColumn *tree_column,
2592 GtkDirectionType direction = 0;
2594 rtl = gtk_widget_get_direction (GTK_WIDGET (tree_column->tree_view)) == GTK_TEXT_DIR_RTL;
2599 direction = GTK_DIR_LEFT;
2603 direction = GTK_DIR_RIGHT;
2607 /* if we are the current focus column and have multiple editable cells,
2608 * try to select the next one, else move the focus to the next column
2610 if (GTK_TREE_VIEW (tree_column->tree_view)->priv->focus_column == tree_column)
2612 if (gtk_cell_area_focus (tree_column->cell_area, direction))
2613 /* Focus stays in this column, so we are done */
2616 /* FIXME: RTL support for the following: */
2617 if (count == -1 && !left)
2619 direction = GTK_DIR_RIGHT;
2620 gtk_cell_area_focus (tree_column->cell_area, direction);
2622 else if (count == 1 && !right)
2624 direction = GTK_DIR_LEFT;
2625 gtk_cell_area_focus (tree_column->cell_area, direction);
2631 return gtk_cell_area_focus (tree_column->cell_area, direction);
2635 * gtk_tree_view_column_cell_is_visible:
2636 * @tree_column: A #GtkTreeViewColumn
2638 * Returns %TRUE if any of the cells packed into the @tree_column are visible.
2639 * For this to be meaningful, you must first initialize the cells with
2640 * gtk_tree_view_column_cell_set_cell_data()
2642 * Return value: %TRUE, if any of the cells packed into the @tree_column are currently visible
2645 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
2650 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2652 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (tree_column->cell_area));
2653 for (list = cells; list; list = list->next)
2655 if (gtk_cell_renderer_get_visible (list->data))
2657 g_list_free (cells);
2662 g_list_free (cells);
2668 * gtk_tree_view_column_focus_cell:
2669 * @tree_column: A #GtkTreeViewColumn
2670 * @cell: A #GtkCellRenderer
2672 * Sets the current keyboard focus to be at @cell, if the column contains
2673 * 2 or more editable and activatable cells.
2678 gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
2679 GtkCellRenderer *cell)
2681 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2682 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
2684 gtk_cell_area_set_focus_cell (tree_column->cell_area, cell);
2688 _gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column,
2689 gboolean install_handler)
2691 tree_column->dirty = TRUE;
2692 tree_column->requested_width = -1;
2693 tree_column->width = 0;
2695 if (tree_column->tree_view &&
2696 gtk_widget_get_realized (tree_column->tree_view))
2698 if (install_handler)
2699 _gtk_tree_view_install_mark_rows_col_dirty (GTK_TREE_VIEW (tree_column->tree_view));
2701 GTK_TREE_VIEW (tree_column->tree_view)->priv->mark_rows_col_dirty = TRUE;
2702 gtk_widget_queue_resize (tree_column->tree_view);
2707 * gtk_tree_view_column_cell_get_position:
2708 * @tree_column: a #GtkTreeViewColumn
2709 * @cell_renderer: a #GtkCellRenderer
2710 * @start_pos: return location for the horizontal position of @cell within
2711 * @tree_column, may be %NULL
2712 * @width: return location for the width of @cell, may be %NULL
2714 * Obtains the horizontal position and size of a cell in a column. If the
2715 * cell is not found in the column, @start_pos and @width are not changed and
2716 * %FALSE is returned.
2718 * Return value: %TRUE if @cell belongs to @tree_column.
2721 gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
2722 GtkCellRenderer *cell_renderer,
2726 GdkRectangle zero_cell_area = { 0, };
2727 GdkRectangle allocation;
2729 /* FIXME: Could use a boolean return value for invalid cells */
2730 gtk_cell_area_get_cell_allocation (tree_column->cell_area,
2731 tree_column->cell_area_context,
2732 tree_column->tree_view,
2738 *start_pos = allocation.x;
2740 *width = allocation.width;
2746 * gtk_tree_view_column_queue_resize:
2747 * @tree_column: A #GtkTreeViewColumn
2749 * Flags the column, and the cell renderers added to this column, to have
2750 * their sizes renegotiated.
2755 gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column)
2757 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2759 if (tree_column->tree_view)
2760 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
2764 * gtk_tree_view_column_get_tree_view:
2765 * @tree_column: A #GtkTreeViewColumn
2767 * Returns the #GtkTreeView wherein @tree_column has been inserted.
2768 * If @column is currently not inserted in any tree view, %NULL is
2771 * Return value: (transfer none): The tree view wherein @column has
2772 * been inserted if any, %NULL otherwise.
2777 gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column)
2779 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2781 return tree_column->tree_view;