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 {
93 gboolean show_dialog_item;
95 GHashTable *custom_item_names;
99 row_separator_func (GtkTreeModel *model,
105 gtk_tree_model_get (model, iter,
106 COLUMN_SEPARATOR, &separator,
113 get_first_iter (GtkListStore *store,
118 if (!gtk_tree_model_get_iter_first (GTK_TREE_MODEL (store), iter))
120 /* the model is empty, append */
121 gtk_list_store_append (store, iter);
125 gtk_list_store_insert_before (store, &iter2, iter);
131 GtkAppChooserButton *self;
137 select_app_data_free (SelectAppData *data)
139 g_clear_object (&data->self);
140 g_clear_object (&data->info);
142 g_slice_free (SelectAppData, data);
146 select_application_func_cb (GtkTreeModel *model,
151 SelectAppData *data = user_data;
152 GAppInfo *app_to_match = data->info, *app = NULL;
155 gtk_tree_model_get (model, iter,
156 COLUMN_APP_INFO, &app,
157 COLUMN_CUSTOM, &custom,
160 /* cutsom items are always after GAppInfos, so iterating further here
166 if (g_app_info_equal (app, app_to_match))
168 gtk_combo_box_set_active_iter (GTK_COMBO_BOX (data->self), iter);
176 gtk_app_chooser_button_select_application (GtkAppChooserButton *self,
181 data = g_slice_new0 (SelectAppData);
182 data->self = g_object_ref (self);
183 data->info = g_object_ref (info);
185 gtk_tree_model_foreach (GTK_TREE_MODEL (self->priv->store),
186 select_application_func_cb, data);
188 select_app_data_free (data);
192 other_application_dialog_response_cb (GtkDialog *dialog,
196 GtkAppChooserButton *self = user_data;
199 if (response_id != GTK_RESPONSE_OK)
201 /* reset the active item, otherwise we are stuck on
202 * 'Other application...'
204 gtk_combo_box_set_active (GTK_COMBO_BOX (self), self->priv->last_active);
205 gtk_widget_destroy (GTK_WIDGET (dialog));
209 info = gtk_app_chooser_get_app_info (GTK_APP_CHOOSER (dialog));
211 /* refresh the combobox to get the new application */
212 gtk_app_chooser_refresh (GTK_APP_CHOOSER (self));
213 gtk_app_chooser_button_select_application (self, info);
215 g_object_unref (info);
219 other_application_item_activated_cb (GtkAppChooserButton *self)
221 GtkWidget *dialog, *widget;
224 toplevel = GTK_WINDOW (gtk_widget_get_toplevel (GTK_WIDGET (self)));
225 dialog = gtk_app_chooser_dialog_new_for_content_type (toplevel, GTK_DIALOG_DESTROY_WITH_PARENT,
226 self->priv->content_type);
228 gtk_window_set_modal (GTK_WINDOW (dialog), gtk_window_get_modal (toplevel));
230 widget = gtk_app_chooser_dialog_get_widget (GTK_APP_CHOOSER_DIALOG (dialog));
231 g_object_set (widget,
232 "show-fallback", TRUE,
235 gtk_widget_show (dialog);
237 g_signal_connect (dialog, "response",
238 G_CALLBACK (other_application_dialog_response_cb), self);
242 gtk_app_chooser_button_ensure_dialog_item (GtkAppChooserButton *self,
243 GtkTreeIter *prev_iter)
245 GtkTreeIter iter, iter2;
247 if (!self->priv->show_dialog_item)
250 if (prev_iter == NULL)
251 gtk_list_store_append (self->priv->store, &iter);
253 gtk_list_store_insert_after (self->priv->store, &iter, prev_iter);
255 real_insert_separator (self, FALSE, &iter);
258 gtk_list_store_insert_after (self->priv->store, &iter, &iter2);
259 real_insert_custom_item (self, CUSTOM_ITEM_OTHER_APP,
260 _("Other application..."), NULL,
265 gtk_app_chooser_button_populate (GtkAppChooserButton *self)
267 GList *recommended_apps = NULL, *l;
269 GtkTreeIter iter, iter2;
271 gboolean cycled_recommended;
274 recommended_apps = g_app_info_get_recommended_for_type (self->priv->content_type);
276 cycled_recommended = FALSE;
278 for (l = recommended_apps; l != NULL; l = l->next)
282 icon = g_app_info_get_icon (app);
285 icon = g_themed_icon_new ("application-x-executable");
289 if (cycled_recommended)
291 gtk_list_store_insert_after (self->priv->store, &iter2, &iter);
296 get_first_iter (self->priv->store, &iter);
297 cycled_recommended = TRUE;
300 gtk_list_store_set (self->priv->store, &iter,
301 COLUMN_APP_INFO, app,
302 COLUMN_LABEL, g_app_info_get_display_name (app),
304 COLUMN_CUSTOM, FALSE,
307 g_object_unref (icon);
310 if (!cycled_recommended)
311 gtk_app_chooser_button_ensure_dialog_item (self, NULL);
313 gtk_app_chooser_button_ensure_dialog_item (self, &iter);
315 gtk_combo_box_set_active (GTK_COMBO_BOX (self), 0);
319 gtk_app_chooser_button_build_ui (GtkAppChooserButton *self)
321 GtkCellRenderer *cell;
324 self->priv->store = gtk_list_store_new (NUM_COLUMNS,
326 G_TYPE_STRING, /* name */
327 G_TYPE_STRING, /* label */
329 G_TYPE_BOOLEAN, /* separator */
330 G_TYPE_BOOLEAN); /* custom */
332 gtk_combo_box_set_model (GTK_COMBO_BOX (self),
333 GTK_TREE_MODEL (self->priv->store));
335 area = gtk_cell_layout_get_area (GTK_CELL_LAYOUT (self));
337 gtk_combo_box_set_row_separator_func (GTK_COMBO_BOX (self),
338 row_separator_func, NULL, NULL);
340 cell = gtk_cell_renderer_pixbuf_new ();
341 gtk_cell_area_add_with_properties (area, cell,
346 gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (self), cell,
347 "gicon", COLUMN_ICON,
350 cell = gtk_cell_renderer_text_new ();
351 gtk_cell_area_add_with_properties (area, cell,
355 gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (self), cell,
356 "text", COLUMN_LABEL,
359 gtk_app_chooser_button_populate (self);
363 gtk_app_chooser_button_remove_non_custom (GtkAppChooserButton *self)
367 gboolean custom, res;
369 model = GTK_TREE_MODEL (self->priv->store);
371 if (!gtk_tree_model_get_iter_first (model, &iter))
375 gtk_tree_model_get (model, &iter,
376 COLUMN_CUSTOM, &custom,
379 res = gtk_tree_model_iter_next (model, &iter);
381 res = gtk_list_store_remove (GTK_LIST_STORE (model), &iter);
386 gtk_app_chooser_button_changed (GtkComboBox *object)
388 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
394 if (!gtk_combo_box_get_active_iter (object, &iter))
397 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
399 COLUMN_CUSTOM, &custom,
406 name_quark = g_quark_from_string (name);
407 g_signal_emit (self, signals[SIGNAL_CUSTOM_ITEM_ACTIVATED], name_quark, name);
408 self->priv->last_active = gtk_combo_box_get_active (object);
412 /* trigger the dialog internally */
413 other_application_item_activated_cb (self);
419 self->priv->last_active = gtk_combo_box_get_active (object);
423 gtk_app_chooser_button_refresh (GtkAppChooser *object)
425 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
427 gtk_app_chooser_button_remove_non_custom (self);
428 gtk_app_chooser_button_populate (self);
432 gtk_app_chooser_button_get_app_info (GtkAppChooser *object)
434 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
438 if (!gtk_combo_box_get_active_iter (GTK_COMBO_BOX (self), &iter))
441 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
442 COLUMN_APP_INFO, &info,
449 gtk_app_chooser_button_constructed (GObject *obj)
451 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
453 if (G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->constructed != NULL)
454 G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->constructed (obj);
456 g_assert (self->priv->content_type != NULL);
458 gtk_app_chooser_button_build_ui (self);
462 gtk_app_chooser_button_set_property (GObject *obj,
467 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
471 case PROP_CONTENT_TYPE:
472 self->priv->content_type = g_value_dup_string (value);
474 case PROP_SHOW_DIALOG_ITEM:
475 gtk_app_chooser_button_set_show_dialog_item (self, g_value_get_boolean (value));
478 G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
484 gtk_app_chooser_button_get_property (GObject *obj,
489 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
493 case PROP_CONTENT_TYPE:
494 g_value_set_string (value, self->priv->content_type);
496 case PROP_SHOW_DIALOG_ITEM:
497 g_value_set_boolean (value, self->priv->show_dialog_item);
500 G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
506 gtk_app_chooser_button_finalize (GObject *obj)
508 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
510 g_hash_table_destroy (self->priv->custom_item_names);
511 g_free (self->priv->content_type);
513 G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->finalize (obj);
517 app_chooser_iface_init (GtkAppChooserIface *iface)
519 iface->get_app_info = gtk_app_chooser_button_get_app_info;
520 iface->refresh = gtk_app_chooser_button_refresh;
524 gtk_app_chooser_button_class_init (GtkAppChooserButtonClass *klass)
526 GObjectClass *oclass = G_OBJECT_CLASS (klass);
527 GtkComboBoxClass *combo_class = GTK_COMBO_BOX_CLASS (klass);
530 oclass->set_property = gtk_app_chooser_button_set_property;
531 oclass->get_property = gtk_app_chooser_button_get_property;
532 oclass->finalize = gtk_app_chooser_button_finalize;
533 oclass->constructed = gtk_app_chooser_button_constructed;
535 combo_class->changed = gtk_app_chooser_button_changed;
537 g_object_class_override_property (oclass, PROP_CONTENT_TYPE, "content-type");
540 * GtkAppChooserButton:show-dialog-item:
542 * The #GtkAppChooserButton:show-dialog-item property determines whether the dropdown menu
543 * should show an item that triggers a #GtkAppChooserDialog when clicked.
546 g_param_spec_boolean ("show-dialog-item",
547 P_("Include an 'Other...' item"),
548 P_("Whether the combobox should include an item that triggers a GtkAppChooserDialog"),
550 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
551 g_object_class_install_property (oclass, PROP_SHOW_DIALOG_ITEM, pspec);
554 * GtkAppChooserButton::custom-item-activated:
555 * @self: the object which received the signal
556 * @item_name: the name of the activated item
558 * Emitted when a custom item, previously added with
559 * gtk_app_chooser_button_append_custom_item(), is activated from the
562 signals[SIGNAL_CUSTOM_ITEM_ACTIVATED] =
563 g_signal_new ("custom-item-activated",
564 GTK_TYPE_APP_CHOOSER_BUTTON,
565 G_SIGNAL_RUN_FIRST | G_SIGNAL_DETAILED,
566 G_STRUCT_OFFSET (GtkAppChooserButtonClass, custom_item_activated),
568 _gtk_marshal_VOID__STRING,
572 g_type_class_add_private (klass, sizeof (GtkAppChooserButtonPrivate));
576 gtk_app_chooser_button_init (GtkAppChooserButton *self)
578 self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, GTK_TYPE_APP_CHOOSER_BUTTON,
579 GtkAppChooserButtonPrivate);
580 self->priv->custom_item_names =
581 g_hash_table_new_full (g_str_hash, g_str_equal,
586 app_chooser_button_iter_from_custom_name (GtkAppChooserButton *self,
591 gchar *custom_name = NULL;
593 if (!gtk_tree_model_get_iter_first
594 (GTK_TREE_MODEL (self->priv->store), &iter))
598 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
599 COLUMN_NAME, &custom_name,
602 if (g_strcmp0 (custom_name, name) == 0)
604 g_free (custom_name);
610 g_free (custom_name);
611 } while (gtk_tree_model_iter_next (GTK_TREE_MODEL (self->priv->store), &iter));
617 real_insert_custom_item (GtkAppChooserButton *self,
626 if (g_hash_table_lookup (self->priv->custom_item_names,
629 g_warning ("Attempting to add custom item %s to GtkAppChooserButton, "
630 "when there's already an item with the same name", name);
634 g_hash_table_insert (self->priv->custom_item_names,
635 g_strdup (name), GINT_TO_POINTER (1));
638 gtk_list_store_set (self->priv->store, iter,
642 COLUMN_CUSTOM, custom,
643 COLUMN_SEPARATOR, FALSE,
648 real_insert_separator (GtkAppChooserButton *self,
652 gtk_list_store_set (self->priv->store, iter,
653 COLUMN_CUSTOM, custom,
654 COLUMN_SEPARATOR, TRUE,
659 * gtk_app_chooser_button_new:
660 * @content_type: the content type to show applications for
662 * Creates a new #GtkAppChooserButton for applications
663 * that can handle content of the given type.
665 * Returns: a newly created #GtkAppChooserButton
670 gtk_app_chooser_button_new (const gchar *content_type)
672 g_return_val_if_fail (content_type != NULL, NULL);
674 return g_object_new (GTK_TYPE_APP_CHOOSER_BUTTON,
675 "content-type", content_type,
680 * gtk_app_chooser_button_append_separator:
681 * @self: a #GtkAppChooserButton
683 * Appends a separator to the list of applications that is shown
689 gtk_app_chooser_button_append_separator (GtkAppChooserButton *self)
693 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
695 gtk_list_store_append (self->priv->store, &iter);
696 real_insert_separator (self, TRUE, &iter);
700 * gtk_app_chooser_button_append_custom_item:
701 * @self: a #GtkAppChooserButton
702 * @name: the name of the custom item
703 * @label: the label for the custom item
704 * @icon: the icon for the custom item
706 * Appends a custom item to the list of applications that is shown
707 * in the popup; the item name must be unique per-widget.
708 * Clients can use the provided name as a detail for the ::custom-item-activated
709 * signal, to add a callback for the activation of a particular
710 * custom item in the list.
711 * See also gtk_app_chooser_button_append_separator().
716 gtk_app_chooser_button_append_custom_item (GtkAppChooserButton *self,
723 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
724 g_return_if_fail (name != NULL);
726 gtk_list_store_append (self->priv->store, &iter);
727 real_insert_custom_item (self, name, label, icon, TRUE, &iter);
731 * gtk_app_chooser_button_select_custom_item:
732 * @self: a #GtkAppChooserButton
733 * @name: the name of the custom item
735 * Selects a custom item previously added with
736 * gtk_app_chooser_button_append_custom_item().
737 * Use gtk_app_chooser_refresh() to bring the selection to its initial
743 gtk_app_chooser_button_set_active_custom_item (GtkAppChooserButton *self,
748 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
749 g_return_if_fail (name != NULL);
751 if (g_hash_table_lookup (self->priv->custom_item_names, name) == NULL ||
752 !app_chooser_button_iter_from_custom_name (self, name, &iter))
754 g_warning ("Can't find the item named %s in the app chooser.",
759 gtk_combo_box_set_active_iter (GTK_COMBO_BOX (self), &iter);
763 * gtk_app_chooser_button_get_show_dialog_item:
764 * @self: a #GtkAppChooserButton
766 * Returns the current value of the #GtkAppChooserButton:show-dialog-item
769 * Returns: the value of #GtkAppChooserButton:show-dialog-item
774 gtk_app_chooser_button_get_show_dialog_item (GtkAppChooserButton *self)
776 g_return_val_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self), FALSE);
778 return self->priv->show_dialog_item;
782 * gtk_app_chooser_button_set_show_dialog_item:
783 * @self: a #GtkAppChooserButton
784 * @setting: the new value for #GtkAppChooserButton:show-dialog-item
786 * Sets whether the dropdown menu of this button should show an
787 * entry to trigger a #GtkAppChooserDialog.
792 gtk_app_chooser_button_set_show_dialog_item (GtkAppChooserButton *self,
795 if (self->priv->show_dialog_item != setting)
797 self->priv->show_dialog_item = setting;
799 g_object_notify (G_OBJECT (self), "show-dialog-item");
801 gtk_app_chooser_refresh (GTK_APP_CHOOSER (self));