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>
26 #include "gtkappchooserbutton.h"
28 #include "gtkappchooser.h"
29 #include "gtkappchooserdialog.h"
30 #include "gtkappchooserprivate.h"
31 #include "gtkcelllayout.h"
32 #include "gtkcellrendererpixbuf.h"
33 #include "gtkcellrenderertext.h"
34 #include "gtkcombobox.h"
35 #include "gtkdialog.h"
39 PROP_CONTENT_TYPE = 1,
40 PROP_SHOW_DIALOG_ITEM,
54 GtkAppChooserButtonItemFunc func;
59 custom_app_data_copy (gpointer boxed)
61 CustomAppComboData *retval, *original;
65 retval = g_slice_new0 (CustomAppComboData);
66 retval->func = original->func;
67 retval->user_data = original->user_data;
73 custom_app_data_free (gpointer boxed)
75 g_slice_free (CustomAppComboData, boxed);
78 #define CUSTOM_COMBO_DATA_TYPE custom_app_combo_data_get_type()
79 G_DEFINE_BOXED_TYPE (CustomAppComboData, custom_app_combo_data,
81 custom_app_data_free);
83 static void app_chooser_iface_init (GtkAppChooserIface *iface);
85 static void real_insert_custom_item (GtkAppChooserButton *self,
88 GtkAppChooserButtonItemFunc func,
93 static void real_insert_separator (GtkAppChooserButton *self,
97 G_DEFINE_TYPE_WITH_CODE (GtkAppChooserButton, gtk_app_chooser_button, GTK_TYPE_COMBO_BOX,
98 G_IMPLEMENT_INTERFACE (GTK_TYPE_APP_CHOOSER,
99 app_chooser_iface_init));
101 struct _GtkAppChooserButtonPrivate {
105 gboolean show_dialog_item;
109 row_separator_func (GtkTreeModel *model,
115 gtk_tree_model_get (model, iter,
116 COLUMN_SEPARATOR, &separator,
123 get_first_iter (GtkListStore *store,
128 if (!gtk_tree_model_get_iter_first (GTK_TREE_MODEL (store), iter))
130 /* the model is empty, append */
131 gtk_list_store_append (store, iter);
135 gtk_list_store_insert_before (store, &iter2, iter);
141 GtkAppChooserButton *self;
147 select_app_data_free (SelectAppData *data)
149 g_clear_object (&data->self);
150 g_clear_object (&data->info);
152 g_slice_free (SelectAppData, data);
156 select_application_func_cb (GtkTreeModel *model,
161 SelectAppData *data = user_data;
162 GAppInfo *app_to_match = data->info, *app = NULL;
165 gtk_tree_model_get (model, iter,
166 COLUMN_APP_INFO, &app,
167 COLUMN_CUSTOM, &custom,
170 /* cutsom items are always after GAppInfos, so iterating further here
176 if (g_app_info_equal (app, app_to_match))
178 gtk_combo_box_set_active_iter (GTK_COMBO_BOX (data->self), iter);
186 gtk_app_chooser_button_select_application (GtkAppChooserButton *self,
191 data = g_slice_new0 (SelectAppData);
192 data->self = g_object_ref (self);
193 data->info = g_object_ref (info);
195 gtk_tree_model_foreach (GTK_TREE_MODEL (self->priv->store),
196 select_application_func_cb, data);
198 select_app_data_free (data);
202 other_application_dialog_response_cb (GtkDialog *dialog,
206 GtkAppChooserButton *self = user_data;
209 if (response_id != GTK_RESPONSE_OK)
211 /* reset the active item, otherwise we are stuck on
212 * 'Other application...'
214 gtk_combo_box_set_active (GTK_COMBO_BOX (self), 0);
215 gtk_widget_destroy (GTK_WIDGET (dialog));
219 info = gtk_app_chooser_get_app_info (GTK_APP_CHOOSER (dialog));
221 /* refresh the combobox to get the new application */
222 gtk_app_chooser_refresh (GTK_APP_CHOOSER (self));
223 gtk_app_chooser_button_select_application (self, info);
225 g_object_unref (info);
229 other_application_item_activated_cb (GtkAppChooserButton *self,
232 GtkWidget *dialog, *widget;
235 toplevel = GTK_WINDOW (gtk_widget_get_toplevel (GTK_WIDGET (self)));
236 dialog = gtk_app_chooser_dialog_new_for_content_type (toplevel, GTK_DIALOG_DESTROY_WITH_PARENT,
237 self->priv->content_type);
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)
256 if (!self->priv->show_dialog_item)
259 icon = g_themed_icon_new ("application-x-executable");
261 gtk_list_store_insert_after (self->priv->store, &iter, prev_iter);
262 real_insert_separator (self, FALSE, &iter);
265 gtk_list_store_insert_after (self->priv->store, &iter, prev_iter);
266 real_insert_custom_item (self,
267 _("Other application..."), icon,
268 other_application_item_activated_cb,
271 g_object_unref (icon);
275 gtk_app_chooser_button_populate (GtkAppChooserButton *self)
277 GList *recommended_apps = NULL, *l;
279 GtkTreeIter iter, iter2;
283 recommended_apps = g_app_info_get_recommended_for_type (self->priv->content_type);
286 for (l = recommended_apps; l != NULL; l = l->next)
290 icon = g_app_info_get_icon (app);
293 icon = g_themed_icon_new ("application-x-executable");
299 get_first_iter (self->priv->store, &iter);
304 gtk_list_store_insert_after (self->priv->store, &iter2, &iter);
308 gtk_list_store_set (self->priv->store, &iter,
309 COLUMN_APP_INFO, app,
310 COLUMN_NAME, g_app_info_get_display_name (app),
312 COLUMN_CUSTOM, FALSE,
315 g_object_unref (icon);
318 gtk_app_chooser_button_ensure_dialog_item (self, &iter);
319 gtk_combo_box_set_active (GTK_COMBO_BOX (self), 0);
323 gtk_app_chooser_button_build_ui (GtkAppChooserButton *self)
325 GtkCellRenderer *cell;
327 self->priv->store = gtk_list_store_new (NUM_COLUMNS,
333 CUSTOM_COMBO_DATA_TYPE);
335 gtk_combo_box_set_model (GTK_COMBO_BOX (self),
336 GTK_TREE_MODEL (self->priv->store));
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_layout_pack_start (GTK_CELL_LAYOUT (self), cell, FALSE);
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_layout_pack_start (GTK_CELL_LAYOUT (self), cell, TRUE);
349 gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (self), cell,
354 gtk_app_chooser_button_populate (self);
358 gtk_app_chooser_button_remove_non_custom (GtkAppChooserButton *self)
362 gboolean custom, res;
364 model = GTK_TREE_MODEL (self->priv->store);
366 if (!gtk_tree_model_get_iter_first (model, &iter))
370 gtk_tree_model_get (model, &iter,
371 COLUMN_CUSTOM, &custom,
374 res = gtk_tree_model_iter_next (model, &iter);
376 res = gtk_list_store_remove (GTK_LIST_STORE (model), &iter);
381 gtk_app_chooser_button_changed (GtkComboBox *object)
383 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
385 CustomAppComboData *custom_data = NULL;
387 if (!gtk_combo_box_get_active_iter (object, &iter))
390 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
391 COLUMN_CALLBACK, &custom_data,
394 if (custom_data != NULL && custom_data->func != NULL)
395 custom_data->func (self, custom_data->user_data);
399 gtk_app_chooser_button_refresh (GtkAppChooser *object)
401 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
403 gtk_app_chooser_button_remove_non_custom (self);
404 gtk_app_chooser_button_populate (self);
408 gtk_app_chooser_button_get_app_info (GtkAppChooser *object)
410 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (object);
414 if (!gtk_combo_box_get_active_iter (GTK_COMBO_BOX (self), &iter))
417 gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
418 COLUMN_APP_INFO, &info,
425 gtk_app_chooser_button_constructed (GObject *obj)
427 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
429 if (G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->constructed != NULL)
430 G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->constructed (obj);
432 g_assert (self->priv->content_type != NULL);
434 gtk_app_chooser_button_build_ui (self);
438 gtk_app_chooser_button_set_property (GObject *obj,
443 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
447 case PROP_CONTENT_TYPE:
448 self->priv->content_type = g_value_dup_string (value);
450 case PROP_SHOW_DIALOG_ITEM:
451 gtk_app_chooser_button_set_show_dialog_item (self, g_value_get_boolean (value));
454 G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
460 gtk_app_chooser_button_get_property (GObject *obj,
465 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
469 case PROP_CONTENT_TYPE:
470 g_value_set_string (value, self->priv->content_type);
472 case PROP_SHOW_DIALOG_ITEM:
473 g_value_set_boolean (value, self->priv->show_dialog_item);
476 G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
482 gtk_app_chooser_button_finalize (GObject *obj)
484 GtkAppChooserButton *self = GTK_APP_CHOOSER_BUTTON (obj);
486 g_free (self->priv->content_type);
488 G_OBJECT_CLASS (gtk_app_chooser_button_parent_class)->finalize (obj);
492 app_chooser_iface_init (GtkAppChooserIface *iface)
494 iface->get_app_info = gtk_app_chooser_button_get_app_info;
495 iface->refresh = gtk_app_chooser_button_refresh;
499 gtk_app_chooser_button_class_init (GtkAppChooserButtonClass *klass)
501 GObjectClass *oclass = G_OBJECT_CLASS (klass);
502 GtkComboBoxClass *combo_class = GTK_COMBO_BOX_CLASS (klass);
505 oclass->set_property = gtk_app_chooser_button_set_property;
506 oclass->get_property = gtk_app_chooser_button_get_property;
507 oclass->finalize = gtk_app_chooser_button_finalize;
508 oclass->constructed = gtk_app_chooser_button_constructed;
510 combo_class->changed = gtk_app_chooser_button_changed;
512 g_object_class_override_property (oclass, PROP_CONTENT_TYPE, "content-type");
515 * GtkAppChooserButton:show-dialog-item:
517 * The ::show-dialog-item property determines whether the dropdown menu
518 * should show an item that triggers a #GtkAppChooserDialog when clicked.
520 pspec = g_param_spec_boolean ("show-dialog-item",
521 P_("Include an 'Other...' item"),
522 P_("Whether the combobox should include an item that triggers a GtkAppChooserDialog"),
524 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
525 g_object_class_install_property (oclass, PROP_SHOW_DIALOG_ITEM, pspec);
527 g_type_class_add_private (klass, sizeof (GtkAppChooserButtonPrivate));
531 gtk_app_chooser_button_init (GtkAppChooserButton *self)
533 self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, GTK_TYPE_APP_CHOOSER_BUTTON,
534 GtkAppChooserButtonPrivate);
538 real_insert_custom_item (GtkAppChooserButton *self,
541 GtkAppChooserButtonItemFunc func,
546 CustomAppComboData *data;
548 data = g_slice_new0 (CustomAppComboData);
550 data->user_data = user_data;
552 gtk_list_store_set (self->priv->store, iter,
555 COLUMN_CALLBACK, data,
556 COLUMN_CUSTOM, custom,
557 COLUMN_SEPARATOR, FALSE,
562 real_insert_separator (GtkAppChooserButton *self,
566 gtk_list_store_set (self->priv->store, iter,
567 COLUMN_CUSTOM, custom,
568 COLUMN_SEPARATOR, TRUE,
573 * gtk_app_chooser_button_new:
574 * @content_type: the content type to show applications for
576 * Creates a new #GtkAppChooserButton for applications
577 * that can handle content of the given type.
579 * Returns: a newly created #GtkAppChooserButton
584 gtk_app_chooser_button_new (const gchar *content_type)
586 g_return_val_if_fail (content_type != NULL, NULL);
588 return g_object_new (GTK_TYPE_APP_CHOOSER_BUTTON,
589 "content-type", content_type,
594 * gtk_app_chooser_button_append_separator:
595 * @self: a #GtkAppChooserButton
597 * Appends a separator to the list of applications that is shown
603 gtk_app_chooser_button_append_separator (GtkAppChooserButton *self)
607 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
609 gtk_list_store_append (self->priv->store, &iter);
610 real_insert_separator (self, TRUE, &iter);
614 * gtk_app_chooser_button_append_custom_item:
615 * @self: a #GtkAppChooserButton
616 * @label: the label for the custom item
617 * @icon: the icon for the custom item
618 * @func: callback to call if the item is activated
619 * @user_data: user data for @func
621 * Appends a custom item to the list of applications that is shown
622 * in the popup. See also gtk_app_chooser_button_append_separator().
627 gtk_app_chooser_button_append_custom_item (GtkAppChooserButton *self,
630 GtkAppChooserButtonItemFunc func,
635 g_return_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self));
637 gtk_list_store_append (self->priv->store, &iter);
638 real_insert_custom_item (self, label, icon,
639 func, user_data, TRUE, &iter);
643 * gtk_app_chooser_button_get_show_dialog_item:
644 * @self: a #GtkAppChooserButton
646 * Returns the current value of the #GtkAppChooserButton:show-dialog-item
649 * Returns: the value of #GtkAppChooserButton:show-dialog-item
654 gtk_app_chooser_button_get_show_dialog_item (GtkAppChooserButton *self)
656 g_return_val_if_fail (GTK_IS_APP_CHOOSER_BUTTON (self), FALSE);
658 return self->priv->show_dialog_item;
662 * gtk_app_chooser_button_get_show_dialog_item:
663 * @self: a #GtkAppChooserButton
664 * @setting: the new value for #GtkAppChooserButton:show-dialog-item
666 * Sets whether the dropdown menu of this button should show an
667 * entry to trigger a #GtkAppChooserDialog.
672 gtk_app_chooser_button_set_show_dialog_item (GtkAppChooserButton *self,
675 if (self->priv->show_dialog_item != setting)
677 self->priv->show_dialog_item = setting;
679 g_object_notify (G_OBJECT (self), "show-dialog-item");
681 gtk_app_chooser_refresh (GTK_APP_CHOOSER (self));