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;
206 static guint tree_column_signals[LAST_SIGNAL] = { 0 };
208 G_DEFINE_TYPE_WITH_CODE (GtkTreeViewColumn, gtk_tree_view_column, G_TYPE_INITIALLY_UNOWNED,
209 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
210 gtk_tree_view_column_cell_layout_init)
211 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
212 gtk_tree_view_column_buildable_init))
216 gtk_tree_view_column_class_init (GtkTreeViewColumnClass *class)
218 GObjectClass *object_class;
220 object_class = (GObjectClass*) class;
222 class->clicked = NULL;
224 object_class->constructor = gtk_tree_view_column_constructor;
225 object_class->finalize = gtk_tree_view_column_finalize;
226 object_class->dispose = gtk_tree_view_column_dispose;
227 object_class->set_property = gtk_tree_view_column_set_property;
228 object_class->get_property = gtk_tree_view_column_get_property;
230 tree_column_signals[CLICKED] =
231 g_signal_new (I_("clicked"),
232 G_OBJECT_CLASS_TYPE (object_class),
234 G_STRUCT_OFFSET (GtkTreeViewColumnClass, clicked),
236 _gtk_marshal_VOID__VOID,
239 g_object_class_install_property (object_class,
241 g_param_spec_boolean ("visible",
243 P_("Whether to display the column"),
245 GTK_PARAM_READWRITE));
247 g_object_class_install_property (object_class,
249 g_param_spec_boolean ("resizable",
251 P_("Column is user-resizable"),
253 GTK_PARAM_READWRITE));
255 g_object_class_install_property (object_class,
257 g_param_spec_int ("width",
259 P_("Current width of the column"),
263 GTK_PARAM_READABLE));
264 g_object_class_install_property (object_class,
266 g_param_spec_int ("spacing",
268 P_("Space which is inserted between cells"),
272 GTK_PARAM_READWRITE));
273 g_object_class_install_property (object_class,
275 g_param_spec_enum ("sizing",
277 P_("Resize mode of the column"),
278 GTK_TYPE_TREE_VIEW_COLUMN_SIZING,
279 GTK_TREE_VIEW_COLUMN_GROW_ONLY,
280 GTK_PARAM_READWRITE));
282 g_object_class_install_property (object_class,
284 g_param_spec_int ("fixed-width",
286 P_("Current fixed width of the column"),
290 GTK_PARAM_READWRITE));
292 g_object_class_install_property (object_class,
294 g_param_spec_int ("min-width",
296 P_("Minimum allowed width of the column"),
300 GTK_PARAM_READWRITE));
302 g_object_class_install_property (object_class,
304 g_param_spec_int ("max-width",
306 P_("Maximum allowed width of the column"),
310 GTK_PARAM_READWRITE));
312 g_object_class_install_property (object_class,
314 g_param_spec_string ("title",
316 P_("Title to appear in column header"),
318 GTK_PARAM_READWRITE));
320 g_object_class_install_property (object_class,
322 g_param_spec_boolean ("expand",
324 P_("Column gets share of extra width allocated to the widget"),
326 GTK_PARAM_READWRITE));
328 g_object_class_install_property (object_class,
330 g_param_spec_boolean ("clickable",
332 P_("Whether the header can be clicked"),
334 GTK_PARAM_READWRITE));
337 g_object_class_install_property (object_class,
339 g_param_spec_object ("widget",
341 P_("Widget to put in column header button instead of column title"),
343 GTK_PARAM_READWRITE));
345 g_object_class_install_property (object_class,
347 g_param_spec_float ("alignment",
349 P_("X Alignment of the column header text or widget"),
353 GTK_PARAM_READWRITE));
355 g_object_class_install_property (object_class,
357 g_param_spec_boolean ("reorderable",
359 P_("Whether the column can be reordered around the headers"),
361 GTK_PARAM_READWRITE));
363 g_object_class_install_property (object_class,
365 g_param_spec_boolean ("sort-indicator",
366 P_("Sort indicator"),
367 P_("Whether to show a sort indicator"),
369 GTK_PARAM_READWRITE));
371 g_object_class_install_property (object_class,
373 g_param_spec_enum ("sort-order",
375 P_("Sort direction the sort indicator should indicate"),
378 GTK_PARAM_READWRITE));
381 * GtkTreeViewColumn:sort-column-id:
383 * Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header
384 * clickable. Set to %-1 to make the column unsortable.
388 g_object_class_install_property (object_class,
390 g_param_spec_int ("sort-column-id",
391 P_("Sort column ID"),
392 P_("Logical sort column ID this column sorts on when selected for sorting"),
396 GTK_PARAM_READWRITE));
399 * GtkTreeViewColumn:cell-area:
401 * The #GtkCellArea used to layout cell renderers for this column.
405 g_object_class_install_property (object_class,
407 g_param_spec_object ("cell-area",
409 P_("The GtkCellArea used to layout cells"),
411 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
413 g_type_class_add_private (class, sizeof (GtkTreeViewColumnPrivate));
417 gtk_tree_view_column_custom_tag_end (GtkBuildable *buildable,
420 const gchar *tagname,
423 /* Just ignore the boolean return from here */
424 _gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname, data);
428 gtk_tree_view_column_buildable_init (GtkBuildableIface *iface)
430 iface->add_child = _gtk_cell_layout_buildable_add_child;
431 iface->custom_tag_start = _gtk_cell_layout_buildable_custom_tag_start;
432 iface->custom_tag_end = gtk_tree_view_column_custom_tag_end;
436 gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface)
438 iface->get_area = gtk_tree_view_column_cell_layout_get_area;
442 gtk_tree_view_column_init (GtkTreeViewColumn *tree_column)
444 GtkTreeViewColumnPrivate *priv;
446 tree_column->priv = G_TYPE_INSTANCE_GET_PRIVATE (tree_column,
447 GTK_TYPE_TREE_VIEW_COLUMN,
448 GtkTreeViewColumnPrivate);
449 priv = tree_column->priv;
455 priv->min_width = -1;
456 priv->max_width = -1;
457 priv->resized_width = 0;
458 priv->column_type = GTK_TREE_VIEW_COLUMN_GROW_ONLY;
459 priv->visible = TRUE;
460 priv->resizable = FALSE;
461 priv->expand = FALSE;
462 priv->clickable = FALSE;
464 priv->sort_order = GTK_SORT_ASCENDING;
465 priv->show_sort_indicator = FALSE;
466 priv->property_changed_signal = 0;
467 priv->sort_clicked_signal = 0;
468 priv->sort_column_changed_signal = 0;
469 priv->sort_column_id = -1;
470 priv->reorderable = FALSE;
471 priv->maybe_reordered = FALSE;
472 priv->fixed_width = 1;
473 priv->use_resized_width = FALSE;
474 priv->title = g_strdup ("");
478 gtk_tree_view_column_constructor (GType type,
479 guint n_construct_properties,
480 GObjectConstructParam *construct_properties)
482 GtkTreeViewColumn *tree_column;
483 GtkTreeViewColumnPrivate *priv;
486 object = G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->constructor
487 (type, n_construct_properties, construct_properties);
489 tree_column = (GtkTreeViewColumn *) object;
490 priv = tree_column->priv;
492 if (!priv->cell_area)
494 priv->cell_area = gtk_cell_area_box_new ();
495 g_object_ref_sink (priv->cell_area);
498 gtk_cell_area_set_style_detail (priv->cell_area, "treeview");
500 priv->add_editable_signal =
501 g_signal_connect (priv->cell_area, "add-editable",
502 G_CALLBACK (gtk_tree_view_column_add_editable_callback),
504 priv->remove_editable_signal =
505 g_signal_connect (priv->cell_area, "remove-editable",
506 G_CALLBACK (gtk_tree_view_column_remove_editable_callback),
509 priv->cell_area_context = gtk_cell_area_create_context (priv->cell_area);
511 priv->context_changed_signal =
512 g_signal_connect (priv->cell_area_context, "notify",
513 G_CALLBACK (gtk_tree_view_column_context_changed), tree_column);
519 gtk_tree_view_column_dispose (GObject *object)
521 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
522 GtkTreeViewColumnPrivate *priv = tree_column->priv;
524 if (priv->cell_area_context)
526 g_signal_handler_disconnect (priv->cell_area_context,
527 priv->context_changed_signal);
529 g_object_unref (priv->cell_area_context);
531 priv->cell_area_context = NULL;
532 priv->context_changed_signal = 0;
537 g_signal_handler_disconnect (priv->cell_area,
538 priv->add_editable_signal);
539 g_signal_handler_disconnect (priv->cell_area,
540 priv->remove_editable_signal);
542 g_object_unref (priv->cell_area);
543 priv->cell_area = NULL;
544 priv->add_editable_signal = 0;
545 priv->remove_editable_signal = 0;
550 g_object_unref (priv->child);
554 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->dispose (object);
558 gtk_tree_view_column_finalize (GObject *object)
560 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
561 GtkTreeViewColumnPrivate *priv = tree_column->priv;
563 g_free (priv->title);
565 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->finalize (object);
569 gtk_tree_view_column_set_property (GObject *object,
574 GtkTreeViewColumn *tree_column;
577 tree_column = GTK_TREE_VIEW_COLUMN (object);
582 gtk_tree_view_column_set_visible (tree_column,
583 g_value_get_boolean (value));
587 gtk_tree_view_column_set_resizable (tree_column,
588 g_value_get_boolean (value));
592 gtk_tree_view_column_set_sizing (tree_column,
593 g_value_get_enum (value));
596 case PROP_FIXED_WIDTH:
597 gtk_tree_view_column_set_fixed_width (tree_column,
598 g_value_get_int (value));
602 gtk_tree_view_column_set_min_width (tree_column,
603 g_value_get_int (value));
607 gtk_tree_view_column_set_max_width (tree_column,
608 g_value_get_int (value));
612 gtk_tree_view_column_set_spacing (tree_column,
613 g_value_get_int (value));
617 gtk_tree_view_column_set_title (tree_column,
618 g_value_get_string (value));
622 gtk_tree_view_column_set_expand (tree_column,
623 g_value_get_boolean (value));
627 gtk_tree_view_column_set_clickable (tree_column,
628 g_value_get_boolean (value));
632 gtk_tree_view_column_set_widget (tree_column,
633 (GtkWidget*) g_value_get_object (value));
637 gtk_tree_view_column_set_alignment (tree_column,
638 g_value_get_float (value));
641 case PROP_REORDERABLE:
642 gtk_tree_view_column_set_reorderable (tree_column,
643 g_value_get_boolean (value));
646 case PROP_SORT_INDICATOR:
647 gtk_tree_view_column_set_sort_indicator (tree_column,
648 g_value_get_boolean (value));
651 case PROP_SORT_ORDER:
652 gtk_tree_view_column_set_sort_order (tree_column,
653 g_value_get_enum (value));
656 case PROP_SORT_COLUMN_ID:
657 gtk_tree_view_column_set_sort_column_id (tree_column,
658 g_value_get_int (value));
662 /* Construct-only, can only be assigned once */
663 area = g_value_get_object (value);
666 tree_column->priv->cell_area = g_object_ref_sink (area);
670 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
676 gtk_tree_view_column_get_property (GObject *object,
681 GtkTreeViewColumn *tree_column;
683 tree_column = GTK_TREE_VIEW_COLUMN (object);
688 g_value_set_boolean (value,
689 gtk_tree_view_column_get_visible (tree_column));
693 g_value_set_boolean (value,
694 gtk_tree_view_column_get_resizable (tree_column));
698 g_value_set_int (value,
699 gtk_tree_view_column_get_width (tree_column));
703 g_value_set_int (value,
704 gtk_tree_view_column_get_spacing (tree_column));
708 g_value_set_enum (value,
709 gtk_tree_view_column_get_sizing (tree_column));
712 case PROP_FIXED_WIDTH:
713 g_value_set_int (value,
714 gtk_tree_view_column_get_fixed_width (tree_column));
718 g_value_set_int (value,
719 gtk_tree_view_column_get_min_width (tree_column));
723 g_value_set_int (value,
724 gtk_tree_view_column_get_max_width (tree_column));
728 g_value_set_string (value,
729 gtk_tree_view_column_get_title (tree_column));
733 g_value_set_boolean (value,
734 gtk_tree_view_column_get_expand (tree_column));
738 g_value_set_boolean (value,
739 gtk_tree_view_column_get_clickable (tree_column));
743 g_value_set_object (value,
744 (GObject*) gtk_tree_view_column_get_widget (tree_column));
748 g_value_set_float (value,
749 gtk_tree_view_column_get_alignment (tree_column));
752 case PROP_REORDERABLE:
753 g_value_set_boolean (value,
754 gtk_tree_view_column_get_reorderable (tree_column));
757 case PROP_SORT_INDICATOR:
758 g_value_set_boolean (value,
759 gtk_tree_view_column_get_sort_indicator (tree_column));
762 case PROP_SORT_ORDER:
763 g_value_set_enum (value,
764 gtk_tree_view_column_get_sort_order (tree_column));
767 case PROP_SORT_COLUMN_ID:
768 g_value_set_int (value,
769 gtk_tree_view_column_get_sort_column_id (tree_column));
773 g_value_set_object (value, tree_column->priv->cell_area);
777 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
782 /* Implementation of GtkCellLayout interface
785 gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout)
787 GtkTreeViewColumn *column = GTK_TREE_VIEW_COLUMN (cell_layout);
788 GtkTreeViewColumnPrivate *priv = column->priv;
790 return priv->cell_area;
793 /* Button handling code
796 gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column)
798 GtkTreeViewColumnPrivate *priv = tree_column->priv;
799 GtkTreeView *tree_view;
803 tree_view = (GtkTreeView *) priv->tree_view;
805 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
806 g_return_if_fail (priv->button == NULL);
808 gtk_widget_push_composite_child ();
809 priv->button = gtk_button_new ();
810 gtk_widget_add_events (priv->button, GDK_POINTER_MOTION_MASK);
811 gtk_widget_pop_composite_child ();
813 /* make sure we own a reference to it as well. */
814 if (_gtk_tree_view_get_header_window (tree_view))
815 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
817 gtk_widget_set_parent (priv->button, GTK_WIDGET (tree_view));
819 g_signal_connect (priv->button, "event",
820 G_CALLBACK (gtk_tree_view_column_button_event),
822 g_signal_connect (priv->button, "clicked",
823 G_CALLBACK (gtk_tree_view_column_button_clicked),
826 priv->alignment = gtk_alignment_new (priv->xalign, 0.5, 0.0, 0.0);
828 hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 2);
829 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_IN);
835 child = gtk_label_new (priv->title);
836 gtk_widget_show (child);
839 g_signal_connect (child, "mnemonic-activate",
840 G_CALLBACK (gtk_tree_view_column_mnemonic_activate),
843 if (priv->xalign <= 0.5)
844 gtk_box_pack_end (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
846 gtk_box_pack_start (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
848 gtk_box_pack_start (GTK_BOX (hbox), priv->alignment, TRUE, TRUE, 0);
850 gtk_container_add (GTK_CONTAINER (priv->alignment), child);
851 gtk_container_add (GTK_CONTAINER (priv->button), hbox);
853 gtk_widget_show (hbox);
854 gtk_widget_show (priv->alignment);
855 gtk_tree_view_column_update_button (tree_column);
859 gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column)
861 GtkTreeViewColumnPrivate *priv = tree_column->priv;
862 gint sort_column_id = -1;
864 GtkWidget *alignment;
866 GtkWidget *current_child;
867 GtkArrowType arrow_type = GTK_ARROW_NONE;
871 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
875 /* Create a button if necessary */
877 priv->button == NULL &&
879 gtk_widget_get_realized (priv->tree_view))
880 gtk_tree_view_column_create_button (tree_column);
885 hbox = gtk_bin_get_child (GTK_BIN (priv->button));
886 alignment = priv->alignment;
888 current_child = gtk_bin_get_child (GTK_BIN (alignment));
890 /* Set up the actual button */
891 gtk_alignment_set (GTK_ALIGNMENT (alignment), priv->xalign,
896 if (current_child != priv->child)
898 gtk_container_remove (GTK_CONTAINER (alignment),
900 gtk_container_add (GTK_CONTAINER (alignment),
906 if (current_child == NULL)
908 current_child = gtk_label_new (NULL);
909 gtk_widget_show (current_child);
910 gtk_container_add (GTK_CONTAINER (alignment),
914 g_return_if_fail (GTK_IS_LABEL (current_child));
917 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
920 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
924 if (GTK_IS_TREE_SORTABLE (model))
925 gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
929 if (priv->show_sort_indicator)
931 gboolean alternative;
933 g_object_get (gtk_widget_get_settings (priv->tree_view),
934 "gtk-alternative-sort-arrows", &alternative,
937 switch (priv->sort_order)
939 case GTK_SORT_ASCENDING:
940 arrow_type = alternative ? GTK_ARROW_UP : GTK_ARROW_DOWN;
943 case GTK_SORT_DESCENDING:
944 arrow_type = alternative ? GTK_ARROW_DOWN : GTK_ARROW_UP;
948 g_warning (G_STRLOC": bad sort order");
953 gtk_arrow_set (GTK_ARROW (arrow),
957 /* Put arrow on the right if the text is left-or-center justified, and on the
958 * left otherwise; do this by packing boxes, so flipping text direction will
961 g_object_ref (arrow);
962 gtk_container_remove (GTK_CONTAINER (hbox), arrow);
964 if (priv->xalign <= 0.5)
966 gtk_box_pack_end (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
970 gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
971 /* move it to the front */
972 gtk_box_reorder_child (GTK_BOX (hbox), arrow, 0);
974 g_object_unref (arrow);
976 if (priv->show_sort_indicator
977 || (GTK_IS_TREE_SORTABLE (model) && priv->sort_column_id >= 0))
978 gtk_widget_show (arrow);
980 gtk_widget_hide (arrow);
982 /* It's always safe to hide the button. It isn't always safe to show it, as
983 * if you show it before it's realized, it'll get the wrong window. */
985 priv->tree_view != NULL &&
986 gtk_widget_get_realized (priv->tree_view))
990 gtk_widget_show_now (priv->button);
995 gdk_window_show (priv->window);
996 gdk_window_raise (priv->window);
1000 gdk_window_hide (priv->window);
1006 gtk_widget_hide (priv->button);
1008 gdk_window_hide (priv->window);
1012 if (priv->reorderable || priv->clickable)
1014 gtk_widget_set_can_focus (priv->button, TRUE);
1018 gtk_widget_set_can_focus (priv->button, FALSE);
1019 if (gtk_widget_has_focus (priv->button))
1021 GtkWidget *toplevel = gtk_widget_get_toplevel (priv->tree_view);
1022 if (gtk_widget_is_toplevel (toplevel))
1024 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1028 /* Queue a resize on the assumption that we always want to catch all changes
1029 * and columns don't change all that often.
1031 if (gtk_widget_get_realized (priv->tree_view))
1032 gtk_widget_queue_resize (priv->tree_view);
1036 /* Button signal handlers
1040 gtk_tree_view_column_button_event (GtkWidget *widget,
1044 GtkTreeViewColumn *column = (GtkTreeViewColumn *) data;
1045 GtkTreeViewColumnPrivate *priv = column->priv;
1047 g_return_val_if_fail (event != NULL, FALSE);
1049 if (event->type == GDK_BUTTON_PRESS &&
1050 priv->reorderable &&
1051 ((GdkEventButton *)event)->button == 1)
1053 priv->maybe_reordered = TRUE;
1054 gdk_window_get_pointer (gtk_button_get_event_window (GTK_BUTTON (widget)),
1058 gtk_widget_grab_focus (widget);
1061 if (event->type == GDK_BUTTON_RELEASE ||
1062 event->type == GDK_LEAVE_NOTIFY)
1063 priv->maybe_reordered = FALSE;
1065 if (event->type == GDK_MOTION_NOTIFY &&
1066 priv->maybe_reordered &&
1067 (gtk_drag_check_threshold (widget,
1070 (gint) ((GdkEventMotion *)event)->x,
1071 (gint) ((GdkEventMotion *)event)->y)))
1073 priv->maybe_reordered = FALSE;
1074 _gtk_tree_view_column_start_drag (GTK_TREE_VIEW (priv->tree_view), column,
1075 event->motion.device);
1079 if (priv->clickable == FALSE)
1081 switch (event->type)
1083 case GDK_BUTTON_PRESS:
1084 case GDK_2BUTTON_PRESS:
1085 case GDK_3BUTTON_PRESS:
1086 case GDK_MOTION_NOTIFY:
1087 case GDK_BUTTON_RELEASE:
1088 case GDK_ENTER_NOTIFY:
1089 case GDK_LEAVE_NOTIFY:
1100 gtk_tree_view_column_button_clicked (GtkWidget *widget, gpointer data)
1102 g_signal_emit_by_name (data, "clicked");
1106 gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
1107 gboolean group_cycling,
1110 GtkTreeViewColumn *column = (GtkTreeViewColumn *)data;
1111 GtkTreeViewColumnPrivate *priv = column->priv;
1113 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (column), FALSE);
1115 _gtk_tree_view_set_focus_column (GTK_TREE_VIEW (priv->tree_view), column);
1117 if (priv->clickable)
1118 gtk_button_clicked (GTK_BUTTON (priv->button));
1119 else if (gtk_widget_get_can_focus (priv->button))
1120 gtk_widget_grab_focus (priv->button);
1122 gtk_widget_grab_focus (priv->tree_view);
1128 gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
1129 GtkTreeViewColumn *column)
1131 GtkTreeViewColumnPrivate *priv = column->priv;
1132 gint sort_column_id;
1135 if (gtk_tree_sortable_get_sort_column_id (sortable,
1139 if (sort_column_id == priv->sort_column_id)
1141 gtk_tree_view_column_set_sort_indicator (column, TRUE);
1142 gtk_tree_view_column_set_sort_order (column, order);
1146 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1151 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1156 gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
1159 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1160 GtkTreeModel *model;
1161 GtkTreeSortable *sortable;
1162 gint sort_column_id;
1164 gboolean has_sort_column;
1165 gboolean has_default_sort_func;
1167 g_return_if_fail (priv->tree_view != NULL);
1169 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1170 sortable = GTK_TREE_SORTABLE (model);
1173 gtk_tree_sortable_get_sort_column_id (sortable,
1176 has_default_sort_func =
1177 gtk_tree_sortable_has_default_sort_func (sortable);
1179 if (has_sort_column &&
1180 sort_column_id == priv->sort_column_id)
1182 if (order == GTK_SORT_ASCENDING)
1183 gtk_tree_sortable_set_sort_column_id (sortable,
1184 priv->sort_column_id,
1185 GTK_SORT_DESCENDING);
1186 else if (order == GTK_SORT_DESCENDING && has_default_sort_func)
1187 gtk_tree_sortable_set_sort_column_id (sortable,
1188 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID,
1189 GTK_SORT_ASCENDING);
1191 gtk_tree_sortable_set_sort_column_id (sortable,
1192 priv->sort_column_id,
1193 GTK_SORT_ASCENDING);
1197 gtk_tree_sortable_set_sort_column_id (sortable,
1198 priv->sort_column_id,
1199 GTK_SORT_ASCENDING);
1204 gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column)
1206 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1207 GtkTreeModel *model;
1209 if (priv->tree_view == NULL)
1212 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1217 if (GTK_IS_TREE_SORTABLE (model) &&
1218 priv->sort_column_id != -1)
1220 gint real_sort_column_id;
1221 GtkSortType real_order;
1223 if (priv->sort_column_changed_signal == 0)
1224 priv->sort_column_changed_signal =
1225 g_signal_connect (model, "sort-column-changed",
1226 G_CALLBACK (gtk_tree_view_model_sort_column_changed),
1229 if (gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
1230 &real_sort_column_id,
1232 (real_sort_column_id == priv->sort_column_id))
1234 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
1235 gtk_tree_view_column_set_sort_order (tree_column, real_order);
1239 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
1245 gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
1247 GtkTreeViewColumn *tree_column)
1249 /* Here we want the column re-requested if the underlying context was
1250 * actually reset for any reason, this can happen if the underlying
1251 * area/cell configuration changes (i.e. cell packing properties
1252 * or cell spacing and the like)
1254 * Note that we block this handler while requesting for sizes
1255 * so there is no need to check for the new context size being -1,
1256 * we also block the handler when explicitly resetting the context
1257 * so as to avoid some infinite stack recursion.
1259 if (!strcmp (pspec->name, "minimum-width") ||
1260 !strcmp (pspec->name, "natural-width") ||
1261 !strcmp (pspec->name, "minimum-height") ||
1262 !strcmp (pspec->name, "natural-height"))
1263 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1267 gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
1268 GtkCellRenderer *renderer,
1269 GtkCellEditable *edit_widget,
1270 GdkRectangle *cell_area,
1271 const gchar *path_string,
1274 GtkTreeViewColumn *column = user_data;
1275 GtkTreeViewColumnPrivate *priv = column->priv;
1278 if (priv->tree_view)
1280 path = gtk_tree_path_new_from_string (path_string);
1282 _gtk_tree_view_add_editable (GTK_TREE_VIEW (priv->tree_view),
1288 gtk_tree_path_free (path);
1293 gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
1294 GtkCellRenderer *renderer,
1295 GtkCellEditable *edit_widget,
1298 GtkTreeViewColumn *column = user_data;
1299 GtkTreeViewColumnPrivate *priv = column->priv;
1301 if (priv->tree_view)
1302 _gtk_tree_view_remove_editable (GTK_TREE_VIEW (priv->tree_view),
1307 /* Exported Private Functions.
1308 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
1311 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
1313 GtkTreeViewColumnPrivate *priv = column->priv;
1314 GtkAllocation allocation;
1315 GtkTreeView *tree_view;
1317 guint attributes_mask;
1320 tree_view = (GtkTreeView *)priv->tree_view;
1321 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
1323 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
1324 g_return_if_fail (gtk_widget_get_realized (priv->tree_view));
1325 g_return_if_fail (priv->button != NULL);
1327 g_return_if_fail (_gtk_tree_view_get_header_window (tree_view) != NULL);
1328 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
1331 gtk_widget_show (priv->button);
1333 attr.window_type = GDK_WINDOW_CHILD;
1334 attr.wclass = GDK_INPUT_ONLY;
1335 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
1336 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view)) |
1337 (GDK_BUTTON_PRESS_MASK |
1338 GDK_BUTTON_RELEASE_MASK |
1339 GDK_POINTER_MOTION_MASK |
1340 GDK_POINTER_MOTION_HINT_MASK |
1341 GDK_KEY_PRESS_MASK);
1342 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
1343 attr.cursor = gdk_cursor_new_for_display
1344 (gdk_window_get_display (_gtk_tree_view_get_header_window (tree_view)), GDK_SB_H_DOUBLE_ARROW);
1346 attr.width = TREE_VIEW_DRAG_WIDTH;
1347 attr.height = _gtk_tree_view_get_header_height (tree_view);
1349 gtk_widget_get_allocation (priv->button, &allocation);
1350 attr.x = (allocation.x + (rtl ? 0 : allocation.width)) - TREE_VIEW_DRAG_WIDTH / 2;
1351 priv->window = gdk_window_new (_gtk_tree_view_get_header_window (tree_view),
1352 &attr, attributes_mask);
1353 gdk_window_set_user_data (priv->window, tree_view);
1355 gtk_tree_view_column_update_button (column);
1357 g_object_unref (attr.cursor);
1361 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
1363 GtkTreeViewColumnPrivate *priv;
1365 g_return_if_fail (column != NULL);
1367 priv = column->priv;
1368 g_return_if_fail (priv->window != NULL);
1370 gdk_window_set_user_data (priv->window, NULL);
1371 gdk_window_destroy (priv->window);
1372 priv->window = NULL;
1376 _gtk_tree_view_column_unset_model (GtkTreeViewColumn *column,
1377 GtkTreeModel *old_model)
1379 GtkTreeViewColumnPrivate *priv = column->priv;
1381 if (priv->sort_column_changed_signal)
1383 g_signal_handler_disconnect (old_model,
1384 priv->sort_column_changed_signal);
1385 priv->sort_column_changed_signal = 0;
1387 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1391 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
1392 GtkTreeView *tree_view)
1394 GtkTreeViewColumnPrivate *priv = column->priv;
1396 g_assert (priv->tree_view == NULL);
1398 priv->tree_view = GTK_WIDGET (tree_view);
1399 gtk_tree_view_column_create_button (column);
1401 priv->property_changed_signal =
1402 g_signal_connect_swapped (tree_view,
1404 G_CALLBACK (gtk_tree_view_column_setup_sort_column_id_callback),
1407 gtk_tree_view_column_setup_sort_column_id_callback (column);
1411 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
1413 GtkTreeViewColumnPrivate *priv = column->priv;
1415 if (priv->tree_view && priv->button)
1417 gtk_container_remove (GTK_CONTAINER (priv->tree_view), priv->button);
1419 if (priv->property_changed_signal)
1421 g_signal_handler_disconnect (priv->tree_view, priv->property_changed_signal);
1422 priv->property_changed_signal = 0;
1425 if (priv->sort_column_changed_signal)
1427 g_signal_handler_disconnect (gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view)),
1428 priv->sort_column_changed_signal);
1429 priv->sort_column_changed_signal = 0;
1432 priv->tree_view = NULL;
1433 priv->button = NULL;
1437 _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column)
1439 GtkTreeViewColumnPrivate *priv = column->priv;
1440 gboolean ret = FALSE;
1441 GList *list, *cells;
1443 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
1445 for (list = cells; list; list = list->next)
1447 GtkCellRenderer *cell = list->data;
1448 GtkCellRendererMode mode;
1450 g_object_get (cell, "mode", &mode, NULL);
1452 if (mode == GTK_CELL_RENDERER_MODE_EDITABLE)
1459 g_list_free (cells);
1464 /* gets cell being edited */
1466 _gtk_tree_view_column_get_edited_cell (GtkTreeViewColumn *column)
1468 GtkTreeViewColumnPrivate *priv = column->priv;
1470 return gtk_cell_area_get_edited_cell (priv->cell_area);
1474 _gtk_tree_view_column_get_cell_at_pos (GtkTreeViewColumn *column,
1475 GdkRectangle *cell_area,
1476 GdkRectangle *background_area,
1480 GtkCellRenderer *match = NULL;
1481 GtkTreeViewColumnPrivate *priv = column->priv;
1483 /* If (x, y) is outside of the background area, immediately return */
1484 if (x < background_area->x ||
1485 x > background_area->x + background_area->width ||
1486 y < background_area->y ||
1487 y > background_area->y + background_area->height)
1490 /* If (x, y) is inside the background area, clamp it to the cell_area
1491 * so that a cell is still returned. The main reason for doing this
1492 * (on the x axis) is for handling clicks in the indentation area
1493 * (either at the left or right depending on RTL setting). Another
1494 * reason is for handling clicks on the area where the focus rectangle
1495 * is drawn (this is outside of cell area), this manifests itself
1496 * mainly when a large setting is used for focus-line-width.
1498 if (x < cell_area->x)
1500 else if (x > cell_area->x + cell_area->width)
1501 x = cell_area->x + cell_area->width;
1503 if (y < cell_area->y)
1505 else if (y > cell_area->y + cell_area->height)
1506 y = cell_area->y + cell_area->height;
1508 match = gtk_cell_area_get_cell_at_position (priv->cell_area,
1509 priv->cell_area_context,
1518 /* Public Functions */
1522 * gtk_tree_view_column_new:
1524 * Creates a new #GtkTreeViewColumn.
1526 * Return value: A newly created #GtkTreeViewColumn.
1529 gtk_tree_view_column_new (void)
1531 GtkTreeViewColumn *tree_column;
1533 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, NULL);
1539 * gtk_tree_view_column_new_with_area:
1540 * @area: the #GtkCellArea that the newly created column should use to layout cells.
1542 * Creates a new #GtkTreeViewColumn using @area to render it's cells.
1544 * Return value: A newly created #GtkTreeViewColumn.
1549 gtk_tree_view_column_new_with_area (GtkCellArea *area)
1551 GtkTreeViewColumn *tree_column;
1553 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, "cell-area", area, NULL);
1560 * gtk_tree_view_column_new_with_attributes:
1561 * @title: The title to set the header to.
1562 * @cell: The #GtkCellRenderer.
1563 * @Varargs: A %NULL-terminated list of attributes.
1565 * Creates a new #GtkTreeViewColumn with a number of default values. This is
1566 * equivalent to calling gtk_tree_view_column_set_title(),
1567 * gtk_tree_view_column_pack_start(), and
1568 * gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn.
1570 * Here's a simple example:
1572 * enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
1575 * GtkTreeViewColumn *column;
1576 * GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
1578 * column = gtk_tree_view_column_new_with_attributes ("Title",
1580 * "text", TEXT_COLUMN,
1581 * "foreground", COLOR_COLUMN,
1586 * Return value: A newly created #GtkTreeViewColumn.
1589 gtk_tree_view_column_new_with_attributes (const gchar *title,
1590 GtkCellRenderer *cell,
1593 GtkTreeViewColumn *retval;
1596 retval = gtk_tree_view_column_new ();
1598 gtk_tree_view_column_set_title (retval, title);
1599 gtk_tree_view_column_pack_start (retval, cell, TRUE);
1601 va_start (args, cell);
1602 gtk_tree_view_column_set_attributesv (retval, cell, args);
1609 * gtk_tree_view_column_pack_start:
1610 * @tree_column: A #GtkTreeViewColumn.
1611 * @cell: The #GtkCellRenderer.
1612 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1614 * Packs the @cell into the beginning of the column. If @expand is %FALSE, then
1615 * the @cell is allocated no more space than it needs. Any unused space is divided
1616 * evenly between cells for which @expand is %TRUE.
1619 gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
1620 GtkCellRenderer *cell,
1623 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (tree_column), cell, expand);
1627 * gtk_tree_view_column_pack_end:
1628 * @tree_column: A #GtkTreeViewColumn.
1629 * @cell: The #GtkCellRenderer.
1630 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1632 * Adds the @cell to end of the column. If @expand is %FALSE, then the @cell
1633 * is allocated no more space than it needs. Any unused space is divided
1634 * evenly between cells for which @expand is %TRUE.
1637 gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
1638 GtkCellRenderer *cell,
1641 gtk_cell_layout_pack_end (GTK_CELL_LAYOUT (tree_column), cell, expand);
1645 * gtk_tree_view_column_clear:
1646 * @tree_column: A #GtkTreeViewColumn
1648 * Unsets all the mappings on all renderers on the @tree_column.
1651 gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column)
1653 gtk_cell_layout_clear (GTK_CELL_LAYOUT (tree_column));
1657 * gtk_tree_view_column_add_attribute:
1658 * @tree_column: A #GtkTreeViewColumn.
1659 * @cell_renderer: the #GtkCellRenderer to set attributes on
1660 * @attribute: An attribute on the renderer
1661 * @column: The column position on the model to get the attribute from.
1663 * Adds an attribute mapping to the list in @tree_column. The @column is the
1664 * column of the model to get a value from, and the @attribute is the
1665 * parameter on @cell_renderer to be set from the value. So for example
1666 * if column 2 of the model contains strings, you could have the
1667 * "text" attribute of a #GtkCellRendererText get its values from
1671 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1672 GtkCellRenderer *cell_renderer,
1673 const gchar *attribute,
1676 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (tree_column),
1677 cell_renderer, attribute, column);
1681 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1682 GtkCellRenderer *cell_renderer,
1685 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1689 attribute = va_arg (args, gchar *);
1691 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (priv->cell_area),
1694 while (attribute != NULL)
1696 column = va_arg (args, gint);
1697 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (priv->cell_area),
1698 cell_renderer, attribute, column);
1699 attribute = va_arg (args, gchar *);
1704 * gtk_tree_view_column_set_attributes:
1705 * @tree_column: A #GtkTreeViewColumn.
1706 * @cell_renderer: the #GtkCellRenderer we're setting the attributes of
1707 * @Varargs: A %NULL-terminated list of attributes.
1709 * Sets the attributes in the list as the attributes of @tree_column.
1710 * The attributes should be in attribute/column order, as in
1711 * gtk_tree_view_column_add_attribute(). All existing attributes
1712 * are removed, and replaced with the new attributes.
1715 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1716 GtkCellRenderer *cell_renderer,
1721 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1722 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1724 va_start (args, cell_renderer);
1725 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1731 * gtk_tree_view_column_set_cell_data_func:
1732 * @tree_column: A #GtkTreeViewColumn
1733 * @cell_renderer: A #GtkCellRenderer
1734 * @func: The #GtkTreeViewColumnFunc to use.
1735 * @func_data: The user data for @func.
1736 * @destroy: The destroy notification for @func_data
1738 * Sets the #GtkTreeViewColumnFunc to use for the column. This
1739 * function is used instead of the standard attributes mapping for
1740 * setting the column value, and should set the value of @tree_column's
1741 * cell renderer as appropriate. @func may be %NULL to remove an
1745 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1746 GtkCellRenderer *cell_renderer,
1747 GtkTreeCellDataFunc func,
1749 GDestroyNotify destroy)
1751 gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT (tree_column),
1753 (GtkCellLayoutDataFunc)func,
1754 func_data, destroy);
1759 * gtk_tree_view_column_clear_attributes:
1760 * @tree_column: a #GtkTreeViewColumn
1761 * @cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1763 * Clears all existing attributes previously set with
1764 * gtk_tree_view_column_set_attributes().
1767 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1768 GtkCellRenderer *cell_renderer)
1770 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (tree_column),
1775 * gtk_tree_view_column_set_spacing:
1776 * @tree_column: A #GtkTreeViewColumn.
1777 * @spacing: distance between cell renderers in pixels.
1779 * Sets the spacing field of @tree_column, which is the number of pixels to
1780 * place between cell renderers packed into it.
1783 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1786 GtkTreeViewColumnPrivate *priv;
1788 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1789 g_return_if_fail (spacing >= 0);
1791 priv = tree_column->priv;
1793 gtk_cell_area_box_set_spacing (GTK_CELL_AREA_BOX (priv->cell_area),
1795 if (priv->tree_view)
1796 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1800 * gtk_tree_view_column_get_spacing:
1801 * @tree_column: A #GtkTreeViewColumn.
1803 * Returns the spacing of @tree_column.
1805 * Return value: the spacing of @tree_column.
1808 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1810 GtkTreeViewColumnPrivate *priv;
1812 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1814 priv = tree_column->priv;
1816 return gtk_cell_area_box_get_spacing (GTK_CELL_AREA_BOX (priv->cell_area));
1819 /* Options for manipulating the columns */
1822 * gtk_tree_view_column_set_visible:
1823 * @tree_column: A #GtkTreeViewColumn.
1824 * @visible: %TRUE if the @tree_column is visible.
1826 * Sets the visibility of @tree_column.
1829 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1832 GtkTreeViewColumnPrivate *priv;
1834 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1836 priv = tree_column->priv;
1837 visible = !! visible;
1839 if (priv->visible == visible)
1842 priv->visible = visible;
1845 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1847 gtk_tree_view_column_update_button (tree_column);
1848 g_object_notify (G_OBJECT (tree_column), "visible");
1852 * gtk_tree_view_column_get_visible:
1853 * @tree_column: A #GtkTreeViewColumn.
1855 * Returns %TRUE if @tree_column is visible.
1857 * Return value: whether the column is visible or not. If it is visible, then
1858 * the tree will show the column.
1861 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1863 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1865 return tree_column->priv->visible;
1869 * gtk_tree_view_column_set_resizable:
1870 * @tree_column: A #GtkTreeViewColumn
1871 * @resizable: %TRUE, if the column can be resized
1873 * If @resizable is %TRUE, then the user can explicitly resize the column by
1874 * grabbing the outer edge of the column button. If resizable is %TRUE and
1875 * sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing
1876 * mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY.
1879 gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
1882 GtkTreeViewColumnPrivate *priv;
1884 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1886 priv = tree_column->priv;
1887 resizable = !! resizable;
1889 if (priv->resizable == resizable)
1892 priv->resizable = resizable;
1894 if (resizable && priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1895 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_GROW_ONLY);
1897 gtk_tree_view_column_update_button (tree_column);
1899 g_object_notify (G_OBJECT (tree_column), "resizable");
1903 * gtk_tree_view_column_get_resizable:
1904 * @tree_column: A #GtkTreeViewColumn
1906 * Returns %TRUE if the @tree_column can be resized by the end user.
1908 * Return value: %TRUE, if the @tree_column can be resized.
1911 gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column)
1913 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1915 return tree_column->priv->resizable;
1920 * gtk_tree_view_column_set_sizing:
1921 * @tree_column: A #GtkTreeViewColumn.
1922 * @type: The #GtkTreeViewColumnSizing.
1924 * Sets the growth behavior of @tree_column to @type.
1927 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
1928 GtkTreeViewColumnSizing type)
1930 GtkTreeViewColumnPrivate *priv;
1932 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1934 priv = tree_column->priv;
1936 if (type == priv->column_type)
1939 if (type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1940 gtk_tree_view_column_set_resizable (tree_column, FALSE);
1942 priv->column_type = type;
1944 gtk_tree_view_column_update_button (tree_column);
1946 g_object_notify (G_OBJECT (tree_column), "sizing");
1950 * gtk_tree_view_column_get_sizing:
1951 * @tree_column: A #GtkTreeViewColumn.
1953 * Returns the current type of @tree_column.
1955 * Return value: The type of @tree_column.
1957 GtkTreeViewColumnSizing
1958 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
1960 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1962 return tree_column->priv->column_type;
1966 * gtk_tree_view_column_get_width:
1967 * @tree_column: A #GtkTreeViewColumn.
1969 * Returns the current size of @tree_column in pixels.
1971 * Return value: The current width of @tree_column.
1974 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
1976 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1978 return tree_column->priv->width;
1982 _gtk_tree_view_column_request_width (GtkTreeViewColumn *tree_column)
1984 GtkTreeViewColumnPrivate *priv;
1985 gint real_requested_width;
1987 priv = tree_column->priv;
1989 if (priv->use_resized_width)
1991 real_requested_width = priv->resized_width;
1993 else if (priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
1995 real_requested_width = priv->fixed_width;
1997 else if (gtk_tree_view_get_headers_visible (GTK_TREE_VIEW (priv->tree_view)))
1999 gint button_request;
2000 gint requested_width;
2002 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
2003 requested_width += priv->padding;
2005 gtk_widget_get_preferred_width (priv->button, &button_request, NULL);
2006 real_requested_width = MAX (requested_width, button_request);
2010 gint requested_width;
2012 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
2013 requested_width += priv->padding;
2015 real_requested_width = requested_width;
2016 if (real_requested_width < 0)
2017 real_requested_width = 0;
2020 if (priv->min_width != -1)
2021 real_requested_width = MAX (real_requested_width, priv->min_width);
2023 if (priv->max_width != -1)
2024 real_requested_width = MIN (real_requested_width, priv->max_width);
2026 return real_requested_width;
2030 _gtk_tree_view_column_allocate (GtkTreeViewColumn *tree_column,
2034 GtkTreeViewColumnPrivate *priv;
2035 GtkAllocation allocation;
2038 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2040 priv = tree_column->priv;
2042 priv->width = width;
2044 gtk_cell_area_context_allocate (priv->cell_area_context, priv->width - priv->padding, -1);
2046 allocation.x = x_offset;
2048 allocation.width = width;
2049 allocation.height = _gtk_tree_view_get_header_height (GTK_TREE_VIEW (priv->tree_view));
2051 gtk_widget_size_allocate (priv->button, &allocation);
2055 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
2056 gdk_window_move_resize (priv->window,
2057 allocation.x + (rtl ? 0 : allocation.width) - TREE_VIEW_DRAG_WIDTH/2,
2059 TREE_VIEW_DRAG_WIDTH, allocation.height);
2062 g_object_notify (G_OBJECT (tree_column), "width");
2066 * gtk_tree_view_column_set_fixed_width:
2067 * @tree_column: A #GtkTreeViewColumn.
2068 * @fixed_width: The size to set @tree_column to. Must be greater than 0.
2070 * Sets the size of the column in pixels. This is meaningful only if the sizing
2071 * type is #GTK_TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to
2072 * the min/max width for the column. Please note that the min/max width of the
2073 * column doesn't actually affect the "fixed_width" property of the widget, just
2074 * the actual size when displayed.
2077 gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
2080 GtkTreeViewColumnPrivate *priv;
2082 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2083 g_return_if_fail (fixed_width > 0);
2085 priv = tree_column->priv;
2087 priv->fixed_width = fixed_width;
2088 priv->use_resized_width = FALSE;
2090 if (priv->tree_view &&
2091 gtk_widget_get_realized (priv->tree_view) &&
2092 priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2094 gtk_widget_queue_resize (priv->tree_view);
2097 g_object_notify (G_OBJECT (tree_column), "fixed-width");
2101 * gtk_tree_view_column_get_fixed_width:
2102 * @tree_column: a #GtkTreeViewColumn
2104 * Gets the fixed width of the column. This value is only meaning may not be
2105 * the actual width of the column on the screen, just what is requested.
2107 * Return value: the fixed width of the column
2110 gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
2112 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2114 return tree_column->priv->fixed_width;
2118 * gtk_tree_view_column_set_min_width:
2119 * @tree_column: A #GtkTreeViewColumn.
2120 * @min_width: The minimum width of the column in pixels, or -1.
2122 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
2123 * minimum width is unset.
2126 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
2129 GtkTreeViewColumnPrivate *priv;
2131 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2132 g_return_if_fail (min_width >= -1);
2134 priv = tree_column->priv;
2136 if (min_width == priv->min_width)
2139 if (priv->visible &&
2140 priv->tree_view != NULL &&
2141 gtk_widget_get_realized (priv->tree_view))
2143 if (min_width > priv->width)
2144 gtk_widget_queue_resize (priv->tree_view);
2147 priv->min_width = min_width;
2148 g_object_freeze_notify (G_OBJECT (tree_column));
2149 if (priv->max_width != -1 && priv->max_width < min_width)
2151 priv->max_width = min_width;
2152 g_object_notify (G_OBJECT (tree_column), "max-width");
2154 g_object_notify (G_OBJECT (tree_column), "min-width");
2155 g_object_thaw_notify (G_OBJECT (tree_column));
2157 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2158 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2163 * gtk_tree_view_column_get_min_width:
2164 * @tree_column: A #GtkTreeViewColumn.
2166 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
2169 * Return value: The minimum width of the @tree_column.
2172 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
2174 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2176 return tree_column->priv->min_width;
2180 * gtk_tree_view_column_set_max_width:
2181 * @tree_column: A #GtkTreeViewColumn.
2182 * @max_width: The maximum width of the column in pixels, or -1.
2184 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
2185 * maximum width is unset. Note, the column can actually be wider than max
2186 * width if it's the last column in a view. In this case, the column expands to
2187 * fill any extra space.
2190 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
2193 GtkTreeViewColumnPrivate *priv;
2195 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2196 g_return_if_fail (max_width >= -1);
2198 priv = tree_column->priv;
2200 if (max_width == priv->max_width)
2203 if (priv->visible &&
2204 priv->tree_view != NULL &&
2205 gtk_widget_get_realized (priv->tree_view))
2207 if (max_width != -1 && max_width < priv->width)
2208 gtk_widget_queue_resize (priv->tree_view);
2211 priv->max_width = max_width;
2212 g_object_freeze_notify (G_OBJECT (tree_column));
2213 if (max_width != -1 && max_width < priv->min_width)
2215 priv->min_width = max_width;
2216 g_object_notify (G_OBJECT (tree_column), "min-width");
2218 g_object_notify (G_OBJECT (tree_column), "max-width");
2219 g_object_thaw_notify (G_OBJECT (tree_column));
2221 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2222 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2227 * gtk_tree_view_column_get_max_width:
2228 * @tree_column: A #GtkTreeViewColumn.
2230 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
2233 * Return value: The maximum width of the @tree_column.
2236 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
2238 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2240 return tree_column->priv->max_width;
2244 * gtk_tree_view_column_clicked:
2245 * @tree_column: a #GtkTreeViewColumn
2247 * Emits the "clicked" signal on the column. This function will only work if
2248 * @tree_column is clickable.
2251 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
2253 GtkTreeViewColumnPrivate *priv;
2255 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2257 priv = tree_column->priv;
2259 if (priv->visible &&
2262 gtk_button_clicked (GTK_BUTTON (priv->button));
2266 * gtk_tree_view_column_set_title:
2267 * @tree_column: A #GtkTreeViewColumn.
2268 * @title: The title of the @tree_column.
2270 * Sets the title of the @tree_column. If a custom widget has been set, then
2271 * this value is ignored.
2274 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
2277 GtkTreeViewColumnPrivate *priv;
2280 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2282 priv = tree_column->priv;
2284 new_title = g_strdup (title);
2285 g_free (priv->title);
2286 priv->title = new_title;
2288 gtk_tree_view_column_update_button (tree_column);
2289 g_object_notify (G_OBJECT (tree_column), "title");
2293 * gtk_tree_view_column_get_title:
2294 * @tree_column: A #GtkTreeViewColumn.
2296 * Returns the title of the widget.
2298 * Return value: the title of the column. This string should not be
2299 * modified or freed.
2301 G_CONST_RETURN gchar *
2302 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
2304 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2306 return tree_column->priv->title;
2310 * gtk_tree_view_column_set_expand:
2311 * @tree_column: A #GtkTreeViewColumn
2312 * @expand: %TRUE if the column should take available extra space, %FALSE if not
2314 * Sets the column to take available extra space. This space is shared equally
2315 * amongst all columns that have the expand set to %TRUE. If no column has this
2316 * option set, then the last column gets all extra space. By default, every
2317 * column is created with this %FALSE.
2322 gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
2325 GtkTreeViewColumnPrivate *priv;
2327 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2329 priv = tree_column->priv;
2331 expand = expand?TRUE:FALSE;
2332 if (priv->expand == expand)
2334 priv->expand = expand;
2336 if (priv->visible &&
2337 priv->tree_view != NULL &&
2338 gtk_widget_get_realized (priv->tree_view))
2340 /* We want to continue using the original width of the
2341 * column that includes additional space added by the user
2342 * resizing the columns and possibly extra (expanded) space, which
2343 * are not included in the resized width.
2345 priv->use_resized_width = FALSE;
2347 gtk_widget_queue_resize (priv->tree_view);
2350 g_object_notify (G_OBJECT (tree_column), "expand");
2354 * gtk_tree_view_column_get_expand:
2355 * @tree_column: a #GtkTreeViewColumn
2357 * Return %TRUE if the column expands to take any available space.
2359 * Return value: %TRUE, if the column expands
2364 gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column)
2366 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2368 return tree_column->priv->expand;
2372 * gtk_tree_view_column_set_clickable:
2373 * @tree_column: A #GtkTreeViewColumn.
2374 * @clickable: %TRUE if the header is active.
2376 * Sets the header to be active if @active is %TRUE. When the header is active,
2377 * then it can take keyboard focus, and can be clicked.
2380 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
2383 GtkTreeViewColumnPrivate *priv;
2385 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2387 priv = tree_column->priv;
2389 clickable = !! clickable;
2390 if (priv->clickable == clickable)
2393 priv->clickable = clickable;
2394 gtk_tree_view_column_update_button (tree_column);
2395 g_object_notify (G_OBJECT (tree_column), "clickable");
2399 * gtk_tree_view_column_get_clickable:
2400 * @tree_column: a #GtkTreeViewColumn
2402 * Returns %TRUE if the user can click on the header for the column.
2404 * Return value: %TRUE if user can click the column header.
2407 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
2409 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2411 return tree_column->priv->clickable;
2415 * gtk_tree_view_column_set_widget:
2416 * @tree_column: A #GtkTreeViewColumn.
2417 * @widget: (allow-none): A child #GtkWidget, or %NULL.
2419 * Sets the widget in the header to be @widget. If widget is %NULL, then the
2420 * header button is set with a #GtkLabel set to the title of @tree_column.
2423 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
2426 GtkTreeViewColumnPrivate *priv;
2428 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2429 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
2431 priv = tree_column->priv;
2434 g_object_ref_sink (widget);
2437 g_object_unref (priv->child);
2439 priv->child = widget;
2440 gtk_tree_view_column_update_button (tree_column);
2441 g_object_notify (G_OBJECT (tree_column), "widget");
2445 * gtk_tree_view_column_get_widget:
2446 * @tree_column: A #GtkTreeViewColumn.
2448 * Returns the #GtkWidget in the button on the column header.
2449 * If a custom widget has not been set then %NULL is returned.
2451 * Return value: (transfer none): The #GtkWidget in the column
2455 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
2457 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2459 return tree_column->priv->child;
2463 * gtk_tree_view_column_set_alignment:
2464 * @tree_column: A #GtkTreeViewColumn.
2465 * @xalign: The alignment, which is between [0.0 and 1.0] inclusive.
2467 * Sets the alignment of the title or custom widget inside the column header.
2468 * The alignment determines its location inside the button -- 0.0 for left, 0.5
2469 * for center, 1.0 for right.
2472 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
2475 GtkTreeViewColumnPrivate *priv;
2477 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2479 priv = tree_column->priv;
2481 xalign = CLAMP (xalign, 0.0, 1.0);
2483 if (priv->xalign == xalign)
2486 priv->xalign = xalign;
2487 gtk_tree_view_column_update_button (tree_column);
2488 g_object_notify (G_OBJECT (tree_column), "alignment");
2492 * gtk_tree_view_column_get_alignment:
2493 * @tree_column: A #GtkTreeViewColumn.
2495 * Returns the current x alignment of @tree_column. This value can range
2496 * between 0.0 and 1.0.
2498 * Return value: The current alignent of @tree_column.
2501 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
2503 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
2505 return tree_column->priv->xalign;
2509 * gtk_tree_view_column_set_reorderable:
2510 * @tree_column: A #GtkTreeViewColumn
2511 * @reorderable: %TRUE, if the column can be reordered.
2513 * If @reorderable is %TRUE, then the column can be reordered by the end user
2514 * dragging the header.
2517 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
2518 gboolean reorderable)
2520 GtkTreeViewColumnPrivate *priv;
2522 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2524 priv = tree_column->priv;
2527 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
2529 if (priv->reorderable == (reorderable?TRUE:FALSE))
2532 priv->reorderable = (reorderable?TRUE:FALSE);
2533 gtk_tree_view_column_update_button (tree_column);
2534 g_object_notify (G_OBJECT (tree_column), "reorderable");
2538 * gtk_tree_view_column_get_reorderable:
2539 * @tree_column: A #GtkTreeViewColumn
2541 * Returns %TRUE if the @tree_column can be reordered by the user.
2543 * Return value: %TRUE if the @tree_column can be reordered by the user.
2546 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
2548 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2550 return tree_column->priv->reorderable;
2555 * gtk_tree_view_column_set_sort_column_id:
2556 * @tree_column: a #GtkTreeViewColumn
2557 * @sort_column_id: The @sort_column_id of the model to sort on.
2559 * Sets the logical @sort_column_id that this column sorts on when this column
2560 * is selected for sorting. Doing so makes the column header clickable.
2563 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
2564 gint sort_column_id)
2566 GtkTreeViewColumnPrivate *priv;
2568 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2569 g_return_if_fail (sort_column_id >= -1);
2571 priv = tree_column->priv;
2573 if (priv->sort_column_id == sort_column_id)
2576 priv->sort_column_id = sort_column_id;
2578 /* Handle unsetting the id */
2579 if (sort_column_id == -1)
2581 GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
2583 if (priv->sort_clicked_signal)
2585 g_signal_handler_disconnect (tree_column, priv->sort_clicked_signal);
2586 priv->sort_clicked_signal = 0;
2589 if (priv->sort_column_changed_signal)
2591 g_signal_handler_disconnect (model, priv->sort_column_changed_signal);
2592 priv->sort_column_changed_signal = 0;
2595 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
2596 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
2597 gtk_tree_view_column_set_clickable (tree_column, FALSE);
2598 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2602 gtk_tree_view_column_set_clickable (tree_column, TRUE);
2604 if (! priv->sort_clicked_signal)
2605 priv->sort_clicked_signal = g_signal_connect (tree_column,
2607 G_CALLBACK (gtk_tree_view_column_sort),
2610 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
2611 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2615 * gtk_tree_view_column_get_sort_column_id:
2616 * @tree_column: a #GtkTreeViewColumn
2618 * Gets the logical @sort_column_id that the model sorts on when this
2619 * column is selected for sorting.
2620 * See gtk_tree_view_column_set_sort_column_id().
2622 * Return value: the current @sort_column_id for this column, or -1 if
2623 * this column can't be used for sorting.
2626 gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column)
2628 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2630 return tree_column->priv->sort_column_id;
2634 * gtk_tree_view_column_set_sort_indicator:
2635 * @tree_column: a #GtkTreeViewColumn
2636 * @setting: %TRUE to display an indicator that the column is sorted
2638 * Call this function with a @setting of %TRUE to display an arrow in
2639 * the header button indicating the column is sorted. Call
2640 * gtk_tree_view_column_set_sort_order() to change the direction of
2645 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
2648 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2650 setting = setting != FALSE;
2652 if (setting == tree_column->priv->show_sort_indicator)
2655 tree_column->priv->show_sort_indicator = setting;
2656 gtk_tree_view_column_update_button (tree_column);
2657 g_object_notify (G_OBJECT (tree_column), "sort-indicator");
2661 * gtk_tree_view_column_get_sort_indicator:
2662 * @tree_column: a #GtkTreeViewColumn
2664 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
2666 * Return value: whether the sort indicator arrow is displayed
2669 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
2671 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2673 return tree_column->priv->show_sort_indicator;
2677 * gtk_tree_view_column_set_sort_order:
2678 * @tree_column: a #GtkTreeViewColumn
2679 * @order: sort order that the sort indicator should indicate
2681 * Changes the appearance of the sort indicator.
2683 * This <emphasis>does not</emphasis> actually sort the model. Use
2684 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
2685 * support. This function is primarily for custom sorting behavior, and should
2686 * be used in conjunction with gtk_tree_sortable_set_sort_column() to do
2687 * that. For custom models, the mechanism will vary.
2689 * The sort indicator changes direction to indicate normal sort or reverse sort.
2690 * Note that you must have the sort indicator enabled to see anything when
2691 * calling this function; see gtk_tree_view_column_set_sort_indicator().
2694 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
2697 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2699 if (order == tree_column->priv->sort_order)
2702 tree_column->priv->sort_order = order;
2703 gtk_tree_view_column_update_button (tree_column);
2704 g_object_notify (G_OBJECT (tree_column), "sort-order");
2708 * gtk_tree_view_column_get_sort_order:
2709 * @tree_column: a #GtkTreeViewColumn
2711 * Gets the value set by gtk_tree_view_column_set_sort_order().
2713 * Return value: the sort order the sort indicator is indicating
2716 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2718 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2720 return tree_column->priv->sort_order;
2724 * gtk_tree_view_column_cell_set_cell_data:
2725 * @tree_column: A #GtkTreeViewColumn.
2726 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2727 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2728 * @is_expander: %TRUE, if the row has children
2729 * @is_expanded: %TRUE, if the row has visible children
2731 * Sets the cell renderer based on the @tree_model and @iter. That is, for
2732 * every attribute mapping in @tree_column, it will get a value from the set
2733 * column on the @iter, and use that value to set the attribute on the cell
2734 * renderer. This is used primarily by the #GtkTreeView.
2737 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2738 GtkTreeModel *tree_model,
2740 gboolean is_expander,
2741 gboolean is_expanded)
2743 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2745 if (tree_model == NULL)
2748 gtk_cell_area_apply_attributes (tree_column->priv->cell_area, tree_model, iter,
2749 is_expander, is_expanded);
2753 * gtk_tree_view_column_cell_get_size:
2754 * @tree_column: A #GtkTreeViewColumn.
2755 * @cell_area: (allow-none): The area a cell in the column will be allocated, or %NULL
2756 * @x_offset: (allow-none): location to return x offset of a cell relative to @cell_area, or %NULL
2757 * @y_offset: (allow-none): location to return y offset of a cell relative to @cell_area, or %NULL
2758 * @width: (allow-none): location to return width needed to render a cell, or %NULL
2759 * @height: (allow-none): location to return height needed to render a cell, or %NULL
2761 * Obtains the width and height needed to render the column. This is used
2762 * primarily by the #GtkTreeView.
2765 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2766 const GdkRectangle *cell_area,
2772 GtkTreeViewColumnPrivate *priv;
2773 gint min_width = 0, min_height = 0;
2775 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2777 priv = tree_column->priv;
2779 g_signal_handler_block (priv->cell_area_context,
2780 priv->context_changed_signal);
2782 gtk_cell_area_get_preferred_width (priv->cell_area,
2783 priv->cell_area_context,
2787 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &min_width, NULL);
2789 gtk_cell_area_get_preferred_height_for_width (priv->cell_area,
2790 priv->cell_area_context,
2796 g_signal_handler_unblock (priv->cell_area_context,
2797 priv->context_changed_signal);
2801 * height = min_height;
2803 * width = min_width;
2808 * gtk_tree_view_column_cell_render:
2809 * @tree_column: A #GtkTreeViewColumn.
2810 * @cr: cairo context to draw to
2811 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2812 * @cell_area: area normally rendered by a cell renderer
2813 * @flags: flags that affect rendering
2815 * Renders the cell contained by #tree_column. This is used primarily by the
2819 _gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2821 const GdkRectangle *background_area,
2822 const GdkRectangle *cell_area,
2824 gboolean draw_focus)
2826 GtkTreeViewColumnPrivate *priv;
2828 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2829 g_return_if_fail (cr != NULL);
2830 g_return_if_fail (background_area != NULL);
2831 g_return_if_fail (cell_area != NULL);
2833 priv = tree_column->priv;
2837 gtk_cell_area_render (priv->cell_area, priv->cell_area_context,
2838 priv->tree_view, cr,
2839 background_area, cell_area, flags,
2846 _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2848 const GdkRectangle *cell_area,
2851 GtkTreeViewColumnPrivate *priv;
2853 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2855 priv = tree_column->priv;
2857 return gtk_cell_area_event (priv->cell_area,
2858 priv->cell_area_context,
2866 * gtk_tree_view_column_cell_is_visible:
2867 * @tree_column: A #GtkTreeViewColumn
2869 * Returns %TRUE if any of the cells packed into the @tree_column are visible.
2870 * For this to be meaningful, you must first initialize the cells with
2871 * gtk_tree_view_column_cell_set_cell_data()
2873 * Return value: %TRUE, if any of the cells packed into the @tree_column are currently visible
2876 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
2880 GtkTreeViewColumnPrivate *priv;
2882 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2884 priv = tree_column->priv;
2886 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
2887 for (list = cells; list; list = list->next)
2889 if (gtk_cell_renderer_get_visible (list->data))
2891 g_list_free (cells);
2896 g_list_free (cells);
2902 * gtk_tree_view_column_focus_cell:
2903 * @tree_column: A #GtkTreeViewColumn
2904 * @cell: A #GtkCellRenderer
2906 * Sets the current keyboard focus to be at @cell, if the column contains
2907 * 2 or more editable and activatable cells.
2912 gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
2913 GtkCellRenderer *cell)
2915 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2916 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
2918 gtk_cell_area_set_focus_cell (tree_column->priv->cell_area, cell);
2922 _gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column,
2923 gboolean install_handler)
2925 GtkTreeViewColumnPrivate *priv = tree_column->priv;
2931 /* Issue a manual reset on the context to have all
2932 * sizes re-requested for the context.
2934 g_signal_handler_block (priv->cell_area_context,
2935 priv->context_changed_signal);
2936 gtk_cell_area_context_reset (priv->cell_area_context);
2937 g_signal_handler_unblock (priv->cell_area_context,
2938 priv->context_changed_signal);
2940 if (priv->tree_view &&
2941 gtk_widget_get_realized (priv->tree_view))
2943 _gtk_tree_view_install_mark_rows_col_dirty (GTK_TREE_VIEW (priv->tree_view), install_handler);
2944 gtk_widget_queue_resize (priv->tree_view);
2949 _gtk_tree_view_column_cell_get_dirty (GtkTreeViewColumn *tree_column)
2951 return tree_column->priv->dirty;
2955 * gtk_tree_view_column_cell_get_position:
2956 * @tree_column: a #GtkTreeViewColumn
2957 * @cell_renderer: a #GtkCellRenderer
2958 * @x_offset: return location for the horizontal position of @cell within
2959 * @tree_column, may be %NULL
2960 * @width: return location for the width of @cell, may be %NULL
2962 * Obtains the horizontal position and size of a cell in a column. If the
2963 * cell is not found in the column, @start_pos and @width are not changed and
2964 * %FALSE is returned.
2966 * Return value: %TRUE if @cell belongs to @tree_column.
2969 gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
2970 GtkCellRenderer *cell_renderer,
2974 GtkTreeViewColumnPrivate *priv;
2975 GdkRectangle zero_cell_area = { 0, };
2976 GdkRectangle allocation;
2978 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2979 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell_renderer), FALSE);
2981 priv = tree_column->priv;
2983 /* FIXME: Could use a boolean return value for invalid cells */
2984 gtk_cell_area_get_cell_allocation (priv->cell_area,
2985 priv->cell_area_context,
2992 *x_offset = allocation.x;
2994 *width = allocation.width;
3000 * gtk_tree_view_column_queue_resize:
3001 * @tree_column: A #GtkTreeViewColumn
3003 * Flags the column, and the cell renderers added to this column, to have
3004 * their sizes renegotiated.
3009 gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column)
3011 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
3013 if (tree_column->priv->tree_view)
3014 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
3018 * gtk_tree_view_column_get_tree_view:
3019 * @tree_column: A #GtkTreeViewColumn
3021 * Returns the #GtkTreeView wherein @tree_column has been inserted.
3022 * If @column is currently not inserted in any tree view, %NULL is
3025 * Return value: (transfer none): The tree view wherein @column has
3026 * been inserted if any, %NULL otherwise.
3031 gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column)
3033 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3035 return tree_column->priv->tree_view;
3039 * gtk_tree_view_column_get_button:
3040 * @tree_column: A #GtkTreeViewColumn
3042 * Returns the button used in the treeview column header
3044 * Return value: (transfer none): The button for the column header.
3049 gtk_tree_view_column_get_button (GtkTreeViewColumn *tree_column)
3051 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3053 return tree_column->priv->button;
3057 _gtk_tree_view_column_get_window (GtkTreeViewColumn *column)
3059 return column->priv->window;
3063 _gtk_tree_view_column_push_padding (GtkTreeViewColumn *column,
3066 column->priv->padding = MAX (column->priv->padding, padding);
3070 _gtk_tree_view_column_get_requested_width (GtkTreeViewColumn *column)
3072 gint requested_width;
3074 gtk_cell_area_context_get_preferred_width (column->priv->cell_area_context, &requested_width, NULL);
3076 return requested_width + column->priv->padding;
3081 _gtk_tree_view_column_set_resized_width (GtkTreeViewColumn *column,
3084 column->priv->resized_width = width;
3088 _gtk_tree_view_column_get_resized_width (GtkTreeViewColumn *column)
3090 return column->priv->resized_width;
3094 _gtk_tree_view_column_set_use_resized_width (GtkTreeViewColumn *column,
3095 gboolean use_resized_width)
3097 column->priv->use_resized_width = use_resized_width;
3101 _gtk_tree_view_column_get_use_resized_width (GtkTreeViewColumn *column)
3103 return column->priv->use_resized_width;
3107 _gtk_tree_view_column_get_drag_x (GtkTreeViewColumn *column)
3109 return column->priv->drag_x;
3112 GtkCellAreaContext *
3113 _gtk_tree_view_column_get_context (GtkTreeViewColumn *column)
3115 return column->priv->cell_area_context;