/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/* e-shell-folder-selection-dialog.c
*
* Copyright (C) 2000, 2001 Ximian, Inc.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of version 2 of the GNU General Public
* License as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*
* Author: Ettore Perazzoli
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "e-shell-folder-selection-dialog.h"
#include "e-shell-constants.h"
#include "e-shell-marshal.h"
#include "e-storage-set-view.h"
#include "e-storage-set.h"
#include "e-shell-folder-creation-dialog.h"
#include <libgnome/gnome-i18n.h>
#include <gal/util/e-util.h>
#include <gal/widgets/e-scroll-frame.h>
#include <gal/widgets/e-gui-utils.h>
#include <gtk/gtksignal.h>
#include <gtk/gtklabel.h>
#include <string.h>
#define PARENT_TYPE (gtk_dialog_get_type ())
static GtkDialogClass *parent_class = NULL;
struct _EShellFolderSelectionDialogPrivate {
EShell *shell;
GList *allowed_types;
EStorageSet *storage_set;
GtkWidget *storage_set_view;
gboolean allow_creation;
};
enum {
FOLDER_SELECTED,
CANCELLED,
LAST_SIGNAL
};
static guint signals[LAST_SIGNAL] = { 0 };
/* Utility functions. */
static gboolean
check_folder_type_valid (EShellFolderSelectionDialog *folder_selection_dialog)
{
EShellFolderSelectionDialogPrivate *priv;
const char *selected_path;
EFolder *folder;
const char *folder_type;
GList *p;
priv = folder_selection_dialog->priv;
if (priv->allowed_types == NULL)
return TRUE;
selected_path = e_shell_folder_selection_dialog_get_selected_path (folder_selection_dialog);
if (selected_path == NULL)
return FALSE;
folder = e_storage_set_get_folder (priv->storage_set, selected_path);
if (folder == NULL)
return FALSE;
folder_type = e_folder_get_type_string (folder);
for (p = priv->allowed_types; p != NULL; p = p->next) {
const char *type, *slash;
type = (const char *) p->data;
if (strcasecmp (folder_type, type) == 0)
return TRUE;
slash = strchr (type, '/');
if (slash && slash[1] == '*' &&
g_strncasecmp (folder_type, type, slash - type) == 0)
return TRUE;
}
return FALSE;
}
static void
set_default_folder (EShellFolderSelectionDialog *shell_folder_selection_dialog,
const char *default_uri)
{
EShellFolderSelectionDialogPrivate *priv;
char *default_path;
g_assert (default_uri != NULL);
priv = shell_folder_selection_dialog->priv;
if (strncmp (default_uri, E_SHELL_URI_PREFIX, E_SHELL_URI_PREFIX_LEN) == 0) {
/* `evolution:' URI. */
default_path = g_strdup (default_uri + E_SHELL_URI_PREFIX_LEN);
} else {
/* Physical URI. */
default_path = e_storage_set_get_path_for_physical_uri (priv->storage_set,
default_uri);
}
e_storage_set_view_set_current_folder (E_STORAGE_SET_VIEW (priv->storage_set_view),
default_path);
g_free (default_path);
}
/* Folder creation dialog callback. */
static void
folder_creation_dialog_result_cb (EShell *shell,
EShellFolderCreationDialogResult result,
const char *path,
void *data)
{
EShellFolderSelectionDialog *dialog;
EShellFolderSelectionDialogPrivate *priv;
dialog = E_SHELL_FOLDER_SELECTION_DIALOG (data);
priv = dialog->priv;
if (priv == NULL) {
g_warning ("dialog->priv is NULL, and should not be");
return;
}
if (result == E_SHELL_FOLDER_CREATION_DIALOG_RESULT_SUCCESS)
e_storage_set_view_set_current_folder (E_STORAGE_SET_VIEW (priv->storage_set_view),
path);
}
/* GtkObject methods. */
/* Saves the expanded state of the tree to a common filename */
static void
save_expanded_state (EShellFolderSelectionDialog *folder_selection_dialog)
{
EShellFolderSelectionDialogPrivate *priv;
char *filename;
priv = folder_selection_dialog->priv;
filename = g_strdup_printf ("%s/config/storage-set-view-expanded:folder-selection-dialog",
e_shell_get_local_directory (priv->shell));
e_tree_save_expanded_state (E_TREE (priv->storage_set_view), filename);
g_free (filename);
}
static void
impl_dispose (GObject *object)
{
EShellFolderSelectionDialog *folder_selection_dialog;
EShellFolderSelectionDialogPrivate *priv;
folder_selection_dialog = E_SHELL_FOLDER_SELECTION_DIALOG (object);
priv = folder_selection_dialog->priv;
if (priv->storage_set != NULL) {
g_object_unref (priv->storage_set);
priv->storage_set = NULL;
}
(* G_OBJECT_CLASS (parent_class)->dispose) (object);
}
static void
impl_finalize (GObject *object)
{
EShellFolderSelectionDialog *folder_selection_dialog;
EShellFolderSelectionDialogPrivate *priv;
folder_selection_dialog = E_SHELL_FOLDER_SELECTION_DIALOG (object);
priv = folder_selection_dialog->priv;
save_expanded_state (folder_selection_dialog);
e_free_string_list (priv->allowed_types);
g_free (priv);
(* G_OBJECT_CLASS (parent_class)->finalize) (object);
}
/* GtkDialog methods. */
static void
impl_response (GtkDialog *dialog,
int response)
{
EShellFolderSelectionDialog *folder_selection_dialog;
EShellFolderSelectionDialogPrivate *priv;
EStorageSetView *storage_set_view;
const char *default_parent_folder;
const char *default_subtype;
char *default_type;
folder_selection_dialog = E_SHELL_FOLDER_SELECTION_DIALOG (dialog);
priv = folder_selection_dialog->priv;
switch (response) {
case GTK_RESPONSE_OK:
if (check_folder_type_valid (folder_selection_dialog)) {
g_signal_emit (folder_selection_dialog, signals[FOLDER_SELECTED], 0,
e_shell_folder_selection_dialog_get_selected_path (folder_selection_dialog));
gtk_widget_destroy (GTK_WIDGET (dialog));
}
break;
case GTK_RESPONSE_CANCEL:
g_signal_emit (folder_selection_dialog, signals[CANCELLED], 0);
gtk_widget_destroy (GTK_WIDGET (dialog));
break;
default: /* New... */
storage_set_view = E_STORAGE_SET_VIEW (priv->storage_set_view);
default_parent_folder = e_storage_set_view_get_current_folder (storage_set_view);
/* The default type in the folder creation dialog will be the
first of the allowed types. If all types are allowed,
hardcode to "mail". */
if (priv->allowed_types == NULL)
default_type = g_strdup ("mail");
else {
default_subtype = (const char *) priv->allowed_types->data;
default_type = g_strndup (default_subtype,
strcspn (default_subtype, "/"));
}
e_shell_show_folder_creation_dialog (priv->shell, GTK_WINDOW (dialog),
default_parent_folder,
default_type,
folder_creation_dialog_result_cb,
dialog);
g_free (default_type);
break;
}
}
/* GTK+ type initialization. */
static void
class_init (EShellFolderSelectionDialogClass *klass)
{
GObjectClass *object_class;
GtkDialogClass *dialog_class;
parent_class = gtk_type_class (PARENT_TYPE);
object_class = G_OBJECT_CLASS (klass);
dialog_class = GTK_DIALOG_CLASS (klass);
object_class->dispose = impl_dispose;
object_class->finalize = impl_finalize;
dialog_class->response = impl_response;
signals[FOLDER_SELECTED]
= gtk_signal_new ("folder_selected",
GTK_RUN_LAST,
GTK_CLASS_TYPE (object_class),
GTK_SIGNAL_OFFSET (EShellFolderSelectionDialogClass, folder_selected),
e_shell_marshal_NONE__STRING,
GTK_TYPE_NONE, 1,
GTK_TYPE_STRING);
signals[CANCELLED]
= gtk_signal_new ("cancelled",
GTK_RUN_LAST,
GTK_CLASS_TYPE (object_class),
GTK_SIGNAL_OFFSET (EShellFolderSelectionDialogClass, cancelled),
e_shell_marshal_NONE__NONE,
GTK_TYPE_NONE, 0);
}
static void
init (EShellFolderSelectionDialog *shell_folder_selection_dialog)
{
EShellFolderSelectionDialogPrivate *priv;
priv = g_new (EShellFolderSelectionDialogPrivate, 1);
priv->shell = NULL;
priv->storage_set = NULL;
priv->storage_set_view = NULL;
priv->allowed_types = NULL;
priv->allow_creation = TRUE;
shell_folder_selection_dialog->priv = priv;
}
/* ETable callbacks. */
static void
folder_selected_cb (EStorageSetView *storage_set_view,
const char *path,
void *data)
{
EShellFolderSelectionDialog *dialog;
dialog = E_SHELL_FOLDER_SELECTION_DIALOG (data);
if (check_folder_type_valid (dialog))
gtk_dialog_set_response_sensitive (GTK_DIALOG (dialog), GTK_RESPONSE_OK, TRUE);
else
gtk_dialog_set_response_sensitive (GTK_DIALOG (dialog), GTK_RESPONSE_OK, FALSE);
}
static gint
delete_event_cb (GtkWidget *w, GdkEvent *event, gpointer data)
{
EShellFolderSelectionDialog *dialog = data;
g_signal_emit (dialog, signals[CANCELLED], 0);
return TRUE;
}
static void
double_click_cb (EStorageSetView *essv,
int row,
ETreePath path,
int col,
GdkEvent *event,
EShellFolderSelectionDialog *folder_selection_dialog)
{
g_return_if_fail (folder_selection_dialog != NULL);
if (check_folder_type_valid (folder_selection_dialog)) {
g_signal_emit (folder_selection_dialog, signals[FOLDER_SELECTED], 0,
e_shell_folder_selection_dialog_get_selected_path (folder_selection_dialog));
gtk_widget_destroy (GTK_WIDGET (folder_selection_dialog));
}
}
/**
* e_shell_folder_selection_dialog_construct:
* @folder_selection_dialog: A folder selection dialog widget
* @shell: The this folder selection dialog is for
* @title: Title of the window
* @caption: A brief text to be put on top of the storage view
* @default_uri: The URI of the folder to be selected by default
* @allowed_types: List of the names of the allowed types
*
* Construct @folder_selection_dialog.
**/
void
e_shell_folder_selection_dialog_construct (EShellFolderSelectionDialog *folder_selection_dialog,
EShell *shell,
const char *title,
const char *caption,
const char *default_uri,
const char *allowed_types[],
gboolean allow_creation)
{
EShellFolderSelectionDialogPrivate *priv;
GtkWidget *scroll_frame;
GtkWidget *caption_label;
int i;
char *filename;
g_return_if_fail (folder_selection_dialog != NULL);
g_return_if_fail (E_IS_SHELL_FOLDER_SELECTION_DIALOG (folder_selection_dialog));
g_return_if_fail (shell != NULL);
g_return_if_fail (E_IS_SHELL (shell));
priv = folder_selection_dialog->priv;
/* Basic dialog setup. */
gtk_window_set_policy (GTK_WINDOW (folder_selection_dialog), FALSE, TRUE, FALSE);
gtk_window_set_default_size (GTK_WINDOW (folder_selection_dialog), 350, 300);
gtk_window_set_modal (GTK_WINDOW (folder_selection_dialog), TRUE);
gtk_window_set_title (GTK_WINDOW (folder_selection_dialog), title);
g_signal_connect (folder_selection_dialog, "delete_event",
G_CALLBACK (delete_event_cb), folder_selection_dialog);
gtk_dialog_add_buttons (GTK_DIALOG (folder_selection_dialog),
GTK_STOCK_OK, GTK_RESPONSE_OK,
GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
NULL);
if (allow_creation)
gtk_dialog_add_buttons (GTK_DIALOG (folder_selection_dialog),
GTK_STOCK_NEW, 1,
NULL);
gtk_dialog_set_response_sensitive (GTK_DIALOG (folder_selection_dialog), GTK_RESPONSE_OK, FALSE);
/* Make sure we get destroyed if the shell gets destroyed. */
priv->shell = shell;
g_object_weak_ref (G_OBJECT (shell), (GWeakNotify) gtk_widget_destroy, folder_selection_dialog);
/* Set up the label. */
if (caption != NULL) {
caption_label = gtk_label_new (caption);
gtk_widget_show (caption_label);
gtk_box_pack_start (GTK_BOX (GTK_DIALOG (folder_selection_dialog)->vbox),
caption_label, FALSE, TRUE, 2);
}
/* Set up the storage set and its view. */
priv->storage_set = e_shell_get_storage_set (shell);
g_object_ref (priv->storage_set);
priv->storage_set_view = e_storage_set_create_new_view (priv->storage_set, NULL);
e_storage_set_view_set_allow_dnd (E_STORAGE_SET_VIEW (priv->storage_set_view), FALSE);
e_storage_set_view_enable_search (E_STORAGE_SET_VIEW (priv->storage_set_view), TRUE);
/* Load the expanded state for this StorageSetView */
filename = g_strdup_printf ("%s/config/storage-set-view-expanded:folder-selection-dialog",
e_shell_get_local_directory (priv->shell));
e_tree_load_expanded_state (E_TREE (priv->storage_set_view),
filename);
g_free (filename);
g_signal_connect (priv->storage_set_view, "double_click", G_CALLBACK (double_click_cb), folder_selection_dialog);
g_signal_connect (priv->storage_set_view, "folder_selected", G_CALLBACK (folder_selected_cb), folder_selection_dialog);
g_assert (priv->allowed_types == NULL);
if (allowed_types != NULL) {
for (i = 0; allowed_types[i] != NULL; i++)
priv->allowed_types = g_list_prepend (priv->allowed_types,
g_strdup (allowed_types[i]));
/* Preserve the order so we can use the first type listed as
the default for the folder creation dialog invoked by the
"New..." button. */
priv->allowed_types = g_list_reverse (priv->allowed_types);
}
if (default_uri != NULL)
set_default_folder (folder_selection_dialog, default_uri);
scroll_frame = e_scroll_frame_new (NULL, NULL);
e_scroll_frame_set_shadow_type (E_SCROLL_FRAME (scroll_frame), GTK_SHADOW_IN);
e_scroll_frame_set_policy (E_SCROLL_FRAME (scroll_frame),
GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
gtk_container_add (GTK_CONTAINER (scroll_frame), priv->storage_set_view);
gtk_box_pack_start (GTK_BOX (GTK_DIALOG (folder_selection_dialog)->vbox),
scroll_frame, TRUE, TRUE, 2);
gtk_widget_show (priv->storage_set_view);
gtk_widget_show (scroll_frame);
GTK_WIDGET_SET_FLAGS (priv->storage_set_view, GTK_CAN_FOCUS);
gtk_widget_grab_focus (priv->storage_set_view);
}
/**
* e_shell_folder_selection_dialog_new:
* @shell: The this folder selection dialog is for
* @title: Title of the window
* @caption: A brief text to be put on top of the storage view
* @default_uri: The URI of the folder to be selected by default
* @allowed_types: List of the names of the allowed types
*
* Create a new folder selection dialog widget. @default_uri can be either an
* `evolution:' URI or a physical URI (all the non-`evolution:' URIs are
* considered to be physical URIs).
*
* Return value:
**/
GtkWidget *
e_shell_folder_selection_dialog_new (EShell *shell,
const char *title,
const char *caption,
const char *default_uri,
const char *allowed_types[],
gboolean allow_creation)
{
EShellFolderSelectionDialog *folder_selection_dialog;
g_return_val_if_fail (shell != NULL, NULL);
g_return_val_if_fail (E_IS_SHELL (shell), NULL);
folder_selection_dialog = g_object_new (e_shell_folder_selection_dialog_get_type (), NULL);
e_shell_folder_selection_dialog_construct (folder_selection_dialog, shell,
title, caption, default_uri, allowed_types,
allow_creation);
return GTK_WIDGET (folder_selection_dialog);
}
const char *
e_shell_folder_selection_dialog_get_selected_path (EShellFolderSelectionDialog *folder_selection_dialog)
{
EShellFolderSelectionDialogPrivate *priv;
g_return_val_if_fail (folder_selection_dialog != NULL, NULL);
g_return_val_if_fail (E_IS_SHELL_FOLDER_SELECTION_DIALOG (folder_selection_dialog), NULL);
priv = folder_selection_dialog->priv;
return e_storage_set_view_get_current_folder (E_STORAGE_SET_VIEW (priv->storage_set_view));
}
E_MAKE_TYPE (e_shell_folder_selection_dialog, "EShellFolderSelectionDialog", EShellFolderSelectionDialog,
class_init, init, PARENT_TYPE)