2 * Copyright (C) 2002, 2003 Kristian Rietveld <kris@gtk.org>
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.
21 #include "gtkcombobox.h"
22 #include "gtkcellareabox.h"
23 #include "gtktreemenu.h"
25 #include "gtkbindings.h"
26 #include "gtkcelllayout.h"
27 #include "gtkcellrenderertext.h"
28 #include "gtkcellview.h"
29 #include "gtkeventbox.h"
32 #include "gtkliststore.h"
34 #include "gtkmenuprivate.h"
35 #include "gtkmenushellprivate.h"
36 #include "gtkscrolledwindow.h"
37 #include "gtkseparatormenuitem.h"
38 #include "deprecated/gtktearoffmenuitem.h"
39 #include "gtktogglebutton.h"
40 #include "gtktreeselection.h"
41 #include "gtkseparator.h"
42 #include "gtkwindow.h"
43 #include "gtktypebuiltins.h"
44 #include "gtkprivate.h"
46 #include <gobject/gvaluecollector.h>
51 #include "gtkmarshalers.h"
54 #include "gtkentryprivate.h"
55 #include "gtktreeprivate.h"
56 #include "a11y/gtkcomboboxaccessible.h"
61 * @Short_description: A widget used to choose from a list of items
63 * @See_also: #GtkComboBoxText, #GtkTreeModel, #GtkCellRenderer
65 * A GtkComboBox is a widget that allows the user to choose from a list of
66 * valid choices. The GtkComboBox displays the selected choice. When
67 * activated, the GtkComboBox displays a popup which allows the user to
68 * make a new choice. The style in which the selected value is displayed,
69 * and the style of the popup is determined by the current theme. It may
70 * be similar to a Windows-style combo box.
72 * The GtkComboBox uses the model-view pattern; the list of valid choices
73 * is specified in the form of a tree model, and the display of the choices
74 * can be adapted to the data in the model by using cell renderers, as you
75 * would in a tree view. This is possible since GtkComboBox implements the
76 * #GtkCellLayout interface. The tree model holding the valid choices is
77 * not restricted to a flat list, it can be a real tree, and the popup will
78 * reflect the tree structure.
80 * To allow the user to enter values not in the model, the 'has-entry'
81 * property allows the GtkComboBox to contain a #GtkEntry. This entry
82 * can be accessed by calling gtk_bin_get_child() on the combo box.
84 * For a simple list of textual choices, the model-view API of GtkComboBox
85 * can be a bit overwhelming. In this case, #GtkComboBoxText offers a
86 * simple alternative. Both GtkComboBox and #GtkComboBoxText can contain
91 /* WELCOME, to THE house of evil code */
92 struct _GtkComboBoxPrivate
102 GtkShadowType shadow_type;
104 gint active; /* Only temporary */
105 GtkTreeRowReference *active_row;
107 GtkWidget *tree_view;
109 GtkWidget *cell_view;
110 GtkWidget *cell_view_frame;
115 GtkWidget *separator;
117 GtkWidget *popup_widget;
118 GtkWidget *popup_window;
119 GtkWidget *scrolled_window;
126 guint activate_button;
127 guint32 activate_time;
129 guint resize_idle_id;
131 /* For "has-entry" specific behavior we track
132 * an automated cell renderer and text column
135 GtkCellRenderer *text_renderer;
139 guint popup_in_progress : 1;
140 guint popup_shown : 1;
141 guint add_tearoffs : 1;
143 guint is_cell_renderer : 1;
144 guint editing_canceled : 1;
145 guint auto_scroll : 1;
146 guint focus_on_click : 1;
147 guint button_sensitivity : 2;
149 guint popup_fixed_width : 1;
151 GtkTreeViewRowSeparatorFunc row_separator_func;
152 gpointer row_separator_data;
153 GDestroyNotify row_separator_destroy;
155 GdkDevice *grab_pointer;
156 GdkDevice *grab_keyboard;
158 gchar *tearoff_title;
161 /* While debugging this evil code, I have learned that
162 * there are actually 4 modes to this widget, which can
163 * be characterized as follows
165 * 1) menu mode, no child added
168 * cell_view -> GtkCellView, regular child
169 * cell_view_frame -> NULL
170 * button -> GtkToggleButton set_parent to combo
171 * arrow -> GtkArrow set_parent to button
172 * separator -> GtkVSepator set_parent to button
173 * popup_widget -> GtkMenu
174 * popup_window -> NULL
175 * scrolled_window -> NULL
177 * 2) menu mode, child added
181 * cell_view_frame -> NULL
182 * button -> GtkToggleButton set_parent to combo
183 * arrow -> GtkArrow, child of button
185 * popup_widget -> GtkMenu
186 * popup_window -> NULL
187 * scrolled_window -> NULL
189 * 3) list mode, no child added
191 * tree_view -> GtkTreeView, child of scrolled_window
192 * cell_view -> GtkCellView, regular child
193 * cell_view_frame -> GtkFrame, set parent to combo
194 * button -> GtkToggleButton, set_parent to combo
195 * arrow -> GtkArrow, child of button
197 * popup_widget -> tree_view
198 * popup_window -> GtkWindow
199 * scrolled_window -> GtkScrolledWindow, child of popup_window
201 * 4) list mode, child added
203 * tree_view -> GtkTreeView, child of scrolled_window
205 * cell_view_frame -> NULL
206 * button -> GtkToggleButton, set_parent to combo
207 * arrow -> GtkArrow, child of button
209 * popup_widget -> tree_view
210 * popup_window -> GtkWindow
211 * scrolled_window -> GtkScrolledWindow, child of popup_window
228 PROP_ROW_SPAN_COLUMN,
229 PROP_COLUMN_SPAN_COLUMN,
236 PROP_BUTTON_SENSITIVITY,
237 PROP_EDITING_CANCELED,
239 PROP_ENTRY_TEXT_COLUMN,
240 PROP_POPUP_FIXED_WIDTH,
246 static guint combo_box_signals[LAST_SIGNAL] = {0,};
248 #define SCROLL_TIME 100
252 static void gtk_combo_box_cell_layout_init (GtkCellLayoutIface *iface);
253 static void gtk_combo_box_cell_editable_init (GtkCellEditableIface *iface);
254 static GObject *gtk_combo_box_constructor (GType type,
255 guint n_construct_properties,
256 GObjectConstructParam *construct_properties);
257 static void gtk_combo_box_dispose (GObject *object);
258 static void gtk_combo_box_finalize (GObject *object);
259 static void gtk_combo_box_destroy (GtkWidget *widget);
261 static void gtk_combo_box_set_property (GObject *object,
265 static void gtk_combo_box_get_property (GObject *object,
270 static void gtk_combo_box_state_flags_changed (GtkWidget *widget,
271 GtkStateFlags previous);
272 static void gtk_combo_box_grab_focus (GtkWidget *widget);
273 static void gtk_combo_box_style_updated (GtkWidget *widget);
274 static void gtk_combo_box_button_toggled (GtkWidget *widget,
276 static void gtk_combo_box_button_state_flags_changed (GtkWidget *widget,
277 GtkStateFlags previous,
279 static void gtk_combo_box_add (GtkContainer *container,
281 static void gtk_combo_box_remove (GtkContainer *container,
284 static void gtk_combo_box_menu_show (GtkWidget *menu,
286 static void gtk_combo_box_menu_hide (GtkWidget *menu,
289 static void gtk_combo_box_set_popup_widget (GtkComboBox *combo_box,
291 static void gtk_combo_box_menu_position_below (GtkMenu *menu,
296 static void gtk_combo_box_menu_position_over (GtkMenu *menu,
301 static void gtk_combo_box_menu_position (GtkMenu *menu,
307 static void gtk_combo_box_unset_model (GtkComboBox *combo_box);
309 static void gtk_combo_box_size_allocate (GtkWidget *widget,
310 GtkAllocation *allocation);
311 static void gtk_combo_box_forall (GtkContainer *container,
312 gboolean include_internals,
313 GtkCallback callback,
314 gpointer callback_data);
315 static gboolean gtk_combo_box_draw (GtkWidget *widget,
317 static gboolean gtk_combo_box_scroll_event (GtkWidget *widget,
318 GdkEventScroll *event);
319 static void gtk_combo_box_set_active_internal (GtkComboBox *combo_box,
322 static void gtk_combo_box_check_appearance (GtkComboBox *combo_box);
323 static void gtk_combo_box_real_move_active (GtkComboBox *combo_box,
324 GtkScrollType scroll);
325 static void gtk_combo_box_real_popup (GtkComboBox *combo_box);
326 static gboolean gtk_combo_box_real_popdown (GtkComboBox *combo_box);
328 /* listening to the model */
329 static void gtk_combo_box_model_row_inserted (GtkTreeModel *model,
333 static void gtk_combo_box_model_row_deleted (GtkTreeModel *model,
336 static void gtk_combo_box_model_rows_reordered (GtkTreeModel *model,
341 static void gtk_combo_box_model_row_changed (GtkTreeModel *model,
345 static void gtk_combo_box_model_row_expanded (GtkTreeModel *model,
351 static void gtk_combo_box_list_position (GtkComboBox *combo_box,
356 static void gtk_combo_box_list_setup (GtkComboBox *combo_box);
357 static void gtk_combo_box_list_destroy (GtkComboBox *combo_box);
359 static gboolean gtk_combo_box_list_button_released (GtkWidget *widget,
360 GdkEventButton *event,
362 static gboolean gtk_combo_box_list_key_press (GtkWidget *widget,
365 static gboolean gtk_combo_box_list_enter_notify (GtkWidget *widget,
366 GdkEventCrossing *event,
368 static void gtk_combo_box_list_auto_scroll (GtkComboBox *combo,
371 static gboolean gtk_combo_box_list_scroll_timeout (GtkComboBox *combo);
372 static gboolean gtk_combo_box_list_button_pressed (GtkWidget *widget,
373 GdkEventButton *event,
376 static gboolean gtk_combo_box_list_select_func (GtkTreeSelection *selection,
379 gboolean path_currently_selected,
382 static void gtk_combo_box_list_row_changed (GtkTreeModel *model,
386 static void gtk_combo_box_list_popup_resize (GtkComboBox *combo_box);
389 static void gtk_combo_box_menu_setup (GtkComboBox *combo_box,
390 gboolean add_children);
391 static void gtk_combo_box_update_title (GtkComboBox *combo_box);
392 static void gtk_combo_box_menu_destroy (GtkComboBox *combo_box);
395 static gboolean gtk_combo_box_menu_button_press (GtkWidget *widget,
396 GdkEventButton *event,
398 static void gtk_combo_box_menu_activate (GtkWidget *menu,
400 GtkComboBox *combo_box);
401 static void gtk_combo_box_update_sensitivity (GtkComboBox *combo_box);
402 static gboolean gtk_combo_box_menu_key_press (GtkWidget *widget,
405 static void gtk_combo_box_menu_popup (GtkComboBox *combo_box,
407 guint32 activate_time);
410 static GtkCellArea *gtk_combo_box_cell_layout_get_area (GtkCellLayout *cell_layout);
412 static gboolean gtk_combo_box_mnemonic_activate (GtkWidget *widget,
413 gboolean group_cycling);
415 static void gtk_combo_box_child_show (GtkWidget *widget,
416 GtkComboBox *combo_box);
417 static void gtk_combo_box_child_hide (GtkWidget *widget,
418 GtkComboBox *combo_box);
420 /* GtkComboBox:has-entry callbacks */
421 static void gtk_combo_box_entry_contents_changed (GtkEntry *entry,
423 static void gtk_combo_box_entry_active_changed (GtkComboBox *combo_box,
425 static gchar *gtk_combo_box_format_entry_text (GtkComboBox *combo_box,
428 /* GtkBuildable method implementation */
429 static GtkBuildableIface *parent_buildable_iface;
431 static void gtk_combo_box_buildable_init (GtkBuildableIface *iface);
432 static gboolean gtk_combo_box_buildable_custom_tag_start (GtkBuildable *buildable,
435 const gchar *tagname,
436 GMarkupParser *parser,
438 static void gtk_combo_box_buildable_custom_tag_end (GtkBuildable *buildable,
441 const gchar *tagname,
443 static GObject *gtk_combo_box_buildable_get_internal_child (GtkBuildable *buildable,
445 const gchar *childname);
448 /* GtkCellEditable method implementations */
449 static void gtk_combo_box_start_editing (GtkCellEditable *cell_editable,
452 static void gtk_combo_box_get_preferred_width (GtkWidget *widget,
455 static void gtk_combo_box_get_preferred_height (GtkWidget *widget,
458 static void gtk_combo_box_get_preferred_width_for_height (GtkWidget *widget,
462 static void gtk_combo_box_get_preferred_height_for_width (GtkWidget *widget,
466 static GtkWidgetPath *gtk_combo_box_get_path_for_child (GtkContainer *container,
468 static void gtk_combo_box_direction_changed (GtkWidget *widget,
469 GtkTextDirection previous_direction);
471 G_DEFINE_TYPE_WITH_CODE (GtkComboBox, gtk_combo_box, GTK_TYPE_BIN,
472 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
473 gtk_combo_box_cell_layout_init)
474 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_EDITABLE,
475 gtk_combo_box_cell_editable_init)
476 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
477 gtk_combo_box_buildable_init))
482 gtk_combo_box_class_init (GtkComboBoxClass *klass)
484 GObjectClass *object_class;
485 GtkContainerClass *container_class;
486 GtkWidgetClass *widget_class;
487 GtkBindingSet *binding_set;
489 container_class = (GtkContainerClass *)klass;
490 container_class->forall = gtk_combo_box_forall;
491 container_class->add = gtk_combo_box_add;
492 container_class->remove = gtk_combo_box_remove;
493 container_class->get_path_for_child = gtk_combo_box_get_path_for_child;
495 widget_class = (GtkWidgetClass *)klass;
496 widget_class->size_allocate = gtk_combo_box_size_allocate;
497 widget_class->draw = gtk_combo_box_draw;
498 widget_class->scroll_event = gtk_combo_box_scroll_event;
499 widget_class->mnemonic_activate = gtk_combo_box_mnemonic_activate;
500 widget_class->grab_focus = gtk_combo_box_grab_focus;
501 widget_class->style_updated = gtk_combo_box_style_updated;
502 widget_class->state_flags_changed = gtk_combo_box_state_flags_changed;
503 widget_class->get_preferred_width = gtk_combo_box_get_preferred_width;
504 widget_class->get_preferred_height = gtk_combo_box_get_preferred_height;
505 widget_class->get_preferred_height_for_width = gtk_combo_box_get_preferred_height_for_width;
506 widget_class->get_preferred_width_for_height = gtk_combo_box_get_preferred_width_for_height;
507 widget_class->destroy = gtk_combo_box_destroy;
508 widget_class->direction_changed = gtk_combo_box_direction_changed;
510 object_class = (GObjectClass *)klass;
511 object_class->constructor = gtk_combo_box_constructor;
512 object_class->dispose = gtk_combo_box_dispose;
513 object_class->finalize = gtk_combo_box_finalize;
514 object_class->set_property = gtk_combo_box_set_property;
515 object_class->get_property = gtk_combo_box_get_property;
517 klass->format_entry_text = gtk_combo_box_format_entry_text;
521 * GtkComboBox::changed:
522 * @widget: the object which received the signal
524 * The changed signal is emitted when the active
525 * item is changed. The can be due to the user selecting
526 * a different item from the list, or due to a
527 * call to gtk_combo_box_set_active_iter().
528 * It will also be emitted while typing into the entry of a combo box
533 combo_box_signals[CHANGED] =
534 g_signal_new (I_("changed"),
535 G_OBJECT_CLASS_TYPE (klass),
537 G_STRUCT_OFFSET (GtkComboBoxClass, changed),
539 g_cclosure_marshal_VOID__VOID,
542 * GtkComboBox::move-active:
543 * @widget: the object that received the signal
544 * @scroll_type: a #GtkScrollType
546 * The ::move-active signal is a
547 * <link linkend="keybinding-signals">keybinding signal</link>
548 * which gets emitted to move the active selection.
552 combo_box_signals[MOVE_ACTIVE] =
553 g_signal_new_class_handler (I_("move-active"),
554 G_OBJECT_CLASS_TYPE (klass),
555 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
556 G_CALLBACK (gtk_combo_box_real_move_active),
558 g_cclosure_marshal_VOID__ENUM,
560 GTK_TYPE_SCROLL_TYPE);
563 * GtkComboBox::popup:
564 * @widget: the object that received the signal
566 * The ::popup signal is a
567 * <link linkend="keybinding-signals">keybinding signal</link>
568 * which gets emitted to popup the combo box list.
570 * The default binding for this signal is Alt+Down.
574 combo_box_signals[POPUP] =
575 g_signal_new_class_handler (I_("popup"),
576 G_OBJECT_CLASS_TYPE (klass),
577 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
578 G_CALLBACK (gtk_combo_box_real_popup),
580 g_cclosure_marshal_VOID__VOID,
583 * GtkComboBox::popdown:
584 * @button: the object which received the signal
586 * The ::popdown signal is a
587 * <link linkend="keybinding-signals">keybinding signal</link>
588 * which gets emitted to popdown the combo box list.
590 * The default bindings for this signal are Alt+Up and Escape.
594 combo_box_signals[POPDOWN] =
595 g_signal_new_class_handler (I_("popdown"),
596 G_OBJECT_CLASS_TYPE (klass),
597 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
598 G_CALLBACK (gtk_combo_box_real_popdown),
600 _gtk_marshal_BOOLEAN__VOID,
604 * GtkComboBox::format-entry-text:
605 * @combo: the object which received the signal
606 * @path: the GtkTreePath string from the combo box's current model to format text for
608 * For combo boxes that are created with an entry (See GtkComboBox:has-entry).
610 * A signal which allows you to change how the text displayed in a combo box's
611 * entry is displayed.
613 * Connect a signal handler which returns an allocated string representing
614 * @path. That string will then be used to set the text in the combo box's entry.
615 * The default signal handler uses the text from the GtkComboBox::entry-text-column
618 * Here's an example signal handler which fetches data from the model and
619 * displays it in the entry.
622 * format_entry_text_callback (GtkComboBox *combo,
624 * gpointer user_data)
627 * GtkTreeModel model;
630 * model = gtk_combo_box_get_model (combo);
632 * gtk_tree_model_get_iter_from_string (model, &iter, path);
633 * gtk_tree_model_get (model, &iter,
634 * THE_DOUBLE_VALUE_COLUMN, &value,
637 * return g_strdup_printf ("%g", value);
641 * Return value: (transfer full): a newly allocated string representing @path
642 * for the current GtkComboBox model.
646 combo_box_signals[FORMAT_ENTRY_TEXT] =
647 g_signal_new (I_("format-entry-text"),
648 G_TYPE_FROM_CLASS (klass),
650 G_STRUCT_OFFSET (GtkComboBoxClass, format_entry_text),
651 _gtk_single_string_accumulator, NULL,
652 _gtk_marshal_STRING__STRING,
653 G_TYPE_STRING, 1, G_TYPE_STRING);
656 binding_set = gtk_binding_set_by_class (widget_class);
658 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Down, GDK_MOD1_MASK,
660 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Down, GDK_MOD1_MASK,
663 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Up, GDK_MOD1_MASK,
665 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Up, GDK_MOD1_MASK,
667 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Escape, 0,
670 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Up, 0,
672 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_STEP_UP);
673 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Up, 0,
675 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_STEP_UP);
676 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Page_Up, 0,
678 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_PAGE_UP);
679 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Page_Up, 0,
681 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_PAGE_UP);
682 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Home, 0,
684 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_START);
685 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Home, 0,
687 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_START);
689 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Down, 0,
691 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_STEP_DOWN);
692 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Down, 0,
694 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_STEP_DOWN);
695 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Page_Down, 0,
697 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_PAGE_DOWN);
698 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Page_Down, 0,
700 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_PAGE_DOWN);
701 gtk_binding_entry_add_signal (binding_set, GDK_KEY_End, 0,
703 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_END);
704 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_End, 0,
706 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_END);
709 g_object_class_override_property (object_class,
710 PROP_EDITING_CANCELED,
716 * The model from which the combo box takes the values shown
721 g_object_class_install_property (object_class,
723 g_param_spec_object ("model",
724 P_("ComboBox model"),
725 P_("The model for the combo box"),
727 GTK_PARAM_READWRITE));
730 * GtkComboBox:wrap-width:
732 * If wrap-width is set to a positive value, the list will be
733 * displayed in multiple columns, the number of columns is
734 * determined by wrap-width.
738 g_object_class_install_property (object_class,
740 g_param_spec_int ("wrap-width",
742 P_("Wrap width for laying out the items in a grid"),
746 GTK_PARAM_READWRITE));
750 * GtkComboBox:row-span-column:
752 * If this is set to a non-negative value, it must be the index of a column
753 * of type %G_TYPE_INT in the model.
755 * The values of that column are used to determine how many rows a value in
756 * the list will span. Therefore, the values in the model column pointed to
757 * by this property must be greater than zero and not larger than wrap-width.
761 g_object_class_install_property (object_class,
762 PROP_ROW_SPAN_COLUMN,
763 g_param_spec_int ("row-span-column",
764 P_("Row span column"),
765 P_("TreeModel column containing the row span values"),
769 GTK_PARAM_READWRITE));
773 * GtkComboBox:column-span-column:
775 * If this is set to a non-negative value, it must be the index of a column
776 * of type %G_TYPE_INT in the model.
778 * The values of that column are used to determine how many columns a value
779 * in the list will span.
783 g_object_class_install_property (object_class,
784 PROP_COLUMN_SPAN_COLUMN,
785 g_param_spec_int ("column-span-column",
786 P_("Column span column"),
787 P_("TreeModel column containing the column span values"),
791 GTK_PARAM_READWRITE));
795 * GtkComboBox:active:
797 * The item which is currently active. If the model is a non-flat treemodel,
798 * and the active item is not an immediate child of the root of the tree,
799 * this property has the value
800 * <literal>gtk_tree_path_get_indices (path)[0]</literal>,
801 * where <literal>path</literal> is the #GtkTreePath of the active item.
805 g_object_class_install_property (object_class,
807 g_param_spec_int ("active",
809 P_("The item which is currently active"),
813 GTK_PARAM_READWRITE));
816 * GtkComboBox:add-tearoffs:
818 * The add-tearoffs property controls whether generated menus
819 * have tearoff menu items.
821 * Note that this only affects menu style combo boxes.
825 g_object_class_install_property (object_class,
827 g_param_spec_boolean ("add-tearoffs",
828 P_("Add tearoffs to menus"),
829 P_("Whether dropdowns should have a tearoff menu item"),
831 GTK_PARAM_READWRITE));
834 * GtkComboBox:has-frame:
836 * The has-frame property controls whether a frame
837 * is drawn around the entry.
841 g_object_class_install_property (object_class,
843 g_param_spec_boolean ("has-frame",
845 P_("Whether the combo box draws a frame around the child"),
847 GTK_PARAM_READWRITE));
849 g_object_class_install_property (object_class,
851 g_param_spec_boolean ("focus-on-click",
852 P_("Focus on click"),
853 P_("Whether the combo box grabs focus when it is clicked with the mouse"),
855 GTK_PARAM_READWRITE));
858 * GtkComboBox:tearoff-title:
860 * A title that may be displayed by the window manager
861 * when the popup is torn-off.
865 g_object_class_install_property (object_class,
867 g_param_spec_string ("tearoff-title",
869 P_("A title that may be displayed by the window manager when the popup is torn-off"),
871 GTK_PARAM_READWRITE));
875 * GtkComboBox:popup-shown:
877 * Whether the combo boxes dropdown is popped up.
878 * Note that this property is mainly useful, because
879 * it allows you to connect to notify::popup-shown.
883 g_object_class_install_property (object_class,
885 g_param_spec_boolean ("popup-shown",
887 P_("Whether the combo's dropdown is shown"),
889 GTK_PARAM_READABLE));
893 * GtkComboBox:button-sensitivity:
895 * Whether the dropdown button is sensitive when
896 * the model is empty.
900 g_object_class_install_property (object_class,
901 PROP_BUTTON_SENSITIVITY,
902 g_param_spec_enum ("button-sensitivity",
903 P_("Button Sensitivity"),
904 P_("Whether the dropdown button is sensitive when the model is empty"),
905 GTK_TYPE_SENSITIVITY_TYPE,
906 GTK_SENSITIVITY_AUTO,
907 GTK_PARAM_READWRITE));
910 * GtkComboBox:has-entry:
912 * Whether the combo box has an entry.
916 g_object_class_install_property (object_class,
918 g_param_spec_boolean ("has-entry",
920 P_("Whether combo box has an entry"),
922 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
925 * GtkComboBox:entry-text-column:
927 * The column in the combo box's model to associate with strings from the entry
928 * if the combo was created with #GtkComboBox:has-entry = %TRUE.
932 g_object_class_install_property (object_class,
933 PROP_ENTRY_TEXT_COLUMN,
934 g_param_spec_int ("entry-text-column",
935 P_("Entry Text Column"),
936 P_("The column in the combo box's model to associate "
937 "with strings from the entry if the combo was "
938 "created with #GtkComboBox:has-entry = %TRUE"),
940 GTK_PARAM_READWRITE));
943 * GtkComboBox:id-column:
945 * The column in the combo box's model that provides string
946 * IDs for the values in the model, if != -1.
950 g_object_class_install_property (object_class,
952 g_param_spec_int ("id-column",
954 P_("The column in the combo box's model that provides "
955 "string IDs for the values in the model"),
957 GTK_PARAM_READWRITE));
960 * GtkComboBox:active-id:
962 * The value of the ID column of the active row.
966 g_object_class_install_property (object_class,
968 g_param_spec_string ("active-id",
970 P_("The value of the id column "
971 "for the active row"),
972 NULL, GTK_PARAM_READWRITE));
975 * GtkComboBox:popup-fixed-width:
977 * Whether the popup's width should be a fixed width matching the
978 * allocated width of the combo box.
982 g_object_class_install_property (object_class,
983 PROP_POPUP_FIXED_WIDTH,
984 g_param_spec_boolean ("popup-fixed-width",
985 P_("Popup Fixed Width"),
986 P_("Whether the popup's width should be a "
987 "fixed width matching the allocated width "
990 GTK_PARAM_READWRITE));
993 * GtkComboBox:cell-area:
995 * The #GtkCellArea used to layout cell renderers for this combo box.
997 * If no area is specified when creating the combo box with gtk_combo_box_new_with_area()
998 * a horizontally oriented #GtkCellAreaBox will be used.
1002 g_object_class_install_property (object_class,
1004 g_param_spec_object ("cell-area",
1006 P_("The GtkCellArea used to layout cells"),
1008 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
1010 gtk_widget_class_install_style_property (widget_class,
1011 g_param_spec_boolean ("appears-as-list",
1012 P_("Appears as list"),
1013 P_("Whether dropdowns should look like lists rather than menus"),
1015 GTK_PARAM_READABLE));
1018 * GtkComboBox:arrow-size:
1020 * Sets the minimum size of the arrow in the combo box. Note
1021 * that the arrow size is coupled to the font size, so in case
1022 * a larger font is used, the arrow will be larger than set
1027 gtk_widget_class_install_style_property (widget_class,
1028 g_param_spec_int ("arrow-size",
1030 P_("The minimum size of the arrow in the combo box"),
1034 GTK_PARAM_READABLE));
1037 * GtkComboBox:arrow-scaling:
1039 * Sets the amount of space used up by the combobox arrow,
1040 * proportional to the font size.
1044 gtk_widget_class_install_style_property (widget_class,
1045 g_param_spec_float ("arrow-scaling",
1046 P_("Arrow Scaling"),
1047 P_("The amount of space used by the arrow"),
1051 GTK_PARAM_READABLE));
1054 * GtkComboBox:shadow-type:
1056 * Which kind of shadow to draw around the combo box.
1060 gtk_widget_class_install_style_property (widget_class,
1061 g_param_spec_enum ("shadow-type",
1063 P_("Which kind of shadow to draw around the combo box"),
1064 GTK_TYPE_SHADOW_TYPE,
1066 GTK_PARAM_READABLE));
1068 g_type_class_add_private (object_class, sizeof (GtkComboBoxPrivate));
1070 gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_COMBO_BOX_ACCESSIBLE);
1074 gtk_combo_box_buildable_init (GtkBuildableIface *iface)
1076 parent_buildable_iface = g_type_interface_peek_parent (iface);
1077 iface->add_child = _gtk_cell_layout_buildable_add_child;
1078 iface->custom_tag_start = gtk_combo_box_buildable_custom_tag_start;
1079 iface->custom_tag_end = gtk_combo_box_buildable_custom_tag_end;
1080 iface->get_internal_child = gtk_combo_box_buildable_get_internal_child;
1084 gtk_combo_box_cell_layout_init (GtkCellLayoutIface *iface)
1086 iface->get_area = gtk_combo_box_cell_layout_get_area;
1090 gtk_combo_box_cell_editable_init (GtkCellEditableIface *iface)
1092 iface->start_editing = gtk_combo_box_start_editing;
1096 gtk_combo_box_init (GtkComboBox *combo_box)
1098 GtkComboBoxPrivate *priv;
1100 combo_box->priv = G_TYPE_INSTANCE_GET_PRIVATE (combo_box,
1102 GtkComboBoxPrivate);
1103 priv = combo_box->priv;
1105 priv->wrap_width = 0;
1108 priv->active_row = NULL;
1109 priv->col_column = -1;
1110 priv->row_column = -1;
1112 priv->popup_shown = FALSE;
1113 priv->add_tearoffs = FALSE;
1114 priv->has_frame = TRUE;
1115 priv->is_cell_renderer = FALSE;
1116 priv->editing_canceled = FALSE;
1117 priv->auto_scroll = FALSE;
1118 priv->focus_on_click = TRUE;
1119 priv->button_sensitivity = GTK_SENSITIVITY_AUTO;
1120 priv->has_entry = FALSE;
1121 priv->popup_fixed_width = TRUE;
1123 priv->text_column = -1;
1124 priv->text_renderer = NULL;
1125 priv->id_column = -1;
1129 gtk_combo_box_set_property (GObject *object,
1131 const GValue *value,
1134 GtkComboBox *combo_box = GTK_COMBO_BOX (object);
1135 GtkComboBoxPrivate *priv = combo_box->priv;
1141 gtk_combo_box_set_model (combo_box, g_value_get_object (value));
1144 case PROP_WRAP_WIDTH:
1145 gtk_combo_box_set_wrap_width (combo_box, g_value_get_int (value));
1148 case PROP_ROW_SPAN_COLUMN:
1149 gtk_combo_box_set_row_span_column (combo_box, g_value_get_int (value));
1152 case PROP_COLUMN_SPAN_COLUMN:
1153 gtk_combo_box_set_column_span_column (combo_box, g_value_get_int (value));
1157 gtk_combo_box_set_active (combo_box, g_value_get_int (value));
1160 case PROP_ADD_TEAROFFS:
1161 gtk_combo_box_set_add_tearoffs (combo_box, g_value_get_boolean (value));
1164 case PROP_HAS_FRAME:
1165 priv->has_frame = g_value_get_boolean (value);
1167 if (priv->has_entry)
1171 child = gtk_bin_get_child (GTK_BIN (combo_box));
1173 gtk_entry_set_has_frame (GTK_ENTRY (child), priv->has_frame);
1178 case PROP_FOCUS_ON_CLICK:
1179 gtk_combo_box_set_focus_on_click (combo_box,
1180 g_value_get_boolean (value));
1183 case PROP_TEAROFF_TITLE:
1184 gtk_combo_box_set_title (combo_box, g_value_get_string (value));
1187 case PROP_POPUP_SHOWN:
1188 if (g_value_get_boolean (value))
1189 gtk_combo_box_popup (combo_box);
1191 gtk_combo_box_popdown (combo_box);
1194 case PROP_BUTTON_SENSITIVITY:
1195 gtk_combo_box_set_button_sensitivity (combo_box,
1196 g_value_get_enum (value));
1199 case PROP_POPUP_FIXED_WIDTH:
1200 gtk_combo_box_set_popup_fixed_width (combo_box,
1201 g_value_get_boolean (value));
1204 case PROP_EDITING_CANCELED:
1205 priv->editing_canceled = g_value_get_boolean (value);
1208 case PROP_HAS_ENTRY:
1209 priv->has_entry = g_value_get_boolean (value);
1212 case PROP_ENTRY_TEXT_COLUMN:
1213 gtk_combo_box_set_entry_text_column (combo_box, g_value_get_int (value));
1216 case PROP_ID_COLUMN:
1217 gtk_combo_box_set_id_column (combo_box, g_value_get_int (value));
1220 case PROP_ACTIVE_ID:
1221 gtk_combo_box_set_active_id (combo_box, g_value_get_string (value));
1224 case PROP_CELL_AREA:
1225 /* Construct-only, can only be assigned once */
1226 area = g_value_get_object (value);
1229 if (priv->area != NULL)
1231 g_warning ("cell-area has already been set, ignoring construct property");
1232 g_object_ref_sink (area);
1233 g_object_unref (area);
1236 priv->area = g_object_ref_sink (area);
1241 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1247 gtk_combo_box_get_property (GObject *object,
1252 GtkComboBox *combo_box = GTK_COMBO_BOX (object);
1253 GtkComboBoxPrivate *priv = combo_box->priv;
1258 g_value_set_object (value, combo_box->priv->model);
1261 case PROP_WRAP_WIDTH:
1262 g_value_set_int (value, combo_box->priv->wrap_width);
1265 case PROP_ROW_SPAN_COLUMN:
1266 g_value_set_int (value, combo_box->priv->row_column);
1269 case PROP_COLUMN_SPAN_COLUMN:
1270 g_value_set_int (value, combo_box->priv->col_column);
1274 g_value_set_int (value, gtk_combo_box_get_active (combo_box));
1277 case PROP_ADD_TEAROFFS:
1278 g_value_set_boolean (value, gtk_combo_box_get_add_tearoffs (combo_box));
1281 case PROP_HAS_FRAME:
1282 g_value_set_boolean (value, combo_box->priv->has_frame);
1285 case PROP_FOCUS_ON_CLICK:
1286 g_value_set_boolean (value, combo_box->priv->focus_on_click);
1289 case PROP_TEAROFF_TITLE:
1290 g_value_set_string (value, gtk_combo_box_get_title (combo_box));
1293 case PROP_POPUP_SHOWN:
1294 g_value_set_boolean (value, combo_box->priv->popup_shown);
1297 case PROP_BUTTON_SENSITIVITY:
1298 g_value_set_enum (value, combo_box->priv->button_sensitivity);
1301 case PROP_POPUP_FIXED_WIDTH:
1302 g_value_set_boolean (value, combo_box->priv->popup_fixed_width);
1305 case PROP_EDITING_CANCELED:
1306 g_value_set_boolean (value, priv->editing_canceled);
1309 case PROP_HAS_ENTRY:
1310 g_value_set_boolean (value, priv->has_entry);
1313 case PROP_ENTRY_TEXT_COLUMN:
1314 g_value_set_int (value, priv->text_column);
1317 case PROP_ID_COLUMN:
1318 g_value_set_int (value, priv->id_column);
1321 case PROP_ACTIVE_ID:
1322 g_value_set_string (value, gtk_combo_box_get_active_id (combo_box));
1325 case PROP_CELL_AREA:
1326 g_value_set_object (value, priv->area);
1330 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1336 gtk_combo_box_state_flags_changed (GtkWidget *widget,
1337 GtkStateFlags previous)
1339 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
1340 GtkComboBoxPrivate *priv = combo_box->priv;
1342 if (gtk_widget_get_realized (widget))
1344 if (priv->tree_view && priv->cell_view)
1346 GtkStyleContext *context;
1347 GtkStateFlags state;
1350 context = gtk_widget_get_style_context (widget);
1351 state = gtk_widget_get_state_flags (widget);
1352 gtk_style_context_get_background_color (context, state, &color);
1354 gtk_cell_view_set_background_rgba (GTK_CELL_VIEW (priv->cell_view), &color);
1358 gtk_widget_queue_draw (widget);
1362 gtk_combo_box_button_state_flags_changed (GtkWidget *widget,
1363 GtkStateFlags previous,
1366 GtkComboBox *combo_box = GTK_COMBO_BOX (data);
1367 GtkComboBoxPrivate *priv = combo_box->priv;
1369 if (gtk_widget_get_realized (widget))
1371 if (!priv->tree_view && priv->cell_view)
1372 gtk_widget_set_state_flags (priv->cell_view,
1373 gtk_widget_get_state_flags (widget),
1377 gtk_widget_queue_draw (widget);
1381 gtk_combo_box_invalidate_order (GtkComboBox *combo_box)
1383 gtk_container_forall (GTK_CONTAINER (combo_box),
1384 (GtkCallback) gtk_widget_reset_style,
1389 gtk_combo_box_direction_changed (GtkWidget *widget,
1390 GtkTextDirection previous_direction)
1392 gtk_combo_box_invalidate_order (GTK_COMBO_BOX (widget));
1395 static GtkWidgetPath *
1396 gtk_combo_box_get_path_for_child (GtkContainer *container,
1399 GtkComboBoxPrivate *priv = GTK_COMBO_BOX (container)->priv;
1400 GtkWidgetPath *path;
1402 gboolean found = FALSE;
1403 GList *visible_children, *l;
1404 GtkWidgetPath *sibling_path;
1407 path = gtk_widget_path_copy (gtk_widget_get_path (GTK_WIDGET (container)));
1409 if (gtk_widget_get_visible (child))
1411 visible_children = NULL;
1413 if (priv->button && gtk_widget_get_visible (priv->button))
1414 visible_children = g_list_prepend (visible_children, priv->button);
1416 if (priv->cell_view_frame && gtk_widget_get_visible (priv->cell_view_frame))
1417 visible_children = g_list_prepend (visible_children, priv->cell_view_frame);
1419 widget = gtk_bin_get_child (GTK_BIN (container));
1420 if (widget && gtk_widget_get_visible (widget))
1421 visible_children = g_list_prepend (visible_children, widget);
1423 if (gtk_widget_get_direction (GTK_WIDGET (container)) == GTK_TEXT_DIR_RTL)
1424 visible_children = g_list_reverse (visible_children);
1428 for (l = visible_children; l; l = l->next)
1432 if (widget == child)
1444 sibling_path = gtk_widget_path_new ();
1446 for (l = visible_children; l; l = l->next)
1447 gtk_widget_path_append_for_widget (sibling_path, l->data);
1449 gtk_widget_path_append_with_siblings (path, sibling_path, pos);
1451 g_list_free (visible_children);
1452 gtk_widget_path_unref (sibling_path);
1456 gtk_widget_path_append_for_widget (path, child);
1463 gtk_combo_box_check_appearance (GtkComboBox *combo_box)
1465 GtkComboBoxPrivate *priv = combo_box->priv;
1466 gboolean appears_as_list;
1468 /* if wrap_width > 0, then we are in grid-mode and forced to use
1471 if (priv->wrap_width)
1472 appears_as_list = FALSE;
1474 gtk_widget_style_get (GTK_WIDGET (combo_box),
1475 "appears-as-list", &appears_as_list,
1478 if (appears_as_list)
1480 /* Destroy all the menu mode widgets, if they exist. */
1481 if (GTK_IS_MENU (priv->popup_widget))
1482 gtk_combo_box_menu_destroy (combo_box);
1484 /* Create the list mode widgets, if they don't already exist. */
1485 if (!GTK_IS_TREE_VIEW (priv->tree_view))
1486 gtk_combo_box_list_setup (combo_box);
1490 /* Destroy all the list mode widgets, if they exist. */
1491 if (GTK_IS_TREE_VIEW (priv->tree_view))
1492 gtk_combo_box_list_destroy (combo_box);
1494 /* Create the menu mode widgets, if they don't already exist. */
1495 if (!GTK_IS_MENU (priv->popup_widget))
1496 gtk_combo_box_menu_setup (combo_box, TRUE);
1499 gtk_widget_style_get (GTK_WIDGET (combo_box),
1500 "shadow-type", &priv->shadow_type,
1505 gtk_combo_box_style_updated (GtkWidget *widget)
1507 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
1508 GtkComboBoxPrivate *priv = combo_box->priv;
1511 GTK_WIDGET_CLASS (gtk_combo_box_parent_class)->style_updated (widget);
1513 gtk_combo_box_check_appearance (combo_box);
1515 if (priv->tree_view && priv->cell_view)
1517 GtkStyleContext *context;
1518 GtkStateFlags state;
1521 context = gtk_widget_get_style_context (widget);
1522 state = gtk_widget_get_state_flags (widget);
1523 gtk_style_context_get_background_color (context, state, &color);
1525 gtk_cell_view_set_background_rgba (GTK_CELL_VIEW (priv->cell_view), &color);
1528 child = gtk_bin_get_child (GTK_BIN (combo_box));
1529 if (GTK_IS_ENTRY (child))
1530 g_object_set (child, "shadow-type",
1531 GTK_SHADOW_NONE == priv->shadow_type ?
1532 GTK_SHADOW_IN : GTK_SHADOW_NONE, NULL);
1536 gtk_combo_box_button_toggled (GtkWidget *widget,
1539 GtkComboBox *combo_box = GTK_COMBO_BOX (data);
1541 if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (widget)))
1543 if (!combo_box->priv->popup_in_progress)
1544 gtk_combo_box_popup (combo_box);
1547 gtk_combo_box_popdown (combo_box);
1551 gtk_combo_box_add (GtkContainer *container,
1554 GtkComboBox *combo_box = GTK_COMBO_BOX (container);
1555 GtkComboBoxPrivate *priv = combo_box->priv;
1557 if (priv->has_entry && !GTK_IS_ENTRY (widget))
1559 g_warning ("Attempting to add a widget with type %s to a GtkComboBox that needs an entry "
1560 "(need an instance of GtkEntry or of a subclass)",
1561 G_OBJECT_TYPE_NAME (widget));
1565 if (priv->cell_view &&
1566 gtk_widget_get_parent (priv->cell_view))
1568 gtk_widget_unparent (priv->cell_view);
1569 _gtk_bin_set_child (GTK_BIN (container), NULL);
1570 gtk_widget_queue_resize (GTK_WIDGET (container));
1573 gtk_widget_set_parent (widget, GTK_WIDGET (container));
1574 _gtk_bin_set_child (GTK_BIN (container), widget);
1576 if (priv->cell_view &&
1577 widget != priv->cell_view)
1579 /* since the cell_view was unparented, it's gone now */
1580 priv->cell_view = NULL;
1582 if (!priv->tree_view && priv->separator)
1584 gtk_container_remove (GTK_CONTAINER (gtk_widget_get_parent (priv->separator)),
1586 priv->separator = NULL;
1588 gtk_widget_queue_resize (GTK_WIDGET (container));
1590 else if (priv->cell_view_frame)
1592 gtk_widget_unparent (priv->cell_view_frame);
1593 priv->cell_view_frame = NULL;
1598 if (priv->has_entry)
1600 /* this flag is a hack to tell the entry to fill its allocation.
1602 _gtk_entry_set_is_cell_renderer (GTK_ENTRY (widget), TRUE);
1604 g_signal_connect (widget, "changed",
1605 G_CALLBACK (gtk_combo_box_entry_contents_changed),
1608 gtk_entry_set_has_frame (GTK_ENTRY (widget), priv->has_frame);
1613 gtk_combo_box_remove (GtkContainer *container,
1616 GtkComboBox *combo_box = GTK_COMBO_BOX (container);
1617 GtkComboBoxPrivate *priv = combo_box->priv;
1619 gboolean appears_as_list;
1621 if (priv->has_entry)
1623 GtkWidget *child_widget;
1625 child_widget = gtk_bin_get_child (GTK_BIN (container));
1626 if (widget && widget == child_widget)
1628 g_signal_handlers_disconnect_by_func (widget,
1629 gtk_combo_box_entry_contents_changed,
1631 _gtk_entry_set_is_cell_renderer (GTK_ENTRY (widget), FALSE);
1635 if (widget == priv->cell_view)
1636 priv->cell_view = NULL;
1638 gtk_widget_unparent (widget);
1639 _gtk_bin_set_child (GTK_BIN (container), NULL);
1641 if (gtk_widget_in_destruction (GTK_WIDGET (combo_box)))
1644 gtk_widget_queue_resize (GTK_WIDGET (container));
1646 if (!priv->tree_view)
1647 appears_as_list = FALSE;
1649 appears_as_list = TRUE;
1651 if (appears_as_list)
1652 gtk_combo_box_list_destroy (combo_box);
1653 else if (GTK_IS_MENU (priv->popup_widget))
1655 gtk_combo_box_menu_destroy (combo_box);
1656 gtk_menu_detach (GTK_MENU (priv->popup_widget));
1657 priv->popup_widget = NULL;
1660 if (!priv->cell_view)
1662 priv->cell_view = gtk_cell_view_new ();
1663 gtk_widget_set_parent (priv->cell_view, GTK_WIDGET (container));
1664 _gtk_bin_set_child (GTK_BIN (container), priv->cell_view);
1666 gtk_widget_show (priv->cell_view);
1667 gtk_cell_view_set_model (GTK_CELL_VIEW (priv->cell_view),
1672 if (appears_as_list)
1673 gtk_combo_box_list_setup (combo_box);
1675 gtk_combo_box_menu_setup (combo_box, TRUE);
1677 if (gtk_tree_row_reference_valid (priv->active_row))
1679 path = gtk_tree_row_reference_get_path (priv->active_row);
1680 gtk_combo_box_set_active_internal (combo_box, path);
1681 gtk_tree_path_free (path);
1684 gtk_combo_box_set_active_internal (combo_box, NULL);
1688 gtk_combo_box_menu_show (GtkWidget *menu,
1691 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
1692 GtkComboBoxPrivate *priv = combo_box->priv;
1694 gtk_combo_box_child_show (menu, user_data);
1696 priv->popup_in_progress = TRUE;
1697 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->button),
1699 priv->popup_in_progress = FALSE;
1703 gtk_combo_box_menu_hide (GtkWidget *menu,
1706 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
1708 gtk_combo_box_child_hide (menu,user_data);
1710 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (combo_box->priv->button),
1715 gtk_combo_box_detacher (GtkWidget *widget,
1718 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
1719 GtkComboBoxPrivate *priv = combo_box->priv;
1721 g_return_if_fail (priv->popup_widget == (GtkWidget *) menu);
1723 g_signal_handlers_disconnect_by_func (menu->priv->toplevel,
1724 gtk_combo_box_menu_show,
1726 g_signal_handlers_disconnect_by_func (menu->priv->toplevel,
1727 gtk_combo_box_menu_hide,
1730 priv->popup_widget = NULL;
1734 gtk_combo_box_set_popup_widget (GtkComboBox *combo_box,
1737 GtkComboBoxPrivate *priv = combo_box->priv;
1739 if (GTK_IS_MENU (priv->popup_widget))
1741 gtk_menu_detach (GTK_MENU (priv->popup_widget));
1742 priv->popup_widget = NULL;
1744 else if (priv->popup_widget)
1746 gtk_container_remove (GTK_CONTAINER (priv->scrolled_window),
1747 priv->popup_widget);
1748 g_object_unref (priv->popup_widget);
1749 priv->popup_widget = NULL;
1752 if (GTK_IS_MENU (popup))
1754 if (priv->popup_window)
1756 gtk_widget_destroy (priv->popup_window);
1757 priv->popup_window = NULL;
1760 priv->popup_widget = popup;
1763 * Note that we connect to show/hide on the toplevel, not the
1764 * menu itself, since the menu is not shown/hidden when it is
1765 * popped up while torn-off.
1767 g_signal_connect (GTK_MENU (popup)->priv->toplevel, "show",
1768 G_CALLBACK (gtk_combo_box_menu_show), combo_box);
1769 g_signal_connect (GTK_MENU (popup)->priv->toplevel, "hide",
1770 G_CALLBACK (gtk_combo_box_menu_hide), combo_box);
1772 gtk_menu_attach_to_widget (GTK_MENU (popup),
1773 GTK_WIDGET (combo_box),
1774 gtk_combo_box_detacher);
1778 if (!priv->popup_window)
1780 GtkWidget *toplevel;
1782 priv->popup_window = gtk_window_new (GTK_WINDOW_POPUP);
1783 gtk_widget_set_name (priv->popup_window, "gtk-combobox-popup-window");
1785 gtk_window_set_type_hint (GTK_WINDOW (priv->popup_window),
1786 GDK_WINDOW_TYPE_HINT_COMBO);
1788 g_signal_connect (GTK_WINDOW (priv->popup_window),"show",
1789 G_CALLBACK (gtk_combo_box_child_show),
1791 g_signal_connect (GTK_WINDOW (priv->popup_window),"hide",
1792 G_CALLBACK (gtk_combo_box_child_hide),
1795 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (combo_box));
1796 if (GTK_IS_WINDOW (toplevel))
1798 gtk_window_group_add_window (gtk_window_get_group (GTK_WINDOW (toplevel)),
1799 GTK_WINDOW (priv->popup_window));
1800 gtk_window_set_transient_for (GTK_WINDOW (priv->popup_window),
1801 GTK_WINDOW (toplevel));
1804 gtk_window_set_resizable (GTK_WINDOW (priv->popup_window), FALSE);
1805 gtk_window_set_screen (GTK_WINDOW (priv->popup_window),
1806 gtk_widget_get_screen (GTK_WIDGET (combo_box)));
1808 priv->scrolled_window = gtk_scrolled_window_new (NULL, NULL);
1810 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (priv->scrolled_window),
1813 gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (priv->scrolled_window),
1816 gtk_widget_show (priv->scrolled_window);
1818 gtk_container_add (GTK_CONTAINER (priv->popup_window),
1819 priv->scrolled_window);
1822 gtk_container_add (GTK_CONTAINER (priv->scrolled_window),
1825 gtk_widget_show (popup);
1826 g_object_ref (popup);
1827 priv->popup_widget = popup;
1832 get_widget_padding_and_border (GtkWidget *widget,
1835 GtkStyleContext *context;
1836 GtkStateFlags state;
1839 context = gtk_widget_get_style_context (widget);
1840 state = gtk_style_context_get_state (context);
1842 gtk_style_context_get_padding (context, state, padding);
1843 gtk_style_context_get_border (context, state, &tmp);
1845 padding->top += tmp.top;
1846 padding->right += tmp.right;
1847 padding->bottom += tmp.bottom;
1848 padding->left += tmp.left;
1852 gtk_combo_box_menu_position_below (GtkMenu *menu,
1858 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
1859 GtkAllocation child_allocation;
1865 GdkRectangle monitor;
1868 /* FIXME: is using the size request here broken? */
1869 child = gtk_bin_get_child (GTK_BIN (combo_box));
1873 gtk_widget_get_allocation (child, &child_allocation);
1875 if (!gtk_widget_get_has_window (child))
1877 sx += child_allocation.x;
1878 sy += child_allocation.y;
1881 gdk_window_get_root_coords (gtk_widget_get_window (child),
1883 get_widget_padding_and_border (GTK_WIDGET (combo_box), &padding);
1886 if (combo_box->priv->popup_fixed_width)
1887 gtk_widget_get_preferred_size (GTK_WIDGET (menu), &req, NULL);
1889 gtk_widget_get_preferred_size (GTK_WIDGET (menu), NULL, &req);
1891 if (gtk_widget_get_direction (GTK_WIDGET (combo_box)) == GTK_TEXT_DIR_LTR)
1894 *x = sx + child_allocation.width - req.width;
1897 screen = gtk_widget_get_screen (GTK_WIDGET (combo_box));
1898 monitor_num = gdk_screen_get_monitor_at_window (screen,
1899 gtk_widget_get_window (GTK_WIDGET (combo_box)));
1900 gdk_screen_get_monitor_workarea (screen, monitor_num, &monitor);
1904 else if (*x + req.width > monitor.x + monitor.width)
1905 *x = monitor.x + monitor.width - req.width;
1907 if (monitor.y + monitor.height - *y - child_allocation.height >= req.height)
1908 *y += child_allocation.height;
1909 else if (*y - monitor.y >= req.height)
1911 else if (monitor.y + monitor.height - *y - child_allocation.height > *y - monitor.y)
1912 *y += child_allocation.height;
1920 gtk_combo_box_menu_position_over (GtkMenu *menu,
1926 GtkComboBox *combo_box;
1930 GtkAllocation allocation;
1931 GtkAllocation child_allocation;
1938 combo_box = GTK_COMBO_BOX (user_data);
1939 widget = GTK_WIDGET (combo_box);
1941 active = gtk_menu_get_active (GTK_MENU (combo_box->priv->popup_widget));
1943 gtk_widget_get_allocation (widget, &allocation);
1945 menu_xpos = allocation.x;
1946 menu_ypos = allocation.y + allocation.height / 2 - 2;
1948 if (combo_box->priv->popup_fixed_width)
1949 gtk_widget_get_preferred_width (GTK_WIDGET (menu), &menu_width, NULL);
1951 gtk_widget_get_preferred_width (GTK_WIDGET (menu), NULL, &menu_width);
1955 gtk_widget_get_allocation (active, &child_allocation);
1956 menu_ypos -= child_allocation.height / 2;
1959 children = GTK_MENU_SHELL (combo_box->priv->popup_widget)->priv->children;
1962 child = children->data;
1964 if (active == child)
1967 if (gtk_widget_get_visible (child))
1969 gtk_widget_get_allocation (child, &child_allocation);
1971 menu_ypos -= child_allocation.height;
1974 children = children->next;
1977 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
1978 menu_xpos = menu_xpos + allocation.width - menu_width;
1980 gdk_window_get_root_coords (gtk_widget_get_window (widget),
1981 menu_xpos, menu_ypos,
1982 &menu_xpos, &menu_ypos);
1984 /* Clamp the position on screen */
1985 screen_width = gdk_screen_get_width (gtk_widget_get_screen (widget));
1989 else if ((menu_xpos + menu_width) > screen_width)
1990 menu_xpos -= ((menu_xpos + menu_width) - screen_width);
1999 gtk_combo_box_menu_position (GtkMenu *menu,
2005 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
2006 GtkComboBoxPrivate *priv = combo_box->priv;
2007 GtkWidget *menu_item;
2009 if (priv->wrap_width > 0 || priv->cell_view == NULL)
2010 gtk_combo_box_menu_position_below (menu, x, y, push_in, user_data);
2013 /* FIXME handle nested menus better */
2014 menu_item = gtk_menu_get_active (GTK_MENU (priv->popup_widget));
2016 gtk_menu_shell_select_item (GTK_MENU_SHELL (priv->popup_widget),
2019 gtk_combo_box_menu_position_over (menu, x, y, push_in, user_data);
2022 if (!gtk_widget_get_visible (GTK_MENU (priv->popup_widget)->priv->toplevel))
2023 gtk_window_set_type_hint (GTK_WINDOW (GTK_MENU (priv->popup_widget)->priv->toplevel),
2024 GDK_WINDOW_TYPE_HINT_COMBO);
2028 gtk_combo_box_list_position (GtkComboBox *combo_box,
2034 GtkComboBoxPrivate *priv = combo_box->priv;
2035 GtkAllocation allocation;
2038 GdkRectangle monitor;
2039 GtkRequisition popup_req;
2040 GtkPolicyType hpolicy, vpolicy;
2043 /* under windows, the drop down list is as wide as the combo box itself.
2045 GtkWidget *widget = GTK_WIDGET (combo_box);
2049 gtk_widget_get_allocation (widget, &allocation);
2051 if (!gtk_widget_get_has_window (widget))
2057 window = gtk_widget_get_window (widget);
2059 gdk_window_get_root_coords (gtk_widget_get_window (widget),
2062 *width = allocation.width;
2064 hpolicy = vpolicy = GTK_POLICY_NEVER;
2065 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (priv->scrolled_window),
2068 if (combo_box->priv->popup_fixed_width)
2070 gtk_widget_get_preferred_size (priv->scrolled_window, &popup_req, NULL);
2072 if (popup_req.width > *width)
2074 hpolicy = GTK_POLICY_ALWAYS;
2075 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (priv->scrolled_window),
2081 /* XXX This code depends on treeviews properly reporting their natural width
2082 * list-mode menus won't fill up to their natural width until then */
2083 gtk_widget_get_preferred_size (priv->scrolled_window, NULL, &popup_req);
2085 if (popup_req.width > *width)
2087 hpolicy = GTK_POLICY_NEVER;
2088 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (priv->scrolled_window),
2091 *width = popup_req.width;
2095 *height = popup_req.height;
2097 screen = gtk_widget_get_screen (GTK_WIDGET (combo_box));
2098 monitor_num = gdk_screen_get_monitor_at_window (screen, window);
2099 gdk_screen_get_monitor_workarea (screen, monitor_num, &monitor);
2101 if (gtk_widget_get_direction (GTK_WIDGET (combo_box)) == GTK_TEXT_DIR_RTL)
2102 *x = *x + allocation.width - *width;
2106 else if (*x + *width > monitor.x + monitor.width)
2107 *x = monitor.x + monitor.width - *width;
2109 if (*y + allocation.height + *height <= monitor.y + monitor.height)
2110 *y += allocation.height;
2111 else if (*y - *height >= monitor.y)
2113 else if (monitor.y + monitor.height - (*y + allocation.height) > *y - monitor.y)
2115 *y += allocation.height;
2116 *height = monitor.y + monitor.height - *y;
2120 *height = *y - monitor.y;
2124 if (popup_req.height > *height)
2126 vpolicy = GTK_POLICY_ALWAYS;
2128 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (priv->scrolled_window),
2134 cell_layout_is_sensitive (GtkCellLayout *layout)
2136 GList *cells, *list;
2139 cells = gtk_cell_layout_get_cells (layout);
2142 for (list = cells; list; list = list->next)
2144 g_object_get (list->data, "sensitive", &sensitive, NULL);
2149 g_list_free (cells);
2155 cell_is_sensitive (GtkCellRenderer *cell,
2158 gboolean *sensitive = data;
2160 g_object_get (cell, "sensitive", sensitive, NULL);
2166 tree_column_row_is_sensitive (GtkComboBox *combo_box,
2169 GtkComboBoxPrivate *priv = combo_box->priv;
2171 if (priv->row_separator_func)
2173 if (priv->row_separator_func (priv->model, iter,
2174 priv->row_separator_data))
2182 gtk_cell_area_apply_attributes (priv->area, priv->model, iter, FALSE, FALSE);
2186 gtk_cell_area_foreach (priv->area, cell_is_sensitive, &sensitive);
2195 update_menu_sensitivity (GtkComboBox *combo_box,
2198 GtkComboBoxPrivate *priv = combo_box->priv;
2199 GList *children, *child;
2200 GtkWidget *item, *submenu, *separator;
2201 GtkWidget *cell_view;
2207 children = gtk_container_get_children (GTK_CONTAINER (menu));
2209 for (child = children; child; child = child->next)
2211 item = GTK_WIDGET (child->data);
2212 cell_view = gtk_bin_get_child (GTK_BIN (item));
2214 if (!GTK_IS_CELL_VIEW (cell_view))
2217 submenu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (item));
2218 if (submenu != NULL)
2220 gtk_widget_set_sensitive (item, TRUE);
2221 update_menu_sensitivity (combo_box, submenu);
2225 sensitive = cell_layout_is_sensitive (GTK_CELL_LAYOUT (cell_view));
2227 if (menu != priv->popup_widget && child == children)
2229 separator = GTK_WIDGET (child->next->data);
2230 g_object_set (item, "visible", sensitive, NULL);
2231 g_object_set (separator, "visible", sensitive, NULL);
2234 gtk_widget_set_sensitive (item, sensitive);
2238 g_list_free (children);
2242 gtk_combo_box_menu_popup (GtkComboBox *combo_box,
2244 guint32 activate_time)
2246 GtkComboBoxPrivate *priv = combo_box->priv;
2249 gint width, min_width, nat_width;
2251 update_menu_sensitivity (combo_box, priv->popup_widget);
2254 if (gtk_tree_row_reference_valid (priv->active_row))
2256 path = gtk_tree_row_reference_get_path (priv->active_row);
2257 active_item = gtk_tree_path_get_indices (path)[0];
2258 gtk_tree_path_free (path);
2260 if (priv->add_tearoffs)
2264 /* FIXME handle nested menus better */
2265 gtk_menu_set_active (GTK_MENU (priv->popup_widget), active_item);
2267 if (priv->wrap_width == 0)
2269 GtkAllocation allocation;
2271 gtk_widget_get_allocation (GTK_WIDGET (combo_box), &allocation);
2272 width = allocation.width;
2273 gtk_widget_set_size_request (priv->popup_widget, -1, -1);
2274 gtk_widget_get_preferred_width (priv->popup_widget, &min_width, &nat_width);
2276 if (combo_box->priv->popup_fixed_width)
2277 width = MAX (width, min_width);
2279 width = MAX (width, nat_width);
2281 gtk_widget_set_size_request (priv->popup_widget, width, -1);
2284 gtk_menu_popup (GTK_MENU (priv->popup_widget),
2286 gtk_combo_box_menu_position, combo_box,
2287 button, activate_time);
2291 popup_grab_on_window (GdkWindow *window,
2292 GdkDevice *keyboard,
2294 guint32 activate_time)
2297 gdk_device_grab (keyboard, window,
2298 GDK_OWNERSHIP_WINDOW, TRUE,
2299 GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
2300 NULL, activate_time) != GDK_GRAB_SUCCESS)
2304 gdk_device_grab (pointer, window,
2305 GDK_OWNERSHIP_WINDOW, TRUE,
2306 GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
2307 GDK_POINTER_MOTION_MASK,
2308 NULL, activate_time) != GDK_GRAB_SUCCESS)
2311 gdk_device_ungrab (keyboard, activate_time);
2320 * gtk_combo_box_popup:
2321 * @combo_box: a #GtkComboBox
2323 * Pops up the menu or dropdown list of @combo_box.
2325 * This function is mostly intended for use by accessibility technologies;
2326 * applications should have little use for it.
2331 gtk_combo_box_popup (GtkComboBox *combo_box)
2333 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
2335 g_signal_emit (combo_box, combo_box_signals[POPUP], 0);
2339 * gtk_combo_box_popup_for_device:
2340 * @combo_box: a #GtkComboBox
2341 * @device: a #GdkDevice
2343 * Pops up the menu or dropdown list of @combo_box, the popup window
2344 * will be grabbed so only @device and its associated pointer/keyboard
2345 * are the only #GdkDevice<!-- -->s able to send events to it.
2350 gtk_combo_box_popup_for_device (GtkComboBox *combo_box,
2353 GtkComboBoxPrivate *priv = combo_box->priv;
2354 gint x, y, width, height;
2355 GtkTreePath *path = NULL, *ppath;
2356 GtkWidget *toplevel;
2357 GdkDevice *keyboard, *pointer;
2360 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
2361 g_return_if_fail (GDK_IS_DEVICE (device));
2363 if (!gtk_widget_get_realized (GTK_WIDGET (combo_box)))
2366 if (gtk_widget_get_mapped (priv->popup_widget))
2369 if (priv->grab_pointer && priv->grab_keyboard)
2372 time = gtk_get_current_event_time ();
2374 if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
2377 pointer = gdk_device_get_associated_device (device);
2382 keyboard = gdk_device_get_associated_device (device);
2385 if (GTK_IS_MENU (priv->popup_widget))
2387 gtk_combo_box_menu_popup (combo_box,
2388 priv->activate_button,
2389 priv->activate_time);
2393 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (combo_box));
2394 if (GTK_IS_WINDOW (toplevel))
2395 gtk_window_group_add_window (gtk_window_get_group (GTK_WINDOW (toplevel)),
2396 GTK_WINDOW (priv->popup_window));
2398 gtk_widget_show_all (priv->scrolled_window);
2399 gtk_combo_box_list_position (combo_box, &x, &y, &width, &height);
2401 gtk_widget_set_size_request (priv->popup_window, width, height);
2402 gtk_window_move (GTK_WINDOW (priv->popup_window), x, y);
2404 if (gtk_tree_row_reference_valid (priv->active_row))
2406 path = gtk_tree_row_reference_get_path (priv->active_row);
2407 ppath = gtk_tree_path_copy (path);
2408 if (gtk_tree_path_up (ppath))
2409 gtk_tree_view_expand_to_path (GTK_TREE_VIEW (priv->tree_view),
2411 gtk_tree_path_free (ppath);
2413 gtk_tree_view_set_hover_expand (GTK_TREE_VIEW (priv->tree_view),
2417 gtk_widget_show (priv->popup_window);
2421 gtk_tree_view_set_cursor (GTK_TREE_VIEW (priv->tree_view),
2423 gtk_tree_path_free (path);
2426 gtk_widget_grab_focus (priv->popup_window);
2427 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->button),
2430 if (!gtk_widget_has_focus (priv->tree_view))
2431 gtk_widget_grab_focus (priv->tree_view);
2433 if (!popup_grab_on_window (gtk_widget_get_window (priv->popup_window),
2434 keyboard, pointer, time))
2436 gtk_widget_hide (priv->popup_window);
2440 gtk_device_grab_add (priv->popup_window, pointer, TRUE);
2441 priv->grab_pointer = pointer;
2442 priv->grab_keyboard = keyboard;
2446 gtk_combo_box_real_popup (GtkComboBox *combo_box)
2450 device = gtk_get_current_event_device ();
2454 GdkDeviceManager *device_manager;
2455 GdkDisplay *display;
2458 display = gtk_widget_get_display (GTK_WIDGET (combo_box));
2459 device_manager = gdk_display_get_device_manager (display);
2461 /* No device was set, pick the first master device */
2462 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
2463 device = devices->data;
2464 g_list_free (devices);
2467 gtk_combo_box_popup_for_device (combo_box, device);
2471 gtk_combo_box_real_popdown (GtkComboBox *combo_box)
2473 if (combo_box->priv->popup_shown)
2475 gtk_combo_box_popdown (combo_box);
2483 * gtk_combo_box_popdown:
2484 * @combo_box: a #GtkComboBox
2486 * Hides the menu or dropdown list of @combo_box.
2488 * This function is mostly intended for use by accessibility technologies;
2489 * applications should have little use for it.
2494 gtk_combo_box_popdown (GtkComboBox *combo_box)
2496 GtkComboBoxPrivate *priv = combo_box->priv;
2498 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
2500 if (GTK_IS_MENU (priv->popup_widget))
2502 gtk_menu_popdown (GTK_MENU (priv->popup_widget));
2506 if (!gtk_widget_get_realized (GTK_WIDGET (combo_box)))
2509 gtk_device_grab_remove (priv->popup_window, priv->grab_pointer);
2510 gtk_widget_hide (priv->popup_window);
2511 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->button),
2514 priv->grab_pointer = NULL;
2515 priv->grab_keyboard = NULL;
2518 #define GTK_COMBO_BOX_SIZE_ALLOCATE_BUTTON \
2519 GtkAllocation button_allocation; \
2520 gtk_widget_get_preferred_size (combo_box->priv->button, \
2524 button_allocation.x = allocation->x; \
2526 button_allocation.x = allocation->x + allocation->width \
2529 button_allocation.y = allocation->y; \
2530 button_allocation.width = MAX (1, req.width); \
2531 button_allocation.height = allocation->height; \
2532 button_allocation.height = MAX (1, button_allocation.height); \
2534 gtk_widget_size_allocate (combo_box->priv->button, \
2535 &button_allocation);
2539 gtk_combo_box_size_allocate (GtkWidget *widget,
2540 GtkAllocation *allocation)
2542 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
2543 GtkComboBoxPrivate *priv = combo_box->priv;
2544 GtkWidget *child_widget;
2545 GtkAllocation child;
2547 gboolean is_rtl = gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL;
2550 gtk_widget_set_allocation (widget, allocation);
2551 child_widget = gtk_bin_get_child (GTK_BIN (widget));
2552 get_widget_padding_and_border (widget, &padding);
2554 allocation->x += padding.left;
2555 allocation->y += padding.top;
2556 allocation->width -= padding.left + padding.right;
2557 allocation->height -= padding.top + padding.bottom;
2559 if (!priv->tree_view)
2561 if (priv->cell_view)
2563 GtkBorder button_padding;
2567 border_width = gtk_container_get_border_width (GTK_CONTAINER (priv->button));
2568 get_widget_padding_and_border (priv->button, &button_padding);
2570 /* menu mode; child_widget is priv->cell_view.
2571 * Allocate the button to the full combobox allocation (minus the
2574 gtk_widget_size_allocate (priv->button, allocation);
2576 child.x = allocation->x;
2577 child.y = allocation->y;
2578 width = allocation->width;
2579 child.height = allocation->height;
2581 if (!priv->is_cell_renderer)
2583 /* restrict allocation of the child into the button box
2584 * if we're not in cell renderer mode.
2586 child.x += border_width + button_padding.left;
2587 child.y += border_width + button_padding.top;
2588 width -= 2 * border_width +
2589 button_padding.left + button_padding.right;
2590 child.height -= 2 * border_width +
2591 button_padding.top + button_padding.bottom;
2594 /* allocate the box containing the separator and the arrow */
2595 gtk_widget_get_preferred_size (priv->box, &req, NULL);
2596 child.width = req.width;
2598 child.x += width - req.width;
2599 child.width = MAX (1, child.width);
2600 child.height = MAX (1, child.height);
2601 gtk_widget_size_allocate (priv->box, &child);
2605 child.x += req.width;
2606 child.width = allocation->x + allocation->width
2607 - border_width - child.x;
2611 child.width = child.x;
2612 child.x = allocation->x
2613 + border_width + button_padding.left;
2614 child.width -= child.x;
2617 if (gtk_widget_get_visible (priv->popup_widget))
2619 gint width, menu_width;
2621 if (priv->wrap_width == 0)
2623 GtkAllocation combo_box_allocation;
2625 gtk_widget_get_allocation (GTK_WIDGET (combo_box), &combo_box_allocation);
2626 width = combo_box_allocation.width;
2627 gtk_widget_set_size_request (priv->popup_widget, -1, -1);
2629 if (combo_box->priv->popup_fixed_width)
2630 gtk_widget_get_preferred_width (priv->popup_widget, &menu_width, NULL);
2632 gtk_widget_get_preferred_width (priv->popup_widget, NULL, &menu_width);
2634 gtk_widget_set_size_request (priv->popup_widget,
2635 MAX (width, menu_width), -1);
2638 /* reposition the menu after giving it a new width */
2639 gtk_menu_reposition (GTK_MENU (priv->popup_widget));
2642 child.width = MAX (1, child.width);
2643 child.height = MAX (1, child.height);
2644 gtk_widget_size_allocate (child_widget, &child);
2648 /* menu mode; child_widget has been set with gtk_container_add().
2649 * E.g. it might be a GtkEntry if priv->has_entry is TRUE.
2650 * Allocate the button at the far end, according to the direction
2653 GTK_COMBO_BOX_SIZE_ALLOCATE_BUTTON
2655 /* After the macro, button_allocation has the button allocation rect */
2658 child.x = button_allocation.x + button_allocation.width;
2660 child.x = allocation->x;
2662 child.y = allocation->y;
2663 child.width = allocation->width - button_allocation.width;
2664 child.height = button_allocation.height;
2666 child.width = MAX (1, child.width);
2668 gtk_widget_size_allocate (child_widget, &child);
2673 /* list mode; child_widget might be either priv->cell_view or a child
2674 * added with gtk_container_add().
2676 guint border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
2678 /* After the macro, button_allocation has the button allocation rect */
2679 GTK_COMBO_BOX_SIZE_ALLOCATE_BUTTON
2682 child.x = button_allocation.x + button_allocation.width;
2684 child.x = allocation->x + border_width;
2686 child.y = allocation->y + border_width;
2687 child.width = allocation->width - button_allocation.width - (2 * border_width);
2688 child.height = button_allocation.height - 2 * border_width;
2690 if (priv->cell_view_frame)
2692 gtk_widget_size_allocate (priv->cell_view_frame, &child);
2694 /* restrict allocation of the child into the frame box if it's present */
2695 if (priv->has_frame)
2697 GtkBorder frame_padding;
2699 border_width = gtk_container_get_border_width (GTK_CONTAINER (priv->cell_view_frame));
2700 get_widget_padding_and_border (priv->cell_view_frame, &frame_padding);
2702 child.x += border_width + frame_padding.left;
2703 child.y += border_width + frame_padding.right;
2704 child.width -= (2 * border_width) + frame_padding.left + frame_padding.right;
2705 child.height -= (2 * border_width) + frame_padding.top + frame_padding.bottom;
2709 if (gtk_widget_get_visible (priv->popup_window))
2711 gint x, y, width, height;
2712 gtk_combo_box_list_position (combo_box, &x, &y, &width, &height);
2713 gtk_window_move (GTK_WINDOW (priv->popup_window), x, y);
2714 gtk_widget_set_size_request (priv->popup_window, width, height);
2717 /* allocate the child */
2718 child.width = MAX (1, child.width);
2719 child.height = MAX (1, child.height);
2720 gtk_widget_size_allocate (child_widget, &child);
2724 #undef GTK_COMBO_BOX_ALLOCATE_BUTTON
2727 gtk_combo_box_unset_model (GtkComboBox *combo_box)
2729 GtkComboBoxPrivate *priv = combo_box->priv;
2733 g_signal_handler_disconnect (priv->model,
2735 g_signal_handler_disconnect (priv->model,
2737 g_signal_handler_disconnect (priv->model,
2738 priv->reordered_id);
2739 g_signal_handler_disconnect (priv->model,
2745 g_object_unref (priv->model);
2749 if (priv->active_row)
2751 gtk_tree_row_reference_free (priv->active_row);
2752 priv->active_row = NULL;
2755 if (priv->cell_view)
2756 gtk_cell_view_set_model (GTK_CELL_VIEW (priv->cell_view), NULL);
2760 gtk_combo_box_forall (GtkContainer *container,
2761 gboolean include_internals,
2762 GtkCallback callback,
2763 gpointer callback_data)
2765 GtkComboBox *combo_box = GTK_COMBO_BOX (container);
2766 GtkComboBoxPrivate *priv = combo_box->priv;
2769 if (include_internals)
2772 (* callback) (priv->button, callback_data);
2773 if (priv->cell_view_frame)
2774 (* callback) (priv->cell_view_frame, callback_data);
2777 child = gtk_bin_get_child (GTK_BIN (container));
2779 (* callback) (child, callback_data);
2783 gtk_combo_box_child_show (GtkWidget *widget,
2784 GtkComboBox *combo_box)
2786 GtkComboBoxPrivate *priv = combo_box->priv;
2788 priv->popup_shown = TRUE;
2789 g_object_notify (G_OBJECT (combo_box), "popup-shown");
2793 gtk_combo_box_child_hide (GtkWidget *widget,
2794 GtkComboBox *combo_box)
2796 GtkComboBoxPrivate *priv = combo_box->priv;
2798 priv->popup_shown = FALSE;
2799 g_object_notify (G_OBJECT (combo_box), "popup-shown");
2803 gtk_combo_box_draw (GtkWidget *widget,
2806 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
2807 GtkComboBoxPrivate *priv = combo_box->priv;
2809 if (priv->shadow_type != GTK_SHADOW_NONE)
2811 GtkStyleContext *context;
2813 context = gtk_widget_get_style_context (widget);
2815 gtk_render_background (context, cr, 0, 0,
2816 gtk_widget_get_allocated_width (widget),
2817 gtk_widget_get_allocated_height (widget));
2818 gtk_render_frame (context, cr, 0, 0,
2819 gtk_widget_get_allocated_width (widget),
2820 gtk_widget_get_allocated_height (widget));
2823 gtk_container_propagate_draw (GTK_CONTAINER (widget),
2826 if (priv->tree_view && priv->cell_view_frame)
2828 gtk_container_propagate_draw (GTK_CONTAINER (widget),
2829 priv->cell_view_frame, cr);
2832 gtk_container_propagate_draw (GTK_CONTAINER (widget),
2833 gtk_bin_get_child (GTK_BIN (widget)),
2849 path_visible (GtkTreeView *view,
2855 /* Note that we rely on the fact that collapsed rows don't have nodes
2857 return _gtk_tree_view_find_node (view, path, &tree, &node);
2861 tree_next_func (GtkTreeModel *model,
2866 SearchData *search_data = (SearchData *)data;
2868 if (search_data->found)
2870 if (!tree_column_row_is_sensitive (search_data->combo, iter))
2873 if (search_data->visible &&
2874 !path_visible (GTK_TREE_VIEW (search_data->combo->priv->tree_view), path))
2877 search_data->set = TRUE;
2878 search_data->iter = *iter;
2883 if (gtk_tree_path_compare (path, search_data->path) == 0)
2884 search_data->found = TRUE;
2890 tree_next (GtkComboBox *combo,
2891 GtkTreeModel *model,
2896 SearchData search_data;
2898 search_data.combo = combo;
2899 search_data.path = gtk_tree_model_get_path (model, iter);
2900 search_data.visible = visible;
2901 search_data.found = FALSE;
2902 search_data.set = FALSE;
2904 gtk_tree_model_foreach (model, tree_next_func, &search_data);
2906 *next = search_data.iter;
2908 gtk_tree_path_free (search_data.path);
2910 return search_data.set;
2914 tree_prev_func (GtkTreeModel *model,
2919 SearchData *search_data = (SearchData *)data;
2921 if (gtk_tree_path_compare (path, search_data->path) == 0)
2923 search_data->found = TRUE;
2927 if (!tree_column_row_is_sensitive (search_data->combo, iter))
2930 if (search_data->visible &&
2931 !path_visible (GTK_TREE_VIEW (search_data->combo->priv->tree_view), path))
2934 search_data->set = TRUE;
2935 search_data->iter = *iter;
2941 tree_prev (GtkComboBox *combo,
2942 GtkTreeModel *model,
2947 SearchData search_data;
2949 search_data.combo = combo;
2950 search_data.path = gtk_tree_model_get_path (model, iter);
2951 search_data.visible = visible;
2952 search_data.found = FALSE;
2953 search_data.set = FALSE;
2955 gtk_tree_model_foreach (model, tree_prev_func, &search_data);
2957 *prev = search_data.iter;
2959 gtk_tree_path_free (search_data.path);
2961 return search_data.set;
2965 tree_last_func (GtkTreeModel *model,
2970 SearchData *search_data = (SearchData *)data;
2972 if (!tree_column_row_is_sensitive (search_data->combo, iter))
2975 /* Note that we rely on the fact that collapsed rows don't have nodes
2977 if (search_data->visible &&
2978 !path_visible (GTK_TREE_VIEW (search_data->combo->priv->tree_view), path))
2981 search_data->set = TRUE;
2982 search_data->iter = *iter;
2988 tree_last (GtkComboBox *combo,
2989 GtkTreeModel *model,
2993 SearchData search_data;
2995 search_data.combo = combo;
2996 search_data.visible = visible;
2997 search_data.set = FALSE;
2999 gtk_tree_model_foreach (model, tree_last_func, &search_data);
3001 *last = search_data.iter;
3003 return search_data.set;
3008 tree_first_func (GtkTreeModel *model,
3013 SearchData *search_data = (SearchData *)data;
3015 if (!tree_column_row_is_sensitive (search_data->combo, iter))
3018 if (search_data->visible &&
3019 !path_visible (GTK_TREE_VIEW (search_data->combo->priv->tree_view), path))
3022 search_data->set = TRUE;
3023 search_data->iter = *iter;
3029 tree_first (GtkComboBox *combo,
3030 GtkTreeModel *model,
3034 SearchData search_data;
3036 search_data.combo = combo;
3037 search_data.visible = visible;
3038 search_data.set = FALSE;
3040 gtk_tree_model_foreach (model, tree_first_func, &search_data);
3042 *first = search_data.iter;
3044 return search_data.set;
3048 gtk_combo_box_scroll_event (GtkWidget *widget,
3049 GdkEventScroll *event)
3051 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
3054 GtkTreeIter new_iter;
3056 if (!gtk_combo_box_get_active_iter (combo_box, &iter))
3059 if (event->direction == GDK_SCROLL_UP)
3060 found = tree_prev (combo_box, combo_box->priv->model,
3061 &iter, &new_iter, FALSE);
3063 found = tree_next (combo_box, combo_box->priv->model,
3064 &iter, &new_iter, FALSE);
3067 gtk_combo_box_set_active_iter (combo_box, &new_iter);
3076 gtk_combo_box_row_separator_func (GtkTreeModel *model,
3080 GtkComboBoxPrivate *priv = combo->priv;
3082 if (priv->row_separator_func)
3083 return priv->row_separator_func (model, iter, priv->row_separator_data);
3089 gtk_combo_box_header_func (GtkTreeModel *model,
3093 /* Every submenu has a selectable header, however we
3094 * can expose a method to make that configurable by
3095 * the user (like row_separator_func is done) */
3100 gtk_combo_box_menu_setup (GtkComboBox *combo_box,
3101 gboolean add_children)
3103 GtkComboBoxPrivate *priv = combo_box->priv;
3107 child = gtk_bin_get_child (GTK_BIN (combo_box));
3109 if (priv->cell_view)
3111 priv->button = gtk_toggle_button_new ();
3112 gtk_button_set_focus_on_click (GTK_BUTTON (priv->button),
3113 priv->focus_on_click);
3115 g_signal_connect (priv->button, "toggled",
3116 G_CALLBACK (gtk_combo_box_button_toggled), combo_box);
3117 gtk_widget_set_parent (priv->button,
3118 gtk_widget_get_parent (child));
3120 priv->box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
3121 gtk_container_add (GTK_CONTAINER (priv->button), priv->box);
3123 priv->separator = gtk_separator_new (GTK_ORIENTATION_VERTICAL);
3124 gtk_container_add (GTK_CONTAINER (priv->box), priv->separator);
3126 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_NONE);
3127 gtk_container_add (GTK_CONTAINER (priv->box), priv->arrow);
3129 gtk_widget_show_all (priv->button);
3133 priv->button = gtk_toggle_button_new ();
3134 gtk_button_set_focus_on_click (GTK_BUTTON (priv->button),
3135 priv->focus_on_click);
3137 g_signal_connect (priv->button, "toggled",
3138 G_CALLBACK (gtk_combo_box_button_toggled), combo_box);
3139 gtk_widget_set_parent (priv->button,
3140 gtk_widget_get_parent (child));
3142 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_NONE);
3143 gtk_container_add (GTK_CONTAINER (priv->button), priv->arrow);
3144 gtk_widget_show_all (priv->button);
3147 g_signal_connect (priv->button, "button-press-event",
3148 G_CALLBACK (gtk_combo_box_menu_button_press),
3150 g_signal_connect (priv->button, "state-flags-changed",
3151 G_CALLBACK (gtk_combo_box_button_state_flags_changed),
3154 /* create our funky menu */
3155 menu = _gtk_tree_menu_new_with_area (priv->area);
3156 gtk_widget_set_name (menu, "gtk-combobox-popup-menu");
3158 _gtk_tree_menu_set_model (GTK_TREE_MENU (menu), priv->model);
3160 _gtk_tree_menu_set_wrap_width (GTK_TREE_MENU (menu), priv->wrap_width);
3161 _gtk_tree_menu_set_row_span_column (GTK_TREE_MENU (menu), priv->row_column);
3162 _gtk_tree_menu_set_column_span_column (GTK_TREE_MENU (menu), priv->col_column);
3163 _gtk_tree_menu_set_tearoff (GTK_TREE_MENU (menu),
3164 combo_box->priv->add_tearoffs);
3166 g_signal_connect (menu, "menu-activate",
3167 G_CALLBACK (gtk_combo_box_menu_activate), combo_box);
3169 /* Chain our row_separator_func through */
3170 _gtk_tree_menu_set_row_separator_func (GTK_TREE_MENU (menu),
3171 (GtkTreeViewRowSeparatorFunc)gtk_combo_box_row_separator_func,
3174 _gtk_tree_menu_set_header_func (GTK_TREE_MENU (menu),
3175 (GtkTreeMenuHeaderFunc)gtk_combo_box_header_func,
3178 g_signal_connect (menu, "key-press-event",
3179 G_CALLBACK (gtk_combo_box_menu_key_press), combo_box);
3180 gtk_combo_box_set_popup_widget (combo_box, menu);
3182 gtk_combo_box_update_title (combo_box);
3186 gtk_combo_box_menu_destroy (GtkComboBox *combo_box)
3188 GtkComboBoxPrivate *priv = combo_box->priv;
3190 g_signal_handlers_disconnect_matched (priv->button,
3191 G_SIGNAL_MATCH_DATA,
3193 gtk_combo_box_menu_button_press, NULL);
3194 g_signal_handlers_disconnect_matched (priv->button,
3195 G_SIGNAL_MATCH_DATA,
3197 gtk_combo_box_button_state_flags_changed, combo_box);
3198 g_signal_handlers_disconnect_matched (priv->popup_widget,
3199 G_SIGNAL_MATCH_DATA,
3201 gtk_combo_box_menu_activate, combo_box);
3203 /* unparent will remove our latest ref */
3204 gtk_widget_unparent (priv->button);
3207 priv->button = NULL;
3209 priv->separator = NULL;
3211 /* changing the popup window will unref the menu and the children */
3216 gtk_combo_box_menu_button_press (GtkWidget *widget,
3217 GdkEventButton *event,
3220 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
3221 GtkComboBoxPrivate *priv = combo_box->priv;
3223 if (GTK_IS_MENU (priv->popup_widget) &&
3224 event->type == GDK_BUTTON_PRESS && event->button == GDK_BUTTON_PRIMARY)
3226 if (priv->focus_on_click &&
3227 !gtk_widget_has_focus (priv->button))
3228 gtk_widget_grab_focus (priv->button);
3230 gtk_combo_box_menu_popup (combo_box, event->button, event->time);
3239 gtk_combo_box_menu_activate (GtkWidget *menu,
3241 GtkComboBox *combo_box)
3245 if (gtk_tree_model_get_iter_from_string (combo_box->priv->model, &iter, path))
3246 gtk_combo_box_set_active_iter (combo_box, &iter);
3248 g_object_set (combo_box,
3249 "editing-canceled", FALSE,
3255 gtk_combo_box_update_sensitivity (GtkComboBox *combo_box)
3258 gboolean sensitive = TRUE; /* fool code checkers */
3260 if (!combo_box->priv->button)
3263 switch (combo_box->priv->button_sensitivity)
3265 case GTK_SENSITIVITY_ON:
3268 case GTK_SENSITIVITY_OFF:
3271 case GTK_SENSITIVITY_AUTO:
3272 sensitive = combo_box->priv->model &&
3273 gtk_tree_model_get_iter_first (combo_box->priv->model, &iter);
3276 g_assert_not_reached ();
3280 gtk_widget_set_sensitive (combo_box->priv->button, sensitive);
3282 /* In list-mode, we also need to update sensitivity of the event box */
3283 if (GTK_IS_TREE_VIEW (combo_box->priv->tree_view)
3284 && combo_box->priv->cell_view)
3285 gtk_widget_set_sensitive (combo_box->priv->box, sensitive);
3289 gtk_combo_box_model_row_inserted (GtkTreeModel *model,
3294 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
3296 if (combo_box->priv->tree_view)
3297 gtk_combo_box_list_popup_resize (combo_box);
3299 gtk_combo_box_update_sensitivity (combo_box);
3303 gtk_combo_box_model_row_deleted (GtkTreeModel *model,
3307 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
3308 GtkComboBoxPrivate *priv = combo_box->priv;
3310 if (!gtk_tree_row_reference_valid (priv->active_row))
3312 if (priv->cell_view)
3313 gtk_cell_view_set_displayed_row (GTK_CELL_VIEW (priv->cell_view), NULL);
3314 g_signal_emit (combo_box, combo_box_signals[CHANGED], 0);
3317 if (priv->tree_view)
3318 gtk_combo_box_list_popup_resize (combo_box);
3320 gtk_combo_box_update_sensitivity (combo_box);
3324 gtk_combo_box_model_rows_reordered (GtkTreeModel *model,
3330 gtk_tree_row_reference_reordered (G_OBJECT (user_data), path, iter, new_order);
3334 gtk_combo_box_model_row_changed (GtkTreeModel *model,
3339 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
3340 GtkComboBoxPrivate *priv = combo_box->priv;
3341 GtkTreePath *active_path;
3343 /* FIXME this belongs to GtkCellView */
3344 if (gtk_tree_row_reference_valid (priv->active_row))
3346 active_path = gtk_tree_row_reference_get_path (priv->active_row);
3347 if (gtk_tree_path_compare (path, active_path) == 0 &&
3349 gtk_widget_queue_resize (GTK_WIDGET (priv->cell_view));
3350 gtk_tree_path_free (active_path);
3353 if (priv->tree_view)
3354 gtk_combo_box_list_row_changed (model, path, iter, user_data);
3358 list_popup_resize_idle (gpointer user_data)
3360 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
3361 GtkComboBoxPrivate *priv = combo_box->priv;
3362 gint x, y, width, height;
3364 if (priv->tree_view && gtk_widget_get_mapped (priv->popup_window))
3366 gtk_combo_box_list_position (combo_box, &x, &y, &width, &height);
3368 gtk_widget_set_size_request (priv->popup_window, width, height);
3369 gtk_window_move (GTK_WINDOW (priv->popup_window), x, y);
3372 priv->resize_idle_id = 0;
3378 gtk_combo_box_list_popup_resize (GtkComboBox *combo_box)
3380 GtkComboBoxPrivate *priv = combo_box->priv;
3382 if (!priv->resize_idle_id)
3383 priv->resize_idle_id =
3384 gdk_threads_add_idle (list_popup_resize_idle, combo_box);
3388 gtk_combo_box_model_row_expanded (GtkTreeModel *model,
3393 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
3395 gtk_combo_box_list_popup_resize (combo_box);
3404 gtk_combo_box_list_setup (GtkComboBox *combo_box)
3406 GtkComboBoxPrivate *priv = combo_box->priv;
3407 GtkTreeSelection *sel;
3409 GtkWidget *widget = GTK_WIDGET (combo_box);
3411 priv->button = gtk_toggle_button_new ();
3412 child = gtk_bin_get_child (GTK_BIN (combo_box));
3413 gtk_widget_set_parent (priv->button,
3414 gtk_widget_get_parent (child));
3415 g_signal_connect (priv->button, "button-press-event",
3416 G_CALLBACK (gtk_combo_box_list_button_pressed), combo_box);
3417 g_signal_connect (priv->button, "toggled",
3418 G_CALLBACK (gtk_combo_box_button_toggled), combo_box);
3420 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_NONE);
3421 gtk_container_add (GTK_CONTAINER (priv->button), priv->arrow);
3422 priv->separator = NULL;
3423 gtk_widget_show_all (priv->button);
3425 if (priv->cell_view)
3427 GtkStyleContext *context;
3428 GtkStateFlags state;
3431 context = gtk_widget_get_style_context (widget);
3432 state = gtk_widget_get_state_flags (widget);
3433 gtk_style_context_get_background_color (context, state, &color);
3435 gtk_cell_view_set_background_rgba (GTK_CELL_VIEW (priv->cell_view), &color);
3437 priv->box = gtk_event_box_new ();
3438 gtk_event_box_set_visible_window (GTK_EVENT_BOX (priv->box),
3441 if (priv->has_frame)
3443 priv->cell_view_frame = gtk_frame_new (NULL);
3444 gtk_frame_set_shadow_type (GTK_FRAME (priv->cell_view_frame),
3449 combo_box->priv->cell_view_frame = gtk_event_box_new ();
3450 gtk_event_box_set_visible_window (GTK_EVENT_BOX (combo_box->priv->cell_view_frame),
3454 gtk_widget_set_parent (priv->cell_view_frame,
3455 gtk_widget_get_parent (child));
3456 gtk_container_add (GTK_CONTAINER (priv->cell_view_frame), priv->box);
3457 gtk_widget_show_all (priv->cell_view_frame);
3459 g_signal_connect (priv->box, "button-press-event",
3460 G_CALLBACK (gtk_combo_box_list_button_pressed),
3464 priv->tree_view = gtk_tree_view_new ();
3465 sel = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view));
3466 gtk_tree_selection_set_mode (sel, GTK_SELECTION_BROWSE);
3467 gtk_tree_selection_set_select_function (sel,
3468 gtk_combo_box_list_select_func,
3470 gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (priv->tree_view),
3472 gtk_tree_view_set_hover_selection (GTK_TREE_VIEW (priv->tree_view),
3475 gtk_tree_view_set_row_separator_func (GTK_TREE_VIEW (priv->tree_view),
3476 (GtkTreeViewRowSeparatorFunc)gtk_combo_box_row_separator_func,
3480 gtk_tree_view_set_model (GTK_TREE_VIEW (priv->tree_view), priv->model);
3482 gtk_tree_view_append_column (GTK_TREE_VIEW (priv->tree_view),
3483 gtk_tree_view_column_new_with_area (priv->area));
3485 if (gtk_tree_row_reference_valid (priv->active_row))
3489 path = gtk_tree_row_reference_get_path (priv->active_row);
3490 gtk_tree_view_set_cursor (GTK_TREE_VIEW (priv->tree_view),
3492 gtk_tree_path_free (path);
3495 /* set sample/popup widgets */
3496 gtk_combo_box_set_popup_widget (combo_box, priv->tree_view);
3498 g_signal_connect (priv->tree_view, "key-press-event",
3499 G_CALLBACK (gtk_combo_box_list_key_press),
3501 g_signal_connect (priv->tree_view, "enter-notify-event",
3502 G_CALLBACK (gtk_combo_box_list_enter_notify),
3504 g_signal_connect (priv->tree_view, "row-expanded",
3505 G_CALLBACK (gtk_combo_box_model_row_expanded),
3507 g_signal_connect (priv->tree_view, "row-collapsed",
3508 G_CALLBACK (gtk_combo_box_model_row_expanded),
3510 g_signal_connect (priv->popup_window, "button-press-event",
3511 G_CALLBACK (gtk_combo_box_list_button_pressed),
3513 g_signal_connect (priv->popup_window, "button-release-event",
3514 G_CALLBACK (gtk_combo_box_list_button_released),
3517 gtk_widget_show (priv->tree_view);
3519 gtk_combo_box_update_sensitivity (combo_box);
3523 gtk_combo_box_list_destroy (GtkComboBox *combo_box)
3525 GtkComboBoxPrivate *priv = combo_box->priv;
3527 /* disconnect signals */
3528 g_signal_handlers_disconnect_matched (priv->tree_view,
3529 G_SIGNAL_MATCH_DATA,
3530 0, 0, NULL, NULL, combo_box);
3531 g_signal_handlers_disconnect_matched (priv->button,
3532 G_SIGNAL_MATCH_DATA,
3534 gtk_combo_box_list_button_pressed,
3536 g_signal_handlers_disconnect_matched (priv->popup_window,
3537 G_SIGNAL_MATCH_DATA,
3539 gtk_combo_box_list_button_pressed,
3541 g_signal_handlers_disconnect_matched (priv->popup_window,
3542 G_SIGNAL_MATCH_DATA,
3544 gtk_combo_box_list_button_released,
3547 g_signal_handlers_disconnect_matched (priv->popup_window,
3548 G_SIGNAL_MATCH_DATA,
3550 gtk_combo_box_child_show,
3553 g_signal_handlers_disconnect_matched (priv->popup_window,
3554 G_SIGNAL_MATCH_DATA,
3556 gtk_combo_box_child_hide,
3560 g_signal_handlers_disconnect_matched (priv->box,
3561 G_SIGNAL_MATCH_DATA,
3563 gtk_combo_box_list_button_pressed,
3566 /* destroy things (unparent will kill the latest ref from us)
3567 * last unref on button will destroy the arrow
3569 gtk_widget_unparent (priv->button);
3570 priv->button = NULL;
3573 if (priv->cell_view)
3575 g_object_set (priv->cell_view,
3576 "background-set", FALSE,
3580 if (priv->cell_view_frame)
3582 gtk_widget_unparent (priv->cell_view_frame);
3583 priv->cell_view_frame = NULL;
3587 if (priv->scroll_timer)
3589 g_source_remove (priv->scroll_timer);
3590 priv->scroll_timer = 0;
3593 if (priv->resize_idle_id)
3595 g_source_remove (priv->resize_idle_id);
3596 priv->resize_idle_id = 0;
3599 gtk_widget_destroy (priv->tree_view);
3601 priv->tree_view = NULL;
3602 if (priv->popup_widget)
3604 g_object_unref (priv->popup_widget);
3605 priv->popup_widget = NULL;
3612 gtk_combo_box_list_button_pressed (GtkWidget *widget,
3613 GdkEventButton *event,
3616 GtkComboBox *combo_box = GTK_COMBO_BOX (data);
3617 GtkComboBoxPrivate *priv = combo_box->priv;
3619 GtkWidget *ewidget = gtk_get_event_widget ((GdkEvent *)event);
3621 if (ewidget == priv->popup_window)
3624 if ((ewidget != priv->button && ewidget != priv->box) ||
3625 gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (priv->button)))
3628 if (priv->focus_on_click &&
3629 !gtk_widget_has_focus (priv->button))
3630 gtk_widget_grab_focus (priv->button);
3632 gtk_combo_box_popup_for_device (combo_box, event->device);
3634 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->button), TRUE);
3636 priv->auto_scroll = FALSE;
3637 if (priv->scroll_timer == 0)
3638 priv->scroll_timer = gdk_threads_add_timeout (SCROLL_TIME,
3639 (GSourceFunc) gtk_combo_box_list_scroll_timeout,
3642 priv->popup_in_progress = TRUE;
3648 gtk_combo_box_list_button_released (GtkWidget *widget,
3649 GdkEventButton *event,
3653 GtkTreePath *path = NULL;
3656 GtkComboBox *combo_box = GTK_COMBO_BOX (data);
3657 GtkComboBoxPrivate *priv = combo_box->priv;
3659 gboolean popup_in_progress = FALSE;
3661 GtkWidget *ewidget = gtk_get_event_widget ((GdkEvent *)event);
3663 if (priv->popup_in_progress)
3665 popup_in_progress = TRUE;
3666 priv->popup_in_progress = FALSE;
3669 gtk_tree_view_set_hover_expand (GTK_TREE_VIEW (priv->tree_view),
3671 if (priv->scroll_timer)
3673 g_source_remove (priv->scroll_timer);
3674 priv->scroll_timer = 0;
3677 if (ewidget != priv->tree_view)
3679 if ((ewidget == priv->button ||
3680 ewidget == priv->box) &&
3681 !popup_in_progress &&
3682 gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (priv->button)))
3684 gtk_combo_box_popdown (combo_box);
3688 /* released outside treeview */
3689 if (ewidget != priv->button && ewidget != priv->box)
3691 gtk_combo_box_popdown (combo_box);
3699 /* select something cool */
3700 ret = gtk_tree_view_get_path_at_pos (GTK_TREE_VIEW (priv->tree_view),
3706 return TRUE; /* clicked outside window? */
3708 gtk_tree_model_get_iter (priv->model, &iter, path);
3709 gtk_tree_path_free (path);
3711 gtk_combo_box_popdown (combo_box);
3713 if (tree_column_row_is_sensitive (combo_box, &iter))
3714 gtk_combo_box_set_active_iter (combo_box, &iter);
3720 gtk_combo_box_menu_key_press (GtkWidget *widget,
3724 GtkComboBox *combo_box = GTK_COMBO_BOX (data);
3726 if (!gtk_bindings_activate_event (G_OBJECT (widget), event))
3728 /* The menu hasn't managed the
3729 * event, forward it to the combobox
3731 gtk_bindings_activate_event (G_OBJECT (combo_box), event);
3738 gtk_combo_box_list_key_press (GtkWidget *widget,
3742 GtkComboBox *combo_box = GTK_COMBO_BOX (data);
3745 if (event->keyval == GDK_KEY_Return || event->keyval == GDK_KEY_ISO_Enter || event->keyval == GDK_KEY_KP_Enter ||
3746 event->keyval == GDK_KEY_space || event->keyval == GDK_KEY_KP_Space)
3748 GtkTreeModel *model = NULL;
3750 gtk_combo_box_popdown (combo_box);
3752 if (combo_box->priv->model)
3754 GtkTreeSelection *sel;
3756 sel = gtk_tree_view_get_selection (GTK_TREE_VIEW (combo_box->priv->tree_view));
3758 if (gtk_tree_selection_get_selected (sel, &model, &iter))
3759 gtk_combo_box_set_active_iter (combo_box, &iter);
3765 if (!gtk_bindings_activate_event (G_OBJECT (widget), event))
3767 /* The list hasn't managed the
3768 * event, forward it to the combobox
3770 gtk_bindings_activate_event (G_OBJECT (combo_box), event);
3777 gtk_combo_box_list_auto_scroll (GtkComboBox *combo_box,
3782 GtkAllocation allocation;
3783 GtkWidget *tree_view = combo_box->priv->tree_view;
3786 gtk_widget_get_allocation (tree_view, &allocation);
3788 adj = gtk_scrolled_window_get_hadjustment (GTK_SCROLLED_WINDOW (combo_box->priv->scrolled_window));
3789 if (adj && gtk_adjustment_get_upper (adj) - gtk_adjustment_get_lower (adj) > gtk_adjustment_get_page_size (adj))
3791 if (x <= allocation.x &&
3792 gtk_adjustment_get_lower (adj) < gtk_adjustment_get_value (adj))
3794 value = gtk_adjustment_get_value (adj) - (allocation.x - x + 1);
3795 gtk_adjustment_set_value (adj, value);
3797 else if (x >= allocation.x + allocation.width &&
3798 gtk_adjustment_get_upper (adj) - gtk_adjustment_get_page_size (adj) > gtk_adjustment_get_value (adj))
3800 value = gtk_adjustment_get_value (adj) + (x - allocation.x - allocation.width + 1);
3801 gtk_adjustment_set_value (adj, MAX (value, 0.0));
3805 adj = gtk_scrolled_window_get_vadjustment (GTK_SCROLLED_WINDOW (combo_box->priv->scrolled_window));
3806 if (adj && gtk_adjustment_get_upper (adj) - gtk_adjustment_get_lower (adj) > gtk_adjustment_get_page_size (adj))
3808 if (y <= allocation.y &&
3809 gtk_adjustment_get_lower (adj) < gtk_adjustment_get_value (adj))
3811 value = gtk_adjustment_get_value (adj) - (allocation.y - y + 1);
3812 gtk_adjustment_set_value (adj, value);
3814 else if (y >= allocation.height &&
3815 gtk_adjustment_get_upper (adj) - gtk_adjustment_get_page_size (adj) > gtk_adjustment_get_value (adj))
3817 value = gtk_adjustment_get_value (adj) + (y - allocation.height + 1);
3818 gtk_adjustment_set_value (adj, MAX (value, 0.0));
3824 gtk_combo_box_list_scroll_timeout (GtkComboBox *combo_box)
3826 GtkComboBoxPrivate *priv = combo_box->priv;
3829 if (priv->auto_scroll)
3831 gdk_window_get_device_position (gtk_widget_get_window (priv->tree_view),
3834 gtk_combo_box_list_auto_scroll (combo_box, x, y);
3841 gtk_combo_box_list_enter_notify (GtkWidget *widget,
3842 GdkEventCrossing *event,
3845 GtkComboBox *combo_box = GTK_COMBO_BOX (data);
3847 combo_box->priv->auto_scroll = TRUE;
3853 gtk_combo_box_list_select_func (GtkTreeSelection *selection,
3854 GtkTreeModel *model,
3856 gboolean path_currently_selected,
3859 GList *list, *columns;
3860 gboolean sensitive = FALSE;
3862 columns = gtk_tree_view_get_columns (gtk_tree_selection_get_tree_view (selection));
3864 for (list = columns; list && !sensitive; list = list->next)
3866 GList *cells, *cell;
3867 gboolean cell_sensitive, cell_visible;
3869 GtkTreeViewColumn *column = GTK_TREE_VIEW_COLUMN (list->data);
3871 if (!gtk_tree_view_column_get_visible (column))
3874 gtk_tree_model_get_iter (model, &iter, path);
3875 gtk_tree_view_column_cell_set_cell_data (column, model, &iter,
3878 cell = cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (column));
3881 g_object_get (cell->data,
3882 "sensitive", &cell_sensitive,
3883 "visible", &cell_visible,
3886 if (cell_visible && cell_sensitive)
3895 g_list_free (cells);
3898 g_list_free (columns);
3904 gtk_combo_box_list_row_changed (GtkTreeModel *model,
3909 /* XXX Do nothing ? */
3913 * GtkCellLayout implementation
3915 static GtkCellArea *
3916 gtk_combo_box_cell_layout_get_area (GtkCellLayout *cell_layout)
3918 GtkComboBox *combo = GTK_COMBO_BOX (cell_layout);
3919 GtkComboBoxPrivate *priv = combo->priv;
3921 if (G_UNLIKELY (!priv->area))
3923 priv->area = gtk_cell_area_box_new ();
3924 g_object_ref_sink (priv->area);
3935 * gtk_combo_box_new:
3937 * Creates a new empty #GtkComboBox.
3939 * Return value: A new #GtkComboBox.
3944 gtk_combo_box_new (void)
3946 return g_object_new (GTK_TYPE_COMBO_BOX, NULL);
3950 * gtk_combo_box_new_with_area:
3951 * @area: the #GtkCellArea to use to layout cell renderers
3953 * Creates a new empty #GtkComboBox using @area to layout cells.
3955 * Return value: A new #GtkComboBox.
3958 gtk_combo_box_new_with_area (GtkCellArea *area)
3960 return g_object_new (GTK_TYPE_COMBO_BOX, "cell-area", area, NULL);
3964 * gtk_combo_box_new_with_area_and_entry:
3965 * @area: the #GtkCellArea to use to layout cell renderers
3967 * Creates a new empty #GtkComboBox with an entry.
3969 * The new combo box will use @area to layout cells.
3971 * Return value: A new #GtkComboBox.
3974 gtk_combo_box_new_with_area_and_entry (GtkCellArea *area)
3976 return g_object_new (GTK_TYPE_COMBO_BOX,
3984 * gtk_combo_box_new_with_entry:
3986 * Creates a new empty #GtkComboBox with an entry.
3988 * Return value: A new #GtkComboBox.
3991 gtk_combo_box_new_with_entry (void)
3993 return g_object_new (GTK_TYPE_COMBO_BOX, "has-entry", TRUE, NULL);
3997 * gtk_combo_box_new_with_model:
3998 * @model: A #GtkTreeModel.
4000 * Creates a new #GtkComboBox with the model initialized to @model.
4002 * Return value: A new #GtkComboBox.
4007 gtk_combo_box_new_with_model (GtkTreeModel *model)
4009 GtkComboBox *combo_box;
4011 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
4013 combo_box = g_object_new (GTK_TYPE_COMBO_BOX, "model", model, NULL);
4015 return GTK_WIDGET (combo_box);
4019 * gtk_combo_box_new_with_model_and_entry:
4020 * @model: A #GtkTreeModel
4022 * Creates a new empty #GtkComboBox with an entry
4023 * and with the model initialized to @model.
4025 * Return value: A new #GtkComboBox
4028 gtk_combo_box_new_with_model_and_entry (GtkTreeModel *model)
4030 return g_object_new (GTK_TYPE_COMBO_BOX,
4037 * gtk_combo_box_get_wrap_width:
4038 * @combo_box: A #GtkComboBox
4040 * Returns the wrap width which is used to determine the number of columns
4041 * for the popup menu. If the wrap width is larger than 1, the combo box
4044 * Returns: the wrap width.
4049 gtk_combo_box_get_wrap_width (GtkComboBox *combo_box)
4051 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), -1);
4053 return combo_box->priv->wrap_width;
4057 * gtk_combo_box_set_wrap_width:
4058 * @combo_box: A #GtkComboBox
4059 * @width: Preferred number of columns
4061 * Sets the wrap width of @combo_box to be @width. The wrap width is basically
4062 * the preferred number of columns when you want the popup to be layed out
4068 gtk_combo_box_set_wrap_width (GtkComboBox *combo_box,
4071 GtkComboBoxPrivate *priv;
4073 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
4074 g_return_if_fail (width >= 0);
4076 priv = combo_box->priv;
4078 if (width != priv->wrap_width)
4080 priv->wrap_width = width;
4082 gtk_combo_box_check_appearance (combo_box);
4084 if (GTK_IS_TREE_MENU (priv->popup_widget))
4085 _gtk_tree_menu_set_wrap_width (GTK_TREE_MENU (priv->popup_widget), priv->wrap_width);
4087 g_object_notify (G_OBJECT (combo_box), "wrap-width");
4092 * gtk_combo_box_get_row_span_column:
4093 * @combo_box: A #GtkComboBox
4095 * Returns the column with row span information for @combo_box.
4097 * Returns: the row span column.
4102 gtk_combo_box_get_row_span_column (GtkComboBox *combo_box)
4104 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), -1);
4106 return combo_box->priv->row_column;
4110 * gtk_combo_box_set_row_span_column:
4111 * @combo_box: A #GtkComboBox.
4112 * @row_span: A column in the model passed during construction.
4114 * Sets the column with row span information for @combo_box to be @row_span.
4115 * The row span column contains integers which indicate how many rows
4116 * an item should span.
4121 gtk_combo_box_set_row_span_column (GtkComboBox *combo_box,
4124 GtkComboBoxPrivate *priv;
4127 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
4129 priv = combo_box->priv;
4131 col = gtk_tree_model_get_n_columns (priv->model);
4132 g_return_if_fail (row_span >= -1 && row_span < col);
4134 if (row_span != priv->row_column)
4136 priv->row_column = row_span;
4138 if (GTK_IS_TREE_MENU (priv->popup_widget))
4139 _gtk_tree_menu_set_row_span_column (GTK_TREE_MENU (priv->popup_widget), priv->row_column);
4141 g_object_notify (G_OBJECT (combo_box), "row-span-column");
4146 * gtk_combo_box_get_column_span_column:
4147 * @combo_box: A #GtkComboBox
4149 * Returns the column with column span information for @combo_box.
4151 * Returns: the column span column.
4156 gtk_combo_box_get_column_span_column (GtkComboBox *combo_box)
4158 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), -1);
4160 return combo_box->priv->col_column;
4164 * gtk_combo_box_set_column_span_column:
4165 * @combo_box: A #GtkComboBox
4166 * @column_span: A column in the model passed during construction
4168 * Sets the column with column span information for @combo_box to be
4169 * @column_span. The column span column contains integers which indicate
4170 * how many columns an item should span.
4175 gtk_combo_box_set_column_span_column (GtkComboBox *combo_box,
4178 GtkComboBoxPrivate *priv;
4181 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
4183 priv = combo_box->priv;
4185 col = gtk_tree_model_get_n_columns (priv->model);
4186 g_return_if_fail (column_span >= -1 && column_span < col);
4188 if (column_span != priv->col_column)
4190 priv->col_column = column_span;
4192 if (GTK_IS_TREE_MENU (priv->popup_widget))
4193 _gtk_tree_menu_set_column_span_column (GTK_TREE_MENU (priv->popup_widget), priv->col_column);
4195 g_object_notify (G_OBJECT (combo_box), "column-span-column");
4200 * gtk_combo_box_get_active:
4201 * @combo_box: A #GtkComboBox
4203 * Returns the index of the currently active item, or -1 if there's no
4204 * active item. If the model is a non-flat treemodel, and the active item
4205 * is not an immediate child of the root of the tree, this function returns
4206 * <literal>gtk_tree_path_get_indices (path)[0]</literal>, where
4207 * <literal>path</literal> is the #GtkTreePath of the active item.
4209 * Return value: An integer which is the index of the currently active item,
4210 * or -1 if there's no active item.
4215 gtk_combo_box_get_active (GtkComboBox *combo_box)
4217 GtkComboBoxPrivate *priv;
4220 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), 0);
4222 priv = combo_box->priv;
4224 if (gtk_tree_row_reference_valid (priv->active_row))
4228 path = gtk_tree_row_reference_get_path (priv->active_row);
4229 result = gtk_tree_path_get_indices (path)[0];
4230 gtk_tree_path_free (path);
4239 * gtk_combo_box_set_active:
4240 * @combo_box: A #GtkComboBox
4241 * @index_: An index in the model passed during construction, or -1 to have
4244 * Sets the active item of @combo_box to be the item at @index.
4249 gtk_combo_box_set_active (GtkComboBox *combo_box,
4252 GtkTreePath *path = NULL;
4253 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
4254 g_return_if_fail (index_ >= -1);
4256 if (combo_box->priv->model == NULL)
4258 /* Save index, in case the model is set after the index */
4259 combo_box->priv->active = index_;
4265 path = gtk_tree_path_new_from_indices (index_, -1);
4267 gtk_combo_box_set_active_internal (combo_box, path);
4270 gtk_tree_path_free (path);
4274 gtk_combo_box_set_active_internal (GtkComboBox *combo_box,
4277 GtkComboBoxPrivate *priv = combo_box->priv;
4278 GtkTreePath *active_path;
4281 /* Remember whether the initially active row is valid. */
4282 gboolean is_valid_row_reference = gtk_tree_row_reference_valid (priv->active_row);
4284 if (path && is_valid_row_reference)
4286 active_path = gtk_tree_row_reference_get_path (priv->active_row);
4287 path_cmp = gtk_tree_path_compare (path, active_path);
4288 gtk_tree_path_free (active_path);
4293 if (priv->active_row)
4295 gtk_tree_row_reference_free (priv->active_row);
4296 priv->active_row = NULL;
4301 if (priv->tree_view)
4302 gtk_tree_selection_unselect_all (gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view)));
4305 GtkMenu *menu = GTK_MENU (priv->popup_widget);
4307 if (GTK_IS_MENU (menu))
4308 gtk_menu_set_active (menu, -1);
4311 if (priv->cell_view)
4312 gtk_cell_view_set_displayed_row (GTK_CELL_VIEW (priv->cell_view), NULL);
4315 * Do not emit a "changed" signal when an already invalid selection was
4316 * now set to invalid.
4318 if (!is_valid_row_reference)
4324 gtk_tree_row_reference_new (priv->model, path);
4326 if (priv->tree_view)
4328 gtk_tree_view_set_cursor (GTK_TREE_VIEW (priv->tree_view),
4331 else if (GTK_IS_MENU (priv->popup_widget))
4333 /* FIXME handle nested menus better */
4334 gtk_menu_set_active (GTK_MENU (priv->popup_widget),
4335 gtk_tree_path_get_indices (path)[0]);
4338 if (priv->cell_view)
4339 gtk_cell_view_set_displayed_row (GTK_CELL_VIEW (priv->cell_view),
4343 g_signal_emit (combo_box, combo_box_signals[CHANGED], 0);
4344 g_object_notify (G_OBJECT (combo_box), "active");
4345 if (combo_box->priv->id_column >= 0)
4346 g_object_notify (G_OBJECT (combo_box), "active-id");
4351 * gtk_combo_box_get_active_iter:
4352 * @combo_box: A #GtkComboBox
4353 * @iter: (out): The uninitialized #GtkTreeIter
4355 * Sets @iter to point to the current active item, if it exists.
4357 * Return value: %TRUE, if @iter was set
4362 gtk_combo_box_get_active_iter (GtkComboBox *combo_box,
4368 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), FALSE);
4370 if (!gtk_tree_row_reference_valid (combo_box->priv->active_row))
4373 path = gtk_tree_row_reference_get_path (combo_box->priv->active_row);
4374 result = gtk_tree_model_get_iter (combo_box->priv->model, iter, path);
4375 gtk_tree_path_free (path);
4381 * gtk_combo_box_set_active_iter:
4382 * @combo_box: A #GtkComboBox
4383 * @iter: (allow-none): The #GtkTreeIter, or %NULL
4385 * Sets the current active item to be the one referenced by @iter, or
4386 * unsets the active item if @iter is %NULL.
4391 gtk_combo_box_set_active_iter (GtkComboBox *combo_box,
4394 GtkTreePath *path = NULL;
4396 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
4399 path = gtk_tree_model_get_path (gtk_combo_box_get_model (combo_box), iter);
4401 gtk_combo_box_set_active_internal (combo_box, path);
4402 gtk_tree_path_free (path);
4406 * gtk_combo_box_set_model:
4407 * @combo_box: A #GtkComboBox
4408 * @model: (allow-none): A #GtkTreeModel
4410 * Sets the model used by @combo_box to be @model. Will unset a previously set
4411 * model (if applicable). If model is %NULL, then it will unset the model.
4413 * Note that this function does not clear the cell renderers, you have to
4414 * call gtk_cell_layout_clear() yourself if you need to set up different
4415 * cell renderers for the new model.
4420 gtk_combo_box_set_model (GtkComboBox *combo_box,
4421 GtkTreeModel *model)
4423 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
4424 g_return_if_fail (model == NULL || GTK_IS_TREE_MODEL (model));
4426 if (model == combo_box->priv->model)
4429 gtk_combo_box_unset_model (combo_box);
4434 combo_box->priv->model = model;
4435 g_object_ref (combo_box->priv->model);
4437 combo_box->priv->inserted_id =
4438 g_signal_connect (combo_box->priv->model, "row-inserted",
4439 G_CALLBACK (gtk_combo_box_model_row_inserted),
4441 combo_box->priv->deleted_id =
4442 g_signal_connect (combo_box->priv->model, "row-deleted",
4443 G_CALLBACK (gtk_combo_box_model_row_deleted),
4445 combo_box->priv->reordered_id =
4446 g_signal_connect (combo_box->priv->model, "rows-reordered",
4447 G_CALLBACK (gtk_combo_box_model_rows_reordered),
4449 combo_box->priv->changed_id =
4450 g_signal_connect (combo_box->priv->model, "row-changed",
4451 G_CALLBACK (gtk_combo_box_model_row_changed),
4454 if (combo_box->priv->tree_view)
4457 gtk_tree_view_set_model (GTK_TREE_VIEW (combo_box->priv->tree_view),
4458 combo_box->priv->model);
4459 gtk_combo_box_list_popup_resize (combo_box);
4462 if (GTK_IS_TREE_MENU (combo_box->priv->popup_widget))
4465 _gtk_tree_menu_set_model (GTK_TREE_MENU (combo_box->priv->popup_widget),
4466 combo_box->priv->model);
4469 if (combo_box->priv->cell_view)
4470 gtk_cell_view_set_model (GTK_CELL_VIEW (combo_box->priv->cell_view),
4471 combo_box->priv->model);
4473 if (combo_box->priv->active != -1)
4475 /* If an index was set in advance, apply it now */
4476 gtk_combo_box_set_active (combo_box, combo_box->priv->active);
4477 combo_box->priv->active = -1;
4481 gtk_combo_box_update_sensitivity (combo_box);
4483 g_object_notify (G_OBJECT (combo_box), "model");
4487 * gtk_combo_box_get_model:
4488 * @combo_box: A #GtkComboBox
4490 * Returns the #GtkTreeModel which is acting as data source for @combo_box.
4492 * Return value: (transfer none): A #GtkTreeModel which was passed
4493 * during construction.
4498 gtk_combo_box_get_model (GtkComboBox *combo_box)
4500 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), NULL);
4502 return combo_box->priv->model;
4506 gtk_combo_box_real_move_active (GtkComboBox *combo_box,
4507 GtkScrollType scroll)
4510 GtkTreeIter new_iter;
4511 gboolean active_iter;
4514 if (!combo_box->priv->model)
4516 gtk_widget_error_bell (GTK_WIDGET (combo_box));
4520 active_iter = gtk_combo_box_get_active_iter (combo_box, &iter);
4524 case GTK_SCROLL_STEP_BACKWARD:
4525 case GTK_SCROLL_STEP_UP:
4526 case GTK_SCROLL_STEP_LEFT:
4529 found = tree_prev (combo_box, combo_box->priv->model,
4530 &iter, &new_iter, FALSE);
4533 /* else fall through */
4535 case GTK_SCROLL_PAGE_FORWARD:
4536 case GTK_SCROLL_PAGE_DOWN:
4537 case GTK_SCROLL_PAGE_RIGHT:
4538 case GTK_SCROLL_END:
4539 found = tree_last (combo_box, combo_box->priv->model, &new_iter, FALSE);
4542 case GTK_SCROLL_STEP_FORWARD:
4543 case GTK_SCROLL_STEP_DOWN:
4544 case GTK_SCROLL_STEP_RIGHT:
4547 found = tree_next (combo_box, combo_box->priv->model,
4548 &iter, &new_iter, FALSE);
4551 /* else fall through */
4553 case GTK_SCROLL_PAGE_BACKWARD:
4554 case GTK_SCROLL_PAGE_UP:
4555 case GTK_SCROLL_PAGE_LEFT:
4556 case GTK_SCROLL_START:
4557 found = tree_first (combo_box, combo_box->priv->model, &new_iter, FALSE);
4564 if (found && active_iter)
4566 GtkTreePath *old_path;
4567 GtkTreePath *new_path;
4569 old_path = gtk_tree_model_get_path (combo_box->priv->model, &iter);
4570 new_path = gtk_tree_model_get_path (combo_box->priv->model, &new_iter);
4572 if (gtk_tree_path_compare (old_path, new_path) == 0)
4575 gtk_tree_path_free (old_path);
4576 gtk_tree_path_free (new_path);
4581 gtk_combo_box_set_active_iter (combo_box, &new_iter);
4585 gtk_widget_error_bell (GTK_WIDGET (combo_box));
4590 gtk_combo_box_mnemonic_activate (GtkWidget *widget,
4591 gboolean group_cycling)
4593 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
4595 if (combo_box->priv->has_entry)
4599 child = gtk_bin_get_child (GTK_BIN (combo_box));
4601 gtk_widget_grab_focus (child);
4604 gtk_widget_grab_focus (combo_box->priv->button);
4610 gtk_combo_box_grab_focus (GtkWidget *widget)
4612 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
4614 if (combo_box->priv->has_entry)
4618 child = gtk_bin_get_child (GTK_BIN (combo_box));
4620 gtk_widget_grab_focus (child);
4623 gtk_widget_grab_focus (combo_box->priv->button);
4627 gtk_combo_box_destroy (GtkWidget *widget)
4629 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
4631 if (combo_box->priv->popup_idle_id > 0)
4633 g_source_remove (combo_box->priv->popup_idle_id);
4634 combo_box->priv->popup_idle_id = 0;
4637 gtk_combo_box_popdown (combo_box);
4639 if (combo_box->priv->row_separator_destroy)
4640 combo_box->priv->row_separator_destroy (combo_box->priv->row_separator_data);
4642 combo_box->priv->row_separator_func = NULL;
4643 combo_box->priv->row_separator_data = NULL;
4644 combo_box->priv->row_separator_destroy = NULL;
4646 GTK_WIDGET_CLASS (gtk_combo_box_parent_class)->destroy (widget);
4647 combo_box->priv->cell_view = NULL;
4651 gtk_combo_box_entry_contents_changed (GtkEntry *entry,
4654 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
4657 * Fixes regression reported in bug #574059. The old functionality relied on
4658 * bug #572478. As a bugfix, we now emit the "changed" signal ourselves
4659 * when the selection was already set to -1.
4661 if (gtk_combo_box_get_active(combo_box) == -1)
4662 g_signal_emit_by_name (combo_box, "changed");
4664 gtk_combo_box_set_active (combo_box, -1);
4668 gtk_combo_box_entry_active_changed (GtkComboBox *combo_box,
4671 GtkTreeModel *model;
4674 if (gtk_combo_box_get_active_iter (combo_box, &iter))
4676 GtkEntry *entry = GTK_ENTRY (gtk_bin_get_child (GTK_BIN (combo_box)));
4684 model = gtk_combo_box_get_model (combo_box);
4685 path = gtk_tree_model_get_path (model, &iter);
4686 path_str = gtk_tree_path_to_string (path);
4688 g_signal_handlers_block_by_func (entry,
4689 gtk_combo_box_entry_contents_changed,
4693 g_signal_emit (combo_box, combo_box_signals[FORMAT_ENTRY_TEXT], 0,
4696 gtk_entry_set_text (entry, text);
4698 g_signal_handlers_unblock_by_func (entry,
4699 gtk_combo_box_entry_contents_changed,
4702 gtk_tree_path_free (path);
4710 gtk_combo_box_format_entry_text (GtkComboBox *combo_box,
4713 GtkComboBoxPrivate *priv = combo_box->priv;
4714 GtkTreeModel *model;
4718 if (priv->text_column >= 0)
4720 model = gtk_combo_box_get_model (combo_box);
4721 gtk_tree_model_get_iter_from_string (model, &iter, path);
4723 gtk_tree_model_get (model, &iter,
4724 priv->text_column, &text,
4733 gtk_combo_box_constructor (GType type,
4734 guint n_construct_properties,
4735 GObjectConstructParam *construct_properties)
4738 GtkComboBox *combo_box;
4739 GtkComboBoxPrivate *priv;
4741 object = G_OBJECT_CLASS (gtk_combo_box_parent_class)->constructor
4742 (type, n_construct_properties, construct_properties);
4744 combo_box = GTK_COMBO_BOX (object);
4745 priv = combo_box->priv;
4749 priv->area = gtk_cell_area_box_new ();
4750 g_object_ref_sink (priv->area);
4753 priv->cell_view = gtk_cell_view_new_with_context (priv->area, NULL);
4754 gtk_cell_view_set_fit_model (GTK_CELL_VIEW (priv->cell_view), TRUE);
4755 gtk_cell_view_set_model (GTK_CELL_VIEW (priv->cell_view), priv->model);
4756 gtk_widget_set_parent (priv->cell_view, GTK_WIDGET (combo_box));
4757 _gtk_bin_set_child (GTK_BIN (combo_box), priv->cell_view);
4758 gtk_widget_show (priv->cell_view);
4760 gtk_combo_box_check_appearance (combo_box);
4762 if (priv->has_entry)
4765 GtkStyleContext *context;
4767 entry = gtk_entry_new ();
4768 gtk_widget_show (entry);
4769 gtk_container_add (GTK_CONTAINER (combo_box), entry);
4771 context = gtk_widget_get_style_context (GTK_WIDGET (combo_box));
4772 gtk_style_context_add_class (context, GTK_STYLE_CLASS_COMBOBOX_ENTRY);
4774 priv->text_renderer = gtk_cell_renderer_text_new ();
4775 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (combo_box),
4776 priv->text_renderer, TRUE);
4778 gtk_combo_box_set_active (GTK_COMBO_BOX (combo_box), -1);
4780 g_signal_connect (combo_box, "changed",
4781 G_CALLBACK (gtk_combo_box_entry_active_changed), NULL);
4789 gtk_combo_box_dispose(GObject* object)
4791 GtkComboBox *combo_box = GTK_COMBO_BOX (object);
4793 if (GTK_IS_MENU (combo_box->priv->popup_widget))
4795 gtk_combo_box_menu_destroy (combo_box);
4796 gtk_menu_detach (GTK_MENU (combo_box->priv->popup_widget));
4797 combo_box->priv->popup_widget = NULL;
4800 if (combo_box->priv->area)
4802 g_object_unref (combo_box->priv->area);
4803 combo_box->priv->area = NULL;
4806 if (GTK_IS_TREE_VIEW (combo_box->priv->tree_view))
4807 gtk_combo_box_list_destroy (combo_box);
4809 if (combo_box->priv->popup_window)
4811 gtk_widget_destroy (combo_box->priv->popup_window);
4812 combo_box->priv->popup_window = NULL;
4815 gtk_combo_box_unset_model (combo_box);
4817 G_OBJECT_CLASS (gtk_combo_box_parent_class)->dispose (object);
4821 gtk_combo_box_finalize (GObject *object)
4823 GtkComboBox *combo_box = GTK_COMBO_BOX (object);
4825 g_free (combo_box->priv->tearoff_title);
4827 G_OBJECT_CLASS (gtk_combo_box_parent_class)->finalize (object);
4831 gtk_cell_editable_key_press (GtkWidget *widget,
4835 GtkComboBox *combo_box = GTK_COMBO_BOX (data);
4837 if (event->keyval == GDK_KEY_Escape)
4839 g_object_set (combo_box,
4840 "editing-canceled", TRUE,
4842 gtk_cell_editable_editing_done (GTK_CELL_EDITABLE (combo_box));
4843 gtk_cell_editable_remove_widget (GTK_CELL_EDITABLE (combo_box));
4847 else if (event->keyval == GDK_KEY_Return ||
4848 event->keyval == GDK_KEY_ISO_Enter ||
4849 event->keyval == GDK_KEY_KP_Enter)
4851 gtk_cell_editable_editing_done (GTK_CELL_EDITABLE (combo_box));
4852 gtk_cell_editable_remove_widget (GTK_CELL_EDITABLE (combo_box));
4861 popdown_idle (gpointer data)
4863 GtkComboBox *combo_box;
4865 combo_box = GTK_COMBO_BOX (data);
4867 gtk_cell_editable_editing_done (GTK_CELL_EDITABLE (combo_box));
4868 gtk_cell_editable_remove_widget (GTK_CELL_EDITABLE (combo_box));
4870 g_object_unref (combo_box);
4876 popdown_handler (GtkWidget *widget,
4879 gdk_threads_add_idle (popdown_idle, g_object_ref (data));
4883 popup_idle (gpointer data)
4885 GtkComboBox *combo_box;
4887 combo_box = GTK_COMBO_BOX (data);
4889 if (GTK_IS_MENU (combo_box->priv->popup_widget) &&
4890 combo_box->priv->cell_view)
4891 g_signal_connect_object (combo_box->priv->popup_widget,
4892 "unmap", G_CALLBACK (popdown_handler),
4895 /* we unset this if a menu item is activated */
4896 g_object_set (combo_box,
4897 "editing-canceled", TRUE,
4899 gtk_combo_box_popup (combo_box);
4901 combo_box->priv->popup_idle_id = 0;
4902 combo_box->priv->activate_button = 0;
4903 combo_box->priv->activate_time = 0;
4909 gtk_combo_box_start_editing (GtkCellEditable *cell_editable,
4912 GtkComboBox *combo_box = GTK_COMBO_BOX (cell_editable);
4915 combo_box->priv->is_cell_renderer = TRUE;
4917 if (combo_box->priv->cell_view)
4919 g_signal_connect_object (combo_box->priv->button, "key-press-event",
4920 G_CALLBACK (gtk_cell_editable_key_press),
4923 gtk_widget_grab_focus (combo_box->priv->button);
4927 child = gtk_bin_get_child (GTK_BIN (combo_box));
4929 g_signal_connect_object (child, "key-press-event",
4930 G_CALLBACK (gtk_cell_editable_key_press),
4933 gtk_widget_grab_focus (child);
4934 gtk_widget_set_can_focus (combo_box->priv->button, FALSE);
4937 /* we do the immediate popup only for the optionmenu-like
4940 if (combo_box->priv->is_cell_renderer &&
4941 combo_box->priv->cell_view && !combo_box->priv->tree_view)
4943 if (event && event->type == GDK_BUTTON_PRESS)
4945 GdkEventButton *event_button = (GdkEventButton *)event;
4947 combo_box->priv->activate_button = event_button->button;
4948 combo_box->priv->activate_time = event_button->time;
4951 combo_box->priv->popup_idle_id =
4952 gdk_threads_add_idle (popup_idle, combo_box);
4958 * gtk_combo_box_get_add_tearoffs:
4959 * @combo_box: a #GtkComboBox
4961 * Gets the current value of the :add-tearoffs property.
4963 * Return value: the current value of the :add-tearoffs property.
4966 gtk_combo_box_get_add_tearoffs (GtkComboBox *combo_box)
4968 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), FALSE);
4970 return combo_box->priv->add_tearoffs;
4974 * gtk_combo_box_set_add_tearoffs:
4975 * @combo_box: a #GtkComboBox
4976 * @add_tearoffs: %TRUE to add tearoff menu items
4978 * Sets whether the popup menu should have a tearoff
4984 gtk_combo_box_set_add_tearoffs (GtkComboBox *combo_box,
4985 gboolean add_tearoffs)
4987 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
4989 add_tearoffs = add_tearoffs != FALSE;
4991 if (combo_box->priv->add_tearoffs != add_tearoffs)
4993 combo_box->priv->add_tearoffs = add_tearoffs;
4994 gtk_combo_box_check_appearance (combo_box);
4996 if (GTK_IS_TREE_MENU (combo_box->priv->popup_widget))
4997 _gtk_tree_menu_set_tearoff (GTK_TREE_MENU (combo_box->priv->popup_widget),
4998 combo_box->priv->add_tearoffs);
5000 g_object_notify (G_OBJECT (combo_box), "add-tearoffs");
5005 * gtk_combo_box_get_title:
5006 * @combo_box: a #GtkComboBox
5008 * Gets the current title of the menu in tearoff mode. See
5009 * gtk_combo_box_set_add_tearoffs().
5011 * Returns: the menu's title in tearoff mode. This is an internal copy of the
5012 * string which must not be freed.
5017 gtk_combo_box_get_title (GtkComboBox *combo_box)
5019 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), NULL);
5021 return combo_box->priv->tearoff_title;
5025 gtk_combo_box_update_title (GtkComboBox *combo_box)
5027 gtk_combo_box_check_appearance (combo_box);
5029 if (combo_box->priv->popup_widget &&
5030 GTK_IS_MENU (combo_box->priv->popup_widget))
5031 gtk_menu_set_title (GTK_MENU (combo_box->priv->popup_widget),
5032 combo_box->priv->tearoff_title);
5036 * gtk_combo_box_set_title:
5037 * @combo_box: a #GtkComboBox
5038 * @title: a title for the menu in tearoff mode
5040 * Sets the menu's title in tearoff mode.
5045 gtk_combo_box_set_title (GtkComboBox *combo_box,
5048 GtkComboBoxPrivate *priv;
5050 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
5052 priv = combo_box->priv;
5054 if (strcmp (title ? title : "",
5055 priv->tearoff_title ? priv->tearoff_title : "") != 0)
5057 g_free (priv->tearoff_title);
5058 priv->tearoff_title = g_strdup (title);
5060 gtk_combo_box_update_title (combo_box);
5062 g_object_notify (G_OBJECT (combo_box), "tearoff-title");
5068 * gtk_combo_box_set_popup_fixed_width:
5069 * @combo_box: a #GtkComboBox
5070 * @fixed: whether to use a fixed popup width
5072 * Specifies whether the popup's width should be a fixed width
5073 * matching the allocated width of the combo box.
5078 gtk_combo_box_set_popup_fixed_width (GtkComboBox *combo_box,
5081 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
5083 if (combo_box->priv->popup_fixed_width != fixed)
5085 combo_box->priv->popup_fixed_width = fixed;
5087 g_object_notify (G_OBJECT (combo_box), "popup-fixed-width");
5092 * gtk_combo_box_get_popup_fixed_width:
5093 * @combo_box: a #GtkComboBox
5095 * Gets whether the popup uses a fixed width matching
5096 * the allocated width of the combo box.
5098 * Returns: %TRUE if the popup uses a fixed width
5103 gtk_combo_box_get_popup_fixed_width (GtkComboBox *combo_box)
5105 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), FALSE);
5107 return combo_box->priv->popup_fixed_width;
5112 * gtk_combo_box_get_popup_accessible:
5113 * @combo_box: a #GtkComboBox
5115 * Gets the accessible object corresponding to the combo box's popup.
5117 * This function is mostly intended for use by accessibility technologies;
5118 * applications should have little use for it.
5120 * Returns: (transfer none): the accessible object corresponding
5121 * to the combo box's popup.
5126 gtk_combo_box_get_popup_accessible (GtkComboBox *combo_box)
5130 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), NULL);
5132 if (combo_box->priv->popup_widget)
5134 atk_obj = gtk_widget_get_accessible (combo_box->priv->popup_widget);
5142 * gtk_combo_box_get_row_separator_func: (skip)
5143 * @combo_box: a #GtkComboBox
5145 * Returns the current row separator function.
5147 * Return value: the current row separator function.
5151 GtkTreeViewRowSeparatorFunc
5152 gtk_combo_box_get_row_separator_func (GtkComboBox *combo_box)
5154 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), NULL);
5156 return combo_box->priv->row_separator_func;
5160 * gtk_combo_box_set_row_separator_func:
5161 * @combo_box: a #GtkComboBox
5162 * @func: a #GtkTreeViewRowSeparatorFunc
5163 * @data: (allow-none): user data to pass to @func, or %NULL
5164 * @destroy: (allow-none): destroy notifier for @data, or %NULL
5166 * Sets the row separator function, which is used to determine
5167 * whether a row should be drawn as a separator. If the row separator
5168 * function is %NULL, no separators are drawn. This is the default value.
5173 gtk_combo_box_set_row_separator_func (GtkComboBox *combo_box,
5174 GtkTreeViewRowSeparatorFunc func,
5176 GDestroyNotify destroy)
5178 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
5180 if (combo_box->priv->row_separator_destroy)
5181 combo_box->priv->row_separator_destroy (combo_box->priv->row_separator_data);
5183 combo_box->priv->row_separator_func = func;
5184 combo_box->priv->row_separator_data = data;
5185 combo_box->priv->row_separator_destroy = destroy;
5187 /* Provoke the underlying treeview/menu to rebuild themselves with the new separator func */
5188 if (combo_box->priv->tree_view)
5190 gtk_tree_view_set_model (GTK_TREE_VIEW (combo_box->priv->tree_view), NULL);
5191 gtk_tree_view_set_model (GTK_TREE_VIEW (combo_box->priv->tree_view), combo_box->priv->model);
5194 if (GTK_IS_TREE_MENU (combo_box->priv->popup_widget))
5196 _gtk_tree_menu_set_model (GTK_TREE_MENU (combo_box->priv->popup_widget), NULL);
5197 _gtk_tree_menu_set_model (GTK_TREE_MENU (combo_box->priv->popup_widget), combo_box->priv->model);
5200 gtk_widget_queue_draw (GTK_WIDGET (combo_box));
5204 * gtk_combo_box_set_button_sensitivity:
5205 * @combo_box: a #GtkComboBox
5206 * @sensitivity: specify the sensitivity of the dropdown button
5208 * Sets whether the dropdown button of the combo box should be
5209 * always sensitive (%GTK_SENSITIVITY_ON), never sensitive (%GTK_SENSITIVITY_OFF)
5210 * or only if there is at least one item to display (%GTK_SENSITIVITY_AUTO).
5215 gtk_combo_box_set_button_sensitivity (GtkComboBox *combo_box,
5216 GtkSensitivityType sensitivity)
5218 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
5220 if (combo_box->priv->button_sensitivity != sensitivity)
5222 combo_box->priv->button_sensitivity = sensitivity;
5223 gtk_combo_box_update_sensitivity (combo_box);
5225 g_object_notify (G_OBJECT (combo_box), "button-sensitivity");
5230 * gtk_combo_box_get_button_sensitivity:
5231 * @combo_box: a #GtkComboBox
5233 * Returns whether the combo box sets the dropdown button
5234 * sensitive or not when there are no items in the model.
5236 * Return Value: %GTK_SENSITIVITY_ON if the dropdown button
5237 * is sensitive when the model is empty, %GTK_SENSITIVITY_OFF
5238 * if the button is always insensitive or
5239 * %GTK_SENSITIVITY_AUTO if it is only sensitive as long as
5240 * the model has one item to be selected.
5245 gtk_combo_box_get_button_sensitivity (GtkComboBox *combo_box)
5247 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), FALSE);
5249 return combo_box->priv->button_sensitivity;
5254 * gtk_combo_box_get_has_entry:
5255 * @combo_box: a #GtkComboBox
5257 * Returns whether the combo box has an entry.
5259 * Return Value: whether there is an entry in @combo_box.
5264 gtk_combo_box_get_has_entry (GtkComboBox *combo_box)
5266 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), FALSE);
5268 return combo_box->priv->has_entry;
5272 * gtk_combo_box_set_entry_text_column:
5273 * @combo_box: A #GtkComboBox
5274 * @text_column: A column in @model to get the strings from for
5275 * the internal entry
5277 * Sets the model column which @combo_box should use to get strings from
5278 * to be @text_column. The column @text_column in the model of @combo_box
5279 * must be of type %G_TYPE_STRING.
5281 * This is only relevant if @combo_box has been created with
5282 * #GtkComboBox:has-entry as %TRUE.
5287 gtk_combo_box_set_entry_text_column (GtkComboBox *combo_box,
5290 GtkComboBoxPrivate *priv = combo_box->priv;
5291 GtkTreeModel *model;
5293 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
5295 model = gtk_combo_box_get_model (combo_box);
5297 g_return_if_fail (text_column >= 0);
5298 g_return_if_fail (model == NULL || text_column < gtk_tree_model_get_n_columns (model));
5300 priv->text_column = text_column;
5302 if (priv->text_renderer != NULL)
5303 gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (combo_box),
5304 priv->text_renderer,
5305 "text", text_column,
5310 * gtk_combo_box_get_entry_text_column:
5311 * @combo_box: A #GtkComboBox.
5313 * Returns the column which @combo_box is using to get the strings
5314 * from to display in the internal entry.
5316 * Return value: A column in the data source model of @combo_box.
5321 gtk_combo_box_get_entry_text_column (GtkComboBox *combo_box)
5323 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), 0);
5325 return combo_box->priv->text_column;
5329 * gtk_combo_box_set_focus_on_click:
5330 * @combo: a #GtkComboBox
5331 * @focus_on_click: whether the combo box grabs focus when clicked
5334 * Sets whether the combo box will grab focus when it is clicked with
5335 * the mouse. Making mouse clicks not grab focus is useful in places
5336 * like toolbars where you don't want the keyboard focus removed from
5337 * the main area of the application.
5342 gtk_combo_box_set_focus_on_click (GtkComboBox *combo_box,
5343 gboolean focus_on_click)
5345 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
5347 focus_on_click = focus_on_click != FALSE;
5349 if (combo_box->priv->focus_on_click != focus_on_click)
5351 combo_box->priv->focus_on_click = focus_on_click;
5353 if (combo_box->priv->button)
5354 gtk_button_set_focus_on_click (GTK_BUTTON (combo_box->priv->button),
5357 g_object_notify (G_OBJECT (combo_box), "focus-on-click");
5362 * gtk_combo_box_get_focus_on_click:
5363 * @combo: a #GtkComboBox
5365 * Returns whether the combo box grabs focus when it is clicked
5366 * with the mouse. See gtk_combo_box_set_focus_on_click().
5368 * Return value: %TRUE if the combo box grabs focus when it is
5369 * clicked with the mouse.
5374 gtk_combo_box_get_focus_on_click (GtkComboBox *combo_box)
5376 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), FALSE);
5378 return combo_box->priv->focus_on_click;
5383 gtk_combo_box_buildable_custom_tag_start (GtkBuildable *buildable,
5384 GtkBuilder *builder,
5386 const gchar *tagname,
5387 GMarkupParser *parser,
5390 if (parent_buildable_iface->custom_tag_start (buildable, builder, child,
5391 tagname, parser, data))
5394 return _gtk_cell_layout_buildable_custom_tag_start (buildable, builder, child,
5395 tagname, parser, data);
5399 gtk_combo_box_buildable_custom_tag_end (GtkBuildable *buildable,
5400 GtkBuilder *builder,
5402 const gchar *tagname,
5405 if (!_gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname, data))
5406 parent_buildable_iface->custom_tag_end (buildable, builder, child, tagname, data);
5410 gtk_combo_box_buildable_get_internal_child (GtkBuildable *buildable,
5411 GtkBuilder *builder,
5412 const gchar *childname)
5414 GtkComboBox *combo_box = GTK_COMBO_BOX (buildable);
5416 if (combo_box->priv->has_entry && strcmp (childname, "entry") == 0)
5417 return G_OBJECT (gtk_bin_get_child (GTK_BIN (buildable)));
5419 return parent_buildable_iface->get_internal_child (buildable, builder, childname);
5423 gtk_combo_box_get_preferred_width (GtkWidget *widget,
5427 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
5428 GtkComboBoxPrivate *priv = combo_box->priv;
5429 gint font_size, arrow_size;
5430 PangoContext *context;
5431 PangoFontMetrics *metrics;
5432 const PangoFontDescription *font_desc;
5434 gint minimum_width = 0, natural_width = 0;
5435 gint child_min, child_nat;
5436 GtkStyleContext *style_context;
5437 GtkStateFlags state;
5439 gfloat arrow_scaling;
5441 child = gtk_bin_get_child (GTK_BIN (widget));
5444 gtk_widget_get_preferred_width (child, &child_min, &child_nat);
5446 gtk_widget_style_get (GTK_WIDGET (widget),
5447 "arrow-size", &arrow_size,
5448 "arrow-scaling", &arrow_scaling,
5451 style_context = gtk_widget_get_style_context (widget);
5452 state = gtk_widget_get_state_flags (widget);
5454 get_widget_padding_and_border (widget, &padding);
5455 font_desc = gtk_style_context_get_font (style_context, state);
5457 context = gtk_widget_get_pango_context (GTK_WIDGET (widget));
5458 metrics = pango_context_get_metrics (context, font_desc,
5459 pango_context_get_language (context));
5460 font_size = PANGO_PIXELS (pango_font_metrics_get_ascent (metrics) +
5461 pango_font_metrics_get_descent (metrics));
5462 pango_font_metrics_unref (metrics);
5464 arrow_size = MAX (arrow_size, font_size) * arrow_scaling;
5466 gtk_widget_set_size_request (priv->arrow, arrow_size, arrow_size);
5468 if (!priv->tree_view)
5471 if (priv->cell_view)
5474 gint border_width, xpad;
5475 GtkBorder button_padding;
5477 border_width = gtk_container_get_border_width (GTK_CONTAINER (combo_box));
5478 get_widget_padding_and_border (priv->button, &button_padding);
5480 gtk_widget_get_preferred_width (priv->box, &box_width, NULL);
5481 xpad = 2 * border_width +
5482 button_padding.left + button_padding.right + padding.left + padding.right;
5484 minimum_width = child_min + box_width + xpad;
5485 natural_width = child_nat + box_width + xpad;
5489 gint but_width, but_nat_width;
5491 gtk_widget_get_preferred_width (priv->button,
5492 &but_width, &but_nat_width);
5494 minimum_width = child_min + but_width;
5495 natural_width = child_nat + but_nat_width;
5501 gint button_width, button_nat_width;
5503 /* sample + frame */
5504 minimum_width = child_min;
5505 natural_width = child_nat;
5507 if (priv->cell_view_frame)
5509 if (priv->has_frame)
5511 gint border_width, xpad;
5512 GtkBorder frame_padding;
5514 border_width = gtk_container_get_border_width (GTK_CONTAINER (priv->cell_view_frame));
5515 get_widget_padding_and_border (priv->cell_view_frame, &frame_padding);
5516 xpad = (2 * border_width) + frame_padding.left + frame_padding.right;
5518 minimum_width += xpad;
5519 natural_width += xpad;
5524 gtk_widget_get_preferred_width (priv->button,
5525 &button_width, &button_nat_width);
5527 minimum_width += button_width;
5528 natural_width += button_nat_width;
5531 minimum_width += padding.left + padding.right;
5532 natural_width += padding.left + padding.right;
5535 *minimum_size = minimum_width;
5538 *natural_size = natural_width;
5542 gtk_combo_box_get_preferred_height (GtkWidget *widget,
5548 /* Combo box is height-for-width only
5549 * (so we always just reserve enough height for the minimum width) */
5550 GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_width, NULL);
5551 GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget, min_width, minimum_size, natural_size);
5555 gtk_combo_box_get_preferred_width_for_height (GtkWidget *widget,
5560 /* Combo box is height-for-width only
5561 * (so we assume we always reserved enough height for the minimum width) */
5562 GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, minimum_size, natural_size);
5567 gtk_combo_box_get_preferred_height_for_width (GtkWidget *widget,
5572 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
5573 GtkComboBoxPrivate *priv = combo_box->priv;
5574 gint min_height = 0, nat_height = 0;
5579 child = gtk_bin_get_child (GTK_BIN (widget));
5581 get_widget_padding_and_border (widget, &padding);
5584 if (!priv->tree_view)
5587 if (priv->cell_view)
5589 /* calculate x/y padding and separator/arrow size */
5590 gint box_width, box_height;
5591 gint border_width, xpad, ypad;
5592 GtkBorder button_padding;
5594 border_width = gtk_container_get_border_width (GTK_CONTAINER (combo_box));
5595 get_widget_padding_and_border (priv->button, &button_padding);
5597 gtk_widget_get_preferred_width (priv->box, &box_width, NULL);
5598 gtk_widget_get_preferred_height_for_width (priv->box,
5599 box_width, &box_height, NULL);
5601 xpad = 2 * border_width +
5602 button_padding.left + button_padding.right;
5603 ypad = 2 * border_width +
5604 button_padding.top + button_padding.bottom;
5606 size -= box_width + xpad;
5608 /* Get height-for-width of the child widget, usually a GtkCellArea calculating
5609 * and fitting the whole treemodel */
5610 gtk_widget_get_preferred_height_for_width (child, size, &min_height, &nat_height);
5612 min_height = MAX (min_height, box_height);
5613 nat_height = MAX (nat_height, box_height);
5620 /* there is a custom child widget inside (no priv->cell_view) */
5621 gint but_width, but_height;
5623 gtk_widget_get_preferred_width (priv->button, &but_width, NULL);
5624 gtk_widget_get_preferred_height_for_width (priv->button,
5625 but_width, &but_height, NULL);
5629 /* Get height-for-width of the child widget, usually a GtkCellArea calculating
5630 * and fitting the whole treemodel */
5631 gtk_widget_get_preferred_height_for_width (child, size, &min_height, &nat_height);
5633 min_height = MAX (min_height, but_height);
5634 nat_height = MAX (nat_height, but_height);
5640 gint but_width, but_height;
5641 gint xpad = 0, ypad = 0;
5643 gtk_widget_get_preferred_width (priv->button, &but_width, NULL);
5644 gtk_widget_get_preferred_height_for_width (priv->button,
5645 but_width, &but_height, NULL);
5647 if (priv->cell_view_frame && priv->has_frame)
5649 GtkBorder frame_padding;
5652 border_width = gtk_container_get_border_width (GTK_CONTAINER (priv->cell_view_frame));
5653 get_widget_padding_and_border (GTK_WIDGET (priv->cell_view_frame), &frame_padding);
5655 xpad = (2 * border_width) + padding.left + frame_padding.right;
5656 ypad = (2 * border_width) + padding.top + frame_padding.bottom;
5662 /* Get height-for-width of the child widget, usually a GtkCellArea calculating
5663 * and fitting the whole treemodel */
5664 gtk_widget_get_preferred_height_for_width (child, size, &min_height, &nat_height);
5666 min_height = MAX (min_height, but_height);
5667 nat_height = MAX (nat_height, but_height);
5673 min_height += padding.top + padding.bottom;
5674 nat_height += padding.top + padding.bottom;
5677 *minimum_size = min_height;
5680 *natural_size = nat_height;
5684 * gtk_combo_box_set_id_column:
5685 * @combo_box: A #GtkComboBox
5686 * @id_column: A column in @model to get string IDs for values from
5688 * Sets the model column which @combo_box should use to get string IDs
5689 * for values from. The column @id_column in the model of @combo_box
5690 * must be of type %G_TYPE_STRING.
5695 gtk_combo_box_set_id_column (GtkComboBox *combo_box,
5698 GtkComboBoxPrivate *priv = combo_box->priv;
5699 GtkTreeModel *model;
5701 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
5703 if (id_column != priv->id_column)
5705 model = gtk_combo_box_get_model (combo_box);
5707 g_return_if_fail (id_column >= 0);
5708 g_return_if_fail (model == NULL ||
5709 id_column < gtk_tree_model_get_n_columns (model));
5711 priv->id_column = id_column;
5713 g_object_notify (G_OBJECT (combo_box), "id-column");
5714 g_object_notify (G_OBJECT (combo_box), "active-id");
5719 * gtk_combo_box_get_id_column:
5720 * @combo_box: A #GtkComboBox
5722 * Returns the column which @combo_box is using to get string IDs
5725 * Return value: A column in the data source model of @combo_box.
5730 gtk_combo_box_get_id_column (GtkComboBox *combo_box)
5732 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), 0);
5734 return combo_box->priv->id_column;
5738 * gtk_combo_box_get_active_id:
5739 * @combo_box: a #GtkComboBox
5741 * Returns the ID of the active row of @combo_box. This value is taken
5742 * from the active row and the column specified by the #GtkComboBox:id-column
5743 * property of @combo_box (see gtk_combo_box_set_id_column()).
5745 * The returned value is an interned string which means that you can
5746 * compare the pointer by value to other interned strings and that you
5749 * If the #GtkComboBox:id-column property of @combo_box is not set, or if
5750 * no row is active, or if the active row has a %NULL ID value, then %NULL
5753 * Return value: the ID of the active row, or %NULL
5758 gtk_combo_box_get_active_id (GtkComboBox *combo_box)
5760 GtkTreeModel *model;
5764 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), NULL);
5766 column = combo_box->priv->id_column;
5771 model = gtk_combo_box_get_model (combo_box);
5772 g_return_val_if_fail (gtk_tree_model_get_column_type (model, column) ==
5773 G_TYPE_STRING, NULL);
5775 if (gtk_combo_box_get_active_iter (combo_box, &iter))
5777 const gchar *interned;
5780 gtk_tree_model_get (model, &iter, column, &id, -1);
5781 interned = g_intern_string (id);
5791 * gtk_combo_box_set_active_id:
5792 * @combo_box: a #GtkComboBox
5793 * @active_id: (allow-none): the ID of the row to select, or %NULL
5795 * Changes the active row of @combo_box to the one that has an ID equal to
5796 * @active_id, or unsets the active row if @active_id is %NULL. Rows having
5797 * a %NULL ID string cannot be made active by this function.
5799 * If the #GtkComboBox:id-column property of @combo_box is unset or if no
5800 * row has the given ID then the function does nothing and returns %FALSE.
5802 * Returns: %TRUE if a row with a matching ID was found. If a %NULL
5803 * @active_id was given to unset the active row, the function
5804 * always returns %TRUE.
5809 gtk_combo_box_set_active_id (GtkComboBox *combo_box,
5810 const gchar *active_id)
5812 GtkTreeModel *model;
5814 gboolean match = FALSE;
5817 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), FALSE);
5819 if (active_id == NULL)
5821 gtk_combo_box_set_active (combo_box, -1);
5822 return TRUE; /* active row was successfully unset */
5825 column = combo_box->priv->id_column;
5830 model = gtk_combo_box_get_model (combo_box);
5831 g_return_val_if_fail (gtk_tree_model_get_column_type (model, column) ==
5832 G_TYPE_STRING, FALSE);
5834 if (gtk_tree_model_get_iter_first (model, &iter))
5838 gtk_tree_model_get (model, &iter, column, &id, -1);
5840 match = strcmp (id, active_id) == 0;
5845 gtk_combo_box_set_active_iter (combo_box, &iter);
5848 } while (gtk_tree_model_iter_next (model, &iter));