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"
39 #include "gtktypebuiltins.h"
43 * SECTION:gtktreeviewcolumn
44 * @Short_description: A visible column in a GtkTreeView widget
45 * @Title: GtkTreeViewColumn
46 * @See_also: #GtkTreeView, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable,
47 * #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable,
48 * #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
50 * The GtkTreeViewColumn object represents a visible column in a #GtkTreeView widget.
51 * It allows to set properties of the column header, and functions as a holding pen for
52 * the cell renderers which determine how the data in the column is displayed.
54 * Please refer to the <link linkend="TreeWidget">tree widget conceptual overview</link>
55 * for an overview of all the objects and data types related to the tree widget and how
61 static void gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface);
64 static void gtk_tree_view_column_set_property (GObject *object,
68 static void gtk_tree_view_column_get_property (GObject *object,
72 static void gtk_tree_view_column_finalize (GObject *object);
73 static void gtk_tree_view_column_dispose (GObject *object);
74 static GObject *gtk_tree_view_column_constructor (GType type,
75 guint n_construct_properties,
76 GObjectConstructParam *construct_properties);
78 /* GtkCellLayout implementation */
79 static GtkCellArea *gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout);
81 /* Button handling code */
82 static void gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column);
83 static void gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column);
85 /* Button signal handlers */
86 static gint gtk_tree_view_column_button_event (GtkWidget *widget,
89 static void gtk_tree_view_column_button_clicked (GtkWidget *widget,
91 static gboolean gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
92 gboolean group_cycling,
95 /* Property handlers */
96 static void gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
97 GtkTreeViewColumn *tree_column);
99 /* GtkCellArea/GtkCellAreaContext callbacks */
100 static void gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
102 GtkTreeViewColumn *tree_column);
103 static void gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
104 GtkCellRenderer *renderer,
105 GtkCellEditable *edit_widget,
106 GdkRectangle *cell_area,
107 const gchar *path_string,
109 static void gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
110 GtkCellRenderer *renderer,
111 GtkCellEditable *edit_widget,
114 /* Internal functions */
115 static void gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
117 static void gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column);
118 static void gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
119 GtkCellRenderer *cell_renderer,
122 /* GtkBuildable implementation */
123 static void gtk_tree_view_column_buildable_init (GtkBuildableIface *iface);
126 struct _GtkTreeViewColumnPrivate
128 GtkWidget *tree_view;
132 GtkWidget *alignment;
135 gulong property_changed_signal;
138 /* see gtk+/doc/tree-column-sizing.txt for more information on them */
139 GtkTreeViewColumnSizing column_type;
147 /* dragging columns */
154 gulong sort_clicked_signal;
155 gulong sort_column_changed_signal;
157 GtkSortType sort_order;
160 GtkCellArea *cell_area;
161 GtkCellAreaContext *cell_area_context;
162 gulong add_editable_signal;
163 gulong remove_editable_signal;
164 gulong context_changed_signal;
171 guint show_sort_indicator : 1;
172 guint maybe_reordered : 1;
173 guint reorderable : 1;
174 guint use_resized_width : 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 priv->add_editable_signal =
500 g_signal_connect (priv->cell_area, "add-editable",
501 G_CALLBACK (gtk_tree_view_column_add_editable_callback),
503 priv->remove_editable_signal =
504 g_signal_connect (priv->cell_area, "remove-editable",
505 G_CALLBACK (gtk_tree_view_column_remove_editable_callback),
508 priv->cell_area_context = gtk_cell_area_create_context (priv->cell_area);
510 priv->context_changed_signal =
511 g_signal_connect (priv->cell_area_context, "notify",
512 G_CALLBACK (gtk_tree_view_column_context_changed), tree_column);
518 gtk_tree_view_column_dispose (GObject *object)
520 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
521 GtkTreeViewColumnPrivate *priv = tree_column->priv;
523 if (priv->cell_area_context)
525 g_signal_handler_disconnect (priv->cell_area_context,
526 priv->context_changed_signal);
528 g_object_unref (priv->cell_area_context);
530 priv->cell_area_context = NULL;
531 priv->context_changed_signal = 0;
536 g_signal_handler_disconnect (priv->cell_area,
537 priv->add_editable_signal);
538 g_signal_handler_disconnect (priv->cell_area,
539 priv->remove_editable_signal);
541 g_object_unref (priv->cell_area);
542 priv->cell_area = NULL;
543 priv->add_editable_signal = 0;
544 priv->remove_editable_signal = 0;
549 g_object_unref (priv->child);
553 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->dispose (object);
557 gtk_tree_view_column_finalize (GObject *object)
559 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
560 GtkTreeViewColumnPrivate *priv = tree_column->priv;
562 g_free (priv->title);
564 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->finalize (object);
568 gtk_tree_view_column_set_property (GObject *object,
573 GtkTreeViewColumn *tree_column;
576 tree_column = GTK_TREE_VIEW_COLUMN (object);
581 gtk_tree_view_column_set_visible (tree_column,
582 g_value_get_boolean (value));
586 gtk_tree_view_column_set_resizable (tree_column,
587 g_value_get_boolean (value));
591 gtk_tree_view_column_set_sizing (tree_column,
592 g_value_get_enum (value));
595 case PROP_FIXED_WIDTH:
596 gtk_tree_view_column_set_fixed_width (tree_column,
597 g_value_get_int (value));
601 gtk_tree_view_column_set_min_width (tree_column,
602 g_value_get_int (value));
606 gtk_tree_view_column_set_max_width (tree_column,
607 g_value_get_int (value));
611 gtk_tree_view_column_set_spacing (tree_column,
612 g_value_get_int (value));
616 gtk_tree_view_column_set_title (tree_column,
617 g_value_get_string (value));
621 gtk_tree_view_column_set_expand (tree_column,
622 g_value_get_boolean (value));
626 gtk_tree_view_column_set_clickable (tree_column,
627 g_value_get_boolean (value));
631 gtk_tree_view_column_set_widget (tree_column,
632 (GtkWidget*) g_value_get_object (value));
636 gtk_tree_view_column_set_alignment (tree_column,
637 g_value_get_float (value));
640 case PROP_REORDERABLE:
641 gtk_tree_view_column_set_reorderable (tree_column,
642 g_value_get_boolean (value));
645 case PROP_SORT_INDICATOR:
646 gtk_tree_view_column_set_sort_indicator (tree_column,
647 g_value_get_boolean (value));
650 case PROP_SORT_ORDER:
651 gtk_tree_view_column_set_sort_order (tree_column,
652 g_value_get_enum (value));
655 case PROP_SORT_COLUMN_ID:
656 gtk_tree_view_column_set_sort_column_id (tree_column,
657 g_value_get_int (value));
661 /* Construct-only, can only be assigned once */
662 area = g_value_get_object (value);
665 tree_column->priv->cell_area = g_object_ref_sink (area);
669 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
675 gtk_tree_view_column_get_property (GObject *object,
680 GtkTreeViewColumn *tree_column;
682 tree_column = GTK_TREE_VIEW_COLUMN (object);
687 g_value_set_boolean (value,
688 gtk_tree_view_column_get_visible (tree_column));
692 g_value_set_boolean (value,
693 gtk_tree_view_column_get_resizable (tree_column));
697 g_value_set_int (value,
698 gtk_tree_view_column_get_width (tree_column));
702 g_value_set_int (value,
703 gtk_tree_view_column_get_spacing (tree_column));
707 g_value_set_enum (value,
708 gtk_tree_view_column_get_sizing (tree_column));
711 case PROP_FIXED_WIDTH:
712 g_value_set_int (value,
713 gtk_tree_view_column_get_fixed_width (tree_column));
717 g_value_set_int (value,
718 gtk_tree_view_column_get_min_width (tree_column));
722 g_value_set_int (value,
723 gtk_tree_view_column_get_max_width (tree_column));
727 g_value_set_string (value,
728 gtk_tree_view_column_get_title (tree_column));
732 g_value_set_boolean (value,
733 gtk_tree_view_column_get_expand (tree_column));
737 g_value_set_boolean (value,
738 gtk_tree_view_column_get_clickable (tree_column));
742 g_value_set_object (value,
743 (GObject*) gtk_tree_view_column_get_widget (tree_column));
747 g_value_set_float (value,
748 gtk_tree_view_column_get_alignment (tree_column));
751 case PROP_REORDERABLE:
752 g_value_set_boolean (value,
753 gtk_tree_view_column_get_reorderable (tree_column));
756 case PROP_SORT_INDICATOR:
757 g_value_set_boolean (value,
758 gtk_tree_view_column_get_sort_indicator (tree_column));
761 case PROP_SORT_ORDER:
762 g_value_set_enum (value,
763 gtk_tree_view_column_get_sort_order (tree_column));
766 case PROP_SORT_COLUMN_ID:
767 g_value_set_int (value,
768 gtk_tree_view_column_get_sort_column_id (tree_column));
772 g_value_set_object (value, tree_column->priv->cell_area);
776 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
781 /* Implementation of GtkCellLayout interface
784 gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout)
786 GtkTreeViewColumn *column = GTK_TREE_VIEW_COLUMN (cell_layout);
787 GtkTreeViewColumnPrivate *priv = column->priv;
789 return priv->cell_area;
792 /* Button handling code
795 gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column)
797 GtkTreeViewColumnPrivate *priv = tree_column->priv;
798 GtkTreeView *tree_view;
802 tree_view = (GtkTreeView *) priv->tree_view;
804 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
805 g_return_if_fail (priv->button == NULL);
807 gtk_widget_push_composite_child ();
808 priv->button = gtk_button_new ();
809 gtk_widget_add_events (priv->button, GDK_POINTER_MOTION_MASK);
810 gtk_widget_pop_composite_child ();
812 /* make sure we own a reference to it as well. */
813 if (_gtk_tree_view_get_header_window (tree_view))
814 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
816 gtk_widget_set_parent (priv->button, GTK_WIDGET (tree_view));
818 g_signal_connect (priv->button, "event",
819 G_CALLBACK (gtk_tree_view_column_button_event),
821 g_signal_connect (priv->button, "clicked",
822 G_CALLBACK (gtk_tree_view_column_button_clicked),
825 priv->alignment = gtk_alignment_new (priv->xalign, 0.5, 0.0, 0.0);
827 hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 2);
828 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_IN);
834 child = gtk_label_new (priv->title);
835 gtk_widget_show (child);
838 g_signal_connect (child, "mnemonic-activate",
839 G_CALLBACK (gtk_tree_view_column_mnemonic_activate),
842 if (priv->xalign <= 0.5)
843 gtk_box_pack_end (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
845 gtk_box_pack_start (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
847 gtk_box_pack_start (GTK_BOX (hbox), priv->alignment, TRUE, TRUE, 0);
849 gtk_container_add (GTK_CONTAINER (priv->alignment), child);
850 gtk_container_add (GTK_CONTAINER (priv->button), hbox);
852 gtk_widget_show (hbox);
853 gtk_widget_show (priv->alignment);
854 gtk_tree_view_column_update_button (tree_column);
858 gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column)
860 GtkTreeViewColumnPrivate *priv = tree_column->priv;
861 gint sort_column_id = -1;
863 GtkWidget *alignment;
865 GtkWidget *current_child;
866 GtkArrowType arrow_type = GTK_ARROW_NONE;
870 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
874 /* Create a button if necessary */
876 priv->button == NULL &&
878 gtk_widget_get_realized (priv->tree_view))
879 gtk_tree_view_column_create_button (tree_column);
884 hbox = gtk_bin_get_child (GTK_BIN (priv->button));
885 alignment = priv->alignment;
887 current_child = gtk_bin_get_child (GTK_BIN (alignment));
889 /* Set up the actual button */
890 gtk_alignment_set (GTK_ALIGNMENT (alignment), priv->xalign,
895 if (current_child != priv->child)
897 gtk_container_remove (GTK_CONTAINER (alignment),
899 gtk_container_add (GTK_CONTAINER (alignment),
905 if (current_child == NULL)
907 current_child = gtk_label_new (NULL);
908 gtk_widget_show (current_child);
909 gtk_container_add (GTK_CONTAINER (alignment),
913 g_return_if_fail (GTK_IS_LABEL (current_child));
916 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
919 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
923 if (GTK_IS_TREE_SORTABLE (model))
924 gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
928 if (priv->show_sort_indicator)
930 gboolean alternative;
932 g_object_get (gtk_widget_get_settings (priv->tree_view),
933 "gtk-alternative-sort-arrows", &alternative,
936 switch (priv->sort_order)
938 case GTK_SORT_ASCENDING:
939 arrow_type = alternative ? GTK_ARROW_UP : GTK_ARROW_DOWN;
942 case GTK_SORT_DESCENDING:
943 arrow_type = alternative ? GTK_ARROW_DOWN : GTK_ARROW_UP;
947 g_warning (G_STRLOC": bad sort order");
952 gtk_arrow_set (GTK_ARROW (arrow),
956 /* Put arrow on the right if the text is left-or-center justified, and on the
957 * left otherwise; do this by packing boxes, so flipping text direction will
960 g_object_ref (arrow);
961 gtk_container_remove (GTK_CONTAINER (hbox), arrow);
963 if (priv->xalign <= 0.5)
965 gtk_box_pack_end (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
969 gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
970 /* move it to the front */
971 gtk_box_reorder_child (GTK_BOX (hbox), arrow, 0);
973 g_object_unref (arrow);
975 if (priv->show_sort_indicator
976 || (GTK_IS_TREE_SORTABLE (model) && priv->sort_column_id >= 0))
977 gtk_widget_show (arrow);
979 gtk_widget_hide (arrow);
981 /* It's always safe to hide the button. It isn't always safe to show it, as
982 * if you show it before it's realized, it'll get the wrong window. */
984 priv->tree_view != NULL &&
985 gtk_widget_get_realized (priv->tree_view))
989 if (gdk_window_is_visible (_gtk_tree_view_get_header_window (GTK_TREE_VIEW (priv->tree_view))))
990 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"))
1264 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1268 gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
1269 GtkCellRenderer *renderer,
1270 GtkCellEditable *edit_widget,
1271 GdkRectangle *cell_area,
1272 const gchar *path_string,
1275 GtkTreeViewColumn *column = user_data;
1276 GtkTreeViewColumnPrivate *priv = column->priv;
1279 if (priv->tree_view)
1281 path = gtk_tree_path_new_from_string (path_string);
1283 _gtk_tree_view_add_editable (GTK_TREE_VIEW (priv->tree_view),
1289 gtk_tree_path_free (path);
1294 gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
1295 GtkCellRenderer *renderer,
1296 GtkCellEditable *edit_widget,
1299 GtkTreeViewColumn *column = user_data;
1300 GtkTreeViewColumnPrivate *priv = column->priv;
1302 if (priv->tree_view)
1303 _gtk_tree_view_remove_editable (GTK_TREE_VIEW (priv->tree_view),
1308 /* Exported Private Functions.
1309 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
1312 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
1314 GtkTreeViewColumnPrivate *priv = column->priv;
1315 GtkAllocation allocation;
1316 GtkTreeView *tree_view;
1318 guint attributes_mask;
1321 tree_view = (GtkTreeView *)priv->tree_view;
1322 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
1324 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
1325 g_return_if_fail (gtk_widget_get_realized (priv->tree_view));
1326 g_return_if_fail (priv->button != NULL);
1328 g_return_if_fail (_gtk_tree_view_get_header_window (tree_view) != NULL);
1329 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
1331 attr.window_type = GDK_WINDOW_CHILD;
1332 attr.wclass = GDK_INPUT_ONLY;
1333 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
1334 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view)) |
1335 (GDK_BUTTON_PRESS_MASK |
1336 GDK_BUTTON_RELEASE_MASK |
1337 GDK_POINTER_MOTION_MASK |
1338 GDK_POINTER_MOTION_HINT_MASK |
1339 GDK_KEY_PRESS_MASK);
1340 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
1341 attr.cursor = gdk_cursor_new_for_display
1342 (gdk_window_get_display (_gtk_tree_view_get_header_window (tree_view)), GDK_SB_H_DOUBLE_ARROW);
1344 attr.width = TREE_VIEW_DRAG_WIDTH;
1345 attr.height = _gtk_tree_view_get_header_height (tree_view);
1347 gtk_widget_get_allocation (priv->button, &allocation);
1348 attr.x = (allocation.x + (rtl ? 0 : allocation.width)) - TREE_VIEW_DRAG_WIDTH / 2;
1349 priv->window = gdk_window_new (_gtk_tree_view_get_header_window (tree_view),
1350 &attr, attributes_mask);
1351 gdk_window_set_user_data (priv->window, tree_view);
1353 gtk_tree_view_column_update_button (column);
1355 g_object_unref (attr.cursor);
1359 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
1361 GtkTreeViewColumnPrivate *priv;
1363 g_return_if_fail (column != NULL);
1365 priv = column->priv;
1366 g_return_if_fail (priv->window != NULL);
1368 gdk_window_set_user_data (priv->window, NULL);
1369 gdk_window_destroy (priv->window);
1370 priv->window = NULL;
1374 _gtk_tree_view_column_unset_model (GtkTreeViewColumn *column,
1375 GtkTreeModel *old_model)
1377 GtkTreeViewColumnPrivate *priv = column->priv;
1379 if (priv->sort_column_changed_signal)
1381 g_signal_handler_disconnect (old_model,
1382 priv->sort_column_changed_signal);
1383 priv->sort_column_changed_signal = 0;
1385 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1389 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
1390 GtkTreeView *tree_view)
1392 GtkTreeViewColumnPrivate *priv = column->priv;
1394 g_assert (priv->tree_view == NULL);
1396 priv->tree_view = GTK_WIDGET (tree_view);
1397 gtk_tree_view_column_create_button (column);
1399 priv->property_changed_signal =
1400 g_signal_connect_swapped (tree_view,
1402 G_CALLBACK (gtk_tree_view_column_setup_sort_column_id_callback),
1405 gtk_tree_view_column_setup_sort_column_id_callback (column);
1409 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
1411 GtkTreeViewColumnPrivate *priv = column->priv;
1413 if (priv->tree_view && priv->button)
1415 gtk_container_remove (GTK_CONTAINER (priv->tree_view), priv->button);
1417 if (priv->property_changed_signal)
1419 g_signal_handler_disconnect (priv->tree_view, priv->property_changed_signal);
1420 priv->property_changed_signal = 0;
1423 if (priv->sort_column_changed_signal)
1425 g_signal_handler_disconnect (gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view)),
1426 priv->sort_column_changed_signal);
1427 priv->sort_column_changed_signal = 0;
1430 priv->tree_view = NULL;
1431 priv->button = NULL;
1435 _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column)
1437 GtkTreeViewColumnPrivate *priv = column->priv;
1438 gboolean ret = FALSE;
1439 GList *list, *cells;
1441 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
1443 for (list = cells; list; list = list->next)
1445 GtkCellRenderer *cell = list->data;
1446 GtkCellRendererMode mode;
1448 g_object_get (cell, "mode", &mode, NULL);
1450 if (mode == GTK_CELL_RENDERER_MODE_EDITABLE)
1457 g_list_free (cells);
1462 /* gets cell being edited */
1464 _gtk_tree_view_column_get_edited_cell (GtkTreeViewColumn *column)
1466 GtkTreeViewColumnPrivate *priv = column->priv;
1468 return gtk_cell_area_get_edited_cell (priv->cell_area);
1472 _gtk_tree_view_column_get_cell_at_pos (GtkTreeViewColumn *column,
1473 GdkRectangle *cell_area,
1474 GdkRectangle *background_area,
1478 GtkCellRenderer *match = NULL;
1479 GtkTreeViewColumnPrivate *priv = column->priv;
1481 /* If (x, y) is outside of the background area, immediately return */
1482 if (x < background_area->x ||
1483 x > background_area->x + background_area->width ||
1484 y < background_area->y ||
1485 y > background_area->y + background_area->height)
1488 /* If (x, y) is inside the background area, clamp it to the cell_area
1489 * so that a cell is still returned. The main reason for doing this
1490 * (on the x axis) is for handling clicks in the indentation area
1491 * (either at the left or right depending on RTL setting). Another
1492 * reason is for handling clicks on the area where the focus rectangle
1493 * is drawn (this is outside of cell area), this manifests itself
1494 * mainly when a large setting is used for focus-line-width.
1496 if (x < cell_area->x)
1498 else if (x > cell_area->x + cell_area->width)
1499 x = cell_area->x + cell_area->width;
1501 if (y < cell_area->y)
1503 else if (y > cell_area->y + cell_area->height)
1504 y = cell_area->y + cell_area->height;
1506 match = gtk_cell_area_get_cell_at_position (priv->cell_area,
1507 priv->cell_area_context,
1517 _gtk_tree_view_column_is_blank_at_pos (GtkTreeViewColumn *column,
1518 GdkRectangle *cell_area,
1519 GdkRectangle *background_area,
1523 GtkCellRenderer *match;
1524 GdkRectangle cell_alloc, aligned_area, inner_area;
1525 GtkTreeViewColumnPrivate *priv = column->priv;
1527 match = _gtk_tree_view_column_get_cell_at_pos (column,
1534 gtk_cell_area_get_cell_allocation (priv->cell_area,
1535 priv->cell_area_context,
1541 gtk_cell_area_inner_cell_area (priv->cell_area, priv->tree_view,
1542 &cell_alloc, &inner_area);
1543 gtk_cell_renderer_get_aligned_area (match, priv->tree_view, 0,
1544 &inner_area, &aligned_area);
1546 if (x < aligned_area.x ||
1547 x > aligned_area.x + aligned_area.width ||
1548 y < aligned_area.y ||
1549 y > aligned_area.y + aligned_area.height)
1555 /* Public Functions */
1559 * gtk_tree_view_column_new:
1561 * Creates a new #GtkTreeViewColumn.
1563 * Return value: A newly created #GtkTreeViewColumn.
1566 gtk_tree_view_column_new (void)
1568 GtkTreeViewColumn *tree_column;
1570 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, NULL);
1576 * gtk_tree_view_column_new_with_area:
1577 * @area: the #GtkCellArea that the newly created column should use to layout cells.
1579 * Creates a new #GtkTreeViewColumn using @area to render it's cells.
1581 * Return value: A newly created #GtkTreeViewColumn.
1586 gtk_tree_view_column_new_with_area (GtkCellArea *area)
1588 GtkTreeViewColumn *tree_column;
1590 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, "cell-area", area, NULL);
1597 * gtk_tree_view_column_new_with_attributes:
1598 * @title: The title to set the header to.
1599 * @cell: The #GtkCellRenderer.
1600 * @Varargs: A %NULL-terminated list of attributes.
1602 * Creates a new #GtkTreeViewColumn with a number of default values. This is
1603 * equivalent to calling gtk_tree_view_column_set_title(),
1604 * gtk_tree_view_column_pack_start(), and
1605 * gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn.
1607 * Here's a simple example:
1609 * enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
1612 * GtkTreeViewColumn *column;
1613 * GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
1615 * column = gtk_tree_view_column_new_with_attributes ("Title",
1617 * "text", TEXT_COLUMN,
1618 * "foreground", COLOR_COLUMN,
1623 * Return value: A newly created #GtkTreeViewColumn.
1626 gtk_tree_view_column_new_with_attributes (const gchar *title,
1627 GtkCellRenderer *cell,
1630 GtkTreeViewColumn *retval;
1633 retval = gtk_tree_view_column_new ();
1635 gtk_tree_view_column_set_title (retval, title);
1636 gtk_tree_view_column_pack_start (retval, cell, TRUE);
1638 va_start (args, cell);
1639 gtk_tree_view_column_set_attributesv (retval, cell, args);
1646 * gtk_tree_view_column_pack_start:
1647 * @tree_column: A #GtkTreeViewColumn.
1648 * @cell: The #GtkCellRenderer.
1649 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1651 * Packs the @cell into the beginning of the column. If @expand is %FALSE, then
1652 * the @cell is allocated no more space than it needs. Any unused space is divided
1653 * evenly between cells for which @expand is %TRUE.
1656 gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
1657 GtkCellRenderer *cell,
1660 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (tree_column), cell, expand);
1664 * gtk_tree_view_column_pack_end:
1665 * @tree_column: A #GtkTreeViewColumn.
1666 * @cell: The #GtkCellRenderer.
1667 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1669 * Adds the @cell to end of the column. If @expand is %FALSE, then the @cell
1670 * is allocated no more space than it needs. Any unused space is divided
1671 * evenly between cells for which @expand is %TRUE.
1674 gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
1675 GtkCellRenderer *cell,
1678 gtk_cell_layout_pack_end (GTK_CELL_LAYOUT (tree_column), cell, expand);
1682 * gtk_tree_view_column_clear:
1683 * @tree_column: A #GtkTreeViewColumn
1685 * Unsets all the mappings on all renderers on the @tree_column.
1688 gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column)
1690 gtk_cell_layout_clear (GTK_CELL_LAYOUT (tree_column));
1694 * gtk_tree_view_column_add_attribute:
1695 * @tree_column: A #GtkTreeViewColumn.
1696 * @cell_renderer: the #GtkCellRenderer to set attributes on
1697 * @attribute: An attribute on the renderer
1698 * @column: The column position on the model to get the attribute from.
1700 * Adds an attribute mapping to the list in @tree_column. The @column is the
1701 * column of the model to get a value from, and the @attribute is the
1702 * parameter on @cell_renderer to be set from the value. So for example
1703 * if column 2 of the model contains strings, you could have the
1704 * "text" attribute of a #GtkCellRendererText get its values from
1708 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1709 GtkCellRenderer *cell_renderer,
1710 const gchar *attribute,
1713 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (tree_column),
1714 cell_renderer, attribute, column);
1718 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1719 GtkCellRenderer *cell_renderer,
1722 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1726 attribute = va_arg (args, gchar *);
1728 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (priv->cell_area),
1731 while (attribute != NULL)
1733 column = va_arg (args, gint);
1734 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (priv->cell_area),
1735 cell_renderer, attribute, column);
1736 attribute = va_arg (args, gchar *);
1741 * gtk_tree_view_column_set_attributes:
1742 * @tree_column: A #GtkTreeViewColumn.
1743 * @cell_renderer: the #GtkCellRenderer we're setting the attributes of
1744 * @Varargs: A %NULL-terminated list of attributes.
1746 * Sets the attributes in the list as the attributes of @tree_column.
1747 * The attributes should be in attribute/column order, as in
1748 * gtk_tree_view_column_add_attribute(). All existing attributes
1749 * are removed, and replaced with the new attributes.
1752 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1753 GtkCellRenderer *cell_renderer,
1758 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1759 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1761 va_start (args, cell_renderer);
1762 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1768 * gtk_tree_view_column_set_cell_data_func:
1769 * @tree_column: A #GtkTreeViewColumn
1770 * @cell_renderer: A #GtkCellRenderer
1771 * @func: (allow-none): The #GtkTreeViewColumnFunc to use.
1772 * @func_data: The user data for @func.
1773 * @destroy: The destroy notification for @func_data
1775 * Sets the #GtkTreeViewColumnFunc to use for the column. This
1776 * function is used instead of the standard attributes mapping for
1777 * setting the column value, and should set the value of @tree_column's
1778 * cell renderer as appropriate. @func may be %NULL to remove an
1782 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1783 GtkCellRenderer *cell_renderer,
1784 GtkTreeCellDataFunc func,
1786 GDestroyNotify destroy)
1788 gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT (tree_column),
1790 (GtkCellLayoutDataFunc)func,
1791 func_data, destroy);
1796 * gtk_tree_view_column_clear_attributes:
1797 * @tree_column: a #GtkTreeViewColumn
1798 * @cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1800 * Clears all existing attributes previously set with
1801 * gtk_tree_view_column_set_attributes().
1804 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1805 GtkCellRenderer *cell_renderer)
1807 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (tree_column),
1812 * gtk_tree_view_column_set_spacing:
1813 * @tree_column: A #GtkTreeViewColumn.
1814 * @spacing: distance between cell renderers in pixels.
1816 * Sets the spacing field of @tree_column, which is the number of pixels to
1817 * place between cell renderers packed into it.
1820 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1823 GtkTreeViewColumnPrivate *priv;
1825 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1826 g_return_if_fail (spacing >= 0);
1828 priv = tree_column->priv;
1830 gtk_cell_area_box_set_spacing (GTK_CELL_AREA_BOX (priv->cell_area),
1832 if (priv->tree_view)
1833 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1837 * gtk_tree_view_column_get_spacing:
1838 * @tree_column: A #GtkTreeViewColumn.
1840 * Returns the spacing of @tree_column.
1842 * Return value: the spacing of @tree_column.
1845 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1847 GtkTreeViewColumnPrivate *priv;
1849 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1851 priv = tree_column->priv;
1853 return gtk_cell_area_box_get_spacing (GTK_CELL_AREA_BOX (priv->cell_area));
1856 /* Options for manipulating the columns */
1859 * gtk_tree_view_column_set_visible:
1860 * @tree_column: A #GtkTreeViewColumn.
1861 * @visible: %TRUE if the @tree_column is visible.
1863 * Sets the visibility of @tree_column.
1866 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1869 GtkTreeViewColumnPrivate *priv;
1871 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1873 priv = tree_column->priv;
1874 visible = !! visible;
1876 if (priv->visible == visible)
1879 priv->visible = visible;
1882 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1884 gtk_tree_view_column_update_button (tree_column);
1885 g_object_notify (G_OBJECT (tree_column), "visible");
1889 * gtk_tree_view_column_get_visible:
1890 * @tree_column: A #GtkTreeViewColumn.
1892 * Returns %TRUE if @tree_column is visible.
1894 * Return value: whether the column is visible or not. If it is visible, then
1895 * the tree will show the column.
1898 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1900 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1902 return tree_column->priv->visible;
1906 * gtk_tree_view_column_set_resizable:
1907 * @tree_column: A #GtkTreeViewColumn
1908 * @resizable: %TRUE, if the column can be resized
1910 * If @resizable is %TRUE, then the user can explicitly resize the column by
1911 * grabbing the outer edge of the column button. If resizable is %TRUE and
1912 * sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing
1913 * mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY.
1916 gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
1919 GtkTreeViewColumnPrivate *priv;
1921 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1923 priv = tree_column->priv;
1924 resizable = !! resizable;
1926 if (priv->resizable == resizable)
1929 priv->resizable = resizable;
1931 if (resizable && priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1932 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_GROW_ONLY);
1934 gtk_tree_view_column_update_button (tree_column);
1936 g_object_notify (G_OBJECT (tree_column), "resizable");
1940 * gtk_tree_view_column_get_resizable:
1941 * @tree_column: A #GtkTreeViewColumn
1943 * Returns %TRUE if the @tree_column can be resized by the end user.
1945 * Return value: %TRUE, if the @tree_column can be resized.
1948 gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column)
1950 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1952 return tree_column->priv->resizable;
1957 * gtk_tree_view_column_set_sizing:
1958 * @tree_column: A #GtkTreeViewColumn.
1959 * @type: The #GtkTreeViewColumnSizing.
1961 * Sets the growth behavior of @tree_column to @type.
1964 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
1965 GtkTreeViewColumnSizing type)
1967 GtkTreeViewColumnPrivate *priv;
1969 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1971 priv = tree_column->priv;
1973 if (type == priv->column_type)
1976 if (type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1977 gtk_tree_view_column_set_resizable (tree_column, FALSE);
1979 priv->column_type = type;
1981 gtk_tree_view_column_update_button (tree_column);
1983 g_object_notify (G_OBJECT (tree_column), "sizing");
1987 * gtk_tree_view_column_get_sizing:
1988 * @tree_column: A #GtkTreeViewColumn.
1990 * Returns the current type of @tree_column.
1992 * Return value: The type of @tree_column.
1994 GtkTreeViewColumnSizing
1995 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
1997 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1999 return tree_column->priv->column_type;
2003 * gtk_tree_view_column_get_width:
2004 * @tree_column: A #GtkTreeViewColumn.
2006 * Returns the current size of @tree_column in pixels.
2008 * Return value: The current width of @tree_column.
2011 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
2013 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2015 return tree_column->priv->width;
2019 _gtk_tree_view_column_request_width (GtkTreeViewColumn *tree_column)
2021 GtkTreeViewColumnPrivate *priv;
2022 gint real_requested_width;
2024 priv = tree_column->priv;
2026 if (priv->use_resized_width)
2028 real_requested_width = priv->resized_width;
2030 else if (priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2032 real_requested_width = priv->fixed_width;
2034 else if (gtk_tree_view_get_headers_visible (GTK_TREE_VIEW (priv->tree_view)))
2036 gint button_request;
2037 gint requested_width;
2039 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
2040 requested_width += priv->padding;
2042 gtk_widget_get_preferred_width (priv->button, &button_request, NULL);
2043 real_requested_width = MAX (requested_width, button_request);
2047 gint requested_width;
2049 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
2050 requested_width += priv->padding;
2052 real_requested_width = requested_width;
2053 if (real_requested_width < 0)
2054 real_requested_width = 0;
2057 if (priv->min_width != -1)
2058 real_requested_width = MAX (real_requested_width, priv->min_width);
2060 if (priv->max_width != -1)
2061 real_requested_width = MIN (real_requested_width, priv->max_width);
2063 return real_requested_width;
2067 _gtk_tree_view_column_allocate (GtkTreeViewColumn *tree_column,
2071 GtkTreeViewColumnPrivate *priv;
2072 GtkAllocation allocation;
2075 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2077 priv = tree_column->priv;
2079 priv->width = width;
2081 gtk_cell_area_context_allocate (priv->cell_area_context, priv->width - priv->padding, -1);
2083 allocation.x = x_offset;
2085 allocation.width = width;
2086 allocation.height = _gtk_tree_view_get_header_height (GTK_TREE_VIEW (priv->tree_view));
2088 gtk_widget_size_allocate (priv->button, &allocation);
2092 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
2093 gdk_window_move_resize (priv->window,
2094 allocation.x + (rtl ? 0 : allocation.width) - TREE_VIEW_DRAG_WIDTH/2,
2096 TREE_VIEW_DRAG_WIDTH, allocation.height);
2099 g_object_notify (G_OBJECT (tree_column), "width");
2103 * gtk_tree_view_column_set_fixed_width:
2104 * @tree_column: A #GtkTreeViewColumn.
2105 * @fixed_width: The size to set @tree_column to. Must be greater than 0.
2107 * Sets the size of the column in pixels. This is meaningful only if the sizing
2108 * type is #GTK_TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to
2109 * the min/max width for the column. Please note that the min/max width of the
2110 * column doesn't actually affect the "fixed_width" property of the widget, just
2111 * the actual size when displayed.
2114 gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
2117 GtkTreeViewColumnPrivate *priv;
2119 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2120 g_return_if_fail (fixed_width > 0);
2122 priv = tree_column->priv;
2124 priv->fixed_width = fixed_width;
2125 priv->use_resized_width = FALSE;
2127 if (priv->tree_view &&
2128 gtk_widget_get_realized (priv->tree_view) &&
2129 priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2131 gtk_widget_queue_resize (priv->tree_view);
2134 g_object_notify (G_OBJECT (tree_column), "fixed-width");
2138 * gtk_tree_view_column_get_fixed_width:
2139 * @tree_column: a #GtkTreeViewColumn
2141 * Gets the fixed width of the column. This value is only meaning may not be
2142 * the actual width of the column on the screen, just what is requested.
2144 * Return value: the fixed width of the column
2147 gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
2149 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2151 return tree_column->priv->fixed_width;
2155 * gtk_tree_view_column_set_min_width:
2156 * @tree_column: A #GtkTreeViewColumn.
2157 * @min_width: The minimum width of the column in pixels, or -1.
2159 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
2160 * minimum width is unset.
2163 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
2166 GtkTreeViewColumnPrivate *priv;
2168 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2169 g_return_if_fail (min_width >= -1);
2171 priv = tree_column->priv;
2173 if (min_width == priv->min_width)
2176 if (priv->visible &&
2177 priv->tree_view != NULL &&
2178 gtk_widget_get_realized (priv->tree_view))
2180 if (min_width > priv->width)
2181 gtk_widget_queue_resize (priv->tree_view);
2184 priv->min_width = min_width;
2185 g_object_freeze_notify (G_OBJECT (tree_column));
2186 if (priv->max_width != -1 && priv->max_width < min_width)
2188 priv->max_width = min_width;
2189 g_object_notify (G_OBJECT (tree_column), "max-width");
2191 g_object_notify (G_OBJECT (tree_column), "min-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_min_width:
2201 * @tree_column: A #GtkTreeViewColumn.
2203 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
2206 * Return value: The minimum width of the @tree_column.
2209 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
2211 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2213 return tree_column->priv->min_width;
2217 * gtk_tree_view_column_set_max_width:
2218 * @tree_column: A #GtkTreeViewColumn.
2219 * @max_width: The maximum width of the column in pixels, or -1.
2221 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
2222 * maximum width is unset. Note, the column can actually be wider than max
2223 * width if it's the last column in a view. In this case, the column expands to
2224 * fill any extra space.
2227 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
2230 GtkTreeViewColumnPrivate *priv;
2232 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2233 g_return_if_fail (max_width >= -1);
2235 priv = tree_column->priv;
2237 if (max_width == priv->max_width)
2240 if (priv->visible &&
2241 priv->tree_view != NULL &&
2242 gtk_widget_get_realized (priv->tree_view))
2244 if (max_width != -1 && max_width < priv->width)
2245 gtk_widget_queue_resize (priv->tree_view);
2248 priv->max_width = max_width;
2249 g_object_freeze_notify (G_OBJECT (tree_column));
2250 if (max_width != -1 && max_width < priv->min_width)
2252 priv->min_width = max_width;
2253 g_object_notify (G_OBJECT (tree_column), "min-width");
2255 g_object_notify (G_OBJECT (tree_column), "max-width");
2256 g_object_thaw_notify (G_OBJECT (tree_column));
2258 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2259 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2264 * gtk_tree_view_column_get_max_width:
2265 * @tree_column: A #GtkTreeViewColumn.
2267 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
2270 * Return value: The maximum width of the @tree_column.
2273 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
2275 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2277 return tree_column->priv->max_width;
2281 * gtk_tree_view_column_clicked:
2282 * @tree_column: a #GtkTreeViewColumn
2284 * Emits the "clicked" signal on the column. This function will only work if
2285 * @tree_column is clickable.
2288 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
2290 GtkTreeViewColumnPrivate *priv;
2292 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2294 priv = tree_column->priv;
2296 if (priv->visible &&
2299 gtk_button_clicked (GTK_BUTTON (priv->button));
2303 * gtk_tree_view_column_set_title:
2304 * @tree_column: A #GtkTreeViewColumn.
2305 * @title: The title of the @tree_column.
2307 * Sets the title of the @tree_column. If a custom widget has been set, then
2308 * this value is ignored.
2311 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
2314 GtkTreeViewColumnPrivate *priv;
2317 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2319 priv = tree_column->priv;
2321 new_title = g_strdup (title);
2322 g_free (priv->title);
2323 priv->title = new_title;
2325 gtk_tree_view_column_update_button (tree_column);
2326 g_object_notify (G_OBJECT (tree_column), "title");
2330 * gtk_tree_view_column_get_title:
2331 * @tree_column: A #GtkTreeViewColumn.
2333 * Returns the title of the widget.
2335 * Return value: the title of the column. This string should not be
2336 * modified or freed.
2338 G_CONST_RETURN gchar *
2339 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
2341 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2343 return tree_column->priv->title;
2347 * gtk_tree_view_column_set_expand:
2348 * @tree_column: A #GtkTreeViewColumn
2349 * @expand: %TRUE if the column should take available extra space, %FALSE if not
2351 * Sets the column to take available extra space. This space is shared equally
2352 * amongst all columns that have the expand set to %TRUE. If no column has this
2353 * option set, then the last column gets all extra space. By default, every
2354 * column is created with this %FALSE.
2359 gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
2362 GtkTreeViewColumnPrivate *priv;
2364 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2366 priv = tree_column->priv;
2368 expand = expand?TRUE:FALSE;
2369 if (priv->expand == expand)
2371 priv->expand = expand;
2373 if (priv->visible &&
2374 priv->tree_view != NULL &&
2375 gtk_widget_get_realized (priv->tree_view))
2377 /* We want to continue using the original width of the
2378 * column that includes additional space added by the user
2379 * resizing the columns and possibly extra (expanded) space, which
2380 * are not included in the resized width.
2382 priv->use_resized_width = FALSE;
2384 gtk_widget_queue_resize (priv->tree_view);
2387 g_object_notify (G_OBJECT (tree_column), "expand");
2391 * gtk_tree_view_column_get_expand:
2392 * @tree_column: a #GtkTreeViewColumn
2394 * Return %TRUE if the column expands to take any available space.
2396 * Return value: %TRUE, if the column expands
2401 gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column)
2403 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2405 return tree_column->priv->expand;
2409 * gtk_tree_view_column_set_clickable:
2410 * @tree_column: A #GtkTreeViewColumn.
2411 * @clickable: %TRUE if the header is active.
2413 * Sets the header to be active if @active is %TRUE. When the header is active,
2414 * then it can take keyboard focus, and can be clicked.
2417 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
2420 GtkTreeViewColumnPrivate *priv;
2422 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2424 priv = tree_column->priv;
2426 clickable = !! clickable;
2427 if (priv->clickable == clickable)
2430 priv->clickable = clickable;
2431 gtk_tree_view_column_update_button (tree_column);
2432 g_object_notify (G_OBJECT (tree_column), "clickable");
2436 * gtk_tree_view_column_get_clickable:
2437 * @tree_column: a #GtkTreeViewColumn
2439 * Returns %TRUE if the user can click on the header for the column.
2441 * Return value: %TRUE if user can click the column header.
2444 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
2446 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2448 return tree_column->priv->clickable;
2452 * gtk_tree_view_column_set_widget:
2453 * @tree_column: A #GtkTreeViewColumn.
2454 * @widget: (allow-none): A child #GtkWidget, or %NULL.
2456 * Sets the widget in the header to be @widget. If widget is %NULL, then the
2457 * header button is set with a #GtkLabel set to the title of @tree_column.
2460 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
2463 GtkTreeViewColumnPrivate *priv;
2465 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2466 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
2468 priv = tree_column->priv;
2471 g_object_ref_sink (widget);
2474 g_object_unref (priv->child);
2476 priv->child = widget;
2477 gtk_tree_view_column_update_button (tree_column);
2478 g_object_notify (G_OBJECT (tree_column), "widget");
2482 * gtk_tree_view_column_get_widget:
2483 * @tree_column: A #GtkTreeViewColumn.
2485 * Returns the #GtkWidget in the button on the column header.
2486 * If a custom widget has not been set then %NULL is returned.
2488 * Return value: (transfer none): The #GtkWidget in the column
2492 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
2494 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2496 return tree_column->priv->child;
2500 * gtk_tree_view_column_set_alignment:
2501 * @tree_column: A #GtkTreeViewColumn.
2502 * @xalign: The alignment, which is between [0.0 and 1.0] inclusive.
2504 * Sets the alignment of the title or custom widget inside the column header.
2505 * The alignment determines its location inside the button -- 0.0 for left, 0.5
2506 * for center, 1.0 for right.
2509 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
2512 GtkTreeViewColumnPrivate *priv;
2514 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2516 priv = tree_column->priv;
2518 xalign = CLAMP (xalign, 0.0, 1.0);
2520 if (priv->xalign == xalign)
2523 priv->xalign = xalign;
2524 gtk_tree_view_column_update_button (tree_column);
2525 g_object_notify (G_OBJECT (tree_column), "alignment");
2529 * gtk_tree_view_column_get_alignment:
2530 * @tree_column: A #GtkTreeViewColumn.
2532 * Returns the current x alignment of @tree_column. This value can range
2533 * between 0.0 and 1.0.
2535 * Return value: The current alignent of @tree_column.
2538 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
2540 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
2542 return tree_column->priv->xalign;
2546 * gtk_tree_view_column_set_reorderable:
2547 * @tree_column: A #GtkTreeViewColumn
2548 * @reorderable: %TRUE, if the column can be reordered.
2550 * If @reorderable is %TRUE, then the column can be reordered by the end user
2551 * dragging the header.
2554 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
2555 gboolean reorderable)
2557 GtkTreeViewColumnPrivate *priv;
2559 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2561 priv = tree_column->priv;
2564 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
2566 if (priv->reorderable == (reorderable?TRUE:FALSE))
2569 priv->reorderable = (reorderable?TRUE:FALSE);
2570 gtk_tree_view_column_update_button (tree_column);
2571 g_object_notify (G_OBJECT (tree_column), "reorderable");
2575 * gtk_tree_view_column_get_reorderable:
2576 * @tree_column: A #GtkTreeViewColumn
2578 * Returns %TRUE if the @tree_column can be reordered by the user.
2580 * Return value: %TRUE if the @tree_column can be reordered by the user.
2583 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
2585 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2587 return tree_column->priv->reorderable;
2592 * gtk_tree_view_column_set_sort_column_id:
2593 * @tree_column: a #GtkTreeViewColumn
2594 * @sort_column_id: The @sort_column_id of the model to sort on.
2596 * Sets the logical @sort_column_id that this column sorts on when this column
2597 * is selected for sorting. Doing so makes the column header clickable.
2600 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
2601 gint sort_column_id)
2603 GtkTreeViewColumnPrivate *priv;
2605 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2606 g_return_if_fail (sort_column_id >= -1);
2608 priv = tree_column->priv;
2610 if (priv->sort_column_id == sort_column_id)
2613 priv->sort_column_id = sort_column_id;
2615 /* Handle unsetting the id */
2616 if (sort_column_id == -1)
2618 GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
2620 if (priv->sort_clicked_signal)
2622 g_signal_handler_disconnect (tree_column, priv->sort_clicked_signal);
2623 priv->sort_clicked_signal = 0;
2626 if (priv->sort_column_changed_signal)
2628 g_signal_handler_disconnect (model, priv->sort_column_changed_signal);
2629 priv->sort_column_changed_signal = 0;
2632 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
2633 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
2634 gtk_tree_view_column_set_clickable (tree_column, FALSE);
2635 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2639 gtk_tree_view_column_set_clickable (tree_column, TRUE);
2641 if (! priv->sort_clicked_signal)
2642 priv->sort_clicked_signal = g_signal_connect (tree_column,
2644 G_CALLBACK (gtk_tree_view_column_sort),
2647 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
2648 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2652 * gtk_tree_view_column_get_sort_column_id:
2653 * @tree_column: a #GtkTreeViewColumn
2655 * Gets the logical @sort_column_id that the model sorts on when this
2656 * column is selected for sorting.
2657 * See gtk_tree_view_column_set_sort_column_id().
2659 * Return value: the current @sort_column_id for this column, or -1 if
2660 * this column can't be used for sorting.
2663 gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column)
2665 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2667 return tree_column->priv->sort_column_id;
2671 * gtk_tree_view_column_set_sort_indicator:
2672 * @tree_column: a #GtkTreeViewColumn
2673 * @setting: %TRUE to display an indicator that the column is sorted
2675 * Call this function with a @setting of %TRUE to display an arrow in
2676 * the header button indicating the column is sorted. Call
2677 * gtk_tree_view_column_set_sort_order() to change the direction of
2682 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
2685 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2687 setting = setting != FALSE;
2689 if (setting == tree_column->priv->show_sort_indicator)
2692 tree_column->priv->show_sort_indicator = setting;
2693 gtk_tree_view_column_update_button (tree_column);
2694 g_object_notify (G_OBJECT (tree_column), "sort-indicator");
2698 * gtk_tree_view_column_get_sort_indicator:
2699 * @tree_column: a #GtkTreeViewColumn
2701 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
2703 * Return value: whether the sort indicator arrow is displayed
2706 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
2708 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2710 return tree_column->priv->show_sort_indicator;
2714 * gtk_tree_view_column_set_sort_order:
2715 * @tree_column: a #GtkTreeViewColumn
2716 * @order: sort order that the sort indicator should indicate
2718 * Changes the appearance of the sort indicator.
2720 * This <emphasis>does not</emphasis> actually sort the model. Use
2721 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
2722 * support. This function is primarily for custom sorting behavior, and should
2723 * be used in conjunction with gtk_tree_sortable_set_sort_column() to do
2724 * that. For custom models, the mechanism will vary.
2726 * The sort indicator changes direction to indicate normal sort or reverse sort.
2727 * Note that you must have the sort indicator enabled to see anything when
2728 * calling this function; see gtk_tree_view_column_set_sort_indicator().
2731 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
2734 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2736 if (order == tree_column->priv->sort_order)
2739 tree_column->priv->sort_order = order;
2740 gtk_tree_view_column_update_button (tree_column);
2741 g_object_notify (G_OBJECT (tree_column), "sort-order");
2745 * gtk_tree_view_column_get_sort_order:
2746 * @tree_column: a #GtkTreeViewColumn
2748 * Gets the value set by gtk_tree_view_column_set_sort_order().
2750 * Return value: the sort order the sort indicator is indicating
2753 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2755 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2757 return tree_column->priv->sort_order;
2761 * gtk_tree_view_column_cell_set_cell_data:
2762 * @tree_column: A #GtkTreeViewColumn.
2763 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2764 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2765 * @is_expander: %TRUE, if the row has children
2766 * @is_expanded: %TRUE, if the row has visible children
2768 * Sets the cell renderer based on the @tree_model and @iter. That is, for
2769 * every attribute mapping in @tree_column, it will get a value from the set
2770 * column on the @iter, and use that value to set the attribute on the cell
2771 * renderer. This is used primarily by the #GtkTreeView.
2774 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2775 GtkTreeModel *tree_model,
2777 gboolean is_expander,
2778 gboolean is_expanded)
2780 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2782 if (tree_model == NULL)
2785 gtk_cell_area_apply_attributes (tree_column->priv->cell_area, tree_model, iter,
2786 is_expander, is_expanded);
2790 * gtk_tree_view_column_cell_get_size:
2791 * @tree_column: A #GtkTreeViewColumn.
2792 * @cell_area: (allow-none): The area a cell in the column will be allocated, or %NULL
2793 * @x_offset: (out) (allow-none): location to return x offset of a cell relative to @cell_area, or %NULL
2794 * @y_offset: (out) (allow-none): location to return y offset of a cell relative to @cell_area, or %NULL
2795 * @width: (out) (allow-none): location to return width needed to render a cell, or %NULL
2796 * @height: (out) (allow-none): location to return height needed to render a cell, or %NULL
2798 * Obtains the width and height needed to render the column. This is used
2799 * primarily by the #GtkTreeView.
2802 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2803 const GdkRectangle *cell_area,
2809 GtkTreeViewColumnPrivate *priv;
2810 gint min_width = 0, min_height = 0;
2812 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2814 priv = tree_column->priv;
2816 g_signal_handler_block (priv->cell_area_context,
2817 priv->context_changed_signal);
2819 gtk_cell_area_get_preferred_width (priv->cell_area,
2820 priv->cell_area_context,
2824 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &min_width, NULL);
2826 gtk_cell_area_get_preferred_height_for_width (priv->cell_area,
2827 priv->cell_area_context,
2833 g_signal_handler_unblock (priv->cell_area_context,
2834 priv->context_changed_signal);
2838 * height = min_height;
2840 * width = min_width;
2845 * gtk_tree_view_column_cell_render:
2846 * @tree_column: A #GtkTreeViewColumn.
2847 * @cr: cairo context to draw to
2848 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2849 * @cell_area: area normally rendered by a cell renderer
2850 * @flags: flags that affect rendering
2852 * Renders the cell contained by #tree_column. This is used primarily by the
2856 _gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2858 const GdkRectangle *background_area,
2859 const GdkRectangle *cell_area,
2861 gboolean draw_focus)
2863 GtkTreeViewColumnPrivate *priv;
2865 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2866 g_return_if_fail (cr != NULL);
2867 g_return_if_fail (background_area != NULL);
2868 g_return_if_fail (cell_area != NULL);
2870 priv = tree_column->priv;
2874 gtk_cell_area_render (priv->cell_area, priv->cell_area_context,
2875 priv->tree_view, cr,
2876 background_area, cell_area, flags,
2883 _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2885 const GdkRectangle *cell_area,
2888 GtkTreeViewColumnPrivate *priv;
2890 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2892 priv = tree_column->priv;
2894 return gtk_cell_area_event (priv->cell_area,
2895 priv->cell_area_context,
2903 * gtk_tree_view_column_cell_is_visible:
2904 * @tree_column: A #GtkTreeViewColumn
2906 * Returns %TRUE if any of the cells packed into the @tree_column are visible.
2907 * For this to be meaningful, you must first initialize the cells with
2908 * gtk_tree_view_column_cell_set_cell_data()
2910 * Return value: %TRUE, if any of the cells packed into the @tree_column are currently visible
2913 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
2917 GtkTreeViewColumnPrivate *priv;
2919 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2921 priv = tree_column->priv;
2923 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
2924 for (list = cells; list; list = list->next)
2926 if (gtk_cell_renderer_get_visible (list->data))
2928 g_list_free (cells);
2933 g_list_free (cells);
2939 * gtk_tree_view_column_focus_cell:
2940 * @tree_column: A #GtkTreeViewColumn
2941 * @cell: A #GtkCellRenderer
2943 * Sets the current keyboard focus to be at @cell, if the column contains
2944 * 2 or more editable and activatable cells.
2949 gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
2950 GtkCellRenderer *cell)
2952 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2953 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
2955 gtk_cell_area_set_focus_cell (tree_column->priv->cell_area, cell);
2959 _gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column,
2960 gboolean install_handler)
2962 GtkTreeViewColumnPrivate *priv = tree_column->priv;
2968 /* Issue a manual reset on the context to have all
2969 * sizes re-requested for the context.
2971 g_signal_handler_block (priv->cell_area_context,
2972 priv->context_changed_signal);
2973 gtk_cell_area_context_reset (priv->cell_area_context);
2974 g_signal_handler_unblock (priv->cell_area_context,
2975 priv->context_changed_signal);
2977 if (priv->tree_view &&
2978 gtk_widget_get_realized (priv->tree_view))
2980 _gtk_tree_view_install_mark_rows_col_dirty (GTK_TREE_VIEW (priv->tree_view), install_handler);
2981 gtk_widget_queue_resize (priv->tree_view);
2986 _gtk_tree_view_column_cell_get_dirty (GtkTreeViewColumn *tree_column)
2988 return tree_column->priv->dirty;
2992 * gtk_tree_view_column_cell_get_position:
2993 * @tree_column: a #GtkTreeViewColumn
2994 * @cell_renderer: a #GtkCellRenderer
2995 * @x_offset: (out) (allow-none): return location for the horizontal
2996 * position of @cell within @tree_column, may be %NULL
2997 * @width: (out) (allow-none): return location for the width of @cell,
3000 * Obtains the horizontal position and size of a cell in a column. If the
3001 * cell is not found in the column, @start_pos and @width are not changed and
3002 * %FALSE is returned.
3004 * Return value: %TRUE if @cell belongs to @tree_column.
3007 gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
3008 GtkCellRenderer *cell_renderer,
3012 GtkTreeViewColumnPrivate *priv;
3013 GdkRectangle cell_area;
3014 GdkRectangle allocation;
3016 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
3017 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell_renderer), FALSE);
3019 priv = tree_column->priv;
3021 gtk_tree_view_get_background_area (GTK_TREE_VIEW (priv->tree_view),
3022 NULL, tree_column, &cell_area);
3024 gtk_cell_area_get_cell_allocation (priv->cell_area,
3025 priv->cell_area_context,
3033 GdkRectangle button_allocation;
3035 /* Retrieve column offset */
3036 gtk_widget_get_allocation (priv->button, &button_allocation);
3037 *x_offset = allocation.x - button_allocation.x;
3040 *width = allocation.width;
3046 * gtk_tree_view_column_queue_resize:
3047 * @tree_column: A #GtkTreeViewColumn
3049 * Flags the column, and the cell renderers added to this column, to have
3050 * their sizes renegotiated.
3055 gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column)
3057 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
3059 if (tree_column->priv->tree_view)
3060 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
3064 * gtk_tree_view_column_get_tree_view:
3065 * @tree_column: A #GtkTreeViewColumn
3067 * Returns the #GtkTreeView wherein @tree_column has been inserted.
3068 * If @column is currently not inserted in any tree view, %NULL is
3071 * Return value: (transfer none): The tree view wherein @column has
3072 * been inserted if any, %NULL otherwise.
3077 gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column)
3079 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3081 return tree_column->priv->tree_view;
3085 * gtk_tree_view_column_get_button:
3086 * @tree_column: A #GtkTreeViewColumn
3088 * Returns the button used in the treeview column header
3090 * Return value: (transfer none): The button for the column header.
3095 gtk_tree_view_column_get_button (GtkTreeViewColumn *tree_column)
3097 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3099 return tree_column->priv->button;
3103 _gtk_tree_view_column_get_window (GtkTreeViewColumn *column)
3105 return column->priv->window;
3109 _gtk_tree_view_column_push_padding (GtkTreeViewColumn *column,
3112 column->priv->padding = MAX (column->priv->padding, padding);
3116 _gtk_tree_view_column_get_requested_width (GtkTreeViewColumn *column)
3118 gint requested_width;
3120 gtk_cell_area_context_get_preferred_width (column->priv->cell_area_context, &requested_width, NULL);
3122 return requested_width + column->priv->padding;
3127 _gtk_tree_view_column_set_resized_width (GtkTreeViewColumn *column,
3130 column->priv->resized_width = width;
3134 _gtk_tree_view_column_get_resized_width (GtkTreeViewColumn *column)
3136 return column->priv->resized_width;
3140 _gtk_tree_view_column_set_use_resized_width (GtkTreeViewColumn *column,
3141 gboolean use_resized_width)
3143 column->priv->use_resized_width = use_resized_width;
3147 _gtk_tree_view_column_get_use_resized_width (GtkTreeViewColumn *column)
3149 return column->priv->use_resized_width;
3153 _gtk_tree_view_column_get_drag_x (GtkTreeViewColumn *column)
3155 return column->priv->drag_x;
3158 GtkCellAreaContext *
3159 _gtk_tree_view_column_get_context (GtkTreeViewColumn *column)
3161 return column->priv->cell_area_context;