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.
20 #include "gtktreeviewcolumn.h"
21 #include "gtktreeview.h"
22 #include "gtktreeprivate.h"
23 #include "gtksignal.h"
24 #include "gtkbutton.h"
25 #include "gtkalignment.h"
55 typedef struct _GtkTreeViewColumnCellInfo GtkTreeViewColumnCellInfo;
56 struct _GtkTreeViewColumnCellInfo
58 GtkCellRenderer *cell;
60 GtkTreeCellDataFunc func;
62 GtkDestroyNotify destroy;
71 static void gtk_tree_view_column_init (GtkTreeViewColumn *tree_column);
72 static void gtk_tree_view_column_class_init (GtkTreeViewColumnClass *klass);
75 static void gtk_tree_view_column_set_property (GObject *object,
79 static void gtk_tree_view_column_get_property (GObject *object,
83 static void gtk_tree_view_column_finalize (GObject *object);
85 /* Button handling code */
86 static void gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column);
87 static void gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column);
89 /* Button signal handlers */
90 static gint gtk_tree_view_column_button_event (GtkWidget *widget,
93 static void gtk_tree_view_column_button_realize (GtkWidget *widget,
95 static void gtk_tree_view_column_button_clicked (GtkWidget *widget,
98 /* Property handlers */
99 static void gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
100 GtkTreeViewColumn *tree_column);
102 /* Internal functions */
103 static void gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
105 static void gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column);
106 static void gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
107 GtkCellRenderer *cell_renderer,
109 static GtkTreeViewColumnCellInfo *gtk_tree_view_column_get_cell_info (GtkTreeViewColumn *tree_column,
110 GtkCellRenderer *cell_renderer);
114 static GtkObjectClass *parent_class = NULL;
115 static guint tree_column_signals[LAST_SIGNAL] = { 0 };
119 gtk_tree_view_column_get_type (void)
121 static GtkType tree_column_type = 0;
123 if (!tree_column_type)
125 static const GTypeInfo tree_column_info =
127 sizeof (GtkTreeViewColumnClass),
128 NULL, /* base_init */
129 NULL, /* base_finalize */
130 (GClassInitFunc) gtk_tree_view_column_class_init,
131 NULL, /* class_finalize */
132 NULL, /* class_data */
133 sizeof (GtkTreeViewColumn),
135 (GInstanceInitFunc) gtk_tree_view_column_init,
138 tree_column_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkTreeViewColumn", &tree_column_info, 0);
141 return tree_column_type;
145 gtk_tree_view_column_class_init (GtkTreeViewColumnClass *class)
147 GObjectClass *object_class;
149 object_class = (GObjectClass*) class;
151 parent_class = g_type_class_peek_parent (class);
153 class->clicked = NULL;
155 object_class->finalize = gtk_tree_view_column_finalize;
156 object_class->set_property = gtk_tree_view_column_set_property;
157 object_class->get_property = gtk_tree_view_column_get_property;
159 tree_column_signals[CLICKED] =
160 g_signal_new ("clicked",
161 GTK_CLASS_TYPE (object_class),
163 G_STRUCT_OFFSET (GtkTreeViewColumnClass, clicked),
165 gtk_marshal_VOID__VOID,
168 g_object_class_install_property (object_class,
170 g_param_spec_boolean ("visible",
172 _("Whether to display the column"),
174 G_PARAM_READABLE | G_PARAM_WRITABLE));
176 g_object_class_install_property (object_class,
178 g_param_spec_enum ("sizing",
180 _("Resize mode of the column"),
181 GTK_TYPE_TREE_VIEW_COLUMN_SIZING,
182 GTK_TREE_VIEW_COLUMN_AUTOSIZE,
183 G_PARAM_READABLE | G_PARAM_WRITABLE));
185 g_object_class_install_property (object_class,
187 g_param_spec_int ("width",
189 _("Current width of the column"),
193 G_PARAM_READABLE | G_PARAM_WRITABLE));
195 g_object_class_install_property (object_class,
197 g_param_spec_int ("min_width",
199 _("Minimum allowed width of the column"),
203 G_PARAM_READABLE | G_PARAM_WRITABLE));
205 g_object_class_install_property (object_class,
207 g_param_spec_int ("max_width",
209 _("Maximum allowed width of the column"),
213 G_PARAM_READABLE | G_PARAM_WRITABLE));
215 g_object_class_install_property (object_class,
217 g_param_spec_string ("title",
219 _("Title to appear in column header"),
221 G_PARAM_READABLE | G_PARAM_WRITABLE));
223 g_object_class_install_property (object_class,
225 g_param_spec_boolean ("clickable",
227 _("Whether the header can be clicked"),
229 G_PARAM_READABLE | G_PARAM_WRITABLE));
232 g_object_class_install_property (object_class,
234 g_param_spec_object ("widget",
236 _("Widget to put in column header button instead of column title"),
238 G_PARAM_READABLE | G_PARAM_WRITABLE));
240 g_object_class_install_property (object_class,
242 g_param_spec_float ("alignment",
244 _("X Alignment of the column header text or widget"),
248 G_PARAM_READABLE | G_PARAM_WRITABLE));
250 g_object_class_install_property (object_class,
252 g_param_spec_boolean ("reorderable",
254 _("Wether the column can be reordered around the headers"),
256 G_PARAM_READABLE | G_PARAM_WRITABLE));
258 g_object_class_install_property (object_class,
260 g_param_spec_boolean ("sort_indicator",
262 _("Whether to show a sort indicator"),
264 G_PARAM_READABLE | G_PARAM_WRITABLE));
266 g_object_class_install_property (object_class,
268 g_param_spec_enum ("sort_order",
270 _("Sort direction the sort indicator should indicate"),
271 GTK_TYPE_TREE_SORT_ORDER,
272 GTK_TREE_SORT_ASCENDING,
273 G_PARAM_READABLE | G_PARAM_WRITABLE));
278 gtk_tree_view_column_init (GtkTreeViewColumn *tree_column)
280 /* FIXME remove on port to GtkObject */
281 gtk_object_ref (GTK_OBJECT (tree_column));
282 gtk_object_sink (GTK_OBJECT (tree_column));
284 tree_column->button = NULL;
285 tree_column->xalign = 0.0;
286 tree_column->width = 1;
287 tree_column->requested_width = -1;
288 tree_column->min_width = -1;
289 tree_column->max_width = -1;
290 tree_column->column_type = GTK_TREE_VIEW_COLUMN_AUTOSIZE;
291 tree_column->visible = TRUE;
292 tree_column->clickable = FALSE;
293 tree_column->dirty = TRUE;
294 tree_column->sort_order = GTK_TREE_SORT_ASCENDING;
295 tree_column->show_sort_indicator = FALSE;
296 tree_column->property_changed_signal = 0;
297 tree_column->sort_clicked_signal = 0;
298 tree_column->sort_column_changed_signal = 0;
299 tree_column->sort_column_id = -1;
300 tree_column->reorderable = FALSE;
301 tree_column->maybe_reordered = FALSE;
305 gtk_tree_view_column_finalize (GObject *object)
307 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
311 for (list = tree_column->cell_list; list; list = list->next)
313 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
314 if (info->func_data && info->destroy)
315 (info->destroy) (info->func_data);
316 gtk_tree_view_column_clear_attributes (tree_column, info->cell);
317 g_object_unref (G_OBJECT (info->cell));
321 g_free (tree_column->title);
325 gtk_tree_view_column_set_property (GObject *object,
330 GtkTreeViewColumn *tree_column;
332 tree_column = GTK_TREE_VIEW_COLUMN (object);
337 gtk_tree_view_column_set_visible (tree_column,
338 g_value_get_boolean (value));
342 gtk_tree_view_column_set_sizing (tree_column,
343 g_value_get_enum (value));
347 gtk_tree_view_column_set_width (tree_column,
348 g_value_get_int (value));
352 gtk_tree_view_column_set_min_width (tree_column,
353 g_value_get_int (value));
357 gtk_tree_view_column_set_max_width (tree_column,
358 g_value_get_int (value));
362 gtk_tree_view_column_set_title (tree_column,
363 g_value_get_string (value));
367 gtk_tree_view_column_set_clickable (tree_column,
368 g_value_get_boolean (value));
372 gtk_tree_view_column_set_widget (tree_column,
373 (GtkWidget*) g_value_get_object (value));
377 gtk_tree_view_column_set_alignment (tree_column,
378 g_value_get_float (value));
381 case PROP_REORDERABLE:
382 gtk_tree_view_column_set_reorderable (tree_column,
383 g_value_get_boolean (value));
386 case PROP_SORT_INDICATOR:
387 gtk_tree_view_column_set_sort_indicator (tree_column,
388 g_value_get_boolean (value));
391 case PROP_SORT_ORDER:
392 gtk_tree_view_column_set_sort_order (tree_column,
393 g_value_get_enum (value));
397 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
403 gtk_tree_view_column_get_property (GObject *object,
408 GtkTreeViewColumn *tree_column;
410 tree_column = GTK_TREE_VIEW_COLUMN (object);
415 g_value_set_boolean (value,
416 gtk_tree_view_column_get_visible (tree_column));
420 g_value_set_enum (value,
421 gtk_tree_view_column_get_sizing (tree_column));
425 g_value_set_int (value,
426 gtk_tree_view_column_get_width (tree_column));
430 g_value_set_int (value,
431 gtk_tree_view_column_get_min_width (tree_column));
435 g_value_set_int (value,
436 gtk_tree_view_column_get_max_width (tree_column));
440 g_value_set_string (value,
441 gtk_tree_view_column_get_title (tree_column));
445 g_value_set_boolean (value,
446 gtk_tree_view_column_get_clickable (tree_column));
450 g_value_set_object (value,
451 (GObject*) gtk_tree_view_column_get_widget (tree_column));
455 g_value_set_float (value,
456 gtk_tree_view_column_get_alignment (tree_column));
459 case PROP_REORDERABLE:
460 g_value_set_boolean (value,
461 gtk_tree_view_column_get_reorderable (tree_column));
464 case PROP_SORT_INDICATOR:
465 g_value_set_boolean (value,
466 gtk_tree_view_column_get_sort_indicator (tree_column));
469 case PROP_SORT_ORDER:
470 g_value_set_enum (value,
471 gtk_tree_view_column_get_sort_order (tree_column));
475 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
483 /* Button handling code
486 gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column)
488 GtkTreeView *tree_view;
492 tree_view = (GtkTreeView *) tree_column->tree_view;
494 g_return_if_fail (tree_view != NULL);
495 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
496 g_return_if_fail (tree_column->button == NULL);
498 gtk_widget_push_composite_child ();
499 tree_column->button = gtk_button_new ();
500 gtk_widget_pop_composite_child ();
502 /* make sure we own a reference to it as well. */
503 gtk_widget_set_parent (tree_column->button, GTK_WIDGET (tree_view));
504 if (tree_view->priv->header_window)
505 gtk_widget_set_parent_window (tree_column->button, tree_view->priv->header_window);
507 gtk_signal_connect (GTK_OBJECT (tree_column->button), "realize",
508 (GtkSignalFunc) gtk_tree_view_column_button_realize,
511 gtk_signal_connect (GTK_OBJECT (tree_column->button), "event",
512 (GtkSignalFunc) gtk_tree_view_column_button_event,
513 (gpointer) tree_column);
515 gtk_signal_connect (GTK_OBJECT (tree_column->button), "clicked",
516 (GtkSignalFunc) gtk_tree_view_column_button_clicked,
517 (gpointer) tree_column);
519 tree_column->alignment = gtk_alignment_new (tree_column->xalign, 0.5, 0.0, 0.0);
521 hbox = gtk_hbox_new (FALSE, 2);
522 tree_column->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_IN);
524 if (tree_column->child)
525 child = tree_column->child;
528 child = gtk_label_new (tree_column->title);
529 gtk_widget_show (child);
532 if (tree_column->xalign <= 0.5)
533 gtk_box_pack_end (GTK_BOX (hbox), tree_column->arrow, FALSE, FALSE, 0);
535 gtk_box_pack_start (GTK_BOX (hbox), tree_column->arrow, FALSE, FALSE, 0);
537 gtk_box_pack_start (GTK_BOX (hbox), tree_column->alignment, TRUE, TRUE, 0);
539 gtk_container_add (GTK_CONTAINER (tree_column->alignment), child);
540 gtk_container_add (GTK_CONTAINER (tree_column->button), hbox);
542 gtk_widget_show (hbox);
543 gtk_widget_show (tree_column->alignment);
544 gtk_tree_view_column_update_button (tree_column);
548 gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column)
551 GtkWidget *alignment;
553 GtkWidget *current_child;
555 /* Create a button if necessary */
556 if (tree_column->visible &&
557 tree_column->button == NULL &&
558 tree_column->tree_view &&
559 GTK_WIDGET_REALIZED (tree_column->tree_view))
560 gtk_tree_view_column_create_button (tree_column);
562 if (! tree_column->button)
565 hbox = GTK_BIN (tree_column->button)->child;
566 alignment = tree_column->alignment;
567 arrow = tree_column->arrow;
568 current_child = GTK_BIN (alignment)->child;
570 /* Set up the actual button */
571 gtk_alignment_set (GTK_ALIGNMENT (alignment), tree_column->xalign,
574 if (tree_column->child)
576 if (current_child != tree_column->child)
578 gtk_container_remove (GTK_CONTAINER (alignment),
580 gtk_container_add (GTK_CONTAINER (alignment),
586 if (current_child == NULL)
588 current_child = gtk_label_new (NULL);
589 gtk_widget_show (current_child);
590 gtk_container_add (GTK_CONTAINER (alignment),
594 g_return_if_fail (GTK_IS_LABEL (current_child));
596 if (tree_column->title)
597 gtk_label_set_text (GTK_LABEL (current_child),
600 gtk_label_set_text (GTK_LABEL (current_child),
604 switch (tree_column->sort_order)
606 case GTK_TREE_SORT_ASCENDING:
607 gtk_arrow_set (GTK_ARROW (arrow),
612 case GTK_TREE_SORT_DESCENDING:
613 gtk_arrow_set (GTK_ARROW (arrow),
619 g_warning (G_STRLOC": bad sort order");
623 /* Put arrow on the right if the text is left-or-center justified,
624 * and on the left otherwise; do this by packing boxes, so flipping
625 * text direction will reverse things
627 gtk_widget_ref (arrow);
628 gtk_container_remove (GTK_CONTAINER (hbox), arrow);
630 if (tree_column->xalign <= 0.5)
632 gtk_box_pack_end (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
636 gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
637 /* move it to the front */
638 gtk_box_reorder_child (GTK_BOX (hbox), arrow, 0);
640 gtk_widget_unref (arrow);
642 if (tree_column->show_sort_indicator)
643 gtk_widget_show (arrow);
645 gtk_widget_hide (arrow);
647 /* It's always safe to hide the button. It isn't always safe to show it, as if you show it
648 * before it's realized, it'll get the wrong window. */
649 if (tree_column->button &&
650 tree_column->tree_view != NULL &&
651 GTK_WIDGET_REALIZED (tree_column->tree_view))
653 if (tree_column->visible)
655 gtk_widget_show_now (tree_column->button);
656 if (tree_column->window)
658 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_RESIZABLE)
660 gdk_window_show (tree_column->window);
661 gdk_window_raise (tree_column->window);
665 gdk_window_hide (tree_column->window);
671 gtk_widget_hide (tree_column->button);
672 if (tree_column->window)
673 gdk_window_hide (tree_column->window);
677 if (tree_column->reorderable || tree_column->clickable)
679 GTK_WIDGET_SET_FLAGS (tree_column->button, GTK_CAN_FOCUS);
683 GTK_WIDGET_UNSET_FLAGS (tree_column->button, GTK_CAN_FOCUS);
684 if (GTK_WIDGET_HAS_FOCUS (tree_column->button))
686 GtkWidget *toplevel = gtk_widget_get_toplevel (tree_column->tree_view);
687 if (GTK_WIDGET_TOPLEVEL (toplevel))
688 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
692 tree_column->dirty = TRUE;
693 gtk_widget_queue_resize (tree_column->tree_view);
696 /* Button signal handlers
700 gtk_tree_view_column_button_event (GtkWidget *widget,
704 GtkTreeViewColumn *column = (GtkTreeViewColumn *) data;
706 g_return_val_if_fail (event != NULL, FALSE);
708 if (event->type == GDK_BUTTON_PRESS &&
711 column->maybe_reordered = TRUE;
712 gdk_window_get_pointer (widget->window,
716 gtk_widget_grab_focus (widget);
719 if (event->type == GDK_BUTTON_RELEASE &&
720 column->maybe_reordered)
721 column->maybe_reordered = FALSE;
723 if (event->type == GDK_MOTION_NOTIFY &&
724 (column->maybe_reordered) &&
725 (gtk_drag_check_threshold (widget,
728 (gint) ((GdkEventMotion *)event)->x,
729 (gint) ((GdkEventMotion *)event)->y)))
731 column->maybe_reordered = FALSE;
732 _gtk_tree_view_column_start_drag (GTK_TREE_VIEW (column->tree_view), column);
735 if (column->clickable == FALSE)
739 case GDK_BUTTON_PRESS:
740 case GDK_2BUTTON_PRESS:
741 case GDK_3BUTTON_PRESS:
742 case GDK_MOTION_NOTIFY:
743 case GDK_BUTTON_RELEASE:
744 case GDK_ENTER_NOTIFY:
745 case GDK_LEAVE_NOTIFY:
755 gtk_tree_view_column_button_realize (GtkWidget *widget, gpointer data)
757 gdk_window_set_events (widget->window, gdk_window_get_events (widget->window) | GDK_POINTER_MOTION_MASK);
761 gtk_tree_view_column_button_clicked (GtkWidget *widget, gpointer data)
763 g_signal_emit_by_name (G_OBJECT (data), "clicked");
767 gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
768 GtkTreeViewColumn *column)
771 GtkTreeSortOrder order;
773 if (gtk_tree_sortable_get_sort_column_id (sortable,
777 if (sort_column_id == column->sort_column_id)
779 gtk_tree_view_column_set_sort_indicator (column, TRUE);
780 gtk_tree_view_column_set_sort_order (column, order);
784 gtk_tree_view_column_set_sort_indicator (column, FALSE);
790 gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
795 g_return_if_fail (tree_column->tree_view != NULL);
797 if (tree_column->show_sort_indicator)
799 if (tree_column->sort_order == GTK_TREE_SORT_ASCENDING)
800 gtk_tree_view_column_set_sort_order (tree_column, GTK_TREE_SORT_DESCENDING);
802 gtk_tree_view_column_set_sort_order (tree_column, GTK_TREE_SORT_ASCENDING);
806 gtk_tree_view_column_set_sort_order (tree_column, GTK_TREE_SORT_ASCENDING);
807 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
810 list = (GTK_TREE_VIEW (tree_column->tree_view)->priv->columns);
814 GtkTreeViewColumn *tmp_column;
816 tmp_column = GTK_TREE_VIEW_COLUMN (list->data);
817 if (tmp_column->visible && tmp_column != tree_column)
818 gtk_tree_view_column_set_sort_indicator (tmp_column, FALSE);
823 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
824 tree_column->sort_column_id,
825 tree_column->sort_order);
830 gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column)
834 if (tree_column->tree_view == NULL)
837 model = gtk_tree_view_get_model (GTK_TREE_VIEW (tree_column->tree_view));
841 if (tree_column->sort_column_changed_signal)
843 g_signal_handler_disconnect (G_OBJECT (tree_column), tree_column->sort_column_changed_signal);
844 tree_column->sort_column_changed_signal = 0;
849 if (GTK_IS_TREE_SORTABLE (model) &&
850 tree_column->sort_column_id != -1)
852 gint real_sort_column_id;
853 GtkTreeSortOrder real_order;
855 if (tree_column->sort_column_changed_signal == 0)
856 tree_column->sort_column_changed_signal =
857 g_signal_connect (G_OBJECT (model), "sort_column_changed",
858 GTK_SIGNAL_FUNC (gtk_tree_view_model_sort_column_changed),
861 if (gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
862 &real_sort_column_id,
864 (real_sort_column_id == tree_column->sort_column_id))
866 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
867 gtk_tree_view_column_set_sort_order (tree_column, real_order);
875 /* Exported Private Functions.
876 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
880 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
882 GtkTreeView *tree_view;
884 guint attributes_mask;
886 tree_view = (GtkTreeView *)column->tree_view;
888 g_return_if_fail (tree_view != NULL);
889 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
890 g_return_if_fail (GTK_WIDGET_REALIZED (tree_view));
891 g_return_if_fail (tree_view->priv->header_window != NULL);
892 g_return_if_fail (column->button != NULL);
894 gtk_widget_set_parent_window (column->button, tree_view->priv->header_window);
897 gtk_widget_show (column->button);
899 attr.window_type = GDK_WINDOW_CHILD;
900 attr.wclass = GDK_INPUT_ONLY;
901 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
902 attr.colormap = gtk_widget_get_colormap (GTK_WIDGET (tree_view));
903 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view));
904 attr.event_mask = (GDK_BUTTON_PRESS_MASK |
905 GDK_BUTTON_RELEASE_MASK |
906 GDK_POINTER_MOTION_MASK |
907 GDK_POINTER_MOTION_HINT_MASK |
909 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
910 attr.cursor = gdk_cursor_new (GDK_SB_H_DOUBLE_ARROW);
911 tree_view->priv->cursor_drag = attr.cursor;
914 attr.width = TREE_VIEW_DRAG_WIDTH;
915 attr.height = tree_view->priv->header_height;
917 attr.x = (column->button->allocation.x + column->button->allocation.width) - 3;
919 column->window = gdk_window_new (tree_view->priv->header_window,
920 &attr, attributes_mask);
921 gdk_window_set_user_data (column->window, tree_view);
923 gtk_tree_view_column_update_button (column);
927 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
929 g_return_if_fail (column != NULL);
930 g_return_if_fail (column->window != NULL);
932 gdk_window_set_user_data (column->window, NULL);
933 gdk_window_destroy (column->window);
934 column->window = NULL;
938 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
939 GtkTreeView *tree_view)
941 g_assert (column->tree_view == NULL);
943 column->tree_view = GTK_WIDGET (tree_view);
944 gtk_tree_view_column_create_button (column);
946 column->property_changed_signal =
947 g_signal_connect_swapped (GTK_OBJECT (tree_view),
949 GTK_SIGNAL_FUNC (gtk_tree_view_column_setup_sort_column_id_callback),
952 gtk_tree_view_column_setup_sort_column_id_callback (column);
956 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
958 if (column->tree_view && column->button)
960 gtk_container_remove (GTK_CONTAINER (column->tree_view), column->button);
962 if (column->property_changed_signal)
964 g_signal_handler_disconnect (G_OBJECT (column->tree_view), column->property_changed_signal);
965 column->property_changed_signal = 0;
968 if (column->sort_column_changed_signal)
970 g_signal_handler_disconnect (G_OBJECT (column), column->sort_column_changed_signal);
971 column->sort_column_changed_signal = 0;
974 column->tree_view = NULL;
975 column->button = NULL;
979 _gtk_tree_view_column_set_width (GtkTreeViewColumn *tree_column,
982 if (tree_column->min_width != -1 &&
983 width <= tree_column->min_width)
984 width = tree_column->min_width;
985 else if (tree_column->max_width != -1 &&
986 width > tree_column->max_width)
987 width = tree_column->max_width;
989 if (tree_column->width == width)
992 tree_column->width = width;
994 g_object_notify (G_OBJECT (tree_column), "width");
996 if (tree_column->tree_view != NULL)
997 gtk_widget_queue_resize (tree_column->tree_view);
1001 /* Public Functions */
1005 * gtk_tree_view_column_new:
1007 * Creates a new #GtkTreeViewColumn.
1009 * Return value: A newly created #GtkTreeViewColumn.
1012 gtk_tree_view_column_new (void)
1014 GtkTreeViewColumn *tree_column;
1016 tree_column = GTK_TREE_VIEW_COLUMN (gtk_type_new (GTK_TYPE_TREE_VIEW_COLUMN));
1022 * gtk_tree_view_column_new_with_attributes:
1023 * @title: The title to set the header to.
1024 * @cell: The #GtkCellRenderer.
1025 * @Varargs: A NULL terminated list of attributes.
1027 * Creates a new #GtkTreeViewColumn with a number of default values. This is
1028 * equivalent to calling @gtk_tree_view_column_set_title,
1029 * @gtk_tree_view_column_set_cell_renderer, and
1030 * @gtk_tree_view_column_set_attributes on the newly created #GtkTreeViewColumn.
1032 * Return value: A newly created #GtkTreeViewColumn.
1035 gtk_tree_view_column_new_with_attributes (const gchar *title,
1036 GtkCellRenderer *cell,
1039 GtkTreeViewColumn *retval;
1042 retval = gtk_tree_view_column_new ();
1044 gtk_tree_view_column_set_title (retval, title);
1045 gtk_tree_view_column_set_cell_renderer (retval, cell);
1047 va_start (args, cell);
1048 gtk_tree_view_column_set_attributesv (retval, cell, args);
1055 * gtk_tree_view_column_set_cell_renderer:
1056 * @tree_column: A #GtkTreeViewColumn.
1057 * @cell: The #GtkCellRenderer, or NULL.
1059 * Sets the cell renderer of the @tree_column. If there is a cell
1060 * renderer already set, then it is removed. If @cell is NULL, then
1061 * the cell renderer is unset.
1064 gtk_tree_view_column_set_cell_renderer (GtkTreeViewColumn *tree_column,
1065 GtkCellRenderer *cell)
1067 gtk_tree_view_column_pack_start_cell_renderer (tree_column, cell, TRUE, TRUE, 0);
1070 static GtkTreeViewColumnCellInfo *
1071 gtk_tree_view_column_get_cell_info (GtkTreeViewColumn *tree_column,
1072 GtkCellRenderer *cell_renderer)
1075 for (list = tree_column->cell_list; list; list = list->next)
1076 if (((GtkTreeViewColumnCellInfo *)list->data)->cell == cell_renderer)
1077 return (GtkTreeViewColumnCellInfo *) list->data;
1082 * gtk_tree_view_column_pack_start_cell_renderer:
1083 * @tree_column: A #GtkTreeViewColumn.
1084 * @cell: The #GtkCellRenderer,
1085 * @expand: TRUE if @cell is to be given extra space allocated to box.
1086 * @fill: TRUE if @cell is to fill space allocated to it.
1087 * @padding: extra space in pixels to place on the outside of the cell
1092 gtk_tree_view_column_pack_start_cell_renderer (GtkTreeViewColumn *tree_column,
1093 GtkCellRenderer *cell,
1098 GtkTreeViewColumnCellInfo *cell_info;
1100 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1101 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
1102 g_return_if_fail (! gtk_tree_view_column_get_cell_info (tree_column, cell));
1104 g_object_ref (G_OBJECT (cell));
1106 cell_info = g_new0 (GtkTreeViewColumnCellInfo, 1);
1107 cell_info->cell = cell;
1108 cell_info->expand = expand ? TRUE : FALSE;
1109 cell_info->fill = fill ? TRUE : FALSE;
1110 cell_info->pack = GTK_PACK_START;
1111 cell_info->attributes = NULL;
1113 tree_column->cell_list = g_list_append (tree_column->cell_list, cell_info);
1117 gtk_tree_view_column_pack_end_cell_renderer (GtkTreeViewColumn *tree_column,
1118 GtkCellRenderer *cell,
1123 GtkTreeViewColumnCellInfo *cell_info;
1125 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1126 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
1127 g_return_if_fail (! gtk_tree_view_column_get_cell_info (tree_column, cell));
1129 g_object_ref (G_OBJECT (cell));
1131 cell_info = g_new (GtkTreeViewColumnCellInfo, 1);
1132 cell_info->cell = cell;
1133 cell_info->expand = expand ? TRUE : FALSE;
1134 cell_info->fill = fill ? TRUE : FALSE;
1135 cell_info->pack = GTK_PACK_END;
1136 cell_info->attributes = NULL;
1138 tree_column->cell_list = g_list_append (tree_column->cell_list, cell_info);
1143 gtk_tree_view_column_clear_cell_renderers (GtkTreeViewColumn *tree_column)
1146 g_return_if_fail (tree_column != NULL);
1148 for (list = tree_column->cell_list; list; list = list->next)
1150 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *)list->data;
1152 g_object_unref (G_OBJECT (info->cell));
1153 gtk_tree_view_column_clear_attributes (tree_column, info->cell);
1157 g_list_free (tree_column->cell_list);
1158 tree_column->cell_list = NULL;
1162 gtk_tree_view_column_get_cell_renderers (GtkTreeViewColumn *tree_column)
1164 GList *retval = NULL, *list;
1166 g_return_val_if_fail (tree_column != NULL, NULL);
1168 for (list = tree_column->cell_list; list; list = list->next)
1170 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *)list->data;
1172 retval = g_list_append (retval, info->cell);
1179 * gtk_tree_view_column_add_attribute:
1180 * @tree_column: A #GtkTreeViewColumn.
1181 * @attribute: An attribute on the columns cell
1182 * @column: The column position on the model to get the attribute from.
1184 * Adds an attribute mapping to the list in @tree_column. The @column is the
1185 * column position on the model to get a value from, and the @attribute is the
1186 * parameter on the @tree_column's cell renderer to set that value to.
1189 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1190 GtkCellRenderer *cell_renderer,
1191 const gchar *attribute,
1194 GtkTreeViewColumnCellInfo *info;
1196 g_return_if_fail (tree_column != NULL);
1197 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1198 info = gtk_tree_view_column_get_cell_info (tree_column, cell_renderer);
1199 g_return_if_fail (info != NULL);
1201 info->attributes = g_slist_prepend (info->attributes, GINT_TO_POINTER (column));
1202 info->attributes = g_slist_prepend (info->attributes, g_strdup (attribute));
1204 if (tree_column->tree_view)
1206 tree_column->dirty = TRUE;
1207 gtk_widget_queue_resize (tree_column->tree_view);
1213 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1214 GtkCellRenderer *cell_renderer,
1220 attribute = va_arg (args, gchar *);
1222 gtk_tree_view_column_clear_attributes (tree_column, cell_renderer);
1224 while (attribute != NULL)
1226 column = va_arg (args, gint);
1227 gtk_tree_view_column_add_attribute (tree_column, cell_renderer, attribute, column);
1228 attribute = va_arg (args, gchar *);
1233 * gtk_tree_view_column_set_attributes:
1234 * @tree_column: A #GtkTreeViewColumn.
1235 * @Varargs: A NULL terminated listing of attributes.
1237 * Sets the attributes in the list as the attributes of @tree_column.
1238 * The attributes should be in attribute/column order, as in
1239 * @gtk_tree_view_column_add_attribute. All existing attributes
1240 * are removed, and replaced with the new attributes.
1243 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1244 GtkCellRenderer *cell_renderer,
1249 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1250 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1251 g_return_if_fail (gtk_tree_view_column_get_cell_info (tree_column, cell_renderer));
1253 va_start (args, cell_renderer);
1254 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1260 * gtk_tree_view_column_set_cell_data_func:
1261 * @tree_column: A #GtkTreeViewColumn
1262 * @func: The #GtkTreeViewColumnFunc to use.
1263 * @func_data: The user data for @func.
1264 * @destroy: The destroy notification for @func_data
1266 * Sets the #GtkTreeViewColumnFunc to use for the column. This function is used
1267 * instead of the standard attributes mapping for setting the column value, and
1268 * should set the value of @tree_column 's cell renderer as appropriate. @func
1269 * may be NULL to remove an older one.
1272 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1273 GtkCellRenderer *cell_renderer,
1274 GtkTreeCellDataFunc func,
1276 GtkDestroyNotify destroy)
1278 GtkTreeViewColumnCellInfo *info;
1280 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1281 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1282 info = gtk_tree_view_column_get_cell_info (tree_column, cell_renderer);
1284 g_return_if_fail (info != NULL);
1286 if (func == info->func &&
1287 func_data == info->func_data &&
1288 destroy == info->destroy)
1291 if (info->func_data && info->destroy)
1292 (info->destroy) (info->func_data);
1295 info->func_data = func_data;
1296 info->destroy = destroy;
1298 if (tree_column->tree_view)
1300 tree_column->dirty = TRUE;
1301 gtk_widget_queue_resize (tree_column->tree_view);
1307 * gtk_tree_view_column_clear_attributes:
1308 * @tree_column: a #GtkTreeViewColumn
1309 *@cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1311 * Clears all existing attributes previously set with
1312 * gtk_tree_view_column_set_attributes().
1315 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1316 GtkCellRenderer *cell_renderer)
1318 GtkTreeViewColumnCellInfo *info;
1321 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1322 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1323 info = gtk_tree_view_column_get_cell_info (tree_column, cell_renderer);
1325 list = info->attributes;
1327 while (list && list->next)
1329 g_free (list->data);
1330 list = list->next->next;
1332 g_slist_free (info->attributes);
1333 info->attributes = NULL;
1335 if (tree_column->tree_view)
1337 tree_column->dirty = TRUE;
1338 gtk_widget_queue_resize (tree_column->tree_view);
1344 * gtk_tree_view_column_set_spacing:
1345 * @tree_column: A #GtkTreeViewColumn.
1346 * @spacing: distance between cell renderers in pixels.
1348 * Sets the spacing field of @tree_column, which is the number of pixels to
1349 * place between cell renderers packed into it.
1352 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1355 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1356 g_return_if_fail (spacing >= 0);
1358 if (tree_column->spacing == spacing)
1361 tree_column->spacing = spacing;
1362 if (tree_column->tree_view)
1364 tree_column->dirty = TRUE;
1365 gtk_widget_queue_resize (tree_column->tree_view);
1370 * gtk_tree_view_column_get_spacing:
1371 * @tree_column: A #GtkTreeViewColumn.
1373 * Returns the spacing of @tree_column.
1376 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1378 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1380 return tree_column->spacing;
1383 /* Options for manipulating the columns */
1386 * gtk_tree_view_column_set_visible:
1387 * @tree_column: A #GtkTreeViewColumn.
1388 * @visible: TRUE if the @tree_column is visible.
1390 * Sets the visibility of @tree_column.
1393 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1396 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1398 visible = !! visible;
1400 if (tree_column->visible == visible)
1403 tree_column->visible = visible;
1405 gtk_tree_view_column_update_button (tree_column);
1406 g_object_notify (G_OBJECT (tree_column), "visible");
1410 * gtk_tree_view_column_get_visible:
1411 * @tree_column: A #GtkTreeViewColumn.
1413 * Returns TRUE if @tree_column is visible.
1415 * Return value: whether the column is visible or not. If it is visible, then
1416 * the tree will show the column.
1419 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1421 g_return_val_if_fail (tree_column != NULL, FALSE);
1422 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1424 return tree_column->visible;
1428 * gtk_tree_view_column_set_sizing:
1429 * @tree_column: A #GtkTreeViewColumn.
1430 * @type: The #GtkTreeViewColumnSizing.
1432 * Sets the growth behavior of @tree_column to @type.
1435 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
1436 GtkTreeViewColumnSizing type)
1438 g_return_if_fail (tree_column != NULL);
1439 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1441 if (type == tree_column->column_type)
1444 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE &&
1445 tree_column->requested_width != -1)
1447 gtk_tree_view_column_set_sizing (tree_column, tree_column->requested_width);
1449 tree_column->column_type = type;
1451 gtk_tree_view_column_update_button (tree_column);
1453 if (type != GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1454 g_object_notify (G_OBJECT (tree_column), "sizing");
1458 * gtk_tree_view_column_get_sizing:
1459 * @tree_column: A #GtkTreeViewColumn.
1461 * Returns the current type of @tree_column.
1463 * Return value: The type of @tree_column.
1465 GtkTreeViewColumnSizing
1466 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
1468 g_return_val_if_fail (tree_column != NULL, 0);
1469 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1471 return tree_column->column_type;
1475 * gtk_tree_view_column_get_size:
1476 * @tree_column: A #GtkTreeViewColumn.
1478 * Returns the current size of the @tree_column in pixels.
1480 * Return value: The current size of the @tree_column.
1483 gtk_tree_view_column_get_size (GtkTreeViewColumn *tree_column)
1485 g_return_val_if_fail (tree_column != NULL, 0);
1486 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1488 return tree_column->width;
1492 * gtk_tree_view_column_set_width:
1493 * @tree_column: A #GtkTreeViewColumn.
1494 * @width: The size to set the @tree_column to.
1496 * Sets the size of the column in pixels, unless the the column type is
1497 * #GTK_TREE_VIEW_COLUMN_AUTOSIZE. In this case, the value is discarded as the
1498 * size of the column is based on the calculated width of the column. The
1499 * width is clamped to the min/max width for the column.
1502 gtk_tree_view_column_set_width (GtkTreeViewColumn *tree_column,
1505 g_return_if_fail (tree_column != NULL);
1506 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1507 g_return_if_fail (width > 0);
1509 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1512 tree_column->requested_width = width;
1513 _gtk_tree_view_column_set_width (tree_column, width);
1517 * gtk_tree_view_column_get_width:
1518 * @tree_column: a #GtkTreeViewColumn
1520 * Gets the value set by gtk_tree_view_column_set_width().
1522 * Return value: the width of the column
1525 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
1527 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1529 return tree_column->width;
1533 * gtk_tree_view_column_set_min_width:
1534 * @tree_column: A #GtkTreeViewColumn.
1535 * @min_width: The minimum width of the column in pixels, or -1.
1537 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
1538 * minimum width is unset.
1541 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
1544 gint real_min_width;
1546 g_return_if_fail (tree_column != NULL);
1547 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1548 g_return_if_fail (min_width >= -1);
1550 if (min_width == tree_column->min_width)
1553 if (tree_column->tree_view == NULL)
1555 tree_column->min_width = min_width;
1559 real_min_width = (tree_column->min_width == -1) ?
1560 tree_column->button->requisition.width : tree_column->min_width;
1562 /* We want to queue a resize if the either the old min_size or the
1563 * new min_size determined the size of the column */
1564 if (GTK_WIDGET_REALIZED (tree_column->tree_view))
1566 if ((tree_column->min_width > tree_column->width) ||
1567 (tree_column->min_width == -1 &&
1568 tree_column->button->requisition.width > tree_column->width) ||
1569 (min_width > tree_column->width) ||
1571 tree_column->button->requisition.width > tree_column->width))
1572 gtk_widget_queue_resize (tree_column->tree_view);
1575 if (tree_column->max_width != -1 && tree_column->max_width < real_min_width)
1576 tree_column->max_width = real_min_width;
1578 tree_column->min_width = min_width;
1580 g_object_notify (G_OBJECT (tree_column), "min_width");
1584 * gtk_tree_view_column_get_min_width:
1585 * @tree_column: A #GtkTreeViewColumn.
1587 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
1590 * Return value: The minimum width of the @tree_column.
1593 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
1595 g_return_val_if_fail (tree_column != NULL, -1);
1596 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
1598 return tree_column->min_width;
1602 * gtk_tree_view_column_set_max_width:
1603 * @tree_column: A #GtkTreeViewColumn.
1604 * @max_width: The maximum width of the column in pixels, or -1.
1606 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
1607 * maximum width is unset.
1610 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
1613 gint real_max_width;
1615 g_return_if_fail (tree_column != NULL);
1616 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1617 g_return_if_fail (max_width >= -1);
1619 if (max_width == tree_column->max_width)
1622 if (tree_column->tree_view == NULL)
1624 tree_column->max_width = max_width;
1628 real_max_width = tree_column->max_width == -1 ?
1629 tree_column->button->requisition.width : tree_column->max_width;
1631 if (tree_column->tree_view &&
1632 GTK_WIDGET_REALIZED (tree_column->tree_view) &&
1633 ((tree_column->max_width < tree_column->width) ||
1634 (max_width != -1 && max_width < tree_column->width)))
1635 gtk_widget_queue_resize (tree_column->tree_view);
1637 tree_column->max_width = max_width;
1639 if (real_max_width > max_width)
1640 tree_column->max_width = max_width;
1642 g_object_notify (G_OBJECT (tree_column), "max_width");
1646 * gtk_tree_view_column_get_max_width:
1647 * @tree_column: A #GtkTreeViewColumn.
1649 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
1652 * Return value: The maximum width of the @tree_column.
1655 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
1657 g_return_val_if_fail (tree_column != NULL, -1);
1658 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
1660 return tree_column->max_width;
1664 * gtk_tree_view_column_clicked:
1665 * @tree_column: a #GtkTreeViewColumn
1667 * Emits the "clicked" signal on the column. This function will only work if
1668 * the user could have conceivably clicked on the button.
1671 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
1673 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1675 if (tree_column->visible &&
1676 tree_column->button &&
1677 tree_column->clickable)
1678 gtk_button_clicked (GTK_BUTTON (tree_column->button));
1682 * gtk_tree_view_column_set_title:
1683 * @tree_column: A #GtkTreeViewColumn.
1684 * @title: The title of the @tree_column.
1686 * Sets the title of the @tree_column. If a custom widget has been set, then
1687 * this value is ignored.
1690 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
1693 g_return_if_fail (tree_column != NULL);
1694 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1696 g_free (tree_column->title);
1698 tree_column->title = g_strdup (title);
1700 tree_column->title = NULL;
1702 gtk_tree_view_column_update_button (tree_column);
1703 g_object_notify (G_OBJECT (tree_column), "title");
1707 * gtk_tree_view_column_get_title:
1708 * @tree_column: A #GtkTreeViewColumn.
1710 * Returns the title of the widget. This value should not be modified.
1712 * Return value: the title of the column.
1714 G_CONST_RETURN gchar *
1715 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
1717 g_return_val_if_fail (tree_column != NULL, NULL);
1718 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
1720 return tree_column->title;
1724 * gtk_tree_view_column_set_clickable:
1725 * @tree_column: A #GtkTreeViewColumn.
1726 * @clickable: TRUE if the header is active.
1728 * Sets the header to be active if @active is TRUE. When the header is active,
1729 * then it can take keyboard focus, and can be clicked.
1732 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
1735 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1737 if (tree_column->clickable == (clickable?TRUE:FALSE))
1740 tree_column->clickable = (clickable?TRUE:FALSE);
1741 gtk_tree_view_column_update_button (tree_column);
1742 g_object_notify (G_OBJECT (tree_column), "clickable");
1746 * gtk_tree_view_column_get_clickable:
1747 * @tree_column: a #GtkTreeViewColumn
1749 * Returns %TRUE if the user can click on the header for the column.
1751 * Return value: whether the user can click the column header
1754 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
1756 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1758 return tree_column->clickable;
1762 * gtk_tree_view_column_set_widget:
1763 * @tree_column: A #GtkTreeViewColumn.
1764 * @widget: A child #GtkWidget, or NULL.
1766 * Sets the widget in the header to be @widget. If widget is NULL, then the
1767 * header button is set with a #GtkLabel set to the title of @tree_column.
1770 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
1773 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1774 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
1778 gtk_object_ref (GTK_OBJECT (widget));
1779 gtk_object_sink (GTK_OBJECT (widget));
1782 if (tree_column->child)
1783 gtk_object_unref (GTK_OBJECT (tree_column->child));
1785 tree_column->child = widget;
1786 gtk_tree_view_column_update_button (tree_column);
1787 g_object_notify (G_OBJECT (tree_column), "widget");
1791 * gtk_tree_view_column_get_widget:
1792 * @tree_column: A #GtkTreeViewColumn.
1794 * Returns the #GtkWidget in the button in the column header. If a custom
1795 * widget has not been set, then this will be a #GtkAlignment with a #GtkLabel
1798 * Return value: The #GtkWidget in the column header.
1801 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
1803 g_return_val_if_fail (tree_column != NULL, NULL);
1804 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
1806 return tree_column->child;
1810 * gtk_tree_view_column_set_alignment:
1811 * @tree_column: A #GtkTreeViewColumn.
1812 * @xalign: alignment (0.0 for left, 0.5 for center, 1.0 for right)
1814 * Sets the alignment of the title or custom widget inside the column header.
1817 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
1820 g_return_if_fail (tree_column != NULL);
1821 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1823 if (tree_column->xalign == xalign)
1826 tree_column->xalign = xalign;
1827 gtk_tree_view_column_update_button (tree_column);
1828 g_object_notify (G_OBJECT (tree_column), "alignment");
1832 * gtk_tree_view_column_get_alignment:
1833 * @tree_column: A #GtkTreeViewColumn.
1835 * Returns the current x alignment of @tree_column. This value can range
1836 * between 0.0 and 1.0.
1838 * Return value: The current alignent of @tree_column.
1841 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
1843 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
1845 return tree_column->xalign;
1849 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
1850 gboolean reorderable)
1852 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1855 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
1857 if (tree_column->reorderable == (reorderable?TRUE:FALSE))
1860 tree_column->reorderable = (reorderable?TRUE:FALSE);
1861 gtk_tree_view_column_update_button (tree_column);
1862 g_object_notify (G_OBJECT (tree_column), "reorderable");
1866 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
1868 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1870 return tree_column->reorderable;
1875 * gtk_tree_view_column_set_sort_column_id:
1876 * @tree_column: a #GtkTreeViewColumn
1877 * @sort_column_id: The sort_column_id of the model to sort on.
1879 * Sets the logical sort_column_id that this column sorts on when this
1880 * column is selected for sorting. Doing so makes
1881 * the column header clickable.
1884 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
1885 gint sort_column_id)
1887 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1888 g_return_if_fail (sort_column_id >= 0);
1890 if (tree_column->sort_column_id == sort_column_id)
1893 tree_column->sort_column_id = sort_column_id;
1895 /* Handle unsetting the id */
1896 if (sort_column_id == -1)
1898 if (tree_column->sort_clicked_signal)
1900 g_signal_handler_disconnect (G_OBJECT (tree_column), tree_column->sort_clicked_signal);
1901 tree_column->sort_clicked_signal = 0;
1904 if (tree_column->sort_column_changed_signal)
1906 g_signal_handler_disconnect (G_OBJECT (tree_column), tree_column->sort_column_changed_signal);
1907 tree_column->sort_column_changed_signal = 0;
1910 gtk_tree_view_column_set_sort_order (tree_column, GTK_TREE_SORT_ASCENDING);
1911 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
1915 gtk_tree_view_column_set_clickable (tree_column, TRUE);
1917 if (! tree_column->sort_clicked_signal)
1918 tree_column->sort_clicked_signal = g_signal_connect (G_OBJECT (tree_column),
1920 G_CALLBACK (gtk_tree_view_column_sort),
1923 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
1927 * gtk_tree_view_column_get_sort_column_id:
1928 * @tree_column: a #GtkTreeViewColumn
1930 * Gets the logical sort_column_id that the model sorts on when this
1931 * coumn is selected for sorting. See gtk_tree_view_column_set_sort_column_id().
1933 * Return value: the current sort_column_id for this column, or -1 if
1934 * this column can't be used for sorting.
1937 gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column)
1939 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1941 return tree_column->sort_column_id;
1945 * gtk_tree_view_column_set_sort_indicator:
1946 * @tree_column: a #GtkTreeViewColumn
1947 * @setting: %TRUE to display an indicator that the column is sorted
1949 * Call this function with a @setting of %TRUE to display an arrow in
1950 * the header button indicating the column is sorted. Call
1951 * gtk_tree_view_column_set_sort_order() to change the direction of
1956 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
1959 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1961 setting = setting != FALSE;
1963 if (setting == tree_column->show_sort_indicator)
1966 tree_column->show_sort_indicator = setting;
1967 gtk_tree_view_column_update_button (tree_column);
1968 g_object_notify (G_OBJECT (tree_column), "sort_indicator");
1972 * gtk_tree_view_column_get_sort_indicator:
1973 * @tree_column: a #GtkTreeViewColumn
1975 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
1977 * Return value: whether the sort indicator arrow is displayed
1980 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
1982 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1984 return tree_column->show_sort_indicator;
1988 * gtk_tree_view_column_set_sort_order:
1989 * @tree_column: a #GtkTreeViewColumn
1990 * @order: sort order that the sort indicator should indicate
1992 * Changes the appearance of the sort indicator. (This <emphasis>does
1993 * not</emphasis> actually sort the model. Use
1994 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
1995 * support. This function is primarily for custom sorting behavior, and should
1996 * be used in conjunction with #gtk_tree_sortable_set_sort_column() to do
1997 * that. For custom models, the mechanism will vary. The sort indicator changes
1998 * direction to indicate normal sort or reverse sort. Note that you must have
1999 * the sort indicator enabled to see anything when calling this function; see
2000 * gtk_tree_view_column_set_sort_indicator().
2004 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
2005 GtkTreeSortOrder order)
2007 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2009 if (order == tree_column->sort_order)
2012 tree_column->sort_order = order;
2013 gtk_tree_view_column_update_button (tree_column);
2014 g_object_notify (G_OBJECT (tree_column), "sort_order");
2018 * gtk_tree_view_column_get_sort_order:
2019 * @tree_column: a #GtkTreeViewColumn
2021 * Gets the value set by gtk_tree_view_column_set_sort_order().
2023 * Return value: the sort order the sort indicator is indicating
2026 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2028 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2030 return tree_column->sort_order;
2034 * gtk_tree_view_column_cell_set_cell_data:
2035 * @tree_column: A #GtkTreeViewColumn.
2036 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2037 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2039 * Sets the cell renderer based on the @tree_model and @tree_node. That is, for
2040 * every attribute mapping in @tree_column, it will get a value from the set
2041 * column on the @tree_node, and use that value to set the attribute on the cell
2042 * renderer. This is used primarily by the GtkTreeView.
2045 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2046 GtkTreeModel *tree_model,
2050 GValue value = { 0, };
2053 g_return_if_fail (tree_column != NULL);
2054 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2055 g_return_if_fail (tree_column->cell_list != NULL);
2057 if (tree_model == NULL)
2060 for (cell_list = tree_column->cell_list; cell_list; cell_list = cell_list->next)
2062 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) cell_list->data;
2063 GObject *cell = (GObject *) info->cell;
2065 list = info->attributes;
2067 g_object_freeze_notify (cell);
2069 while (list && list->next)
2071 gtk_tree_model_get_value (tree_model, iter,
2072 GPOINTER_TO_INT (list->next->data),
2074 g_object_set_property (cell, (gchar *) list->data, &value);
2075 g_value_unset (&value);
2076 list = list->next->next;
2080 (* info->func) (tree_column, info->cell, tree_model, iter, info->func_data);
2081 g_object_thaw_notify (G_OBJECT (info->cell));
2087 * gtk_tree_view_column_cell_get_size:
2088 * @tree_column: A #GtkTreeViewColumn.
2089 * @cell_area: The area a the column will be allocated, or %NULL
2090 * @x_offset: location to return x offset of cell relative to @cell_area, or %NULL
2091 * @y_offset: location to return y offset of cell relative to @cell_area, or %NULL
2092 * @width: location to return width needed to render a cell, or %NULL
2093 * @height: location to return height needed to render a cell, or %NULL
2095 * Obtains the width and height needed to render the column. This is used
2096 * primarily by the GtkTreeView.
2099 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2100 GdkRectangle *cell_area,
2106 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2108 gtk_cell_renderer_get_size (((GtkTreeViewColumnCellInfo *) tree_column->cell_list->data)->cell,
2109 tree_column->tree_view,
2119 * gtk_tree_view_column_cell_render:
2120 * @tree_column: A #GtkTreeViewColumn.
2121 * @window: a #GdkDrawable to draw to
2122 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2123 * @cell_area: area normally rendered by a cell renderer
2124 * @expose_area: area that actually needs updating
2125 * @flags: flags that affect rendering
2127 * Renders the cell contained by #tree_column. This is used primarily by the
2131 gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2133 GdkRectangle *background_area,
2134 GdkRectangle *cell_area,
2135 GdkRectangle *expose_area,
2139 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2141 g_object_get (G_OBJECT ((((GtkTreeViewColumnCellInfo *) tree_column->cell_list->data)->cell)), "visible", &visible, NULL);
2143 gtk_cell_renderer_render (((GtkTreeViewColumnCellInfo *) tree_column->cell_list->data)->cell,
2145 tree_column->tree_view,
2153 * gtk_tree_view_column_cell_event:
2154 * @tree_column: A #GtkTreeViewColumn.
2155 * @event: a #GdkEvent
2156 * @path_string: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
2157 * @background_area: background area as passed to gtk_cell_renderer_render()
2158 * @cell_area: cell area as passed to gtk_cell_renderer_render()
2159 * @flags: render flags
2161 * Handles an event. This is used primarily by the GtkTreeView.
2163 * Return value: %TRUE if the event was consumed/handled
2166 gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2169 GdkRectangle *background_area,
2170 GdkRectangle *cell_area,
2173 gboolean visible, can_activate;
2175 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2177 g_object_get (G_OBJECT (((GtkTreeViewColumnCellInfo *) tree_column->cell_list->data)->cell),
2178 "visible", &visible,
2179 "can_activate", &can_activate,
2181 if (visible && can_activate)
2183 if (gtk_cell_renderer_event (((GtkTreeViewColumnCellInfo *) tree_column->cell_list->data)->cell,
2185 tree_column->tree_view,
2197 gtk_tree_view_column_cell_can_focus (GtkTreeViewColumn *tree_column)
2201 gboolean can_activate;
2203 for (list = tree_column->cell_list; list; list = list->next)
2205 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2206 g_object_get (G_OBJECT (info->cell),
2207 "can_activate", &can_activate,
2208 "visible", &visible,
2210 if (can_activate && visible)
2219 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
2224 for (list = tree_column->cell_list; list; list = list->next)
2226 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2227 g_object_get (G_OBJECT (info->cell),
2228 "visible", &visible,