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,
54 SIGNAL_CUSTOM_ITEM_ACTIVATED,
68 #define CUSTOM_ITEM_OTHER_APP "gtk-internal-item-other-app"
70 static void app_chooser_iface_init (GtkAppChooserIface *iface);
72 static void real_insert_custom_item (GtkAppChooserButton *self,
79 static void real_insert_separator (GtkAppChooserButton *self,
83 static guint signals[NUM_SIGNALS] = { 0, };
85 G_DEFINE_TYPE_WITH_CODE (GtkAppChooserButton, gtk_app_chooser_button, GTK_TYPE_COMBO_BOX,
86 G_IMPLEMENT_INTERFACE (GTK_TYPE_APP_CHOOSER,
87 app_chooser_iface_init));
89 struct _GtkAppChooserButtonPrivate {
95 gboolean show_dialog_item;
97 GHashTable *custom_item_names;
101 row_separator_func (GtkTreeModel *model,
107 gtk_tree_model_get (model, iter,
108 COLUMN_SEPARATOR, &separator,
115 get_first_iter (GtkListStore *store,
120 if (!gtk_tree_model_get_iter_first (GTK_TREE_MODEL (store), iter))
122 /* the model is empty, append */
123 gtk_list_store_append (store, iter);
127 gtk_list_store_insert_before (store, &iter2, iter);
133 GtkAppChooserButton *self;
139 select_app_data_free (SelectAppData *data)
141 g_clear_object (&data->self);
142 g_clear_object (&data->info);
144 g_slice_free (SelectAppData, data);
148 select_application_func_cb (GtkTreeModel *model,
153 SelectAppData *data = user_data;
154 GAppInfo *app_to_match = data->info, *app = NULL;
158 gtk_tree_model_get (model, iter,
159 COLUMN_APP_INFO, &app,
160 COLUMN_CUSTOM, &custom,
163 /* custom items are always after GAppInfos, so iterating further here
168 else if (g_app_info_equal (app, app_to_match))
170 gtk_combo_box_set_active_iter (GTK_COMBO_BOX (data->self), iter);
176 g_object_unref (app);
182 gtk_app_chooser_button_select_application (GtkAppChooserButton *self,
187 data = g_slice_new0 (SelectAppData);
188 data->self = g_object_ref (self);
189 data->info = g_object_ref (info);
191 gtk_tree_model_foreach (GTK_TREE_MODEL (self->priv->store),
192 select_application_func_cb, data);
194 select_app_data_free (data);
198 other_application_dialog_response_cb (GtkDialog *dialog,
202 GtkAppChooserButton *self = user_data;
205 if (response_id != GTK_RESPONSE_OK)
207 /* reset the active item, otherwise we are stuck on
208 * 'Other application...'
210 gtk_combo_box_set_active (GTK_COMBO_BOX (self), self->priv->last_active);
211 gtk_widget_destroy (GTK_WIDGET (dialog));
215 info = gtk_app_chooser_get_app_info (GTK_APP_CHOOSER (dialog));
217 /* refresh the combobox to get the new application */
218 gtk_app_chooser_refresh (GTK_APP_CHOOSER (self));
219 gtk_app_chooser_button_select_application (self, info);
221 g_object_unref (info);
225 other_application_item_activated_cb (GtkAppChooserButton *self)
227 GtkWidget *dialog, *widget;
230 toplevel = GTK_WINDOW (gtk_widget_get_toplevel (GTK_WIDGET (self)));
231 dialog = gtk_app_chooser_dialog_new_for_content_type (toplevel, GTK_DIALOG_DESTROY_WITH_PARENT,
232 self->priv->content_type);
234 gtk_window_set_modal (GTK_WINDOW (dialog), gtk_window_get_modal (toplevel));
235 gtk_app_chooser_dialog_set_heading (GTK_APP_CHOOSER_DIALOG (dialog),
236 self->priv->heading);
238 widget = gtk_app_chooser_dialog_get_widget (GTK_APP_CHOOSER_DIALOG (dialog));
239 g_object_set (widget,
240 "show-fallback", TRUE,
243 gtk_widget_show (dialog);
245 g_signal_connect (dialog, "response",
246 G_CALLBACK (other_application_dialog_response_cb), self);
250 gtk_app_chooser_button_ensure_dialog_item (GtkAppChooserButton *self,
251 GtkTreeIter *prev_iter)
253 GtkTreeIter iter, iter2;
255 if (!self->priv->show_dialog_item || !self->priv->content_type)
258 if (prev_iter == NULL)
259 gtk_list_store_append (self->priv->store, &iter);
261 gtk_list_store_insert_after (self->priv->store, &iter, prev_iter);
263 real_insert_separator (self, FALSE, &iter);
266 gtk_list_store_insert_after (self->priv->store, &iter, &iter2);
267 real_insert_custom_item (self, CUSTOM_ITEM_OTHER_APP,
268 _("Other application..."), NULL,
273 gtk_app_chooser_button_populate (GtkAppChooserButton *self)
275 GList *recommended_apps = NULL, *l;
277 GtkTreeIter iter, iter2;
279 gboolean cycled_recommended;
282 if (self->priv->content_type)
283 recommended_apps = g_app_info_get_recommended_for_type (self->priv->content_type);
285 cycled_recommended = FALSE;
287 for (l = recommended_apps; l != NULL; l = l->next)
291 icon = g_app_info_get_icon (app);
294 icon = g_themed_icon_new ("application-x-executable");
298 if (cycled_recommended)
300 gtk_list_store_insert_after (self->priv->store, &iter2, &iter);
305 get_first_iter (self->priv->store, &iter);
306 cycled_recommended = TRUE;
309 gtk_list_store_set (self->priv->store, &iter,
310 COLUMN_APP_INFO, app,
311 COLUMN_LABEL, g_app_info_get_name (app),
313 COLUMN_CUSTOM, FALSE,
316 g_object_unref (icon);
319 if (!cycled_recommended)
320 gtk_app_chooser_button_ensure_dialog_item (self, NULL);
322 gtk_app_chooser_button_ensure_dialog_item (self, &iter);
324 gtk_combo_box_set_active (GTK_COMBO_BOX (self), 0);
328 gtk_app_chooser_button_build_ui (GtkAppChooserButton *self)
330 GtkCellRenderer *cell;
333 gtk_combo_box_set_model (GTK_COMBO_BOX (self),
334 GTK_TREE_MODEL (self->priv->store));
336 area = gtk_cell_layout_get_area (GTK_CELL_LAYOUT (self));
338 gtk_combo_box_set_row_separator_func (GTK_COMBO_BOX (self),
339 row_separator_func, NULL, NULL);
341 cell = gtk_cell_renderer_pixbuf_new ();
342 gtk_cell_area_add_with_properties (area, cell,
347 gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (self), cell,
348 "gicon", COLUMN_ICON,
351 cell = gtk_cell_renderer_text_new ();
352 gtk_cell_area_add_with_properties (area, cell,
356 gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (self), cell,
357 "text", COLUMN_LABEL,
360 gtk_app_chooser_button_populate (self);
364 gtk_app_chooser_button_remove_non_custom (GtkAppChooserButton *self)
368 gboolean custom, res;
370 model = GTK_TREE_MODEL (self->priv->store);
372 if (!gtk_tree_model_get_iter_first (model, &iter))
376 gtk_tree_model_get (model, &iter,
377 COLUMN_CUSTOM, &custom,
380 res = gtk_tree_model_iter_next (model, &iter);
382 res = gtk_list_store_remove (GTK_LIST_STORE (model), &iter);
387 gtk_app_chooser_button_changed (GtkComboBox *object)
389 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
395 if (!gtk_combo_box_get_active_iter (object, &iter))
398 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
400 COLUMN_CUSTOM, &custom,
407 name_quark = g_quark_from_string (name);
408 g_signal_emit (self, signals[SIGNAL_CUSTOM_ITEM_ACTIVATED], name_quark, name);
409 self->priv->last_active = gtk_combo_box_get_active (object);
413 /* trigger the dialog internally */
414 other_application_item_activated_cb (self);
420 self->priv->last_active = gtk_combo_box_get_active (object);
424 gtk_app_chooser_button_refresh (GtkAppChooser *object)
426 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
428 gtk_app_chooser_button_remove_non_custom (self);
429 gtk_app_chooser_button_populate (self);
433 gtk_app_chooser_button_get_app_info (GtkAppChooser *object)
435 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
439 if (!gtk_combo_box_get_active_iter (GTK_COMBO_BOX (self), &iter))
442 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
443 COLUMN_APP_INFO, &info,
450 gtk_app_chooser_button_constructed (GObject *obj)
452 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
454 if (G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->constructed != NULL)
455 G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->constructed (obj);
457 gtk_app_chooser_button_build_ui (self);
461 gtk_app_chooser_button_set_property (GObject *obj,
466 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
470 case PROP_CONTENT_TYPE:
471 self->priv->content_type = g_value_dup_string (value);
473 case PROP_SHOW_DIALOG_ITEM:
474 gtk_app_chooser_button_set_show_dialog_item (self, g_value_get_boolean (value));
477 gtk_app_chooser_button_set_heading (self, g_value_get_string (value));
480 G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
486 gtk_app_chooser_button_get_property (GObject *obj,
491 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
495 case PROP_CONTENT_TYPE:
496 g_value_set_string (value, self->priv->content_type);
498 case PROP_SHOW_DIALOG_ITEM:
499 g_value_set_boolean (value, self->priv->show_dialog_item);
502 g_value_set_string (value, self->priv->heading);
505 G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
511 gtk_app_chooser_button_finalize (GObject *obj)
513 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
515 g_hash_table_destroy (self->priv->custom_item_names);
516 g_free (self->priv->content_type);
517 g_free (self->priv->heading);
519 g_object_unref (self->priv->store);
521 G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->finalize (obj);
525 app_chooser_iface_init (GtkAppChooserIface *iface)
527 iface->get_app_info = gtk_app_chooser_button_get_app_info;
528 iface->refresh = gtk_app_chooser_button_refresh;
532 gtk_app_chooser_button_class_init (GtkAppChooserButtonClass *klass)
534 GObjectClass *oclass = G_OBJECT_CLASS (klass);
535 GtkComboBoxClass *combo_class = GTK_COMBO_BOX_CLASS (klass);
538 oclass->set_property = gtk_app_chooser_button_set_property;
539 oclass->get_property = gtk_app_chooser_button_get_property;
540 oclass->finalize = gtk_app_chooser_button_finalize;
541 oclass->constructed = gtk_app_chooser_button_constructed;
543 combo_class->changed = gtk_app_chooser_button_changed;
545 g_object_class_override_property (oclass, PROP_CONTENT_TYPE, "content-type");
548 * GtkAppChooserButton:show-dialog-item:
550 * The #GtkAppChooserButton:show-dialog-item property determines whether the dropdown menu
551 * should show an item that triggers a #GtkAppChooserDialog when clicked.
554 g_param_spec_boolean ("show-dialog-item",
555 P_("Include an 'Other...' item"),
556 P_("Whether the combobox should include an item that triggers a GtkAppChooserDialog"),
558 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
559 g_object_class_install_property (oclass, PROP_SHOW_DIALOG_ITEM, pspec);
562 * GtkAppChooserButton:heading:
564 * The text to show at the top of the dialog that can be
565 * opened from the button. The string may contain Pango markup.
567 pspec = g_param_spec_string ("heading",
569 P_("The text to show at the top of the dialog"),
571 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
572 g_object_class_install_property (oclass, PROP_HEADING, pspec);
576 * GtkAppChooserButton::custom-item-activated:
577 * @self: the object which received the signal
578 * @item_name: the name of the activated item
580 * Emitted when a custom item, previously added with
581 * gtk_app_chooser_button_append_custom_item(), is activated from the
584 signals[SIGNAL_CUSTOM_ITEM_ACTIVATED] =
585 g_signal_new ("custom-item-activated",
586 GTK_TYPE_APP_CHOOSER_BUTTON,
587 G_SIGNAL_RUN_FIRST | G_SIGNAL_DETAILED,
588 G_STRUCT_OFFSET (GtkAppChooserButtonClass, custom_item_activated),
590 _gtk_marshal_VOID__STRING,
594 g_type_class_add_private (klass, sizeof (GtkAppChooserButtonPrivate));
598 gtk_app_chooser_button_init (GtkAppChooserButton *self)
600 self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, GTK_TYPE_APP_CHOOSER_BUTTON,
601 GtkAppChooserButtonPrivate);
602 self->priv->custom_item_names =
603 g_hash_table_new_full (g_str_hash, g_str_equal,
606 self->priv->store = gtk_list_store_new (NUM_COLUMNS,
608 G_TYPE_STRING, /* name */
609 G_TYPE_STRING, /* label */
611 G_TYPE_BOOLEAN, /* separator */
612 G_TYPE_BOOLEAN); /* custom */
616 app_chooser_button_iter_from_custom_name (GtkAppChooserButton *self,
621 gchar *custom_name = NULL;
623 if (!gtk_tree_model_get_iter_first
624 (GTK_TREE_MODEL (self->priv->store), &iter))
628 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
629 COLUMN_NAME, &custom_name,
632 if (g_strcmp0 (custom_name, name) == 0)
634 g_free (custom_name);
640 g_free (custom_name);
641 } while (gtk_tree_model_iter_next (GTK_TREE_MODEL (self->priv->store), &iter));
647 real_insert_custom_item (GtkAppChooserButton *self,
656 if (g_hash_table_lookup (self->priv->custom_item_names,
659 g_warning ("Attempting to add custom item %s to GtkAppChooserButton, "
660 "when there's already an item with the same name", name);
664 g_hash_table_insert (self->priv->custom_item_names,
665 g_strdup (name), GINT_TO_POINTER (1));
668 gtk_list_store_set (self->priv->store, iter,
672 COLUMN_CUSTOM, custom,
673 COLUMN_SEPARATOR, FALSE,
678 real_insert_separator (GtkAppChooserButton *self,
682 gtk_list_store_set (self->priv->store, iter,
683 COLUMN_CUSTOM, custom,
684 COLUMN_SEPARATOR, TRUE,
689 * gtk_app_chooser_button_new:
690 * @content_type: the content type to show applications for
692 * Creates a new #GtkAppChooserButton for applications
693 * that can handle content of the given type.
695 * Returns: a newly created #GtkAppChooserButton
700 gtk_app_chooser_button_new (const gchar *content_type)
702 g_return_val_if_fail (content_type != NULL, NULL);
704 return g_object_new (GTK_TYPE_APP_CHOOSER_BUTTON,
705 "content-type", content_type,
710 * gtk_app_chooser_button_append_separator:
711 * @self: a #GtkAppChooserButton
713 * Appends a separator to the list of applications that is shown
719 gtk_app_chooser_button_append_separator (GtkAppChooserButton *self)
723 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
725 gtk_list_store_append (self->priv->store, &iter);
726 real_insert_separator (self, TRUE, &iter);
730 * gtk_app_chooser_button_append_custom_item:
731 * @self: a #GtkAppChooserButton
732 * @name: the name of the custom item
733 * @label: the label for the custom item
734 * @icon: the icon for the custom item
736 * Appends a custom item to the list of applications that is shown
737 * in the popup; the item name must be unique per-widget.
738 * Clients can use the provided name as a detail for the ::custom-item-activated
739 * signal, to add a callback for the activation of a particular
740 * custom item in the list.
741 * See also gtk_app_chooser_button_append_separator().
746 gtk_app_chooser_button_append_custom_item (GtkAppChooserButton *self,
753 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
754 g_return_if_fail (name != NULL);
756 gtk_list_store_append (self->priv->store, &iter);
757 real_insert_custom_item (self, name, label, icon, TRUE, &iter);
761 * gtk_app_chooser_button_set_active_custom_item:
762 * @self: a #GtkAppChooserButton
763 * @name: the name of the custom item
765 * Selects a custom item previously added with
766 * gtk_app_chooser_button_append_custom_item().
768 * Use gtk_app_chooser_refresh() to bring the selection
769 * to its initial state.
774 gtk_app_chooser_button_set_active_custom_item (GtkAppChooserButton *self,
779 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
780 g_return_if_fail (name != NULL);
782 if (g_hash_table_lookup (self->priv->custom_item_names, name) == NULL ||
783 !app_chooser_button_iter_from_custom_name (self, name, &iter))
785 g_warning ("Can't find the item named %s in the app chooser.",
790 gtk_combo_box_set_active_iter (GTK_COMBO_BOX (self), &iter);
794 * gtk_app_chooser_button_get_show_dialog_item:
795 * @self: a #GtkAppChooserButton
797 * Returns the current value of the #GtkAppChooserButton:show-dialog-item
800 * Returns: the value of #GtkAppChooserButton:show-dialog-item
805 gtk_app_chooser_button_get_show_dialog_item (GtkAppChooserButton *self)
807 g_return_val_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self), FALSE);
809 return self->priv->show_dialog_item;
813 * gtk_app_chooser_button_set_show_dialog_item:
814 * @self: a #GtkAppChooserButton
815 * @setting: the new value for #GtkAppChooserButton:show-dialog-item
817 * Sets whether the dropdown menu of this button should show an
818 * entry to trigger a #GtkAppChooserDialog.
823 gtk_app_chooser_button_set_show_dialog_item (GtkAppChooserButton *self,
826 if (self->priv->show_dialog_item != setting)
828 self->priv->show_dialog_item = setting;
830 g_object_notify (G_OBJECT (self), "show-dialog-item");
832 gtk_app_chooser_refresh (GTK_APP_CHOOSER (self));
837 * gtk_app_chooser_button_set_heading:
838 * @self: a #GtkAppChooserButton
839 * @heading: a string containing Pango markup
841 * Sets the text to display at the top of the dialog.
842 * If the heading is not set, the dialog displays a default text.
845 gtk_app_chooser_button_set_heading (GtkAppChooserButton *self,
846 const gchar *heading)
848 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
850 g_free (self->priv->heading);
851 self->priv->heading = g_strdup (heading);
853 g_object_notify (G_OBJECT (self), "heading");
857 * gtk_app_chooser_button_get_heading:
858 * @self: a #GtkAppChooserButton
860 * Returns the text to display at the top of the dialog.
862 * Returns: the text to display at the top of the dialog, or %NULL, in which
863 * case a default text is displayed
866 gtk_app_chooser_button_get_heading (GtkAppChooserButton *self)
868 g_return_val_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self), NULL);
870 return self->priv->heading;