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 {
94 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;
157 gtk_tree_model_get (model, iter,
158 COLUMN_APP_INFO, &app,
159 COLUMN_CUSTOM, &custom,
162 /* cutsom items are always after GAppInfos, so iterating further here
168 if (g_app_info_equal (app, app_to_match))
170 gtk_combo_box_set_active_iter (GTK_COMBO_BOX (data->self), iter);
178 gtk_app_chooser_button_select_application (GtkAppChooserButton *self,
183 data = g_slice_new0 (SelectAppData);
184 data->self = g_object_ref (self);
185 data->info = g_object_ref (info);
187 gtk_tree_model_foreach (GTK_TREE_MODEL (self->priv->store),
188 select_application_func_cb, data);
190 select_app_data_free (data);
194 other_application_dialog_response_cb (GtkDialog *dialog,
198 GtkAppChooserButton *self = user_data;
201 if (response_id != GTK_RESPONSE_OK)
203 /* reset the active item, otherwise we are stuck on
204 * 'Other application...'
206 gtk_combo_box_set_active (GTK_COMBO_BOX (self), self->priv->last_active);
207 gtk_widget_destroy (GTK_WIDGET (dialog));
211 info = gtk_app_chooser_get_app_info (GTK_APP_CHOOSER (dialog));
213 /* refresh the combobox to get the new application */
214 gtk_app_chooser_refresh (GTK_APP_CHOOSER (self));
215 gtk_app_chooser_button_select_application (self, info);
217 g_object_unref (info);
221 other_application_item_activated_cb (GtkAppChooserButton *self)
223 GtkWidget *dialog, *widget;
226 toplevel = GTK_WINDOW (gtk_widget_get_toplevel (GTK_WIDGET (self)));
227 dialog = gtk_app_chooser_dialog_new_for_content_type (toplevel, GTK_DIALOG_DESTROY_WITH_PARENT,
228 self->priv->content_type);
230 gtk_window_set_modal (GTK_WINDOW (dialog), gtk_window_get_modal (toplevel));
231 gtk_app_chooser_dialog_set_heading (GTK_APP_CHOOSER_DIALOG (dialog),
232 self->priv->heading);
234 widget = gtk_app_chooser_dialog_get_widget (GTK_APP_CHOOSER_DIALOG (dialog));
235 g_object_set (widget,
236 "show-fallback", TRUE,
239 gtk_widget_show (dialog);
241 g_signal_connect (dialog, "response",
242 G_CALLBACK (other_application_dialog_response_cb), self);
246 gtk_app_chooser_button_ensure_dialog_item (GtkAppChooserButton *self,
247 GtkTreeIter *prev_iter)
249 GtkTreeIter iter, iter2;
251 if (!self->priv->show_dialog_item || !self->priv->content_type)
254 if (prev_iter == NULL)
255 gtk_list_store_append (self->priv->store, &iter);
257 gtk_list_store_insert_after (self->priv->store, &iter, prev_iter);
259 real_insert_separator (self, FALSE, &iter);
262 gtk_list_store_insert_after (self->priv->store, &iter, &iter2);
263 real_insert_custom_item (self, CUSTOM_ITEM_OTHER_APP,
264 _("Other application..."), NULL,
269 gtk_app_chooser_button_populate (GtkAppChooserButton *self)
271 GList *recommended_apps = NULL, *l;
273 GtkTreeIter iter, iter2;
275 gboolean cycled_recommended;
278 if (self->priv->content_type)
279 recommended_apps = g_app_info_get_recommended_for_type (self->priv->content_type);
281 cycled_recommended = FALSE;
283 for (l = recommended_apps; l != NULL; l = l->next)
287 icon = g_app_info_get_icon (app);
290 icon = g_themed_icon_new ("application-x-executable");
294 if (cycled_recommended)
296 gtk_list_store_insert_after (self->priv->store, &iter2, &iter);
301 get_first_iter (self->priv->store, &iter);
302 cycled_recommended = TRUE;
305 gtk_list_store_set (self->priv->store, &iter,
306 COLUMN_APP_INFO, app,
307 COLUMN_LABEL, g_app_info_get_name (app),
309 COLUMN_CUSTOM, FALSE,
312 g_object_unref (icon);
315 if (!cycled_recommended)
316 gtk_app_chooser_button_ensure_dialog_item (self, NULL);
318 gtk_app_chooser_button_ensure_dialog_item (self, &iter);
320 gtk_combo_box_set_active (GTK_COMBO_BOX (self), 0);
324 gtk_app_chooser_button_build_ui (GtkAppChooserButton *self)
326 GtkCellRenderer *cell;
329 gtk_combo_box_set_model (GTK_COMBO_BOX (self),
330 GTK_TREE_MODEL (self->priv->store));
332 area = gtk_cell_layout_get_area (GTK_CELL_LAYOUT (self));
334 gtk_combo_box_set_row_separator_func (GTK_COMBO_BOX (self),
335 row_separator_func, NULL, NULL);
337 cell = gtk_cell_renderer_pixbuf_new ();
338 gtk_cell_area_add_with_properties (area, cell,
343 gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (self), cell,
344 "gicon", COLUMN_ICON,
347 cell = gtk_cell_renderer_text_new ();
348 gtk_cell_area_add_with_properties (area, cell,
352 gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (self), cell,
353 "text", COLUMN_LABEL,
356 gtk_app_chooser_button_populate (self);
360 gtk_app_chooser_button_remove_non_custom (GtkAppChooserButton *self)
364 gboolean custom, res;
366 model = GTK_TREE_MODEL (self->priv->store);
368 if (!gtk_tree_model_get_iter_first (model, &iter))
372 gtk_tree_model_get (model, &iter,
373 COLUMN_CUSTOM, &custom,
376 res = gtk_tree_model_iter_next (model, &iter);
378 res = gtk_list_store_remove (GTK_LIST_STORE (model), &iter);
383 gtk_app_chooser_button_changed (GtkComboBox *object)
385 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
391 if (!gtk_combo_box_get_active_iter (object, &iter))
394 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
396 COLUMN_CUSTOM, &custom,
403 name_quark = g_quark_from_string (name);
404 g_signal_emit (self, signals[SIGNAL_CUSTOM_ITEM_ACTIVATED], name_quark, name);
405 self->priv->last_active = gtk_combo_box_get_active (object);
409 /* trigger the dialog internally */
410 other_application_item_activated_cb (self);
416 self->priv->last_active = gtk_combo_box_get_active (object);
420 gtk_app_chooser_button_refresh (GtkAppChooser *object)
422 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
424 gtk_app_chooser_button_remove_non_custom (self);
425 gtk_app_chooser_button_populate (self);
429 gtk_app_chooser_button_get_app_info (GtkAppChooser *object)
431 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
435 if (!gtk_combo_box_get_active_iter (GTK_COMBO_BOX (self), &iter))
438 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
439 COLUMN_APP_INFO, &info,
446 gtk_app_chooser_button_constructed (GObject *obj)
448 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
450 if (G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->constructed != NULL)
451 G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->constructed (obj);
453 gtk_app_chooser_button_build_ui (self);
457 gtk_app_chooser_button_set_property (GObject *obj,
462 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
466 case PROP_CONTENT_TYPE:
467 self->priv->content_type = g_value_dup_string (value);
469 case PROP_SHOW_DIALOG_ITEM:
470 gtk_app_chooser_button_set_show_dialog_item (self, g_value_get_boolean (value));
473 gtk_app_chooser_button_set_heading (self, g_value_get_string (value));
476 G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
482 gtk_app_chooser_button_get_property (GObject *obj,
487 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
491 case PROP_CONTENT_TYPE:
492 g_value_set_string (value, self->priv->content_type);
494 case PROP_SHOW_DIALOG_ITEM:
495 g_value_set_boolean (value, self->priv->show_dialog_item);
498 g_value_set_string (value, self->priv->heading);
501 G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
507 gtk_app_chooser_button_finalize (GObject *obj)
509 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
511 g_hash_table_destroy (self->priv->custom_item_names);
512 g_free (self->priv->content_type);
513 g_free (self->priv->heading);
515 g_object_unref (self->priv->store);
517 G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->finalize (obj);
521 app_chooser_iface_init (GtkAppChooserIface *iface)
523 iface->get_app_info = gtk_app_chooser_button_get_app_info;
524 iface->refresh = gtk_app_chooser_button_refresh;
528 gtk_app_chooser_button_class_init (GtkAppChooserButtonClass *klass)
530 GObjectClass *oclass = G_OBJECT_CLASS (klass);
531 GtkComboBoxClass *combo_class = GTK_COMBO_BOX_CLASS (klass);
534 oclass->set_property = gtk_app_chooser_button_set_property;
535 oclass->get_property = gtk_app_chooser_button_get_property;
536 oclass->finalize = gtk_app_chooser_button_finalize;
537 oclass->constructed = gtk_app_chooser_button_constructed;
539 combo_class->changed = gtk_app_chooser_button_changed;
541 g_object_class_override_property (oclass, PROP_CONTENT_TYPE, "content-type");
544 * GtkAppChooserButton:show-dialog-item:
546 * The #GtkAppChooserButton:show-dialog-item property determines whether the dropdown menu
547 * should show an item that triggers a #GtkAppChooserDialog when clicked.
550 g_param_spec_boolean ("show-dialog-item",
551 P_("Include an 'Other...' item"),
552 P_("Whether the combobox should include an item that triggers a GtkAppChooserDialog"),
554 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
555 g_object_class_install_property (oclass, PROP_SHOW_DIALOG_ITEM, pspec);
558 * GtkAppChooserButton:heading:
560 * The text to show at the top of the dialog that can be
561 * opened from the button. The string may contain Pango markup.
563 pspec = g_param_spec_string ("heading",
565 P_("The text to show at the top of the dialog"),
567 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
568 g_object_class_install_property (oclass, PROP_HEADING, pspec);
572 * GtkAppChooserButton::custom-item-activated:
573 * @self: the object which received the signal
574 * @item_name: the name of the activated item
576 * Emitted when a custom item, previously added with
577 * gtk_app_chooser_button_append_custom_item(), is activated from the
580 signals[SIGNAL_CUSTOM_ITEM_ACTIVATED] =
581 g_signal_new ("custom-item-activated",
582 GTK_TYPE_APP_CHOOSER_BUTTON,
583 G_SIGNAL_RUN_FIRST | G_SIGNAL_DETAILED,
584 G_STRUCT_OFFSET (GtkAppChooserButtonClass, custom_item_activated),
586 _gtk_marshal_VOID__STRING,
590 g_type_class_add_private (klass, sizeof (GtkAppChooserButtonPrivate));
594 gtk_app_chooser_button_init (GtkAppChooserButton *self)
596 self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, GTK_TYPE_APP_CHOOSER_BUTTON,
597 GtkAppChooserButtonPrivate);
598 self->priv->custom_item_names =
599 g_hash_table_new_full (g_str_hash, g_str_equal,
602 self->priv->store = gtk_list_store_new (NUM_COLUMNS,
604 G_TYPE_STRING, /* name */
605 G_TYPE_STRING, /* label */
607 G_TYPE_BOOLEAN, /* separator */
608 G_TYPE_BOOLEAN); /* custom */
612 app_chooser_button_iter_from_custom_name (GtkAppChooserButton *self,
617 gchar *custom_name = NULL;
619 if (!gtk_tree_model_get_iter_first
620 (GTK_TREE_MODEL (self->priv->store), &iter))
624 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
625 COLUMN_NAME, &custom_name,
628 if (g_strcmp0 (custom_name, name) == 0)
630 g_free (custom_name);
636 g_free (custom_name);
637 } while (gtk_tree_model_iter_next (GTK_TREE_MODEL (self->priv->store), &iter));
643 real_insert_custom_item (GtkAppChooserButton *self,
652 if (g_hash_table_lookup (self->priv->custom_item_names,
655 g_warning ("Attempting to add custom item %s to GtkAppChooserButton, "
656 "when there's already an item with the same name", name);
660 g_hash_table_insert (self->priv->custom_item_names,
661 g_strdup (name), GINT_TO_POINTER (1));
664 gtk_list_store_set (self->priv->store, iter,
668 COLUMN_CUSTOM, custom,
669 COLUMN_SEPARATOR, FALSE,
674 real_insert_separator (GtkAppChooserButton *self,
678 gtk_list_store_set (self->priv->store, iter,
679 COLUMN_CUSTOM, custom,
680 COLUMN_SEPARATOR, TRUE,
685 * gtk_app_chooser_button_new:
686 * @content_type: the content type to show applications for
688 * Creates a new #GtkAppChooserButton for applications
689 * that can handle content of the given type.
691 * Returns: a newly created #GtkAppChooserButton
696 gtk_app_chooser_button_new (const gchar *content_type)
698 g_return_val_if_fail (content_type != NULL, NULL);
700 return g_object_new (GTK_TYPE_APP_CHOOSER_BUTTON,
701 "content-type", content_type,
706 * gtk_app_chooser_button_append_separator:
707 * @self: a #GtkAppChooserButton
709 * Appends a separator to the list of applications that is shown
715 gtk_app_chooser_button_append_separator (GtkAppChooserButton *self)
719 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
721 gtk_list_store_append (self->priv->store, &iter);
722 real_insert_separator (self, TRUE, &iter);
726 * gtk_app_chooser_button_append_custom_item:
727 * @self: a #GtkAppChooserButton
728 * @name: the name of the custom item
729 * @label: the label for the custom item
730 * @icon: the icon for the custom item
732 * Appends a custom item to the list of applications that is shown
733 * in the popup; the item name must be unique per-widget.
734 * Clients can use the provided name as a detail for the ::custom-item-activated
735 * signal, to add a callback for the activation of a particular
736 * custom item in the list.
737 * See also gtk_app_chooser_button_append_separator().
742 gtk_app_chooser_button_append_custom_item (GtkAppChooserButton *self,
749 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
750 g_return_if_fail (name != NULL);
752 gtk_list_store_append (self->priv->store, &iter);
753 real_insert_custom_item (self, name, label, icon, TRUE, &iter);
757 * gtk_app_chooser_button_set_active_custom_item:
758 * @self: a #GtkAppChooserButton
759 * @name: the name of the custom item
761 * Selects a custom item previously added with
762 * gtk_app_chooser_button_append_custom_item().
764 * Use gtk_app_chooser_refresh() to bring the selection
765 * to its initial state.
770 gtk_app_chooser_button_set_active_custom_item (GtkAppChooserButton *self,
775 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
776 g_return_if_fail (name != NULL);
778 if (g_hash_table_lookup (self->priv->custom_item_names, name) == NULL ||
779 !app_chooser_button_iter_from_custom_name (self, name, &iter))
781 g_warning ("Can't find the item named %s in the app chooser.",
786 gtk_combo_box_set_active_iter (GTK_COMBO_BOX (self), &iter);
790 * gtk_app_chooser_button_get_show_dialog_item:
791 * @self: a #GtkAppChooserButton
793 * Returns the current value of the #GtkAppChooserButton:show-dialog-item
796 * Returns: the value of #GtkAppChooserButton:show-dialog-item
801 gtk_app_chooser_button_get_show_dialog_item (GtkAppChooserButton *self)
803 g_return_val_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self), FALSE);
805 return self->priv->show_dialog_item;
809 * gtk_app_chooser_button_set_show_dialog_item:
810 * @self: a #GtkAppChooserButton
811 * @setting: the new value for #GtkAppChooserButton:show-dialog-item
813 * Sets whether the dropdown menu of this button should show an
814 * entry to trigger a #GtkAppChooserDialog.
819 gtk_app_chooser_button_set_show_dialog_item (GtkAppChooserButton *self,
822 if (self->priv->show_dialog_item != setting)
824 self->priv->show_dialog_item = setting;
826 g_object_notify (G_OBJECT (self), "show-dialog-item");
828 gtk_app_chooser_refresh (GTK_APP_CHOOSER (self));
833 * gtk_app_chooser_button_set_heading:
834 * @self: a #GtkAppChooserButton
835 * @heading: a string containing Pango markup
837 * Sets the text to display at the top of the dialog.
838 * If the heading is not set, the dialog displays a default text.
841 gtk_app_chooser_button_set_heading (GtkAppChooserButton *self,
842 const gchar *heading)
844 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
846 g_free (self->priv->heading);
847 self->priv->heading = g_strdup (heading);
849 g_object_notify (G_OBJECT (self), "heading");
853 * gtk_app_chooser_button_get_heading:
854 * @self: a #GtkAppChooserButton
856 * Returns the text to display at the top of the dialog.
858 * Returns: the text to display at the top of the dialog, or %NULL, in which
859 * case a default text is displayed
862 gtk_app_chooser_button_get_heading (GtkAppChooserButton *self)
864 g_return_val_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self), NULL);
866 return self->priv->heading;