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
60 static void gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface);
63 static void gtk_tree_view_column_set_property (GObject *object,
67 static void gtk_tree_view_column_get_property (GObject *object,
71 static void gtk_tree_view_column_finalize (GObject *object);
72 static void gtk_tree_view_column_dispose (GObject *object);
73 static GObject *gtk_tree_view_column_constructor (GType type,
74 guint n_construct_properties,
75 GObjectConstructParam *construct_properties);
77 /* GtkCellLayout implementation */
78 static GtkCellArea *gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout);
80 /* Button handling code */
81 static void gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column);
82 static void gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column);
84 /* Button signal handlers */
85 static gint gtk_tree_view_column_button_event (GtkWidget *widget,
88 static void gtk_tree_view_column_button_clicked (GtkWidget *widget,
90 static gboolean gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
91 gboolean group_cycling,
94 /* Property handlers */
95 static void gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
96 GtkTreeViewColumn *tree_column);
98 /* GtkCellArea/GtkCellAreaContext callbacks */
99 static void gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
101 GtkTreeViewColumn *tree_column);
102 static void gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
103 GtkCellRenderer *renderer,
104 GtkCellEditable *edit_widget,
105 GdkRectangle *cell_area,
106 const gchar *path_string,
108 static void gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
109 GtkCellRenderer *renderer,
110 GtkCellEditable *edit_widget,
113 /* Internal functions */
114 static void gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
116 static void gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column);
117 static void gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
118 GtkCellRenderer *cell_renderer,
121 /* GtkBuildable implementation */
122 static void gtk_tree_view_column_buildable_init (GtkBuildableIface *iface);
125 struct _GtkTreeViewColumnPrivate
127 GtkWidget *tree_view;
131 GtkWidget *alignment;
134 gulong property_changed_signal;
137 /* see gtk+/doc/tree-column-sizing.txt for more information on them */
138 GtkTreeViewColumnSizing column_type;
146 /* dragging columns */
153 gulong sort_clicked_signal;
154 gulong sort_column_changed_signal;
156 GtkSortType sort_order;
159 GtkCellArea *cell_area;
160 GtkCellAreaContext *cell_area_context;
161 gulong add_editable_signal;
162 gulong remove_editable_signal;
163 gulong context_changed_signal;
170 guint show_sort_indicator : 1;
171 guint maybe_reordered : 1;
172 guint reorderable : 1;
173 guint use_resized_width : 1;
175 guint resetting_context : 1;
207 static guint tree_column_signals[LAST_SIGNAL] = { 0 };
209 G_DEFINE_TYPE_WITH_CODE (GtkTreeViewColumn, gtk_tree_view_column, G_TYPE_INITIALLY_UNOWNED,
210 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
211 gtk_tree_view_column_cell_layout_init)
212 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
213 gtk_tree_view_column_buildable_init))
217 gtk_tree_view_column_class_init (GtkTreeViewColumnClass *class)
219 GObjectClass *object_class;
221 object_class = (GObjectClass*) class;
223 class->clicked = NULL;
225 object_class->constructor = gtk_tree_view_column_constructor;
226 object_class->finalize = gtk_tree_view_column_finalize;
227 object_class->dispose = gtk_tree_view_column_dispose;
228 object_class->set_property = gtk_tree_view_column_set_property;
229 object_class->get_property = gtk_tree_view_column_get_property;
231 tree_column_signals[CLICKED] =
232 g_signal_new (I_("clicked"),
233 G_OBJECT_CLASS_TYPE (object_class),
235 G_STRUCT_OFFSET (GtkTreeViewColumnClass, clicked),
237 _gtk_marshal_VOID__VOID,
240 g_object_class_install_property (object_class,
242 g_param_spec_boolean ("visible",
244 P_("Whether to display the column"),
246 GTK_PARAM_READWRITE));
248 g_object_class_install_property (object_class,
250 g_param_spec_boolean ("resizable",
252 P_("Column is user-resizable"),
254 GTK_PARAM_READWRITE));
256 g_object_class_install_property (object_class,
258 g_param_spec_int ("width",
260 P_("Current width of the column"),
264 GTK_PARAM_READABLE));
265 g_object_class_install_property (object_class,
267 g_param_spec_int ("spacing",
269 P_("Space which is inserted between cells"),
273 GTK_PARAM_READWRITE));
274 g_object_class_install_property (object_class,
276 g_param_spec_enum ("sizing",
278 P_("Resize mode of the column"),
279 GTK_TYPE_TREE_VIEW_COLUMN_SIZING,
280 GTK_TREE_VIEW_COLUMN_GROW_ONLY,
281 GTK_PARAM_READWRITE));
283 g_object_class_install_property (object_class,
285 g_param_spec_int ("fixed-width",
287 P_("Current fixed width of the column"),
291 GTK_PARAM_READWRITE));
293 g_object_class_install_property (object_class,
295 g_param_spec_int ("min-width",
297 P_("Minimum allowed width of the column"),
301 GTK_PARAM_READWRITE));
303 g_object_class_install_property (object_class,
305 g_param_spec_int ("max-width",
307 P_("Maximum allowed width of the column"),
311 GTK_PARAM_READWRITE));
313 g_object_class_install_property (object_class,
315 g_param_spec_string ("title",
317 P_("Title to appear in column header"),
319 GTK_PARAM_READWRITE));
321 g_object_class_install_property (object_class,
323 g_param_spec_boolean ("expand",
325 P_("Column gets share of extra width allocated to the widget"),
327 GTK_PARAM_READWRITE));
329 g_object_class_install_property (object_class,
331 g_param_spec_boolean ("clickable",
333 P_("Whether the header can be clicked"),
335 GTK_PARAM_READWRITE));
338 g_object_class_install_property (object_class,
340 g_param_spec_object ("widget",
342 P_("Widget to put in column header button instead of column title"),
344 GTK_PARAM_READWRITE));
346 g_object_class_install_property (object_class,
348 g_param_spec_float ("alignment",
350 P_("X Alignment of the column header text or widget"),
354 GTK_PARAM_READWRITE));
356 g_object_class_install_property (object_class,
358 g_param_spec_boolean ("reorderable",
360 P_("Whether the column can be reordered around the headers"),
362 GTK_PARAM_READWRITE));
364 g_object_class_install_property (object_class,
366 g_param_spec_boolean ("sort-indicator",
367 P_("Sort indicator"),
368 P_("Whether to show a sort indicator"),
370 GTK_PARAM_READWRITE));
372 g_object_class_install_property (object_class,
374 g_param_spec_enum ("sort-order",
376 P_("Sort direction the sort indicator should indicate"),
379 GTK_PARAM_READWRITE));
382 * GtkTreeViewColumn:sort-column-id:
384 * Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header
385 * clickable. Set to %-1 to make the column unsortable.
389 g_object_class_install_property (object_class,
391 g_param_spec_int ("sort-column-id",
392 P_("Sort column ID"),
393 P_("Logical sort column ID this column sorts on when selected for sorting"),
397 GTK_PARAM_READWRITE));
400 * GtkTreeViewColumn:cell-area:
402 * The #GtkCellArea used to layout cell renderers for this column.
406 g_object_class_install_property (object_class,
408 g_param_spec_object ("cell-area",
410 P_("The GtkCellArea used to layout cells"),
412 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
414 g_type_class_add_private (class, sizeof (GtkTreeViewColumnPrivate));
418 gtk_tree_view_column_custom_tag_end (GtkBuildable *buildable,
421 const gchar *tagname,
424 /* Just ignore the boolean return from here */
425 _gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname, data);
429 gtk_tree_view_column_buildable_init (GtkBuildableIface *iface)
431 iface->add_child = _gtk_cell_layout_buildable_add_child;
432 iface->custom_tag_start = _gtk_cell_layout_buildable_custom_tag_start;
433 iface->custom_tag_end = gtk_tree_view_column_custom_tag_end;
437 gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface)
439 iface->get_area = gtk_tree_view_column_cell_layout_get_area;
443 gtk_tree_view_column_init (GtkTreeViewColumn *tree_column)
445 GtkTreeViewColumnPrivate *priv;
447 tree_column->priv = G_TYPE_INSTANCE_GET_PRIVATE (tree_column,
448 GTK_TYPE_TREE_VIEW_COLUMN,
449 GtkTreeViewColumnPrivate);
450 priv = tree_column->priv;
456 priv->min_width = -1;
457 priv->max_width = -1;
458 priv->resized_width = 0;
459 priv->column_type = GTK_TREE_VIEW_COLUMN_GROW_ONLY;
460 priv->visible = TRUE;
461 priv->resizable = FALSE;
462 priv->expand = FALSE;
463 priv->clickable = FALSE;
465 priv->sort_order = GTK_SORT_ASCENDING;
466 priv->show_sort_indicator = FALSE;
467 priv->property_changed_signal = 0;
468 priv->sort_clicked_signal = 0;
469 priv->sort_column_changed_signal = 0;
470 priv->sort_column_id = -1;
471 priv->reorderable = FALSE;
472 priv->maybe_reordered = FALSE;
473 priv->fixed_width = 1;
474 priv->use_resized_width = FALSE;
475 priv->title = g_strdup ("");
479 gtk_tree_view_column_constructor (GType type,
480 guint n_construct_properties,
481 GObjectConstructParam *construct_properties)
483 GtkTreeViewColumn *tree_column;
484 GtkTreeViewColumnPrivate *priv;
487 object = G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->constructor
488 (type, n_construct_properties, construct_properties);
490 tree_column = (GtkTreeViewColumn *) object;
491 priv = tree_column->priv;
493 if (!priv->cell_area)
495 priv->cell_area = gtk_cell_area_box_new ();
496 g_object_ref_sink (priv->cell_area);
499 gtk_cell_area_set_style_detail (priv->cell_area, "treeview");
501 priv->add_editable_signal =
502 g_signal_connect (priv->cell_area, "add-editable",
503 G_CALLBACK (gtk_tree_view_column_add_editable_callback),
505 priv->remove_editable_signal =
506 g_signal_connect (priv->cell_area, "remove-editable",
507 G_CALLBACK (gtk_tree_view_column_remove_editable_callback),
510 priv->cell_area_context = gtk_cell_area_create_context (priv->cell_area);
512 priv->context_changed_signal =
513 g_signal_connect (priv->cell_area_context, "notify",
514 G_CALLBACK (gtk_tree_view_column_context_changed), tree_column);
520 gtk_tree_view_column_dispose (GObject *object)
522 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
523 GtkTreeViewColumnPrivate *priv = tree_column->priv;
525 if (priv->cell_area_context)
527 g_signal_handler_disconnect (priv->cell_area_context,
528 priv->context_changed_signal);
530 g_object_unref (priv->cell_area_context);
532 priv->cell_area_context = NULL;
533 priv->context_changed_signal = 0;
538 g_signal_handler_disconnect (priv->cell_area,
539 priv->add_editable_signal);
540 g_signal_handler_disconnect (priv->cell_area,
541 priv->remove_editable_signal);
543 g_object_unref (priv->cell_area);
544 priv->cell_area = NULL;
545 priv->add_editable_signal = 0;
546 priv->remove_editable_signal = 0;
551 g_object_unref (priv->child);
555 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->dispose (object);
559 gtk_tree_view_column_finalize (GObject *object)
561 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
562 GtkTreeViewColumnPrivate *priv = tree_column->priv;
564 g_free (priv->title);
566 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->finalize (object);
570 gtk_tree_view_column_set_property (GObject *object,
575 GtkTreeViewColumn *tree_column;
578 tree_column = GTK_TREE_VIEW_COLUMN (object);
583 gtk_tree_view_column_set_visible (tree_column,
584 g_value_get_boolean (value));
588 gtk_tree_view_column_set_resizable (tree_column,
589 g_value_get_boolean (value));
593 gtk_tree_view_column_set_sizing (tree_column,
594 g_value_get_enum (value));
597 case PROP_FIXED_WIDTH:
598 gtk_tree_view_column_set_fixed_width (tree_column,
599 g_value_get_int (value));
603 gtk_tree_view_column_set_min_width (tree_column,
604 g_value_get_int (value));
608 gtk_tree_view_column_set_max_width (tree_column,
609 g_value_get_int (value));
613 gtk_tree_view_column_set_spacing (tree_column,
614 g_value_get_int (value));
618 gtk_tree_view_column_set_title (tree_column,
619 g_value_get_string (value));
623 gtk_tree_view_column_set_expand (tree_column,
624 g_value_get_boolean (value));
628 gtk_tree_view_column_set_clickable (tree_column,
629 g_value_get_boolean (value));
633 gtk_tree_view_column_set_widget (tree_column,
634 (GtkWidget*) g_value_get_object (value));
638 gtk_tree_view_column_set_alignment (tree_column,
639 g_value_get_float (value));
642 case PROP_REORDERABLE:
643 gtk_tree_view_column_set_reorderable (tree_column,
644 g_value_get_boolean (value));
647 case PROP_SORT_INDICATOR:
648 gtk_tree_view_column_set_sort_indicator (tree_column,
649 g_value_get_boolean (value));
652 case PROP_SORT_ORDER:
653 gtk_tree_view_column_set_sort_order (tree_column,
654 g_value_get_enum (value));
657 case PROP_SORT_COLUMN_ID:
658 gtk_tree_view_column_set_sort_column_id (tree_column,
659 g_value_get_int (value));
663 /* Construct-only, can only be assigned once */
664 area = g_value_get_object (value);
667 tree_column->priv->cell_area = g_object_ref_sink (area);
671 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
677 gtk_tree_view_column_get_property (GObject *object,
682 GtkTreeViewColumn *tree_column;
684 tree_column = GTK_TREE_VIEW_COLUMN (object);
689 g_value_set_boolean (value,
690 gtk_tree_view_column_get_visible (tree_column));
694 g_value_set_boolean (value,
695 gtk_tree_view_column_get_resizable (tree_column));
699 g_value_set_int (value,
700 gtk_tree_view_column_get_width (tree_column));
704 g_value_set_int (value,
705 gtk_tree_view_column_get_spacing (tree_column));
709 g_value_set_enum (value,
710 gtk_tree_view_column_get_sizing (tree_column));
713 case PROP_FIXED_WIDTH:
714 g_value_set_int (value,
715 gtk_tree_view_column_get_fixed_width (tree_column));
719 g_value_set_int (value,
720 gtk_tree_view_column_get_min_width (tree_column));
724 g_value_set_int (value,
725 gtk_tree_view_column_get_max_width (tree_column));
729 g_value_set_string (value,
730 gtk_tree_view_column_get_title (tree_column));
734 g_value_set_boolean (value,
735 gtk_tree_view_column_get_expand (tree_column));
739 g_value_set_boolean (value,
740 gtk_tree_view_column_get_clickable (tree_column));
744 g_value_set_object (value,
745 (GObject*) gtk_tree_view_column_get_widget (tree_column));
749 g_value_set_float (value,
750 gtk_tree_view_column_get_alignment (tree_column));
753 case PROP_REORDERABLE:
754 g_value_set_boolean (value,
755 gtk_tree_view_column_get_reorderable (tree_column));
758 case PROP_SORT_INDICATOR:
759 g_value_set_boolean (value,
760 gtk_tree_view_column_get_sort_indicator (tree_column));
763 case PROP_SORT_ORDER:
764 g_value_set_enum (value,
765 gtk_tree_view_column_get_sort_order (tree_column));
768 case PROP_SORT_COLUMN_ID:
769 g_value_set_int (value,
770 gtk_tree_view_column_get_sort_column_id (tree_column));
774 g_value_set_object (value, tree_column->priv->cell_area);
778 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
783 /* Implementation of GtkCellLayout interface
786 gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout)
788 GtkTreeViewColumn *column = GTK_TREE_VIEW_COLUMN (cell_layout);
789 GtkTreeViewColumnPrivate *priv = column->priv;
791 return priv->cell_area;
794 /* Button handling code
797 gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column)
799 GtkTreeViewColumnPrivate *priv = tree_column->priv;
800 GtkTreeView *tree_view;
804 tree_view = (GtkTreeView *) priv->tree_view;
806 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
807 g_return_if_fail (priv->button == NULL);
809 gtk_widget_push_composite_child ();
810 priv->button = gtk_button_new ();
811 gtk_widget_add_events (priv->button, GDK_POINTER_MOTION_MASK);
812 gtk_widget_pop_composite_child ();
814 /* make sure we own a reference to it as well. */
815 if (_gtk_tree_view_get_header_window (tree_view))
816 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
818 gtk_widget_set_parent (priv->button, GTK_WIDGET (tree_view));
820 g_signal_connect (priv->button, "event",
821 G_CALLBACK (gtk_tree_view_column_button_event),
823 g_signal_connect (priv->button, "clicked",
824 G_CALLBACK (gtk_tree_view_column_button_clicked),
827 priv->alignment = gtk_alignment_new (priv->xalign, 0.5, 0.0, 0.0);
829 hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 2);
830 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_IN);
836 child = gtk_label_new (priv->title);
837 gtk_widget_show (child);
840 g_signal_connect (child, "mnemonic-activate",
841 G_CALLBACK (gtk_tree_view_column_mnemonic_activate),
844 if (priv->xalign <= 0.5)
845 gtk_box_pack_end (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
847 gtk_box_pack_start (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
849 gtk_box_pack_start (GTK_BOX (hbox), priv->alignment, TRUE, TRUE, 0);
851 gtk_container_add (GTK_CONTAINER (priv->alignment), child);
852 gtk_container_add (GTK_CONTAINER (priv->button), hbox);
854 gtk_widget_show (hbox);
855 gtk_widget_show (priv->alignment);
856 gtk_tree_view_column_update_button (tree_column);
860 gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column)
862 GtkTreeViewColumnPrivate *priv = tree_column->priv;
863 gint sort_column_id = -1;
865 GtkWidget *alignment;
867 GtkWidget *current_child;
868 GtkArrowType arrow_type = GTK_ARROW_NONE;
872 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
876 /* Create a button if necessary */
878 priv->button == NULL &&
880 gtk_widget_get_realized (priv->tree_view))
881 gtk_tree_view_column_create_button (tree_column);
886 hbox = gtk_bin_get_child (GTK_BIN (priv->button));
887 alignment = priv->alignment;
889 current_child = gtk_bin_get_child (GTK_BIN (alignment));
891 /* Set up the actual button */
892 gtk_alignment_set (GTK_ALIGNMENT (alignment), priv->xalign,
897 if (current_child != priv->child)
899 gtk_container_remove (GTK_CONTAINER (alignment),
901 gtk_container_add (GTK_CONTAINER (alignment),
907 if (current_child == NULL)
909 current_child = gtk_label_new (NULL);
910 gtk_widget_show (current_child);
911 gtk_container_add (GTK_CONTAINER (alignment),
915 g_return_if_fail (GTK_IS_LABEL (current_child));
918 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
921 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
925 if (GTK_IS_TREE_SORTABLE (model))
926 gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
930 if (priv->show_sort_indicator)
932 gboolean alternative;
934 g_object_get (gtk_widget_get_settings (priv->tree_view),
935 "gtk-alternative-sort-arrows", &alternative,
938 switch (priv->sort_order)
940 case GTK_SORT_ASCENDING:
941 arrow_type = alternative ? GTK_ARROW_UP : GTK_ARROW_DOWN;
944 case GTK_SORT_DESCENDING:
945 arrow_type = alternative ? GTK_ARROW_DOWN : GTK_ARROW_UP;
949 g_warning (G_STRLOC": bad sort order");
954 gtk_arrow_set (GTK_ARROW (arrow),
958 /* Put arrow on the right if the text is left-or-center justified, and on the
959 * left otherwise; do this by packing boxes, so flipping text direction will
962 g_object_ref (arrow);
963 gtk_container_remove (GTK_CONTAINER (hbox), arrow);
965 if (priv->xalign <= 0.5)
967 gtk_box_pack_end (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
971 gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
972 /* move it to the front */
973 gtk_box_reorder_child (GTK_BOX (hbox), arrow, 0);
975 g_object_unref (arrow);
977 if (priv->show_sort_indicator
978 || (GTK_IS_TREE_SORTABLE (model) && priv->sort_column_id >= 0))
979 gtk_widget_show (arrow);
981 gtk_widget_hide (arrow);
983 /* It's always safe to hide the button. It isn't always safe to show it, as
984 * if you show it before it's realized, it'll get the wrong window. */
986 priv->tree_view != NULL &&
987 gtk_widget_get_realized (priv->tree_view))
991 gtk_widget_show_now (priv->button);
996 gdk_window_show (priv->window);
997 gdk_window_raise (priv->window);
1001 gdk_window_hide (priv->window);
1007 gtk_widget_hide (priv->button);
1009 gdk_window_hide (priv->window);
1013 if (priv->reorderable || priv->clickable)
1015 gtk_widget_set_can_focus (priv->button, TRUE);
1019 gtk_widget_set_can_focus (priv->button, FALSE);
1020 if (gtk_widget_has_focus (priv->button))
1022 GtkWidget *toplevel = gtk_widget_get_toplevel (priv->tree_view);
1023 if (gtk_widget_is_toplevel (toplevel))
1025 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1029 /* Queue a resize on the assumption that we always want to catch all changes
1030 * and columns don't change all that often.
1032 if (gtk_widget_get_realized (priv->tree_view))
1033 gtk_widget_queue_resize (priv->tree_view);
1037 /* Button signal handlers
1041 gtk_tree_view_column_button_event (GtkWidget *widget,
1045 GtkTreeViewColumn *column = (GtkTreeViewColumn *) data;
1046 GtkTreeViewColumnPrivate *priv = column->priv;
1048 g_return_val_if_fail (event != NULL, FALSE);
1050 if (event->type == GDK_BUTTON_PRESS &&
1051 priv->reorderable &&
1052 ((GdkEventButton *)event)->button == 1)
1054 priv->maybe_reordered = TRUE;
1055 gdk_window_get_pointer (gtk_button_get_event_window (GTK_BUTTON (widget)),
1059 gtk_widget_grab_focus (widget);
1062 if (event->type == GDK_BUTTON_RELEASE ||
1063 event->type == GDK_LEAVE_NOTIFY)
1064 priv->maybe_reordered = FALSE;
1066 if (event->type == GDK_MOTION_NOTIFY &&
1067 priv->maybe_reordered &&
1068 (gtk_drag_check_threshold (widget,
1071 (gint) ((GdkEventMotion *)event)->x,
1072 (gint) ((GdkEventMotion *)event)->y)))
1074 priv->maybe_reordered = FALSE;
1075 _gtk_tree_view_column_start_drag (GTK_TREE_VIEW (priv->tree_view), column,
1076 event->motion.device);
1080 if (priv->clickable == FALSE)
1082 switch (event->type)
1084 case GDK_BUTTON_PRESS:
1085 case GDK_2BUTTON_PRESS:
1086 case GDK_3BUTTON_PRESS:
1087 case GDK_MOTION_NOTIFY:
1088 case GDK_BUTTON_RELEASE:
1089 case GDK_ENTER_NOTIFY:
1090 case GDK_LEAVE_NOTIFY:
1101 gtk_tree_view_column_button_clicked (GtkWidget *widget, gpointer data)
1103 g_signal_emit_by_name (data, "clicked");
1107 gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
1108 gboolean group_cycling,
1111 GtkTreeViewColumn *column = (GtkTreeViewColumn *)data;
1112 GtkTreeViewColumnPrivate *priv = column->priv;
1114 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (column), FALSE);
1116 _gtk_tree_view_set_focus_column (GTK_TREE_VIEW (priv->tree_view), column);
1118 if (priv->clickable)
1119 gtk_button_clicked (GTK_BUTTON (priv->button));
1120 else if (gtk_widget_get_can_focus (priv->button))
1121 gtk_widget_grab_focus (priv->button);
1123 gtk_widget_grab_focus (priv->tree_view);
1129 gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
1130 GtkTreeViewColumn *column)
1132 GtkTreeViewColumnPrivate *priv = column->priv;
1133 gint sort_column_id;
1136 if (gtk_tree_sortable_get_sort_column_id (sortable,
1140 if (sort_column_id == priv->sort_column_id)
1142 gtk_tree_view_column_set_sort_indicator (column, TRUE);
1143 gtk_tree_view_column_set_sort_order (column, order);
1147 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1152 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1157 gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
1160 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1161 GtkTreeModel *model;
1162 GtkTreeSortable *sortable;
1163 gint sort_column_id;
1165 gboolean has_sort_column;
1166 gboolean has_default_sort_func;
1168 g_return_if_fail (priv->tree_view != NULL);
1170 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1171 sortable = GTK_TREE_SORTABLE (model);
1174 gtk_tree_sortable_get_sort_column_id (sortable,
1177 has_default_sort_func =
1178 gtk_tree_sortable_has_default_sort_func (sortable);
1180 if (has_sort_column &&
1181 sort_column_id == priv->sort_column_id)
1183 if (order == GTK_SORT_ASCENDING)
1184 gtk_tree_sortable_set_sort_column_id (sortable,
1185 priv->sort_column_id,
1186 GTK_SORT_DESCENDING);
1187 else if (order == GTK_SORT_DESCENDING && has_default_sort_func)
1188 gtk_tree_sortable_set_sort_column_id (sortable,
1189 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID,
1190 GTK_SORT_ASCENDING);
1192 gtk_tree_sortable_set_sort_column_id (sortable,
1193 priv->sort_column_id,
1194 GTK_SORT_ASCENDING);
1198 gtk_tree_sortable_set_sort_column_id (sortable,
1199 priv->sort_column_id,
1200 GTK_SORT_ASCENDING);
1205 gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column)
1207 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1208 GtkTreeModel *model;
1210 if (priv->tree_view == NULL)
1213 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1218 if (GTK_IS_TREE_SORTABLE (model) &&
1219 priv->sort_column_id != -1)
1221 gint real_sort_column_id;
1222 GtkSortType real_order;
1224 if (priv->sort_column_changed_signal == 0)
1225 priv->sort_column_changed_signal =
1226 g_signal_connect (model, "sort-column-changed",
1227 G_CALLBACK (gtk_tree_view_model_sort_column_changed),
1230 if (gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
1231 &real_sort_column_id,
1233 (real_sort_column_id == priv->sort_column_id))
1235 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
1236 gtk_tree_view_column_set_sort_order (tree_column, real_order);
1240 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
1246 gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
1248 GtkTreeViewColumn *tree_column)
1250 /* Here we want the column re-requested if the underlying context was
1251 * actually reset for any reason, this can happen if the underlying
1252 * area/cell configuration changes (i.e. cell packing properties
1253 * or cell spacing and the like)
1255 * Note that we block this handler while requesting for sizes
1256 * so there is no need to check for the new context size being -1,
1257 * we also block the handler when explicitly resetting the context
1258 * so as to avoid some infinite stack recursion.
1260 if (!strcmp (pspec->name, "minimum-width") ||
1261 !strcmp (pspec->name, "natural-width") ||
1262 !strcmp (pspec->name, "minimum-height") ||
1263 !strcmp (pspec->name, "natural-height"))
1265 tree_column->priv->resetting_context = TRUE;
1266 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1267 tree_column->priv->resetting_context = FALSE;
1272 gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
1273 GtkCellRenderer *renderer,
1274 GtkCellEditable *edit_widget,
1275 GdkRectangle *cell_area,
1276 const gchar *path_string,
1279 GtkTreeViewColumn *column = user_data;
1280 GtkTreeViewColumnPrivate *priv = column->priv;
1283 if (priv->tree_view)
1285 path = gtk_tree_path_new_from_string (path_string);
1287 _gtk_tree_view_add_editable (GTK_TREE_VIEW (priv->tree_view),
1293 gtk_tree_path_free (path);
1298 gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
1299 GtkCellRenderer *renderer,
1300 GtkCellEditable *edit_widget,
1303 GtkTreeViewColumn *column = user_data;
1304 GtkTreeViewColumnPrivate *priv = column->priv;
1306 if (priv->tree_view)
1307 _gtk_tree_view_remove_editable (GTK_TREE_VIEW (priv->tree_view),
1312 /* Exported Private Functions.
1313 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
1316 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
1318 GtkTreeViewColumnPrivate *priv = column->priv;
1319 GtkAllocation allocation;
1320 GtkTreeView *tree_view;
1322 guint attributes_mask;
1325 tree_view = (GtkTreeView *)priv->tree_view;
1326 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
1328 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
1329 g_return_if_fail (gtk_widget_get_realized (priv->tree_view));
1330 g_return_if_fail (priv->button != NULL);
1332 g_return_if_fail (_gtk_tree_view_get_header_window (tree_view) != NULL);
1333 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
1336 gtk_widget_show (priv->button);
1338 attr.window_type = GDK_WINDOW_CHILD;
1339 attr.wclass = GDK_INPUT_ONLY;
1340 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
1341 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view)) |
1342 (GDK_BUTTON_PRESS_MASK |
1343 GDK_BUTTON_RELEASE_MASK |
1344 GDK_POINTER_MOTION_MASK |
1345 GDK_POINTER_MOTION_HINT_MASK |
1346 GDK_KEY_PRESS_MASK);
1347 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
1348 attr.cursor = gdk_cursor_new_for_display
1349 (gdk_window_get_display (_gtk_tree_view_get_header_window (tree_view)), GDK_SB_H_DOUBLE_ARROW);
1351 attr.width = TREE_VIEW_DRAG_WIDTH;
1352 attr.height = _gtk_tree_view_get_header_height (tree_view);
1354 gtk_widget_get_allocation (priv->button, &allocation);
1355 attr.x = (allocation.x + (rtl ? 0 : allocation.width)) - TREE_VIEW_DRAG_WIDTH / 2;
1356 priv->window = gdk_window_new (_gtk_tree_view_get_header_window (tree_view),
1357 &attr, attributes_mask);
1358 gdk_window_set_user_data (priv->window, tree_view);
1360 gtk_tree_view_column_update_button (column);
1362 gdk_cursor_unref (attr.cursor);
1366 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
1368 GtkTreeViewColumnPrivate *priv;
1370 g_return_if_fail (column != NULL);
1372 priv = column->priv;
1373 g_return_if_fail (priv->window != NULL);
1375 gdk_window_set_user_data (priv->window, NULL);
1376 gdk_window_destroy (priv->window);
1377 priv->window = NULL;
1381 _gtk_tree_view_column_unset_model (GtkTreeViewColumn *column,
1382 GtkTreeModel *old_model)
1384 GtkTreeViewColumnPrivate *priv = column->priv;
1386 if (priv->sort_column_changed_signal)
1388 g_signal_handler_disconnect (old_model,
1389 priv->sort_column_changed_signal);
1390 priv->sort_column_changed_signal = 0;
1392 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1396 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
1397 GtkTreeView *tree_view)
1399 GtkTreeViewColumnPrivate *priv = column->priv;
1401 g_assert (priv->tree_view == NULL);
1403 priv->tree_view = GTK_WIDGET (tree_view);
1404 gtk_tree_view_column_create_button (column);
1406 priv->property_changed_signal =
1407 g_signal_connect_swapped (tree_view,
1409 G_CALLBACK (gtk_tree_view_column_setup_sort_column_id_callback),
1412 gtk_tree_view_column_setup_sort_column_id_callback (column);
1416 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
1418 GtkTreeViewColumnPrivate *priv = column->priv;
1420 if (priv->tree_view && priv->button)
1422 gtk_container_remove (GTK_CONTAINER (priv->tree_view), priv->button);
1424 if (priv->property_changed_signal)
1426 g_signal_handler_disconnect (priv->tree_view, priv->property_changed_signal);
1427 priv->property_changed_signal = 0;
1430 if (priv->sort_column_changed_signal)
1432 g_signal_handler_disconnect (gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view)),
1433 priv->sort_column_changed_signal);
1434 priv->sort_column_changed_signal = 0;
1437 priv->tree_view = NULL;
1438 priv->button = NULL;
1442 _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column)
1444 GtkTreeViewColumnPrivate *priv = column->priv;
1445 gboolean ret = FALSE;
1446 GList *list, *cells;
1448 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
1450 for (list = cells; list; list = list->next)
1452 GtkCellRenderer *cell = list->data;
1453 GtkCellRendererMode mode;
1455 g_object_get (cell, "mode", &mode, NULL);
1457 if (mode == GTK_CELL_RENDERER_MODE_EDITABLE)
1464 g_list_free (cells);
1469 /* gets cell being edited */
1471 _gtk_tree_view_column_get_edited_cell (GtkTreeViewColumn *column)
1473 GtkTreeViewColumnPrivate *priv = column->priv;
1475 return gtk_cell_area_get_edited_cell (priv->cell_area);
1479 _gtk_tree_view_column_get_cell_at_pos (GtkTreeViewColumn *column,
1484 GtkCellRenderer *match = NULL;
1485 GtkTreeViewColumnPrivate *priv = column->priv;
1487 list = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (column));
1488 for (cell = list; cell; cell = cell->next)
1490 GdkRectangle zero_cell_area = { 0, };
1491 GdkRectangle allocation;
1493 gtk_cell_area_get_cell_allocation (priv->cell_area,
1494 priv->cell_area_context,
1500 if (allocation.x <= x && x <= allocation.x + allocation.width)
1512 /* Public Functions */
1516 * gtk_tree_view_column_new:
1518 * Creates a new #GtkTreeViewColumn.
1520 * Return value: A newly created #GtkTreeViewColumn.
1523 gtk_tree_view_column_new (void)
1525 GtkTreeViewColumn *tree_column;
1527 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, NULL);
1533 * gtk_tree_view_column_new_with_attributes:
1534 * @title: The title to set the header to.
1535 * @cell: The #GtkCellRenderer.
1536 * @Varargs: A %NULL-terminated list of attributes.
1538 * Creates a new #GtkTreeViewColumn with a number of default values. This is
1539 * equivalent to calling gtk_tree_view_column_set_title(),
1540 * gtk_tree_view_column_pack_start(), and
1541 * gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn.
1543 * Here's a simple example:
1545 * enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
1548 * GtkTreeViewColumn *column;
1549 * GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
1551 * column = gtk_tree_view_column_new_with_attributes ("Title",
1553 * "text", TEXT_COLUMN,
1554 * "foreground", COLOR_COLUMN,
1559 * Return value: A newly created #GtkTreeViewColumn.
1562 gtk_tree_view_column_new_with_attributes (const gchar *title,
1563 GtkCellRenderer *cell,
1566 GtkTreeViewColumn *retval;
1569 retval = gtk_tree_view_column_new ();
1571 gtk_tree_view_column_set_title (retval, title);
1572 gtk_tree_view_column_pack_start (retval, cell, TRUE);
1574 va_start (args, cell);
1575 gtk_tree_view_column_set_attributesv (retval, cell, args);
1582 * gtk_tree_view_column_pack_start:
1583 * @tree_column: A #GtkTreeViewColumn.
1584 * @cell: The #GtkCellRenderer.
1585 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1587 * Packs the @cell into the beginning of the column. If @expand is %FALSE, then
1588 * the @cell is allocated no more space than it needs. Any unused space is divided
1589 * evenly between cells for which @expand is %TRUE.
1592 gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
1593 GtkCellRenderer *cell,
1596 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (tree_column), cell, expand);
1600 * gtk_tree_view_column_pack_end:
1601 * @tree_column: A #GtkTreeViewColumn.
1602 * @cell: The #GtkCellRenderer.
1603 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1605 * Adds the @cell to end of the column. If @expand is %FALSE, then the @cell
1606 * is allocated no more space than it needs. Any unused space is divided
1607 * evenly between cells for which @expand is %TRUE.
1610 gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
1611 GtkCellRenderer *cell,
1614 gtk_cell_layout_pack_end (GTK_CELL_LAYOUT (tree_column), cell, expand);
1618 * gtk_tree_view_column_clear:
1619 * @tree_column: A #GtkTreeViewColumn
1621 * Unsets all the mappings on all renderers on the @tree_column.
1624 gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column)
1626 gtk_cell_layout_clear (GTK_CELL_LAYOUT (tree_column));
1630 * gtk_tree_view_column_add_attribute:
1631 * @tree_column: A #GtkTreeViewColumn.
1632 * @cell_renderer: the #GtkCellRenderer to set attributes on
1633 * @attribute: An attribute on the renderer
1634 * @column: The column position on the model to get the attribute from.
1636 * Adds an attribute mapping to the list in @tree_column. The @column is the
1637 * column of the model to get a value from, and the @attribute is the
1638 * parameter on @cell_renderer to be set from the value. So for example
1639 * if column 2 of the model contains strings, you could have the
1640 * "text" attribute of a #GtkCellRendererText get its values from
1644 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1645 GtkCellRenderer *cell_renderer,
1646 const gchar *attribute,
1649 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (tree_column),
1650 cell_renderer, attribute, column);
1654 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1655 GtkCellRenderer *cell_renderer,
1658 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1662 attribute = va_arg (args, gchar *);
1664 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (priv->cell_area),
1667 while (attribute != NULL)
1669 column = va_arg (args, gint);
1670 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (priv->cell_area),
1671 cell_renderer, attribute, column);
1672 attribute = va_arg (args, gchar *);
1677 * gtk_tree_view_column_set_attributes:
1678 * @tree_column: A #GtkTreeViewColumn.
1679 * @cell_renderer: the #GtkCellRenderer we're setting the attributes of
1680 * @Varargs: A %NULL-terminated list of attributes.
1682 * Sets the attributes in the list as the attributes of @tree_column.
1683 * The attributes should be in attribute/column order, as in
1684 * gtk_tree_view_column_add_attribute(). All existing attributes
1685 * are removed, and replaced with the new attributes.
1688 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1689 GtkCellRenderer *cell_renderer,
1694 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1695 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1697 va_start (args, cell_renderer);
1698 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1704 * gtk_tree_view_column_set_cell_data_func:
1705 * @tree_column: A #GtkTreeViewColumn
1706 * @cell_renderer: A #GtkCellRenderer
1707 * @func: The #GtkTreeViewColumnFunc to use.
1708 * @func_data: The user data for @func.
1709 * @destroy: The destroy notification for @func_data
1711 * Sets the #GtkTreeViewColumnFunc to use for the column. This
1712 * function is used instead of the standard attributes mapping for
1713 * setting the column value, and should set the value of @tree_column's
1714 * cell renderer as appropriate. @func may be %NULL to remove an
1718 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1719 GtkCellRenderer *cell_renderer,
1720 GtkTreeCellDataFunc func,
1722 GDestroyNotify destroy)
1724 gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT (tree_column),
1726 (GtkCellLayoutDataFunc)func,
1727 func_data, destroy);
1732 * gtk_tree_view_column_clear_attributes:
1733 * @tree_column: a #GtkTreeViewColumn
1734 * @cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1736 * Clears all existing attributes previously set with
1737 * gtk_tree_view_column_set_attributes().
1740 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1741 GtkCellRenderer *cell_renderer)
1743 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (tree_column),
1748 * gtk_tree_view_column_set_spacing:
1749 * @tree_column: A #GtkTreeViewColumn.
1750 * @spacing: distance between cell renderers in pixels.
1752 * Sets the spacing field of @tree_column, which is the number of pixels to
1753 * place between cell renderers packed into it.
1756 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1759 GtkTreeViewColumnPrivate *priv;
1761 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1762 g_return_if_fail (spacing >= 0);
1764 priv = tree_column->priv;
1766 gtk_cell_area_box_set_spacing (GTK_CELL_AREA_BOX (priv->cell_area),
1768 if (priv->tree_view)
1769 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1773 * gtk_tree_view_column_get_spacing:
1774 * @tree_column: A #GtkTreeViewColumn.
1776 * Returns the spacing of @tree_column.
1778 * Return value: the spacing of @tree_column.
1781 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1783 GtkTreeViewColumnPrivate *priv;
1785 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1787 priv = tree_column->priv;
1789 return gtk_cell_area_box_get_spacing (GTK_CELL_AREA_BOX (priv->cell_area));
1792 /* Options for manipulating the columns */
1795 * gtk_tree_view_column_set_visible:
1796 * @tree_column: A #GtkTreeViewColumn.
1797 * @visible: %TRUE if the @tree_column is visible.
1799 * Sets the visibility of @tree_column.
1802 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1805 GtkTreeViewColumnPrivate *priv;
1807 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1809 priv = tree_column->priv;
1810 visible = !! visible;
1812 if (priv->visible == visible)
1815 priv->visible = visible;
1818 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1820 gtk_tree_view_column_update_button (tree_column);
1821 g_object_notify (G_OBJECT (tree_column), "visible");
1825 * gtk_tree_view_column_get_visible:
1826 * @tree_column: A #GtkTreeViewColumn.
1828 * Returns %TRUE if @tree_column is visible.
1830 * Return value: whether the column is visible or not. If it is visible, then
1831 * the tree will show the column.
1834 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1836 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1838 return tree_column->priv->visible;
1842 * gtk_tree_view_column_set_resizable:
1843 * @tree_column: A #GtkTreeViewColumn
1844 * @resizable: %TRUE, if the column can be resized
1846 * If @resizable is %TRUE, then the user can explicitly resize the column by
1847 * grabbing the outer edge of the column button. If resizable is %TRUE and
1848 * sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing
1849 * mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY.
1852 gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
1855 GtkTreeViewColumnPrivate *priv;
1857 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1859 priv = tree_column->priv;
1860 resizable = !! resizable;
1862 if (priv->resizable == resizable)
1865 priv->resizable = resizable;
1867 if (resizable && priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1868 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_GROW_ONLY);
1870 gtk_tree_view_column_update_button (tree_column);
1872 g_object_notify (G_OBJECT (tree_column), "resizable");
1876 * gtk_tree_view_column_get_resizable:
1877 * @tree_column: A #GtkTreeViewColumn
1879 * Returns %TRUE if the @tree_column can be resized by the end user.
1881 * Return value: %TRUE, if the @tree_column can be resized.
1884 gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column)
1886 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1888 return tree_column->priv->resizable;
1893 * gtk_tree_view_column_set_sizing:
1894 * @tree_column: A #GtkTreeViewColumn.
1895 * @type: The #GtkTreeViewColumnSizing.
1897 * Sets the growth behavior of @tree_column to @type.
1900 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
1901 GtkTreeViewColumnSizing type)
1903 GtkTreeViewColumnPrivate *priv;
1905 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1907 priv = tree_column->priv;
1909 if (type == priv->column_type)
1912 if (type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1913 gtk_tree_view_column_set_resizable (tree_column, FALSE);
1915 priv->column_type = type;
1917 gtk_tree_view_column_update_button (tree_column);
1919 g_object_notify (G_OBJECT (tree_column), "sizing");
1923 * gtk_tree_view_column_get_sizing:
1924 * @tree_column: A #GtkTreeViewColumn.
1926 * Returns the current type of @tree_column.
1928 * Return value: The type of @tree_column.
1930 GtkTreeViewColumnSizing
1931 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
1933 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1935 return tree_column->priv->column_type;
1939 * gtk_tree_view_column_get_width:
1940 * @tree_column: A #GtkTreeViewColumn.
1942 * Returns the current size of @tree_column in pixels.
1944 * Return value: The current width of @tree_column.
1947 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
1949 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1951 return tree_column->priv->width;
1955 _gtk_tree_view_column_request_width (GtkTreeViewColumn *tree_column)
1957 GtkTreeViewColumnPrivate *priv;
1958 gint real_requested_width;
1960 priv = tree_column->priv;
1962 if (priv->use_resized_width)
1964 real_requested_width = priv->resized_width;
1966 else if (priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
1968 real_requested_width = priv->fixed_width;
1970 else if (gtk_tree_view_get_headers_visible (GTK_TREE_VIEW (priv->tree_view)))
1972 gint button_request;
1973 gint requested_width;
1975 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
1976 requested_width += priv->padding;
1978 gtk_widget_get_preferred_width (priv->button, &button_request, NULL);
1979 real_requested_width = MAX (requested_width, button_request);
1983 gint requested_width;
1985 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
1986 requested_width += priv->padding;
1988 real_requested_width = requested_width;
1989 if (real_requested_width < 0)
1990 real_requested_width = 0;
1993 if (priv->min_width != -1)
1994 real_requested_width = MAX (real_requested_width, priv->min_width);
1996 if (priv->max_width != -1)
1997 real_requested_width = MIN (real_requested_width, priv->max_width);
1999 return real_requested_width;
2003 _gtk_tree_view_column_allocate (GtkTreeViewColumn *tree_column,
2007 GtkTreeViewColumnPrivate *priv;
2008 GtkAllocation allocation;
2011 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2013 priv = tree_column->priv;
2015 priv->width = width;
2017 gtk_cell_area_context_allocate (priv->cell_area_context, priv->width - priv->padding, -1);
2019 allocation.x = x_offset;
2021 allocation.width = width;
2022 allocation.height = _gtk_tree_view_get_header_height (GTK_TREE_VIEW (priv->tree_view));
2024 gtk_widget_size_allocate (priv->button, &allocation);
2028 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
2029 gdk_window_move_resize (priv->window,
2030 allocation.x + (rtl ? 0 : allocation.width) - TREE_VIEW_DRAG_WIDTH/2,
2032 TREE_VIEW_DRAG_WIDTH, allocation.height);
2035 g_object_notify (G_OBJECT (tree_column), "width");
2039 * gtk_tree_view_column_set_fixed_width:
2040 * @tree_column: A #GtkTreeViewColumn.
2041 * @fixed_width: The size to set @tree_column to. Must be greater than 0.
2043 * Sets the size of the column in pixels. This is meaningful only if the sizing
2044 * type is #GTK_TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to
2045 * the min/max width for the column. Please note that the min/max width of the
2046 * column doesn't actually affect the "fixed_width" property of the widget, just
2047 * the actual size when displayed.
2050 gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
2053 GtkTreeViewColumnPrivate *priv;
2055 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2056 g_return_if_fail (fixed_width > 0);
2058 priv = tree_column->priv;
2060 priv->fixed_width = fixed_width;
2061 priv->use_resized_width = FALSE;
2063 if (priv->tree_view &&
2064 gtk_widget_get_realized (priv->tree_view) &&
2065 priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2067 gtk_widget_queue_resize (priv->tree_view);
2070 g_object_notify (G_OBJECT (tree_column), "fixed-width");
2074 * gtk_tree_view_column_get_fixed_width:
2075 * @tree_column: a #GtkTreeViewColumn
2077 * Gets the fixed width of the column. This value is only meaning may not be
2078 * the actual width of the column on the screen, just what is requested.
2080 * Return value: the fixed width of the column
2083 gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
2085 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2087 return tree_column->priv->fixed_width;
2091 * gtk_tree_view_column_set_min_width:
2092 * @tree_column: A #GtkTreeViewColumn.
2093 * @min_width: The minimum width of the column in pixels, or -1.
2095 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
2096 * minimum width is unset.
2099 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
2102 GtkTreeViewColumnPrivate *priv;
2104 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2105 g_return_if_fail (min_width >= -1);
2107 priv = tree_column->priv;
2109 if (min_width == priv->min_width)
2112 if (priv->visible &&
2113 priv->tree_view != NULL &&
2114 gtk_widget_get_realized (priv->tree_view))
2116 if (min_width > priv->width)
2117 gtk_widget_queue_resize (priv->tree_view);
2120 priv->min_width = min_width;
2121 g_object_freeze_notify (G_OBJECT (tree_column));
2122 if (priv->max_width != -1 && priv->max_width < min_width)
2124 priv->max_width = min_width;
2125 g_object_notify (G_OBJECT (tree_column), "max-width");
2127 g_object_notify (G_OBJECT (tree_column), "min-width");
2128 g_object_thaw_notify (G_OBJECT (tree_column));
2130 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2131 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2136 * gtk_tree_view_column_get_min_width:
2137 * @tree_column: A #GtkTreeViewColumn.
2139 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
2142 * Return value: The minimum width of the @tree_column.
2145 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
2147 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2149 return tree_column->priv->min_width;
2153 * gtk_tree_view_column_set_max_width:
2154 * @tree_column: A #GtkTreeViewColumn.
2155 * @max_width: The maximum width of the column in pixels, or -1.
2157 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
2158 * maximum width is unset. Note, the column can actually be wider than max
2159 * width if it's the last column in a view. In this case, the column expands to
2160 * fill any extra space.
2163 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
2166 GtkTreeViewColumnPrivate *priv;
2168 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2169 g_return_if_fail (max_width >= -1);
2171 priv = tree_column->priv;
2173 if (max_width == priv->max_width)
2176 if (priv->visible &&
2177 priv->tree_view != NULL &&
2178 gtk_widget_get_realized (priv->tree_view))
2180 if (max_width != -1 && max_width < priv->width)
2181 gtk_widget_queue_resize (priv->tree_view);
2184 priv->max_width = max_width;
2185 g_object_freeze_notify (G_OBJECT (tree_column));
2186 if (max_width != -1 && max_width < priv->min_width)
2188 priv->min_width = max_width;
2189 g_object_notify (G_OBJECT (tree_column), "min-width");
2191 g_object_notify (G_OBJECT (tree_column), "max-width");
2192 g_object_thaw_notify (G_OBJECT (tree_column));
2194 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2195 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2200 * gtk_tree_view_column_get_max_width:
2201 * @tree_column: A #GtkTreeViewColumn.
2203 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
2206 * Return value: The maximum width of the @tree_column.
2209 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
2211 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2213 return tree_column->priv->max_width;
2217 * gtk_tree_view_column_clicked:
2218 * @tree_column: a #GtkTreeViewColumn
2220 * Emits the "clicked" signal on the column. This function will only work if
2221 * @tree_column is clickable.
2224 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
2226 GtkTreeViewColumnPrivate *priv;
2228 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2230 priv = tree_column->priv;
2232 if (priv->visible &&
2235 gtk_button_clicked (GTK_BUTTON (priv->button));
2239 * gtk_tree_view_column_set_title:
2240 * @tree_column: A #GtkTreeViewColumn.
2241 * @title: The title of the @tree_column.
2243 * Sets the title of the @tree_column. If a custom widget has been set, then
2244 * this value is ignored.
2247 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
2250 GtkTreeViewColumnPrivate *priv;
2253 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2255 priv = tree_column->priv;
2257 new_title = g_strdup (title);
2258 g_free (priv->title);
2259 priv->title = new_title;
2261 gtk_tree_view_column_update_button (tree_column);
2262 g_object_notify (G_OBJECT (tree_column), "title");
2266 * gtk_tree_view_column_get_title:
2267 * @tree_column: A #GtkTreeViewColumn.
2269 * Returns the title of the widget.
2271 * Return value: the title of the column. This string should not be
2272 * modified or freed.
2274 G_CONST_RETURN gchar *
2275 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
2277 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2279 return tree_column->priv->title;
2283 * gtk_tree_view_column_set_expand:
2284 * @tree_column: A #GtkTreeViewColumn
2285 * @expand: %TRUE if the column should take available extra space, %FALSE if not
2287 * Sets the column to take available extra space. This space is shared equally
2288 * amongst all columns that have the expand set to %TRUE. If no column has this
2289 * option set, then the last column gets all extra space. By default, every
2290 * column is created with this %FALSE.
2295 gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
2298 GtkTreeViewColumnPrivate *priv;
2300 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2302 priv = tree_column->priv;
2304 expand = expand?TRUE:FALSE;
2305 if (priv->expand == expand)
2307 priv->expand = expand;
2309 if (priv->visible &&
2310 priv->tree_view != NULL &&
2311 gtk_widget_get_realized (priv->tree_view))
2313 /* We want to continue using the original width of the
2314 * column that includes additional space added by the user
2315 * resizing the columns and possibly extra (expanded) space, which
2316 * are not included in the resized width.
2318 priv->use_resized_width = FALSE;
2320 gtk_widget_queue_resize (priv->tree_view);
2323 g_object_notify (G_OBJECT (tree_column), "expand");
2327 * gtk_tree_view_column_get_expand:
2328 * @tree_column: a #GtkTreeViewColumn
2330 * Return %TRUE if the column expands to take any available space.
2332 * Return value: %TRUE, if the column expands
2337 gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column)
2339 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2341 return tree_column->priv->expand;
2345 * gtk_tree_view_column_set_clickable:
2346 * @tree_column: A #GtkTreeViewColumn.
2347 * @clickable: %TRUE if the header is active.
2349 * Sets the header to be active if @active is %TRUE. When the header is active,
2350 * then it can take keyboard focus, and can be clicked.
2353 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
2356 GtkTreeViewColumnPrivate *priv;
2358 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2360 priv = tree_column->priv;
2362 clickable = !! clickable;
2363 if (priv->clickable == clickable)
2366 priv->clickable = clickable;
2367 gtk_tree_view_column_update_button (tree_column);
2368 g_object_notify (G_OBJECT (tree_column), "clickable");
2372 * gtk_tree_view_column_get_clickable:
2373 * @tree_column: a #GtkTreeViewColumn
2375 * Returns %TRUE if the user can click on the header for the column.
2377 * Return value: %TRUE if user can click the column header.
2380 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
2382 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2384 return tree_column->priv->clickable;
2388 * gtk_tree_view_column_set_widget:
2389 * @tree_column: A #GtkTreeViewColumn.
2390 * @widget: (allow-none): A child #GtkWidget, or %NULL.
2392 * Sets the widget in the header to be @widget. If widget is %NULL, then the
2393 * header button is set with a #GtkLabel set to the title of @tree_column.
2396 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
2399 GtkTreeViewColumnPrivate *priv;
2401 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2402 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
2404 priv = tree_column->priv;
2407 g_object_ref_sink (widget);
2410 g_object_unref (priv->child);
2412 priv->child = widget;
2413 gtk_tree_view_column_update_button (tree_column);
2414 g_object_notify (G_OBJECT (tree_column), "widget");
2418 * gtk_tree_view_column_get_widget:
2419 * @tree_column: A #GtkTreeViewColumn.
2421 * Returns the #GtkWidget in the button on the column header.
2422 * If a custom widget has not been set then %NULL is returned.
2424 * Return value: (transfer none): The #GtkWidget in the column
2428 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
2430 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2432 return tree_column->priv->child;
2436 * gtk_tree_view_column_set_alignment:
2437 * @tree_column: A #GtkTreeViewColumn.
2438 * @xalign: The alignment, which is between [0.0 and 1.0] inclusive.
2440 * Sets the alignment of the title or custom widget inside the column header.
2441 * The alignment determines its location inside the button -- 0.0 for left, 0.5
2442 * for center, 1.0 for right.
2445 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
2448 GtkTreeViewColumnPrivate *priv;
2450 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2452 priv = tree_column->priv;
2454 xalign = CLAMP (xalign, 0.0, 1.0);
2456 if (priv->xalign == xalign)
2459 priv->xalign = xalign;
2460 gtk_tree_view_column_update_button (tree_column);
2461 g_object_notify (G_OBJECT (tree_column), "alignment");
2465 * gtk_tree_view_column_get_alignment:
2466 * @tree_column: A #GtkTreeViewColumn.
2468 * Returns the current x alignment of @tree_column. This value can range
2469 * between 0.0 and 1.0.
2471 * Return value: The current alignent of @tree_column.
2474 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
2476 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
2478 return tree_column->priv->xalign;
2482 * gtk_tree_view_column_set_reorderable:
2483 * @tree_column: A #GtkTreeViewColumn
2484 * @reorderable: %TRUE, if the column can be reordered.
2486 * If @reorderable is %TRUE, then the column can be reordered by the end user
2487 * dragging the header.
2490 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
2491 gboolean reorderable)
2493 GtkTreeViewColumnPrivate *priv;
2495 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2497 priv = tree_column->priv;
2500 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
2502 if (priv->reorderable == (reorderable?TRUE:FALSE))
2505 priv->reorderable = (reorderable?TRUE:FALSE);
2506 gtk_tree_view_column_update_button (tree_column);
2507 g_object_notify (G_OBJECT (tree_column), "reorderable");
2511 * gtk_tree_view_column_get_reorderable:
2512 * @tree_column: A #GtkTreeViewColumn
2514 * Returns %TRUE if the @tree_column can be reordered by the user.
2516 * Return value: %TRUE if the @tree_column can be reordered by the user.
2519 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
2521 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2523 return tree_column->priv->reorderable;
2528 * gtk_tree_view_column_set_sort_column_id:
2529 * @tree_column: a #GtkTreeViewColumn
2530 * @sort_column_id: The @sort_column_id of the model to sort on.
2532 * Sets the logical @sort_column_id that this column sorts on when this column
2533 * is selected for sorting. Doing so makes the column header clickable.
2536 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
2537 gint sort_column_id)
2539 GtkTreeViewColumnPrivate *priv;
2541 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2542 g_return_if_fail (sort_column_id >= -1);
2544 priv = tree_column->priv;
2546 if (priv->sort_column_id == sort_column_id)
2549 priv->sort_column_id = sort_column_id;
2551 /* Handle unsetting the id */
2552 if (sort_column_id == -1)
2554 GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
2556 if (priv->sort_clicked_signal)
2558 g_signal_handler_disconnect (tree_column, priv->sort_clicked_signal);
2559 priv->sort_clicked_signal = 0;
2562 if (priv->sort_column_changed_signal)
2564 g_signal_handler_disconnect (model, priv->sort_column_changed_signal);
2565 priv->sort_column_changed_signal = 0;
2568 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
2569 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
2570 gtk_tree_view_column_set_clickable (tree_column, FALSE);
2571 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2575 gtk_tree_view_column_set_clickable (tree_column, TRUE);
2577 if (! priv->sort_clicked_signal)
2578 priv->sort_clicked_signal = g_signal_connect (tree_column,
2580 G_CALLBACK (gtk_tree_view_column_sort),
2583 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
2584 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2588 * gtk_tree_view_column_get_sort_column_id:
2589 * @tree_column: a #GtkTreeViewColumn
2591 * Gets the logical @sort_column_id that the model sorts on when this
2592 * column is selected for sorting.
2593 * See gtk_tree_view_column_set_sort_column_id().
2595 * Return value: the current @sort_column_id for this column, or -1 if
2596 * this column can't be used for sorting.
2599 gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column)
2601 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2603 return tree_column->priv->sort_column_id;
2607 * gtk_tree_view_column_set_sort_indicator:
2608 * @tree_column: a #GtkTreeViewColumn
2609 * @setting: %TRUE to display an indicator that the column is sorted
2611 * Call this function with a @setting of %TRUE to display an arrow in
2612 * the header button indicating the column is sorted. Call
2613 * gtk_tree_view_column_set_sort_order() to change the direction of
2618 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
2621 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2623 setting = setting != FALSE;
2625 if (setting == tree_column->priv->show_sort_indicator)
2628 tree_column->priv->show_sort_indicator = setting;
2629 gtk_tree_view_column_update_button (tree_column);
2630 g_object_notify (G_OBJECT (tree_column), "sort-indicator");
2634 * gtk_tree_view_column_get_sort_indicator:
2635 * @tree_column: a #GtkTreeViewColumn
2637 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
2639 * Return value: whether the sort indicator arrow is displayed
2642 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
2644 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2646 return tree_column->priv->show_sort_indicator;
2650 * gtk_tree_view_column_set_sort_order:
2651 * @tree_column: a #GtkTreeViewColumn
2652 * @order: sort order that the sort indicator should indicate
2654 * Changes the appearance of the sort indicator.
2656 * This <emphasis>does not</emphasis> actually sort the model. Use
2657 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
2658 * support. This function is primarily for custom sorting behavior, and should
2659 * be used in conjunction with gtk_tree_sortable_set_sort_column() to do
2660 * that. For custom models, the mechanism will vary.
2662 * The sort indicator changes direction to indicate normal sort or reverse sort.
2663 * Note that you must have the sort indicator enabled to see anything when
2664 * calling this function; see gtk_tree_view_column_set_sort_indicator().
2667 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
2670 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2672 if (order == tree_column->priv->sort_order)
2675 tree_column->priv->sort_order = order;
2676 gtk_tree_view_column_update_button (tree_column);
2677 g_object_notify (G_OBJECT (tree_column), "sort-order");
2681 * gtk_tree_view_column_get_sort_order:
2682 * @tree_column: a #GtkTreeViewColumn
2684 * Gets the value set by gtk_tree_view_column_set_sort_order().
2686 * Return value: the sort order the sort indicator is indicating
2689 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2691 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2693 return tree_column->priv->sort_order;
2697 * gtk_tree_view_column_cell_set_cell_data:
2698 * @tree_column: A #GtkTreeViewColumn.
2699 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2700 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2701 * @is_expander: %TRUE, if the row has children
2702 * @is_expanded: %TRUE, if the row has visible children
2704 * Sets the cell renderer based on the @tree_model and @iter. That is, for
2705 * every attribute mapping in @tree_column, it will get a value from the set
2706 * column on the @iter, and use that value to set the attribute on the cell
2707 * renderer. This is used primarily by the #GtkTreeView.
2710 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2711 GtkTreeModel *tree_model,
2713 gboolean is_expander,
2714 gboolean is_expanded)
2716 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2718 if (tree_model == NULL)
2721 gtk_cell_area_apply_attributes (tree_column->priv->cell_area, tree_model, iter,
2722 is_expander, is_expanded);
2726 * gtk_tree_view_column_cell_get_size:
2727 * @tree_column: A #GtkTreeViewColumn.
2728 * @cell_area: (allow-none): The area a cell in the column will be allocated, or %NULL
2729 * @x_offset: (allow-none): location to return x offset of a cell relative to @cell_area, or %NULL
2730 * @y_offset: (allow-none): location to return y offset of a cell relative to @cell_area, or %NULL
2731 * @width: (allow-none): location to return width needed to render a cell, or %NULL
2732 * @height: (allow-none): location to return height needed to render a cell, or %NULL
2734 * Obtains the width and height needed to render the column. This is used
2735 * primarily by the #GtkTreeView.
2738 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2739 const GdkRectangle *cell_area,
2745 GtkTreeViewColumnPrivate *priv;
2746 gint min_width = 0, min_height = 0;
2748 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2750 priv = tree_column->priv;
2752 g_signal_handler_block (priv->cell_area_context,
2753 priv->context_changed_signal);
2755 gtk_cell_area_get_preferred_width (priv->cell_area,
2756 priv->cell_area_context,
2760 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &min_width, NULL);
2762 gtk_cell_area_get_preferred_height_for_width (priv->cell_area,
2763 priv->cell_area_context,
2769 g_signal_handler_unblock (priv->cell_area_context,
2770 priv->context_changed_signal);
2774 * height = min_height;
2776 * width = min_width;
2781 * gtk_tree_view_column_cell_render:
2782 * @tree_column: A #GtkTreeViewColumn.
2783 * @cr: cairo context to draw to
2784 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2785 * @cell_area: area normally rendered by a cell renderer
2786 * @flags: flags that affect rendering
2788 * Renders the cell contained by #tree_column. This is used primarily by the
2792 _gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2794 const GdkRectangle *background_area,
2795 const GdkRectangle *cell_area,
2797 gboolean draw_focus)
2799 GtkTreeViewColumnPrivate *priv;
2801 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2802 g_return_if_fail (cr != NULL);
2803 g_return_if_fail (background_area != NULL);
2804 g_return_if_fail (cell_area != NULL);
2806 priv = tree_column->priv;
2810 gtk_cell_area_render (priv->cell_area, priv->cell_area_context,
2811 priv->tree_view, cr,
2812 background_area, cell_area, flags,
2819 _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2821 const GdkRectangle *cell_area,
2824 GtkTreeViewColumnPrivate *priv;
2826 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2828 priv = tree_column->priv;
2830 return gtk_cell_area_event (priv->cell_area,
2831 priv->cell_area_context,
2839 * gtk_tree_view_column_cell_is_visible:
2840 * @tree_column: A #GtkTreeViewColumn
2842 * Returns %TRUE if any of the cells packed into the @tree_column are visible.
2843 * For this to be meaningful, you must first initialize the cells with
2844 * gtk_tree_view_column_cell_set_cell_data()
2846 * Return value: %TRUE, if any of the cells packed into the @tree_column are currently visible
2849 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
2853 GtkTreeViewColumnPrivate *priv;
2855 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2857 priv = tree_column->priv;
2859 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
2860 for (list = cells; list; list = list->next)
2862 if (gtk_cell_renderer_get_visible (list->data))
2864 g_list_free (cells);
2869 g_list_free (cells);
2875 * gtk_tree_view_column_focus_cell:
2876 * @tree_column: A #GtkTreeViewColumn
2877 * @cell: A #GtkCellRenderer
2879 * Sets the current keyboard focus to be at @cell, if the column contains
2880 * 2 or more editable and activatable cells.
2885 gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
2886 GtkCellRenderer *cell)
2888 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2889 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
2891 gtk_cell_area_set_focus_cell (tree_column->priv->cell_area, cell);
2895 _gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column,
2896 gboolean install_handler)
2898 GtkTreeViewColumnPrivate *priv = tree_column->priv;
2904 /* Issue a manual reset on the context to have all
2905 * sizes re-requested for the context.
2907 * This annoying 'resetting_context' flag is unfortunately
2908 * necessary to prevent some infinite recursion
2910 if (!tree_column->priv->resetting_context)
2912 g_signal_handler_block (priv->cell_area_context,
2913 priv->context_changed_signal);
2914 gtk_cell_area_context_reset (priv->cell_area_context);
2915 g_signal_handler_unblock (priv->cell_area_context,
2916 priv->context_changed_signal);
2919 if (priv->tree_view &&
2920 gtk_widget_get_realized (priv->tree_view))
2922 _gtk_tree_view_install_mark_rows_col_dirty (GTK_TREE_VIEW (priv->tree_view), install_handler);
2923 gtk_widget_queue_resize (priv->tree_view);
2928 _gtk_tree_view_column_cell_get_dirty (GtkTreeViewColumn *tree_column)
2930 return tree_column->priv->dirty;
2934 * gtk_tree_view_column_cell_get_position:
2935 * @tree_column: a #GtkTreeViewColumn
2936 * @cell_renderer: a #GtkCellRenderer
2937 * @x_offset: return location for the horizontal position of @cell within
2938 * @tree_column, may be %NULL
2939 * @width: return location for the width of @cell, may be %NULL
2941 * Obtains the horizontal position and size of a cell in a column. If the
2942 * cell is not found in the column, @start_pos and @width are not changed and
2943 * %FALSE is returned.
2945 * Return value: %TRUE if @cell belongs to @tree_column.
2948 gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
2949 GtkCellRenderer *cell_renderer,
2953 GtkTreeViewColumnPrivate *priv;
2954 GdkRectangle zero_cell_area = { 0, };
2955 GdkRectangle allocation;
2957 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2958 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell_renderer), FALSE);
2960 priv = tree_column->priv;
2962 /* FIXME: Could use a boolean return value for invalid cells */
2963 gtk_cell_area_get_cell_allocation (priv->cell_area,
2964 priv->cell_area_context,
2971 *x_offset = allocation.x;
2973 *width = allocation.width;
2979 * gtk_tree_view_column_queue_resize:
2980 * @tree_column: A #GtkTreeViewColumn
2982 * Flags the column, and the cell renderers added to this column, to have
2983 * their sizes renegotiated.
2988 gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column)
2990 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2992 if (tree_column->priv->tree_view)
2993 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
2997 * gtk_tree_view_column_get_tree_view:
2998 * @tree_column: A #GtkTreeViewColumn
3000 * Returns the #GtkTreeView wherein @tree_column has been inserted.
3001 * If @column is currently not inserted in any tree view, %NULL is
3004 * Return value: (transfer none): The tree view wherein @column has
3005 * been inserted if any, %NULL otherwise.
3010 gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column)
3012 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3014 return tree_column->priv->tree_view;
3018 * gtk_tree_view_column_get_button:
3019 * @tree_column: A #GtkTreeViewColumn
3021 * Returns the button used in the treeview column header
3023 * Return value: (transfer none): The button for the column header.
3028 gtk_tree_view_column_get_button (GtkTreeViewColumn *tree_column)
3030 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3032 return tree_column->priv->button;
3036 _gtk_tree_view_column_get_window (GtkTreeViewColumn *column)
3038 return column->priv->window;
3042 _gtk_tree_view_column_push_padding (GtkTreeViewColumn *column,
3045 column->priv->padding = MAX (column->priv->padding, padding);
3049 _gtk_tree_view_column_get_requested_width (GtkTreeViewColumn *column)
3051 gint requested_width;
3053 gtk_cell_area_context_get_preferred_width (column->priv->cell_area_context, &requested_width, NULL);
3055 return requested_width + column->priv->padding;
3060 _gtk_tree_view_column_set_resized_width (GtkTreeViewColumn *column,
3063 column->priv->resized_width = width;
3067 _gtk_tree_view_column_get_resized_width (GtkTreeViewColumn *column)
3069 return column->priv->resized_width;
3073 _gtk_tree_view_column_set_use_resized_width (GtkTreeViewColumn *column,
3074 gboolean use_resized_width)
3076 column->priv->use_resized_width = use_resized_width;
3080 _gtk_tree_view_column_get_use_resized_width (GtkTreeViewColumn *column)
3082 return column->priv->use_resized_width;
3086 _gtk_tree_view_column_get_drag_x (GtkTreeViewColumn *column)
3088 return column->priv->drag_x;
3091 GtkCellAreaContext *
3092 _gtk_tree_view_column_get_context (GtkTreeViewColumn *column)
3094 return column->priv->cell_area_context;