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 gtk_widget_destroy (GTK_WIDGET (dialog));
219 /* refresh the combobox to get the new application */
220 gtk_app_chooser_refresh (GTK_APP_CHOOSER (self));
221 gtk_app_chooser_button_select_application (self, info);
223 g_object_unref (info);
227 other_application_item_activated_cb (GtkAppChooserButton *self)
229 GtkWidget *dialog, *widget;
232 toplevel = GTK_WINDOW (gtk_widget_get_toplevel (GTK_WIDGET (self)));
233 dialog = gtk_app_chooser_dialog_new_for_content_type (toplevel, GTK_DIALOG_DESTROY_WITH_PARENT,
234 self->priv->content_type);
236 gtk_window_set_modal (GTK_WINDOW (dialog), gtk_window_get_modal (toplevel));
237 gtk_app_chooser_dialog_set_heading (GTK_APP_CHOOSER_DIALOG (dialog),
238 self->priv->heading);
240 widget = gtk_app_chooser_dialog_get_widget (GTK_APP_CHOOSER_DIALOG (dialog));
241 g_object_set (widget,
242 "show-fallback", TRUE,
245 gtk_widget_show (dialog);
247 g_signal_connect (dialog, "response",
248 G_CALLBACK (other_application_dialog_response_cb), self);
252 gtk_app_chooser_button_ensure_dialog_item (GtkAppChooserButton *self,
253 GtkTreeIter *prev_iter)
255 GtkTreeIter iter, iter2;
257 if (!self->priv->show_dialog_item || !self->priv->content_type)
260 if (prev_iter == NULL)
261 gtk_list_store_append (self->priv->store, &iter);
263 gtk_list_store_insert_after (self->priv->store, &iter, prev_iter);
265 real_insert_separator (self, FALSE, &iter);
268 gtk_list_store_insert_after (self->priv->store, &iter, &iter2);
269 real_insert_custom_item (self, CUSTOM_ITEM_OTHER_APP,
270 _("Other application..."), NULL,
275 gtk_app_chooser_button_populate (GtkAppChooserButton *self)
277 GList *recommended_apps = NULL, *l;
279 GtkTreeIter iter, iter2;
281 gboolean cycled_recommended;
284 if (self->priv->content_type)
285 recommended_apps = g_app_info_get_recommended_for_type (self->priv->content_type);
287 cycled_recommended = FALSE;
289 for (l = recommended_apps; l != NULL; l = l->next)
293 icon = g_app_info_get_icon (app);
296 icon = g_themed_icon_new ("application-x-executable");
300 if (cycled_recommended)
302 gtk_list_store_insert_after (self->priv->store, &iter2, &iter);
307 get_first_iter (self->priv->store, &iter);
308 cycled_recommended = TRUE;
311 gtk_list_store_set (self->priv->store, &iter,
312 COLUMN_APP_INFO, app,
313 COLUMN_LABEL, g_app_info_get_name (app),
315 COLUMN_CUSTOM, FALSE,
318 g_object_unref (icon);
321 if (!cycled_recommended)
322 gtk_app_chooser_button_ensure_dialog_item (self, NULL);
324 gtk_app_chooser_button_ensure_dialog_item (self, &iter);
326 gtk_combo_box_set_active (GTK_COMBO_BOX (self), 0);
330 gtk_app_chooser_button_build_ui (GtkAppChooserButton *self)
332 GtkCellRenderer *cell;
335 gtk_combo_box_set_model (GTK_COMBO_BOX (self),
336 GTK_TREE_MODEL (self->priv->store));
338 area = gtk_cell_layout_get_area (GTK_CELL_LAYOUT (self));
340 gtk_combo_box_set_row_separator_func (GTK_COMBO_BOX (self),
341 row_separator_func, NULL, NULL);
343 cell = gtk_cell_renderer_pixbuf_new ();
344 gtk_cell_area_add_with_properties (area, cell,
349 gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (self), cell,
350 "gicon", COLUMN_ICON,
353 cell = gtk_cell_renderer_text_new ();
354 gtk_cell_area_add_with_properties (area, cell,
358 gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (self), cell,
359 "text", COLUMN_LABEL,
362 gtk_app_chooser_button_populate (self);
366 gtk_app_chooser_button_remove_non_custom (GtkAppChooserButton *self)
370 gboolean custom, res;
372 model = GTK_TREE_MODEL (self->priv->store);
374 if (!gtk_tree_model_get_iter_first (model, &iter))
378 gtk_tree_model_get (model, &iter,
379 COLUMN_CUSTOM, &custom,
382 res = gtk_tree_model_iter_next (model, &iter);
384 res = gtk_list_store_remove (GTK_LIST_STORE (model), &iter);
389 gtk_app_chooser_button_changed (GtkComboBox *object)
391 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
397 if (!gtk_combo_box_get_active_iter (object, &iter))
400 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
402 COLUMN_CUSTOM, &custom,
409 name_quark = g_quark_from_string (name);
410 g_signal_emit (self, signals[SIGNAL_CUSTOM_ITEM_ACTIVATED], name_quark, name);
411 self->priv->last_active = gtk_combo_box_get_active (object);
415 /* trigger the dialog internally */
416 other_application_item_activated_cb (self);
422 self->priv->last_active = gtk_combo_box_get_active (object);
426 gtk_app_chooser_button_refresh (GtkAppChooser *object)
428 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
430 gtk_app_chooser_button_remove_non_custom (self);
431 gtk_app_chooser_button_populate (self);
435 gtk_app_chooser_button_get_app_info (GtkAppChooser *object)
437 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
441 if (!gtk_combo_box_get_active_iter (GTK_COMBO_BOX (self), &iter))
444 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
445 COLUMN_APP_INFO, &info,
452 gtk_app_chooser_button_constructed (GObject *obj)
454 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
456 if (G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->constructed != NULL)
457 G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->constructed (obj);
459 gtk_app_chooser_button_build_ui (self);
463 gtk_app_chooser_button_set_property (GObject *obj,
468 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
472 case PROP_CONTENT_TYPE:
473 self->priv->content_type = g_value_dup_string (value);
475 case PROP_SHOW_DIALOG_ITEM:
476 gtk_app_chooser_button_set_show_dialog_item (self, g_value_get_boolean (value));
479 gtk_app_chooser_button_set_heading (self, g_value_get_string (value));
482 G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
488 gtk_app_chooser_button_get_property (GObject *obj,
493 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
497 case PROP_CONTENT_TYPE:
498 g_value_set_string (value, self->priv->content_type);
500 case PROP_SHOW_DIALOG_ITEM:
501 g_value_set_boolean (value, self->priv->show_dialog_item);
504 g_value_set_string (value, self->priv->heading);
507 G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
513 gtk_app_chooser_button_finalize (GObject *obj)
515 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
517 g_hash_table_destroy (self->priv->custom_item_names);
518 g_free (self->priv->content_type);
519 g_free (self->priv->heading);
521 g_object_unref (self->priv->store);
523 G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->finalize (obj);
527 app_chooser_iface_init (GtkAppChooserIface *iface)
529 iface->get_app_info = gtk_app_chooser_button_get_app_info;
530 iface->refresh = gtk_app_chooser_button_refresh;
534 gtk_app_chooser_button_class_init (GtkAppChooserButtonClass *klass)
536 GObjectClass *oclass = G_OBJECT_CLASS (klass);
537 GtkComboBoxClass *combo_class = GTK_COMBO_BOX_CLASS (klass);
540 oclass->set_property = gtk_app_chooser_button_set_property;
541 oclass->get_property = gtk_app_chooser_button_get_property;
542 oclass->finalize = gtk_app_chooser_button_finalize;
543 oclass->constructed = gtk_app_chooser_button_constructed;
545 combo_class->changed = gtk_app_chooser_button_changed;
547 g_object_class_override_property (oclass, PROP_CONTENT_TYPE, "content-type");
550 * GtkAppChooserButton:show-dialog-item:
552 * The #GtkAppChooserButton:show-dialog-item property determines whether the dropdown menu
553 * should show an item that triggers a #GtkAppChooserDialog when clicked.
556 g_param_spec_boolean ("show-dialog-item",
557 P_("Include an 'Other...' item"),
558 P_("Whether the combobox should include an item that triggers a GtkAppChooserDialog"),
560 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
561 g_object_class_install_property (oclass, PROP_SHOW_DIALOG_ITEM, pspec);
564 * GtkAppChooserButton:heading:
566 * The text to show at the top of the dialog that can be
567 * opened from the button. The string may contain Pango markup.
569 pspec = g_param_spec_string ("heading",
571 P_("The text to show at the top of the dialog"),
573 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
574 g_object_class_install_property (oclass, PROP_HEADING, pspec);
578 * GtkAppChooserButton::custom-item-activated:
579 * @self: the object which received the signal
580 * @item_name: the name of the activated item
582 * Emitted when a custom item, previously added with
583 * gtk_app_chooser_button_append_custom_item(), is activated from the
586 signals[SIGNAL_CUSTOM_ITEM_ACTIVATED] =
587 g_signal_new ("custom-item-activated",
588 GTK_TYPE_APP_CHOOSER_BUTTON,
589 G_SIGNAL_RUN_FIRST | G_SIGNAL_DETAILED,
590 G_STRUCT_OFFSET (GtkAppChooserButtonClass, custom_item_activated),
592 _gtk_marshal_VOID__STRING,
596 g_type_class_add_private (klass, sizeof (GtkAppChooserButtonPrivate));
600 gtk_app_chooser_button_init (GtkAppChooserButton *self)
602 self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, GTK_TYPE_APP_CHOOSER_BUTTON,
603 GtkAppChooserButtonPrivate);
604 self->priv->custom_item_names =
605 g_hash_table_new_full (g_str_hash, g_str_equal,
608 self->priv->store = gtk_list_store_new (NUM_COLUMNS,
610 G_TYPE_STRING, /* name */
611 G_TYPE_STRING, /* label */
613 G_TYPE_BOOLEAN, /* separator */
614 G_TYPE_BOOLEAN); /* custom */
618 app_chooser_button_iter_from_custom_name (GtkAppChooserButton *self,
623 gchar *custom_name = NULL;
625 if (!gtk_tree_model_get_iter_first
626 (GTK_TREE_MODEL (self->priv->store), &iter))
630 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
631 COLUMN_NAME, &custom_name,
634 if (g_strcmp0 (custom_name, name) == 0)
636 g_free (custom_name);
642 g_free (custom_name);
643 } while (gtk_tree_model_iter_next (GTK_TREE_MODEL (self->priv->store), &iter));
649 real_insert_custom_item (GtkAppChooserButton *self,
658 if (g_hash_table_lookup (self->priv->custom_item_names,
661 g_warning ("Attempting to add custom item %s to GtkAppChooserButton, "
662 "when there's already an item with the same name", name);
666 g_hash_table_insert (self->priv->custom_item_names,
667 g_strdup (name), GINT_TO_POINTER (1));
670 gtk_list_store_set (self->priv->store, iter,
674 COLUMN_CUSTOM, custom,
675 COLUMN_SEPARATOR, FALSE,
680 real_insert_separator (GtkAppChooserButton *self,
684 gtk_list_store_set (self->priv->store, iter,
685 COLUMN_CUSTOM, custom,
686 COLUMN_SEPARATOR, TRUE,
691 * gtk_app_chooser_button_new:
692 * @content_type: the content type to show applications for
694 * Creates a new #GtkAppChooserButton for applications
695 * that can handle content of the given type.
697 * Returns: a newly created #GtkAppChooserButton
702 gtk_app_chooser_button_new (const gchar *content_type)
704 g_return_val_if_fail (content_type != NULL, NULL);
706 return g_object_new (GTK_TYPE_APP_CHOOSER_BUTTON,
707 "content-type", content_type,
712 * gtk_app_chooser_button_append_separator:
713 * @self: a #GtkAppChooserButton
715 * Appends a separator to the list of applications that is shown
721 gtk_app_chooser_button_append_separator (GtkAppChooserButton *self)
725 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
727 gtk_list_store_append (self->priv->store, &iter);
728 real_insert_separator (self, TRUE, &iter);
732 * gtk_app_chooser_button_append_custom_item:
733 * @self: a #GtkAppChooserButton
734 * @name: the name of the custom item
735 * @label: the label for the custom item
736 * @icon: the icon for the custom item
738 * Appends a custom item to the list of applications that is shown
739 * in the popup; the item name must be unique per-widget.
740 * Clients can use the provided name as a detail for the ::custom-item-activated
741 * signal, to add a callback for the activation of a particular
742 * custom item in the list.
743 * See also gtk_app_chooser_button_append_separator().
748 gtk_app_chooser_button_append_custom_item (GtkAppChooserButton *self,
755 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
756 g_return_if_fail (name != NULL);
758 gtk_list_store_append (self->priv->store, &iter);
759 real_insert_custom_item (self, name, label, icon, TRUE, &iter);
763 * gtk_app_chooser_button_set_active_custom_item:
764 * @self: a #GtkAppChooserButton
765 * @name: the name of the custom item
767 * Selects a custom item previously added with
768 * gtk_app_chooser_button_append_custom_item().
770 * Use gtk_app_chooser_refresh() to bring the selection
771 * to its initial state.
776 gtk_app_chooser_button_set_active_custom_item (GtkAppChooserButton *self,
781 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
782 g_return_if_fail (name != NULL);
784 if (g_hash_table_lookup (self->priv->custom_item_names, name) == NULL ||
785 !app_chooser_button_iter_from_custom_name (self, name, &iter))
787 g_warning ("Can't find the item named %s in the app chooser.",
792 gtk_combo_box_set_active_iter (GTK_COMBO_BOX (self), &iter);
796 * gtk_app_chooser_button_get_show_dialog_item:
797 * @self: a #GtkAppChooserButton
799 * Returns the current value of the #GtkAppChooserButton:show-dialog-item
802 * Returns: the value of #GtkAppChooserButton:show-dialog-item
807 gtk_app_chooser_button_get_show_dialog_item (GtkAppChooserButton *self)
809 g_return_val_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self), FALSE);
811 return self->priv->show_dialog_item;
815 * gtk_app_chooser_button_set_show_dialog_item:
816 * @self: a #GtkAppChooserButton
817 * @setting: the new value for #GtkAppChooserButton:show-dialog-item
819 * Sets whether the dropdown menu of this button should show an
820 * entry to trigger a #GtkAppChooserDialog.
825 gtk_app_chooser_button_set_show_dialog_item (GtkAppChooserButton *self,
828 if (self->priv->show_dialog_item != setting)
830 self->priv->show_dialog_item = setting;
832 g_object_notify (G_OBJECT (self), "show-dialog-item");
834 gtk_app_chooser_refresh (GTK_APP_CHOOSER (self));
839 * gtk_app_chooser_button_set_heading:
840 * @self: a #GtkAppChooserButton
841 * @heading: a string containing Pango markup
843 * Sets the text to display at the top of the dialog.
844 * If the heading is not set, the dialog displays a default text.
847 gtk_app_chooser_button_set_heading (GtkAppChooserButton *self,
848 const gchar *heading)
850 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
852 g_free (self->priv->heading);
853 self->priv->heading = g_strdup (heading);
855 g_object_notify (G_OBJECT (self), "heading");
859 * gtk_app_chooser_button_get_heading:
860 * @self: a #GtkAppChooserButton
862 * Returns the text to display at the top of the dialog.
864 * Returns: the text to display at the top of the dialog, or %NULL, in which
865 * case a default text is displayed
868 gtk_app_chooser_button_get_heading (GtkAppChooserButton *self)
870 g_return_val_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self), NULL);
872 return self->priv->heading;