2 * gtkappchooserbutton.h: an app-chooser combobox
4 * Copyright (C) 2010 Red Hat, Inc.
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public License as
8 * published by the Free Software Foundation; either version 2 of the
9 * License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with the Gnome Library; see the file COPYING.LIB. If not,
18 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
21 * Authors: Cosimo Cecchi <ccecchi@redhat.com>
25 * SECTION:gtkappchooserbutton
26 * @Title: GtkAppChooserButton
27 * @Short_description: A button to launch an application chooser dialog
29 * The #GtkAppChooserButton is a widget that lets the user select
30 * an application. It implements the #GtkAppChooser interface.
34 #include "gtkappchooserbutton.h"
36 #include "gtkappchooser.h"
37 #include "gtkappchooserdialog.h"
38 #include "gtkappchooserprivate.h"
39 #include "gtkcelllayout.h"
40 #include "gtkcellrendererpixbuf.h"
41 #include "gtkcellrenderertext.h"
42 #include "gtkcombobox.h"
43 #include "gtkdialog.h"
45 #include "gtkmarshalers.h"
48 PROP_CONTENT_TYPE = 1,
49 PROP_SHOW_DIALOG_ITEM,
53 SIGNAL_CUSTOM_ITEM_ACTIVATED,
67 #define CUSTOM_ITEM_OTHER_APP "gtk-internal-item-other-app"
69 static void app_chooser_iface_init (GtkAppChooserIface *iface);
71 static void real_insert_custom_item (GtkAppChooserButton *self,
78 static void real_insert_separator (GtkAppChooserButton *self,
82 static guint signals[NUM_SIGNALS] = { 0, };
84 G_DEFINE_TYPE_WITH_CODE (GtkAppChooserButton, gtk_app_chooser_button, GTK_TYPE_COMBO_BOX,
85 G_IMPLEMENT_INTERFACE (GTK_TYPE_APP_CHOOSER,
86 app_chooser_iface_init));
88 struct _GtkAppChooserButtonPrivate {
92 gboolean show_dialog_item;
94 GHashTable *custom_item_names;
98 row_separator_func (GtkTreeModel *model,
104 gtk_tree_model_get (model, iter,
105 COLUMN_SEPARATOR, &separator,
112 get_first_iter (GtkListStore *store,
117 if (!gtk_tree_model_get_iter_first (GTK_TREE_MODEL (store), iter))
119 /* the model is empty, append */
120 gtk_list_store_append (store, iter);
124 gtk_list_store_insert_before (store, &iter2, iter);
130 GtkAppChooserButton *self;
136 select_app_data_free (SelectAppData *data)
138 g_clear_object (&data->self);
139 g_clear_object (&data->info);
141 g_slice_free (SelectAppData, data);
145 select_application_func_cb (GtkTreeModel *model,
150 SelectAppData *data = user_data;
151 GAppInfo *app_to_match = data->info, *app = NULL;
154 gtk_tree_model_get (model, iter,
155 COLUMN_APP_INFO, &app,
156 COLUMN_CUSTOM, &custom,
159 /* cutsom items are always after GAppInfos, so iterating further here
165 if (g_app_info_equal (app, app_to_match))
167 gtk_combo_box_set_active_iter (GTK_COMBO_BOX (data->self), iter);
175 gtk_app_chooser_button_select_application (GtkAppChooserButton *self,
180 data = g_slice_new0 (SelectAppData);
181 data->self = g_object_ref (self);
182 data->info = g_object_ref (info);
184 gtk_tree_model_foreach (GTK_TREE_MODEL (self->priv->store),
185 select_application_func_cb, data);
187 select_app_data_free (data);
191 other_application_dialog_response_cb (GtkDialog *dialog,
195 GtkAppChooserButton *self = user_data;
198 if (response_id != GTK_RESPONSE_OK)
200 /* reset the active item, otherwise we are stuck on
201 * 'Other application...'
203 gtk_combo_box_set_active (GTK_COMBO_BOX (self), 0);
204 gtk_widget_destroy (GTK_WIDGET (dialog));
208 info = gtk_app_chooser_get_app_info (GTK_APP_CHOOSER (dialog));
210 /* refresh the combobox to get the new application */
211 gtk_app_chooser_refresh (GTK_APP_CHOOSER (self));
212 gtk_app_chooser_button_select_application (self, info);
214 g_object_unref (info);
218 other_application_item_activated_cb (GtkAppChooserButton *self)
220 GtkWidget *dialog, *widget;
223 toplevel = GTK_WINDOW (gtk_widget_get_toplevel (GTK_WIDGET (self)));
224 dialog = gtk_app_chooser_dialog_new_for_content_type (toplevel, GTK_DIALOG_DESTROY_WITH_PARENT,
225 self->priv->content_type);
227 gtk_window_set_modal (GTK_WINDOW (dialog), gtk_window_get_modal (toplevel));
229 widget = gtk_app_chooser_dialog_get_widget (GTK_APP_CHOOSER_DIALOG (dialog));
230 g_object_set (widget,
231 "show-fallback", TRUE,
234 gtk_widget_show (dialog);
236 g_signal_connect (dialog, "response",
237 G_CALLBACK (other_application_dialog_response_cb), self);
241 gtk_app_chooser_button_ensure_dialog_item (GtkAppChooserButton *self,
242 GtkTreeIter *prev_iter)
244 GtkTreeIter iter, iter2;
246 if (!self->priv->show_dialog_item)
249 if (prev_iter == NULL)
250 gtk_list_store_append (self->priv->store, &iter);
252 gtk_list_store_insert_after (self->priv->store, &iter, prev_iter);
254 real_insert_separator (self, FALSE, &iter);
257 gtk_list_store_insert_after (self->priv->store, &iter, &iter2);
258 real_insert_custom_item (self, CUSTOM_ITEM_OTHER_APP,
259 _("Other application..."), NULL,
264 gtk_app_chooser_button_populate (GtkAppChooserButton *self)
266 GList *recommended_apps = NULL, *l;
268 GtkTreeIter iter, iter2;
270 gboolean cycled_recommended;
273 recommended_apps = g_app_info_get_recommended_for_type (self->priv->content_type);
275 cycled_recommended = FALSE;
277 for (l = recommended_apps; l != NULL; l = l->next)
281 icon = g_app_info_get_icon (app);
284 icon = g_themed_icon_new ("application-x-executable");
288 if (cycled_recommended)
290 gtk_list_store_insert_after (self->priv->store, &iter2, &iter);
295 get_first_iter (self->priv->store, &iter);
296 cycled_recommended = TRUE;
299 gtk_list_store_set (self->priv->store, &iter,
300 COLUMN_APP_INFO, app,
301 COLUMN_LABEL, g_app_info_get_display_name (app),
303 COLUMN_CUSTOM, FALSE,
306 g_object_unref (icon);
309 if (!cycled_recommended)
310 gtk_app_chooser_button_ensure_dialog_item (self, NULL);
312 gtk_app_chooser_button_ensure_dialog_item (self, &iter);
314 gtk_combo_box_set_active (GTK_COMBO_BOX (self), 0);
318 gtk_app_chooser_button_build_ui (GtkAppChooserButton *self)
320 GtkCellRenderer *cell;
323 self->priv->store = gtk_list_store_new (NUM_COLUMNS,
325 G_TYPE_STRING, /* name */
326 G_TYPE_STRING, /* label */
328 G_TYPE_BOOLEAN, /* separator */
329 G_TYPE_BOOLEAN); /* custom */
331 gtk_combo_box_set_model (GTK_COMBO_BOX (self),
332 GTK_TREE_MODEL (self->priv->store));
334 area = gtk_cell_layout_get_area (GTK_CELL_LAYOUT (self));
336 gtk_combo_box_set_row_separator_func (GTK_COMBO_BOX (self),
337 row_separator_func, NULL, NULL);
339 cell = gtk_cell_renderer_pixbuf_new ();
340 gtk_cell_area_add_with_properties (area, cell,
345 gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (self), cell,
346 "gicon", COLUMN_ICON,
349 cell = gtk_cell_renderer_text_new ();
350 gtk_cell_area_add_with_properties (area, cell,
354 gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (self), cell,
355 "text", COLUMN_LABEL,
358 gtk_app_chooser_button_populate (self);
362 gtk_app_chooser_button_remove_non_custom (GtkAppChooserButton *self)
366 gboolean custom, res;
368 model = GTK_TREE_MODEL (self->priv->store);
370 if (!gtk_tree_model_get_iter_first (model, &iter))
374 gtk_tree_model_get (model, &iter,
375 COLUMN_CUSTOM, &custom,
378 res = gtk_tree_model_iter_next (model, &iter);
380 res = gtk_list_store_remove (GTK_LIST_STORE (model), &iter);
385 gtk_app_chooser_button_changed (GtkComboBox *object)
387 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
393 if (!gtk_combo_box_get_active_iter (object, &iter))
396 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
398 COLUMN_CUSTOM, &custom,
405 name_quark = g_quark_from_string (name);
406 g_signal_emit (self, signals[SIGNAL_CUSTOM_ITEM_ACTIVATED], name_quark, name);
410 /* trigger the dialog internally */
411 other_application_item_activated_cb (self);
419 gtk_app_chooser_button_refresh (GtkAppChooser *object)
421 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
423 gtk_app_chooser_button_remove_non_custom (self);
424 gtk_app_chooser_button_populate (self);
428 gtk_app_chooser_button_get_app_info (GtkAppChooser *object)
430 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
434 if (!gtk_combo_box_get_active_iter (GTK_COMBO_BOX (self), &iter))
437 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
438 COLUMN_APP_INFO, &info,
445 gtk_app_chooser_button_constructed (GObject *obj)
447 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
449 if (G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->constructed != NULL)
450 G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->constructed (obj);
452 g_assert (self->priv->content_type != NULL);
454 gtk_app_chooser_button_build_ui (self);
458 gtk_app_chooser_button_set_property (GObject *obj,
463 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
467 case PROP_CONTENT_TYPE:
468 self->priv->content_type = g_value_dup_string (value);
470 case PROP_SHOW_DIALOG_ITEM:
471 gtk_app_chooser_button_set_show_dialog_item (self, g_value_get_boolean (value));
474 G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
480 gtk_app_chooser_button_get_property (GObject *obj,
485 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
489 case PROP_CONTENT_TYPE:
490 g_value_set_string (value, self->priv->content_type);
492 case PROP_SHOW_DIALOG_ITEM:
493 g_value_set_boolean (value, self->priv->show_dialog_item);
496 G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
502 gtk_app_chooser_button_finalize (GObject *obj)
504 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
506 g_hash_table_destroy (self->priv->custom_item_names);
507 g_free (self->priv->content_type);
509 G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->finalize (obj);
513 app_chooser_iface_init (GtkAppChooserIface *iface)
515 iface->get_app_info = gtk_app_chooser_button_get_app_info;
516 iface->refresh = gtk_app_chooser_button_refresh;
520 gtk_app_chooser_button_class_init (GtkAppChooserButtonClass *klass)
522 GObjectClass *oclass = G_OBJECT_CLASS (klass);
523 GtkComboBoxClass *combo_class = GTK_COMBO_BOX_CLASS (klass);
526 oclass->set_property = gtk_app_chooser_button_set_property;
527 oclass->get_property = gtk_app_chooser_button_get_property;
528 oclass->finalize = gtk_app_chooser_button_finalize;
529 oclass->constructed = gtk_app_chooser_button_constructed;
531 combo_class->changed = gtk_app_chooser_button_changed;
533 g_object_class_override_property (oclass, PROP_CONTENT_TYPE, "content-type");
536 * GtkAppChooserButton:show-dialog-item:
538 * The #GtkAppChooserButton:show-dialog-item property determines whether the dropdown menu
539 * should show an item that triggers a #GtkAppChooserDialog when clicked.
542 g_param_spec_boolean ("show-dialog-item",
543 P_("Include an 'Other...' item"),
544 P_("Whether the combobox should include an item that triggers a GtkAppChooserDialog"),
546 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
547 g_object_class_install_property (oclass, PROP_SHOW_DIALOG_ITEM, pspec);
550 * GtkAppChooserButton::custom-item-activated:
551 * @self: the object which received the signal
552 * @item_name: the name of the activated item
554 * Emitted when a custom item, previously added with
555 * gtk_app_chooser_button_append_custom_item(), is activated from the
558 signals[SIGNAL_CUSTOM_ITEM_ACTIVATED] =
559 g_signal_new ("custom-item-activated",
560 GTK_TYPE_APP_CHOOSER_BUTTON,
561 G_SIGNAL_RUN_FIRST | G_SIGNAL_DETAILED,
562 G_STRUCT_OFFSET (GtkAppChooserButtonClass, custom_item_activated),
564 _gtk_marshal_VOID__STRING,
568 g_type_class_add_private (klass, sizeof (GtkAppChooserButtonPrivate));
572 gtk_app_chooser_button_init (GtkAppChooserButton *self)
574 self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, GTK_TYPE_APP_CHOOSER_BUTTON,
575 GtkAppChooserButtonPrivate);
576 self->priv->custom_item_names =
577 g_hash_table_new_full (g_str_hash, g_str_equal,
582 app_chooser_button_iter_from_custom_name (GtkAppChooserButton *self,
587 gchar *custom_name = NULL;
589 if (!gtk_tree_model_get_iter_first
590 (GTK_TREE_MODEL (self->priv->store), &iter))
594 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
595 COLUMN_NAME, &custom_name,
598 if (g_strcmp0 (custom_name, name) == 0)
600 g_free (custom_name);
606 g_free (custom_name);
607 } while (gtk_tree_model_iter_next (GTK_TREE_MODEL (self->priv->store), &iter));
613 real_insert_custom_item (GtkAppChooserButton *self,
622 if (g_hash_table_lookup (self->priv->custom_item_names,
625 g_warning ("Attempting to add custom item %s to GtkAppChooserButton, "
626 "when there's already an item with the same name", name);
630 g_hash_table_insert (self->priv->custom_item_names,
631 g_strdup (name), GINT_TO_POINTER (1));
634 gtk_list_store_set (self->priv->store, iter,
638 COLUMN_CUSTOM, custom,
639 COLUMN_SEPARATOR, FALSE,
644 real_insert_separator (GtkAppChooserButton *self,
648 gtk_list_store_set (self->priv->store, iter,
649 COLUMN_CUSTOM, custom,
650 COLUMN_SEPARATOR, TRUE,
655 * gtk_app_chooser_button_new:
656 * @content_type: the content type to show applications for
658 * Creates a new #GtkAppChooserButton for applications
659 * that can handle content of the given type.
661 * Returns: a newly created #GtkAppChooserButton
666 gtk_app_chooser_button_new (const gchar *content_type)
668 g_return_val_if_fail (content_type != NULL, NULL);
670 return g_object_new (GTK_TYPE_APP_CHOOSER_BUTTON,
671 "content-type", content_type,
676 * gtk_app_chooser_button_append_separator:
677 * @self: a #GtkAppChooserButton
679 * Appends a separator to the list of applications that is shown
685 gtk_app_chooser_button_append_separator (GtkAppChooserButton *self)
689 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
691 gtk_list_store_append (self->priv->store, &iter);
692 real_insert_separator (self, TRUE, &iter);
696 * gtk_app_chooser_button_append_custom_item:
697 * @self: a #GtkAppChooserButton
698 * @name: the name of the custom item
699 * @label: the label for the custom item
700 * @icon: the icon for the custom item
702 * Appends a custom item to the list of applications that is shown
703 * in the popup; the item name must be unique per-widget.
704 * Clients can use the provided name as a detail for the ::custom-item-activated
705 * signal, to add a callback for the activation of a particular
706 * custom item in the list.
707 * See also gtk_app_chooser_button_append_separator().
712 gtk_app_chooser_button_append_custom_item (GtkAppChooserButton *self,
719 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
720 g_return_if_fail (name != NULL);
722 gtk_list_store_append (self->priv->store, &iter);
723 real_insert_custom_item (self, name, label, icon, TRUE, &iter);
727 * gtk_app_chooser_button_select_custom_item:
728 * @self: a #GtkAppChooserButton
729 * @name: the name of the custom item
731 * Selects a custom item previously added with
732 * gtk_app_chooser_button_append_custom_item().
733 * Use gtk_app_chooser_refresh() to bring the selection to its initial
739 gtk_app_chooser_button_set_active_custom_item (GtkAppChooserButton *self,
744 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
745 g_return_if_fail (name != NULL);
747 if (g_hash_table_lookup (self->priv->custom_item_names, name) == NULL ||
748 !app_chooser_button_iter_from_custom_name (self, name, &iter))
750 g_warning ("Can't find the item named %s in the app chooser.",
755 gtk_combo_box_set_active_iter (GTK_COMBO_BOX (self), &iter);
759 * gtk_app_chooser_button_get_show_dialog_item:
760 * @self: a #GtkAppChooserButton
762 * Returns the current value of the #GtkAppChooserButton:show-dialog-item
765 * Returns: the value of #GtkAppChooserButton:show-dialog-item
770 gtk_app_chooser_button_get_show_dialog_item (GtkAppChooserButton *self)
772 g_return_val_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self), FALSE);
774 return self->priv->show_dialog_item;
778 * gtk_app_chooser_button_set_show_dialog_item:
779 * @self: a #GtkAppChooserButton
780 * @setting: the new value for #GtkAppChooserButton:show-dialog-item
782 * Sets whether the dropdown menu of this button should show an
783 * entry to trigger a #GtkAppChooserDialog.
788 gtk_app_chooser_button_set_show_dialog_item (GtkAppChooserButton *self,
791 if (self->priv->show_dialog_item != setting)
793 self->priv->show_dialog_item = setting;
795 g_object_notify (G_OBJECT (self), "show-dialog-item");
797 gtk_app_chooser_refresh (GTK_APP_CHOOSER (self));