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;
139 gint requested_width;
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;
454 priv->requested_width = -1;
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 if (!strcmp (pspec->name, "minimum-width") ||
1250 !strcmp (pspec->name, "natural-width") ||
1251 !strcmp (pspec->name, "minimum-height") ||
1252 !strcmp (pspec->name, "natural-height"))
1254 /* XXX We want to do something specific if the size actually got cleared
1255 * or if it just grew a little bit because of a data change and we
1256 * are in GROW_ONLY mode.
1258 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1263 gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
1264 GtkCellRenderer *renderer,
1265 GtkCellEditable *edit_widget,
1266 GdkRectangle *cell_area,
1267 const gchar *path_string,
1270 GtkTreeViewColumn *column = user_data;
1271 GtkTreeViewColumnPrivate *priv = column->priv;
1274 if (priv->tree_view)
1276 path = gtk_tree_path_new_from_string (path_string);
1278 _gtk_tree_view_add_editable (GTK_TREE_VIEW (priv->tree_view),
1284 gtk_tree_path_free (path);
1289 gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
1290 GtkCellRenderer *renderer,
1291 GtkCellEditable *edit_widget,
1294 GtkTreeViewColumn *column = user_data;
1295 GtkTreeViewColumnPrivate *priv = column->priv;
1297 if (priv->tree_view)
1298 _gtk_tree_view_remove_editable (GTK_TREE_VIEW (priv->tree_view),
1303 /* Exported Private Functions.
1304 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
1307 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
1309 GtkTreeViewColumnPrivate *priv = column->priv;
1310 GtkAllocation allocation;
1311 GtkTreeView *tree_view;
1313 guint attributes_mask;
1316 tree_view = (GtkTreeView *)priv->tree_view;
1317 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
1319 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
1320 g_return_if_fail (gtk_widget_get_realized (priv->tree_view));
1321 g_return_if_fail (priv->button != NULL);
1323 g_return_if_fail (_gtk_tree_view_get_header_window (tree_view) != NULL);
1324 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
1327 gtk_widget_show (priv->button);
1329 attr.window_type = GDK_WINDOW_CHILD;
1330 attr.wclass = GDK_INPUT_ONLY;
1331 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
1332 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view)) |
1333 (GDK_BUTTON_PRESS_MASK |
1334 GDK_BUTTON_RELEASE_MASK |
1335 GDK_POINTER_MOTION_MASK |
1336 GDK_POINTER_MOTION_HINT_MASK |
1337 GDK_KEY_PRESS_MASK);
1338 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
1339 attr.cursor = gdk_cursor_new_for_display
1340 (gdk_window_get_display (_gtk_tree_view_get_header_window (tree_view)), GDK_SB_H_DOUBLE_ARROW);
1342 attr.width = TREE_VIEW_DRAG_WIDTH;
1343 attr.height = _gtk_tree_view_get_header_height (tree_view);
1345 gtk_widget_get_allocation (priv->button, &allocation);
1346 attr.x = (allocation.x + (rtl ? 0 : allocation.width)) - TREE_VIEW_DRAG_WIDTH / 2;
1347 priv->window = gdk_window_new (_gtk_tree_view_get_header_window (tree_view),
1348 &attr, attributes_mask);
1349 gdk_window_set_user_data (priv->window, tree_view);
1351 gtk_tree_view_column_update_button (column);
1353 gdk_cursor_unref (attr.cursor);
1357 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
1359 GtkTreeViewColumnPrivate *priv;
1361 g_return_if_fail (column != NULL);
1363 priv = column->priv;
1364 g_return_if_fail (priv->window != NULL);
1366 gdk_window_set_user_data (priv->window, NULL);
1367 gdk_window_destroy (priv->window);
1368 priv->window = NULL;
1372 _gtk_tree_view_column_unset_model (GtkTreeViewColumn *column,
1373 GtkTreeModel *old_model)
1375 GtkTreeViewColumnPrivate *priv = column->priv;
1377 if (priv->sort_column_changed_signal)
1379 g_signal_handler_disconnect (old_model,
1380 priv->sort_column_changed_signal);
1381 priv->sort_column_changed_signal = 0;
1383 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1387 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
1388 GtkTreeView *tree_view)
1390 GtkTreeViewColumnPrivate *priv = column->priv;
1392 g_assert (priv->tree_view == NULL);
1394 priv->tree_view = GTK_WIDGET (tree_view);
1395 gtk_tree_view_column_create_button (column);
1397 priv->property_changed_signal =
1398 g_signal_connect_swapped (tree_view,
1400 G_CALLBACK (gtk_tree_view_column_setup_sort_column_id_callback),
1403 gtk_tree_view_column_setup_sort_column_id_callback (column);
1407 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
1409 GtkTreeViewColumnPrivate *priv = column->priv;
1411 if (priv->tree_view && priv->button)
1413 gtk_container_remove (GTK_CONTAINER (priv->tree_view), priv->button);
1415 if (priv->property_changed_signal)
1417 g_signal_handler_disconnect (priv->tree_view, priv->property_changed_signal);
1418 priv->property_changed_signal = 0;
1421 if (priv->sort_column_changed_signal)
1423 g_signal_handler_disconnect (gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view)),
1424 priv->sort_column_changed_signal);
1425 priv->sort_column_changed_signal = 0;
1428 priv->tree_view = NULL;
1429 priv->button = NULL;
1433 _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column)
1435 GtkTreeViewColumnPrivate *priv = column->priv;
1436 gboolean ret = FALSE;
1437 GList *list, *cells;
1439 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
1441 for (list = cells; list; list = list->next)
1443 GtkCellRenderer *cell = list->data;
1444 GtkCellRendererMode mode;
1446 g_object_get (cell, "mode", &mode, NULL);
1448 if (mode == GTK_CELL_RENDERER_MODE_EDITABLE)
1455 g_list_free (cells);
1460 /* gets cell being edited */
1462 _gtk_tree_view_column_get_edited_cell (GtkTreeViewColumn *column)
1464 GtkTreeViewColumnPrivate *priv = column->priv;
1466 return gtk_cell_area_get_edited_cell (priv->cell_area);
1469 /* Public Functions */
1473 * gtk_tree_view_column_new:
1475 * Creates a new #GtkTreeViewColumn.
1477 * Return value: A newly created #GtkTreeViewColumn.
1480 gtk_tree_view_column_new (void)
1482 GtkTreeViewColumn *tree_column;
1484 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, NULL);
1490 * gtk_tree_view_column_new_with_attributes:
1491 * @title: The title to set the header to.
1492 * @cell: The #GtkCellRenderer.
1493 * @Varargs: A %NULL-terminated list of attributes.
1495 * Creates a new #GtkTreeViewColumn with a number of default values. This is
1496 * equivalent to calling gtk_tree_view_column_set_title(),
1497 * gtk_tree_view_column_pack_start(), and
1498 * gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn.
1500 * Here's a simple example:
1502 * enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
1505 * GtkTreeViewColumn *column;
1506 * GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
1508 * column = gtk_tree_view_column_new_with_attributes ("Title",
1510 * "text", TEXT_COLUMN,
1511 * "foreground", COLOR_COLUMN,
1516 * Return value: A newly created #GtkTreeViewColumn.
1519 gtk_tree_view_column_new_with_attributes (const gchar *title,
1520 GtkCellRenderer *cell,
1523 GtkTreeViewColumn *retval;
1526 retval = gtk_tree_view_column_new ();
1528 gtk_tree_view_column_set_title (retval, title);
1529 gtk_tree_view_column_pack_start (retval, cell, TRUE);
1531 va_start (args, cell);
1532 gtk_tree_view_column_set_attributesv (retval, cell, args);
1539 * gtk_tree_view_column_pack_start:
1540 * @tree_column: A #GtkTreeViewColumn.
1541 * @cell: The #GtkCellRenderer.
1542 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1544 * Packs the @cell into the beginning of the column. If @expand is %FALSE, then
1545 * the @cell is allocated no more space than it needs. Any unused space is divided
1546 * evenly between cells for which @expand is %TRUE.
1549 gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
1550 GtkCellRenderer *cell,
1553 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (tree_column), cell, expand);
1557 * gtk_tree_view_column_pack_end:
1558 * @tree_column: A #GtkTreeViewColumn.
1559 * @cell: The #GtkCellRenderer.
1560 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1562 * Adds the @cell to end of the column. If @expand is %FALSE, then the @cell
1563 * is allocated no more space than it needs. Any unused space is divided
1564 * evenly between cells for which @expand is %TRUE.
1567 gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
1568 GtkCellRenderer *cell,
1571 gtk_cell_layout_pack_end (GTK_CELL_LAYOUT (tree_column), cell, expand);
1575 * gtk_tree_view_column_clear:
1576 * @tree_column: A #GtkTreeViewColumn
1578 * Unsets all the mappings on all renderers on the @tree_column.
1581 gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column)
1583 gtk_cell_layout_clear (GTK_CELL_LAYOUT (tree_column));
1587 * gtk_tree_view_column_add_attribute:
1588 * @tree_column: A #GtkTreeViewColumn.
1589 * @cell_renderer: the #GtkCellRenderer to set attributes on
1590 * @attribute: An attribute on the renderer
1591 * @column: The column position on the model to get the attribute from.
1593 * Adds an attribute mapping to the list in @tree_column. The @column is the
1594 * column of the model to get a value from, and the @attribute is the
1595 * parameter on @cell_renderer to be set from the value. So for example
1596 * if column 2 of the model contains strings, you could have the
1597 * "text" attribute of a #GtkCellRendererText get its values from
1601 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1602 GtkCellRenderer *cell_renderer,
1603 const gchar *attribute,
1606 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (tree_column),
1607 cell_renderer, attribute, column);
1611 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1612 GtkCellRenderer *cell_renderer,
1615 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1619 attribute = va_arg (args, gchar *);
1621 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (priv->cell_area),
1624 while (attribute != NULL)
1626 column = va_arg (args, gint);
1627 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (priv->cell_area),
1628 cell_renderer, attribute, column);
1629 attribute = va_arg (args, gchar *);
1634 * gtk_tree_view_column_set_attributes:
1635 * @tree_column: A #GtkTreeViewColumn.
1636 * @cell_renderer: the #GtkCellRenderer we're setting the attributes of
1637 * @Varargs: A %NULL-terminated list of attributes.
1639 * Sets the attributes in the list as the attributes of @tree_column.
1640 * The attributes should be in attribute/column order, as in
1641 * gtk_tree_view_column_add_attribute(). All existing attributes
1642 * are removed, and replaced with the new attributes.
1645 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1646 GtkCellRenderer *cell_renderer,
1651 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1652 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1654 va_start (args, cell_renderer);
1655 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1661 * gtk_tree_view_column_set_cell_data_func:
1662 * @tree_column: A #GtkTreeViewColumn
1663 * @cell_renderer: A #GtkCellRenderer
1664 * @func: The #GtkTreeViewColumnFunc to use.
1665 * @func_data: The user data for @func.
1666 * @destroy: The destroy notification for @func_data
1668 * Sets the #GtkTreeViewColumnFunc to use for the column. This
1669 * function is used instead of the standard attributes mapping for
1670 * setting the column value, and should set the value of @tree_column's
1671 * cell renderer as appropriate. @func may be %NULL to remove an
1675 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1676 GtkCellRenderer *cell_renderer,
1677 GtkTreeCellDataFunc func,
1679 GDestroyNotify destroy)
1681 gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT (tree_column),
1683 (GtkCellLayoutDataFunc)func,
1684 func_data, destroy);
1689 * gtk_tree_view_column_clear_attributes:
1690 * @tree_column: a #GtkTreeViewColumn
1691 * @cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1693 * Clears all existing attributes previously set with
1694 * gtk_tree_view_column_set_attributes().
1697 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1698 GtkCellRenderer *cell_renderer)
1700 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (tree_column),
1705 * gtk_tree_view_column_set_spacing:
1706 * @tree_column: A #GtkTreeViewColumn.
1707 * @spacing: distance between cell renderers in pixels.
1709 * Sets the spacing field of @tree_column, which is the number of pixels to
1710 * place between cell renderers packed into it.
1713 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1716 GtkTreeViewColumnPrivate *priv;
1718 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1719 g_return_if_fail (spacing >= 0);
1721 priv = tree_column->priv;
1723 gtk_cell_area_box_set_spacing (GTK_CELL_AREA_BOX (priv->cell_area),
1725 if (priv->tree_view)
1726 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1730 * gtk_tree_view_column_get_spacing:
1731 * @tree_column: A #GtkTreeViewColumn.
1733 * Returns the spacing of @tree_column.
1735 * Return value: the spacing of @tree_column.
1738 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1740 GtkTreeViewColumnPrivate *priv;
1742 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1744 priv = tree_column->priv;
1746 return gtk_cell_area_box_get_spacing (GTK_CELL_AREA_BOX (priv->cell_area));
1749 /* Options for manipulating the columns */
1752 * gtk_tree_view_column_set_visible:
1753 * @tree_column: A #GtkTreeViewColumn.
1754 * @visible: %TRUE if the @tree_column is visible.
1756 * Sets the visibility of @tree_column.
1759 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1762 GtkTreeViewColumnPrivate *priv;
1764 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1766 priv = tree_column->priv;
1767 visible = !! visible;
1769 if (priv->visible == visible)
1772 priv->visible = visible;
1775 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1777 gtk_tree_view_column_update_button (tree_column);
1778 g_object_notify (G_OBJECT (tree_column), "visible");
1782 * gtk_tree_view_column_get_visible:
1783 * @tree_column: A #GtkTreeViewColumn.
1785 * Returns %TRUE if @tree_column is visible.
1787 * Return value: whether the column is visible or not. If it is visible, then
1788 * the tree will show the column.
1791 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1793 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1795 return tree_column->priv->visible;
1799 * gtk_tree_view_column_set_resizable:
1800 * @tree_column: A #GtkTreeViewColumn
1801 * @resizable: %TRUE, if the column can be resized
1803 * If @resizable is %TRUE, then the user can explicitly resize the column by
1804 * grabbing the outer edge of the column button. If resizable is %TRUE and
1805 * sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing
1806 * mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY.
1809 gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
1812 GtkTreeViewColumnPrivate *priv;
1814 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1816 priv = tree_column->priv;
1817 resizable = !! resizable;
1819 if (priv->resizable == resizable)
1822 priv->resizable = resizable;
1824 if (resizable && priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1825 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_GROW_ONLY);
1827 gtk_tree_view_column_update_button (tree_column);
1829 g_object_notify (G_OBJECT (tree_column), "resizable");
1833 * gtk_tree_view_column_get_resizable:
1834 * @tree_column: A #GtkTreeViewColumn
1836 * Returns %TRUE if the @tree_column can be resized by the end user.
1838 * Return value: %TRUE, if the @tree_column can be resized.
1841 gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column)
1843 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1845 return tree_column->priv->resizable;
1850 * gtk_tree_view_column_set_sizing:
1851 * @tree_column: A #GtkTreeViewColumn.
1852 * @type: The #GtkTreeViewColumnSizing.
1854 * Sets the growth behavior of @tree_column to @type.
1857 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
1858 GtkTreeViewColumnSizing type)
1860 GtkTreeViewColumnPrivate *priv;
1862 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1864 priv = tree_column->priv;
1866 if (type == priv->column_type)
1869 if (type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1870 gtk_tree_view_column_set_resizable (tree_column, FALSE);
1873 /* I was clearly on crack when I wrote this. I'm not sure what's supposed to
1874 * be below so I'll leave it until I figure it out.
1876 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE &&
1877 priv->requested_width != -1)
1879 gtk_tree_view_column_set_sizing (tree_column, priv->requested_width);
1882 priv->column_type = type;
1884 gtk_tree_view_column_update_button (tree_column);
1886 g_object_notify (G_OBJECT (tree_column), "sizing");
1890 * gtk_tree_view_column_get_sizing:
1891 * @tree_column: A #GtkTreeViewColumn.
1893 * Returns the current type of @tree_column.
1895 * Return value: The type of @tree_column.
1897 GtkTreeViewColumnSizing
1898 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
1900 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1902 return tree_column->priv->column_type;
1906 * gtk_tree_view_column_get_width:
1907 * @tree_column: A #GtkTreeViewColumn.
1909 * Returns the current size of @tree_column in pixels.
1911 * Return value: The current width of @tree_column.
1914 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
1916 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1918 return tree_column->priv->width;
1922 _gtk_tree_view_column_request_width (GtkTreeViewColumn *tree_column)
1924 GtkTreeViewColumnPrivate *priv;
1925 gint real_requested_width;
1927 priv = tree_column->priv;
1929 if (priv->use_resized_width)
1931 real_requested_width = priv->resized_width;
1933 else if (priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
1935 real_requested_width = priv->fixed_width;
1937 else if (gtk_tree_view_get_headers_visible (GTK_TREE_VIEW (priv->tree_view)))
1939 gint button_request;
1941 gtk_widget_get_preferred_width (priv->button, &button_request, NULL);
1942 real_requested_width = MAX (priv->requested_width, button_request);
1946 real_requested_width = priv->requested_width;
1947 if (real_requested_width < 0)
1948 real_requested_width = 0;
1951 if (priv->min_width != -1)
1952 real_requested_width = MAX (real_requested_width, priv->min_width);
1954 if (priv->max_width != -1)
1955 real_requested_width = MIN (real_requested_width, priv->max_width);
1957 return real_requested_width;
1961 _gtk_tree_view_column_allocate (GtkTreeViewColumn *tree_column,
1966 GtkTreeViewColumnPrivate *priv;
1967 GtkAllocation allocation;
1970 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1972 priv = tree_column->priv;
1974 priv->width = width;
1976 gtk_cell_area_context_allocate (priv->cell_area_context, cell_width, -1);
1978 allocation.x = x_offset;
1980 allocation.width = width;
1981 allocation.height = _gtk_tree_view_get_header_height (GTK_TREE_VIEW (priv->tree_view));
1983 gtk_widget_size_allocate (priv->button, &allocation);
1987 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
1988 gdk_window_move_resize (priv->window,
1989 allocation.x + (rtl ? 0 : allocation.width) - TREE_VIEW_DRAG_WIDTH/2,
1991 TREE_VIEW_DRAG_WIDTH, allocation.height);
1994 g_object_notify (G_OBJECT (tree_column), "width");
1998 * gtk_tree_view_column_set_fixed_width:
1999 * @tree_column: A #GtkTreeViewColumn.
2000 * @fixed_width: The size to set @tree_column to. Must be greater than 0.
2002 * Sets the size of the column in pixels. This is meaningful only if the sizing
2003 * type is #GTK_TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to
2004 * the min/max width for the column. Please note that the min/max width of the
2005 * column doesn't actually affect the "fixed_width" property of the widget, just
2006 * the actual size when displayed.
2009 gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
2012 GtkTreeViewColumnPrivate *priv;
2014 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2015 g_return_if_fail (fixed_width > 0);
2017 priv = tree_column->priv;
2019 priv->fixed_width = fixed_width;
2020 priv->use_resized_width = FALSE;
2022 if (priv->tree_view &&
2023 gtk_widget_get_realized (priv->tree_view) &&
2024 priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2026 gtk_widget_queue_resize (priv->tree_view);
2029 g_object_notify (G_OBJECT (tree_column), "fixed-width");
2033 * gtk_tree_view_column_get_fixed_width:
2034 * @tree_column: a #GtkTreeViewColumn
2036 * Gets the fixed width of the column. This value is only meaning may not be
2037 * the actual width of the column on the screen, just what is requested.
2039 * Return value: the fixed width of the column
2042 gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
2044 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2046 return tree_column->priv->fixed_width;
2050 * gtk_tree_view_column_set_min_width:
2051 * @tree_column: A #GtkTreeViewColumn.
2052 * @min_width: The minimum width of the column in pixels, or -1.
2054 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
2055 * minimum width is unset.
2058 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
2061 GtkTreeViewColumnPrivate *priv;
2063 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2064 g_return_if_fail (min_width >= -1);
2066 priv = tree_column->priv;
2068 if (min_width == priv->min_width)
2071 if (priv->visible &&
2072 priv->tree_view != NULL &&
2073 gtk_widget_get_realized (priv->tree_view))
2075 if (min_width > priv->width)
2076 gtk_widget_queue_resize (priv->tree_view);
2079 priv->min_width = min_width;
2080 g_object_freeze_notify (G_OBJECT (tree_column));
2081 if (priv->max_width != -1 && priv->max_width < min_width)
2083 priv->max_width = min_width;
2084 g_object_notify (G_OBJECT (tree_column), "max-width");
2086 g_object_notify (G_OBJECT (tree_column), "min-width");
2087 g_object_thaw_notify (G_OBJECT (tree_column));
2089 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2090 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2095 * gtk_tree_view_column_get_min_width:
2096 * @tree_column: A #GtkTreeViewColumn.
2098 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
2101 * Return value: The minimum width of the @tree_column.
2104 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
2106 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2108 return tree_column->priv->min_width;
2112 * gtk_tree_view_column_set_max_width:
2113 * @tree_column: A #GtkTreeViewColumn.
2114 * @max_width: The maximum width of the column in pixels, or -1.
2116 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
2117 * maximum width is unset. Note, the column can actually be wider than max
2118 * width if it's the last column in a view. In this case, the column expands to
2119 * fill any extra space.
2122 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
2125 GtkTreeViewColumnPrivate *priv;
2127 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2128 g_return_if_fail (max_width >= -1);
2130 priv = tree_column->priv;
2132 if (max_width == priv->max_width)
2135 if (priv->visible &&
2136 priv->tree_view != NULL &&
2137 gtk_widget_get_realized (priv->tree_view))
2139 if (max_width != -1 && max_width < priv->width)
2140 gtk_widget_queue_resize (priv->tree_view);
2143 priv->max_width = max_width;
2144 g_object_freeze_notify (G_OBJECT (tree_column));
2145 if (max_width != -1 && max_width < priv->min_width)
2147 priv->min_width = max_width;
2148 g_object_notify (G_OBJECT (tree_column), "min-width");
2150 g_object_notify (G_OBJECT (tree_column), "max-width");
2151 g_object_thaw_notify (G_OBJECT (tree_column));
2153 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2154 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2159 * gtk_tree_view_column_get_max_width:
2160 * @tree_column: A #GtkTreeViewColumn.
2162 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
2165 * Return value: The maximum width of the @tree_column.
2168 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
2170 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2172 return tree_column->priv->max_width;
2176 * gtk_tree_view_column_clicked:
2177 * @tree_column: a #GtkTreeViewColumn
2179 * Emits the "clicked" signal on the column. This function will only work if
2180 * @tree_column is clickable.
2183 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
2185 GtkTreeViewColumnPrivate *priv;
2187 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2189 priv = tree_column->priv;
2191 if (priv->visible &&
2194 gtk_button_clicked (GTK_BUTTON (priv->button));
2198 * gtk_tree_view_column_set_title:
2199 * @tree_column: A #GtkTreeViewColumn.
2200 * @title: The title of the @tree_column.
2202 * Sets the title of the @tree_column. If a custom widget has been set, then
2203 * this value is ignored.
2206 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
2209 GtkTreeViewColumnPrivate *priv;
2212 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2214 priv = tree_column->priv;
2216 new_title = g_strdup (title);
2217 g_free (priv->title);
2218 priv->title = new_title;
2220 gtk_tree_view_column_update_button (tree_column);
2221 g_object_notify (G_OBJECT (tree_column), "title");
2225 * gtk_tree_view_column_get_title:
2226 * @tree_column: A #GtkTreeViewColumn.
2228 * Returns the title of the widget.
2230 * Return value: the title of the column. This string should not be
2231 * modified or freed.
2233 G_CONST_RETURN gchar *
2234 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
2236 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2238 return tree_column->priv->title;
2242 * gtk_tree_view_column_set_expand:
2243 * @tree_column: A #GtkTreeViewColumn
2244 * @expand: %TRUE if the column should take available extra space, %FALSE if not
2246 * Sets the column to take available extra space. This space is shared equally
2247 * amongst all columns that have the expand set to %TRUE. If no column has this
2248 * option set, then the last column gets all extra space. By default, every
2249 * column is created with this %FALSE.
2254 gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
2257 GtkTreeViewColumnPrivate *priv;
2259 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2261 priv = tree_column->priv;
2263 expand = expand?TRUE:FALSE;
2264 if (priv->expand == expand)
2266 priv->expand = expand;
2268 if (priv->visible &&
2269 priv->tree_view != NULL &&
2270 gtk_widget_get_realized (priv->tree_view))
2272 /* We want to continue using the original width of the
2273 * column that includes additional space added by the user
2274 * resizing the columns and possibly extra (expanded) space, which
2275 * are not included in the resized width.
2277 priv->use_resized_width = FALSE;
2279 gtk_widget_queue_resize (priv->tree_view);
2282 g_object_notify (G_OBJECT (tree_column), "expand");
2286 * gtk_tree_view_column_get_expand:
2287 * @tree_column: a #GtkTreeViewColumn
2289 * Return %TRUE if the column expands to take any available space.
2291 * Return value: %TRUE, if the column expands
2296 gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column)
2298 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2300 return tree_column->priv->expand;
2304 * gtk_tree_view_column_set_clickable:
2305 * @tree_column: A #GtkTreeViewColumn.
2306 * @clickable: %TRUE if the header is active.
2308 * Sets the header to be active if @active is %TRUE. When the header is active,
2309 * then it can take keyboard focus, and can be clicked.
2312 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
2315 GtkTreeViewColumnPrivate *priv;
2317 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2319 priv = tree_column->priv;
2321 clickable = !! clickable;
2322 if (priv->clickable == clickable)
2325 priv->clickable = clickable;
2326 gtk_tree_view_column_update_button (tree_column);
2327 g_object_notify (G_OBJECT (tree_column), "clickable");
2331 * gtk_tree_view_column_get_clickable:
2332 * @tree_column: a #GtkTreeViewColumn
2334 * Returns %TRUE if the user can click on the header for the column.
2336 * Return value: %TRUE if user can click the column header.
2339 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
2341 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2343 return tree_column->priv->clickable;
2347 * gtk_tree_view_column_set_widget:
2348 * @tree_column: A #GtkTreeViewColumn.
2349 * @widget: (allow-none): A child #GtkWidget, or %NULL.
2351 * Sets the widget in the header to be @widget. If widget is %NULL, then the
2352 * header button is set with a #GtkLabel set to the title of @tree_column.
2355 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
2358 GtkTreeViewColumnPrivate *priv;
2360 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2361 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
2363 priv = tree_column->priv;
2366 g_object_ref_sink (widget);
2369 g_object_unref (priv->child);
2371 priv->child = widget;
2372 gtk_tree_view_column_update_button (tree_column);
2373 g_object_notify (G_OBJECT (tree_column), "widget");
2377 * gtk_tree_view_column_get_widget:
2378 * @tree_column: A #GtkTreeViewColumn.
2380 * Returns the #GtkWidget in the button on the column header.
2381 * If a custom widget has not been set then %NULL is returned.
2383 * Return value: (transfer none): The #GtkWidget in the column
2387 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
2389 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2391 return tree_column->priv->child;
2395 * gtk_tree_view_column_set_alignment:
2396 * @tree_column: A #GtkTreeViewColumn.
2397 * @xalign: The alignment, which is between [0.0 and 1.0] inclusive.
2399 * Sets the alignment of the title or custom widget inside the column header.
2400 * The alignment determines its location inside the button -- 0.0 for left, 0.5
2401 * for center, 1.0 for right.
2404 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
2407 GtkTreeViewColumnPrivate *priv;
2409 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2411 priv = tree_column->priv;
2413 xalign = CLAMP (xalign, 0.0, 1.0);
2415 if (priv->xalign == xalign)
2418 priv->xalign = xalign;
2419 gtk_tree_view_column_update_button (tree_column);
2420 g_object_notify (G_OBJECT (tree_column), "alignment");
2424 * gtk_tree_view_column_get_alignment:
2425 * @tree_column: A #GtkTreeViewColumn.
2427 * Returns the current x alignment of @tree_column. This value can range
2428 * between 0.0 and 1.0.
2430 * Return value: The current alignent of @tree_column.
2433 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
2435 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
2437 return tree_column->priv->xalign;
2441 * gtk_tree_view_column_set_reorderable:
2442 * @tree_column: A #GtkTreeViewColumn
2443 * @reorderable: %TRUE, if the column can be reordered.
2445 * If @reorderable is %TRUE, then the column can be reordered by the end user
2446 * dragging the header.
2449 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
2450 gboolean reorderable)
2452 GtkTreeViewColumnPrivate *priv;
2454 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2456 priv = tree_column->priv;
2459 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
2461 if (priv->reorderable == (reorderable?TRUE:FALSE))
2464 priv->reorderable = (reorderable?TRUE:FALSE);
2465 gtk_tree_view_column_update_button (tree_column);
2466 g_object_notify (G_OBJECT (tree_column), "reorderable");
2470 * gtk_tree_view_column_get_reorderable:
2471 * @tree_column: A #GtkTreeViewColumn
2473 * Returns %TRUE if the @tree_column can be reordered by the user.
2475 * Return value: %TRUE if the @tree_column can be reordered by the user.
2478 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
2480 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2482 return tree_column->priv->reorderable;
2487 * gtk_tree_view_column_set_sort_column_id:
2488 * @tree_column: a #GtkTreeViewColumn
2489 * @sort_column_id: The @sort_column_id of the model to sort on.
2491 * Sets the logical @sort_column_id that this column sorts on when this column
2492 * is selected for sorting. Doing so makes the column header clickable.
2495 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
2496 gint sort_column_id)
2498 GtkTreeViewColumnPrivate *priv;
2500 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2501 g_return_if_fail (sort_column_id >= -1);
2503 priv = tree_column->priv;
2505 if (priv->sort_column_id == sort_column_id)
2508 priv->sort_column_id = sort_column_id;
2510 /* Handle unsetting the id */
2511 if (sort_column_id == -1)
2513 GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
2515 if (priv->sort_clicked_signal)
2517 g_signal_handler_disconnect (tree_column, priv->sort_clicked_signal);
2518 priv->sort_clicked_signal = 0;
2521 if (priv->sort_column_changed_signal)
2523 g_signal_handler_disconnect (model, priv->sort_column_changed_signal);
2524 priv->sort_column_changed_signal = 0;
2527 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
2528 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
2529 gtk_tree_view_column_set_clickable (tree_column, FALSE);
2530 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2534 gtk_tree_view_column_set_clickable (tree_column, TRUE);
2536 if (! priv->sort_clicked_signal)
2537 priv->sort_clicked_signal = g_signal_connect (tree_column,
2539 G_CALLBACK (gtk_tree_view_column_sort),
2542 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
2543 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2547 * gtk_tree_view_column_get_sort_column_id:
2548 * @tree_column: a #GtkTreeViewColumn
2550 * Gets the logical @sort_column_id that the model sorts on when this
2551 * column is selected for sorting.
2552 * See gtk_tree_view_column_set_sort_column_id().
2554 * Return value: the current @sort_column_id for this column, or -1 if
2555 * this column can't be used for sorting.
2558 gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column)
2560 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2562 return tree_column->priv->sort_column_id;
2566 * gtk_tree_view_column_set_sort_indicator:
2567 * @tree_column: a #GtkTreeViewColumn
2568 * @setting: %TRUE to display an indicator that the column is sorted
2570 * Call this function with a @setting of %TRUE to display an arrow in
2571 * the header button indicating the column is sorted. Call
2572 * gtk_tree_view_column_set_sort_order() to change the direction of
2577 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
2580 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2582 setting = setting != FALSE;
2584 if (setting == tree_column->priv->show_sort_indicator)
2587 tree_column->priv->show_sort_indicator = setting;
2588 gtk_tree_view_column_update_button (tree_column);
2589 g_object_notify (G_OBJECT (tree_column), "sort-indicator");
2593 * gtk_tree_view_column_get_sort_indicator:
2594 * @tree_column: a #GtkTreeViewColumn
2596 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
2598 * Return value: whether the sort indicator arrow is displayed
2601 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
2603 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2605 return tree_column->priv->show_sort_indicator;
2609 * gtk_tree_view_column_set_sort_order:
2610 * @tree_column: a #GtkTreeViewColumn
2611 * @order: sort order that the sort indicator should indicate
2613 * Changes the appearance of the sort indicator.
2615 * This <emphasis>does not</emphasis> actually sort the model. Use
2616 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
2617 * support. This function is primarily for custom sorting behavior, and should
2618 * be used in conjunction with gtk_tree_sortable_set_sort_column() to do
2619 * that. For custom models, the mechanism will vary.
2621 * The sort indicator changes direction to indicate normal sort or reverse sort.
2622 * Note that you must have the sort indicator enabled to see anything when
2623 * calling this function; see gtk_tree_view_column_set_sort_indicator().
2626 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
2629 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2631 if (order == tree_column->priv->sort_order)
2634 tree_column->priv->sort_order = order;
2635 gtk_tree_view_column_update_button (tree_column);
2636 g_object_notify (G_OBJECT (tree_column), "sort-order");
2640 * gtk_tree_view_column_get_sort_order:
2641 * @tree_column: a #GtkTreeViewColumn
2643 * Gets the value set by gtk_tree_view_column_set_sort_order().
2645 * Return value: the sort order the sort indicator is indicating
2648 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2650 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2652 return tree_column->priv->sort_order;
2656 * gtk_tree_view_column_cell_set_cell_data:
2657 * @tree_column: A #GtkTreeViewColumn.
2658 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2659 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2660 * @is_expander: %TRUE, if the row has children
2661 * @is_expanded: %TRUE, if the row has visible children
2663 * Sets the cell renderer based on the @tree_model and @iter. That is, for
2664 * every attribute mapping in @tree_column, it will get a value from the set
2665 * column on the @iter, and use that value to set the attribute on the cell
2666 * renderer. This is used primarily by the #GtkTreeView.
2669 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2670 GtkTreeModel *tree_model,
2672 gboolean is_expander,
2673 gboolean is_expanded)
2675 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2677 if (tree_model == NULL)
2680 gtk_cell_area_apply_attributes (tree_column->priv->cell_area, tree_model, iter,
2681 is_expander, is_expanded);
2685 * gtk_tree_view_column_cell_get_size:
2686 * @tree_column: A #GtkTreeViewColumn.
2687 * @cell_area: (allow-none): The area a cell in the column will be allocated, or %NULL
2688 * @x_offset: (allow-none): location to return x offset of a cell relative to @cell_area, or %NULL
2689 * @y_offset: (allow-none): location to return y offset of a cell relative to @cell_area, or %NULL
2690 * @width: (allow-none): location to return width needed to render a cell, or %NULL
2691 * @height: (allow-none): location to return height needed to render a cell, or %NULL
2693 * Obtains the width and height needed to render the column. This is used
2694 * primarily by the #GtkTreeView.
2697 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2698 const GdkRectangle *cell_area,
2704 GtkTreeViewColumnPrivate *priv;
2705 int focus_line_width;
2707 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2709 priv = tree_column->priv;
2716 /* FIXME: This is a temporary hack to get things to allocate mostly right.
2718 * We will add twice the focus-line-width to the for-width
2719 * parameter below. If we do not do this, the height returned is the
2720 * height for two lines of text instead of one. It feels like some lines
2721 * get less width than expected (due to subtraction of focus_line_width?)
2722 * and will unnecessarily wrap.
2724 gtk_widget_style_get (priv->tree_view,
2725 "focus-line-width", &focus_line_width,
2728 g_signal_handler_block (priv->cell_area_context,
2729 priv->context_changed_signal);
2731 gtk_cell_area_get_preferred_width (priv->cell_area,
2732 priv->cell_area_context,
2735 gtk_cell_area_get_preferred_height_for_width (priv->cell_area,
2736 priv->cell_area_context,
2738 *width + focus_line_width * 2,
2742 g_signal_handler_unblock (priv->cell_area_context,
2743 priv->context_changed_signal);
2747 * height = min_height;
2749 * width = min_width;
2754 * gtk_tree_view_column_cell_render:
2755 * @tree_column: A #GtkTreeViewColumn.
2756 * @cr: cairo context to draw to
2757 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2758 * @cell_area: area normally rendered by a cell renderer
2759 * @flags: flags that affect rendering
2761 * Renders the cell contained by #tree_column. This is used primarily by the
2765 _gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2767 const GdkRectangle *background_area,
2768 const GdkRectangle *cell_area,
2770 gboolean draw_focus)
2772 GtkTreeViewColumnPrivate *priv;
2774 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2775 g_return_if_fail (cr != NULL);
2776 g_return_if_fail (background_area != NULL);
2777 g_return_if_fail (cell_area != NULL);
2779 priv = tree_column->priv;
2783 gtk_cell_area_render (priv->cell_area, priv->cell_area_context,
2784 priv->tree_view, cr,
2785 background_area, cell_area, flags,
2792 _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2793 GtkCellEditable **editable_widget,
2796 const GdkRectangle *background_area,
2797 const GdkRectangle *cell_area,
2800 GtkTreeViewColumnPrivate *priv;
2802 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2804 priv = tree_column->priv;
2806 /* FIXME: Should we pass background area here as well?
2807 * What will happen to the path_string and editable widget
2810 * Answer, No dont pass background area... editable widgets
2811 * grab the pointer and keyboard so the treeview doesnt
2812 * recieve these events while editable widgets are editing.
2814 * Also it's important that gtk_cell_area_apply_attributes be
2815 * called before passing the event to the cell (maybe we need to
2816 * instead use the path_string here to apply the attributes ?,
2817 * if the attributes are applied, the underlying CellArea knows
2818 * the path string, which is expected when handling events).
2820 return gtk_cell_area_event (priv->cell_area,
2821 priv->cell_area_context,
2829 _gtk_tree_view_column_get_focus_area (GtkTreeViewColumn *tree_column,
2830 const GdkRectangle *background_area,
2831 const GdkRectangle *cell_area,
2832 GdkRectangle *focus_area)
2836 gtk_tree_view_column_cell_process_action (tree_column,
2849 _gtk_tree_view_column_cell_focus (GtkTreeViewColumn *tree_column,
2855 GtkDirectionType direction = 0;
2856 GtkTreeViewColumnPrivate *priv = tree_column->priv;
2858 rtl = gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL;
2863 direction = GTK_DIR_LEFT;
2867 direction = GTK_DIR_RIGHT;
2871 /* if we are the current focus column and have multiple editable cells,
2872 * try to select the next one, else move the focus to the next column
2874 if (_gtk_tree_view_get_focus_column (GTK_TREE_VIEW (priv->tree_view)) == tree_column)
2876 if (gtk_cell_area_focus (priv->cell_area, direction))
2877 /* Focus stays in this column, so we are done */
2880 /* FIXME: RTL support for the following: */
2881 if (count == -1 && !left)
2883 direction = GTK_DIR_RIGHT;
2884 gtk_cell_area_focus (priv->cell_area, direction);
2886 else if (count == 1 && !right)
2888 direction = GTK_DIR_LEFT;
2889 gtk_cell_area_focus (priv->cell_area, direction);
2895 return gtk_cell_area_focus (priv->cell_area, direction);
2899 * gtk_tree_view_column_cell_is_visible:
2900 * @tree_column: A #GtkTreeViewColumn
2902 * Returns %TRUE if any of the cells packed into the @tree_column are visible.
2903 * For this to be meaningful, you must first initialize the cells with
2904 * gtk_tree_view_column_cell_set_cell_data()
2906 * Return value: %TRUE, if any of the cells packed into the @tree_column are currently visible
2909 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
2913 GtkTreeViewColumnPrivate *priv;
2915 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2917 priv = tree_column->priv;
2919 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
2920 for (list = cells; list; list = list->next)
2922 if (gtk_cell_renderer_get_visible (list->data))
2924 g_list_free (cells);
2929 g_list_free (cells);
2935 * gtk_tree_view_column_focus_cell:
2936 * @tree_column: A #GtkTreeViewColumn
2937 * @cell: A #GtkCellRenderer
2939 * Sets the current keyboard focus to be at @cell, if the column contains
2940 * 2 or more editable and activatable cells.
2945 gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
2946 GtkCellRenderer *cell)
2948 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2949 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
2951 gtk_cell_area_set_focus_cell (tree_column->priv->cell_area, cell);
2955 _gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column,
2956 gboolean install_handler)
2958 GtkTreeViewColumnPrivate *priv = tree_column->priv;
2961 priv->requested_width = -1;
2964 if (priv->tree_view &&
2965 gtk_widget_get_realized (priv->tree_view))
2967 _gtk_tree_view_install_mark_rows_col_dirty (GTK_TREE_VIEW (priv->tree_view), install_handler);
2968 gtk_widget_queue_resize (priv->tree_view);
2973 _gtk_tree_view_column_cell_get_dirty (GtkTreeViewColumn *tree_column)
2975 return tree_column->priv->dirty;
2979 * gtk_tree_view_column_cell_get_position:
2980 * @tree_column: a #GtkTreeViewColumn
2981 * @cell_renderer: a #GtkCellRenderer
2982 * @start_pos: return location for the horizontal position of @cell within
2983 * @tree_column, may be %NULL
2984 * @width: return location for the width of @cell, may be %NULL
2986 * Obtains the horizontal position and size of a cell in a column. If the
2987 * cell is not found in the column, @start_pos and @width are not changed and
2988 * %FALSE is returned.
2990 * Return value: %TRUE if @cell belongs to @tree_column.
2993 gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
2994 GtkCellRenderer *cell_renderer,
2998 GtkTreeViewColumnPrivate *priv;
2999 GdkRectangle zero_cell_area = { 0, };
3000 GdkRectangle allocation;
3002 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
3003 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell_renderer), FALSE);
3005 priv = tree_column->priv;
3007 /* FIXME: Could use a boolean return value for invalid cells */
3008 gtk_cell_area_get_cell_allocation (priv->cell_area,
3009 priv->cell_area_context,
3016 *start_pos = allocation.x;
3018 *width = allocation.width;
3024 * gtk_tree_view_column_queue_resize:
3025 * @tree_column: A #GtkTreeViewColumn
3027 * Flags the column, and the cell renderers added to this column, to have
3028 * their sizes renegotiated.
3033 gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column)
3035 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
3037 if (tree_column->priv->tree_view)
3038 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
3042 * gtk_tree_view_column_get_tree_view:
3043 * @tree_column: A #GtkTreeViewColumn
3045 * Returns the #GtkTreeView wherein @tree_column has been inserted.
3046 * If @column is currently not inserted in any tree view, %NULL is
3049 * Return value: (transfer none): The tree view wherein @column has
3050 * been inserted if any, %NULL otherwise.
3055 gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column)
3057 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3059 return tree_column->priv->tree_view;
3063 * gtk_tree_view_column_get_button:
3064 * @tree_column: A #GtkTreeViewColumn
3066 * Returns the button used in the treeview column header
3068 * Return value: (transfer none): The button for the column header.
3073 gtk_tree_view_column_get_button (GtkTreeViewColumn *tree_column)
3075 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3077 return tree_column->priv->button;
3081 _gtk_tree_view_column_get_window (GtkTreeViewColumn *column)
3083 return column->priv->window;
3087 _gtk_tree_view_column_set_requested_width (GtkTreeViewColumn *column,
3090 column->priv->requested_width = width;
3094 _gtk_tree_view_column_get_requested_width (GtkTreeViewColumn *column)
3096 return column->priv->requested_width;
3100 _gtk_tree_view_column_set_resized_width (GtkTreeViewColumn *column,
3103 column->priv->resized_width = width;
3107 _gtk_tree_view_column_get_resized_width (GtkTreeViewColumn *column)
3109 return column->priv->resized_width;
3113 _gtk_tree_view_column_set_use_resized_width (GtkTreeViewColumn *column,
3114 gboolean use_resized_width)
3116 column->priv->use_resized_width = use_resized_width;
3120 _gtk_tree_view_column_get_use_resized_width (GtkTreeViewColumn *column)
3122 return column->priv->use_resized_width;
3126 _gtk_tree_view_column_get_drag_x (GtkTreeViewColumn *column)
3128 return column->priv->drag_x;
3131 GtkCellAreaContext *
3132 _gtk_tree_view_column_get_context (GtkTreeViewColumn *column)
3134 return column->priv->cell_area_context;