diff options
Diffstat (limited to 'src/caja-notes-viewer.c')
| -rw-r--r-- | src/caja-notes-viewer.c | 535 |
1 files changed, 535 insertions, 0 deletions
diff --git a/src/caja-notes-viewer.c b/src/caja-notes-viewer.c new file mode 100644 index 00000000..0ae29348 --- /dev/null +++ b/src/caja-notes-viewer.c @@ -0,0 +1,535 @@ +/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 8 -*- */ + +/* + * Caja + * + * Copyright (C) 2000, 2001 Eazel, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License as + * published by the Free Software Foundation; either version 2 of the + * License, or (at your option) any later version. + * + * This library 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 library; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + * + * Author: Andy Hertzfeld <[email protected]> + * + */ + +/* notes sidebar panel -- allows editing per-directory notes */ + +#include <config.h> + +#include "caja-notes-viewer.h" + +#include <eel/eel-debug.h> +#include <eel/eel-gtk-extensions.h> +#include <eel/eel-string.h> +#include <gtk/gtk.h> +#include <glib/gi18n.h> +#include <libcaja-private/caja-file-attributes.h> +#include <libcaja-private/caja-file.h> +#include <libcaja-private/caja-file-utilities.h> +#include <libcaja-private/caja-global-preferences.h> +#include <libcaja-private/caja-metadata.h> +#include <libcaja-private/caja-clipboard.h> +#include <libcaja-private/caja-module.h> +#include <libcaja-private/caja-sidebar-provider.h> +#include <libcaja-private/caja-window-info.h> +#include <libcaja-private/caja-window-slot-info.h> +#include <libcaja-extension/caja-property-page-provider.h> + +#define SAVE_TIMEOUT 3 + +static void load_note_text_from_metadata (CajaFile *file, + CajaNotesViewer *notes); +static void notes_save_metainfo (CajaNotesViewer *notes); +static void caja_notes_viewer_sidebar_iface_init (CajaSidebarIface *iface); +static void on_changed (GtkEditable *editable, + CajaNotesViewer *notes); +static void property_page_provider_iface_init (CajaPropertyPageProviderIface *iface); +static void sidebar_provider_iface_init (CajaSidebarProviderIface *iface); + +typedef struct +{ + GtkScrolledWindowClass parent; +} CajaNotesViewerClass; + +typedef struct +{ + GObject parent; +} CajaNotesViewerProvider; + +typedef struct +{ + GObjectClass parent; +} CajaNotesViewerProviderClass; + + +G_DEFINE_TYPE_WITH_CODE (CajaNotesViewer, caja_notes_viewer, GTK_TYPE_SCROLLED_WINDOW, + G_IMPLEMENT_INTERFACE (CAJA_TYPE_SIDEBAR, + caja_notes_viewer_sidebar_iface_init)); + +static GType caja_notes_viewer_provider_get_type (void); + +G_DEFINE_TYPE_WITH_CODE (CajaNotesViewerProvider, caja_notes_viewer_provider, G_TYPE_OBJECT, + G_IMPLEMENT_INTERFACE (CAJA_TYPE_PROPERTY_PAGE_PROVIDER, + property_page_provider_iface_init); + G_IMPLEMENT_INTERFACE (CAJA_TYPE_SIDEBAR_PROVIDER, + sidebar_provider_iface_init)); + + +struct _CajaNotesViewerDetails +{ + GtkWidget *note_text_field; + GtkTextBuffer *text_buffer; + char *uri; + CajaFile *file; + guint save_timeout_id; + char *previous_saved_text; + GdkPixbuf *icon; +}; + +static gboolean +schedule_save_callback (gpointer data) +{ + CajaNotesViewer *notes; + + notes = data; + + /* Zero out save_timeout_id so no one will try to cancel our + * in-progress timeout callback. + */ + notes->details->save_timeout_id = 0; + + notes_save_metainfo (notes); + + return FALSE; +} + +static void +cancel_pending_save (CajaNotesViewer *notes) +{ + if (notes->details->save_timeout_id != 0) + { + g_source_remove (notes->details->save_timeout_id); + notes->details->save_timeout_id = 0; + } +} + +static void +schedule_save (CajaNotesViewer *notes) +{ + cancel_pending_save (notes); + + notes->details->save_timeout_id = g_timeout_add_seconds (SAVE_TIMEOUT, schedule_save_callback, notes); +} + +/* notifies event listeners if the notes data actually changed */ +static void +set_saved_text (CajaNotesViewer *notes, char *new_notes) +{ + char *old_text; + + old_text = notes->details->previous_saved_text; + notes->details->previous_saved_text = new_notes; + + if (eel_strcmp (old_text, new_notes) != 0) + { + g_signal_emit_by_name (CAJA_SIDEBAR (notes), + "tab_icon_changed"); + } + + g_free (old_text); +} + +/* save the metainfo corresponding to the current uri, if any, into the text field */ +static void +notes_save_metainfo (CajaNotesViewer *notes) +{ + char *notes_text; + GtkTextIter start_iter; + GtkTextIter end_iter; + + if (notes->details->file == NULL) + { + return; + } + + cancel_pending_save (notes); + + /* Block the handler, so we don't respond to our own change. + */ + g_signal_handlers_block_matched (notes->details->file, + G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA, + 0, 0, NULL, + G_CALLBACK (load_note_text_from_metadata), + notes); + + gtk_text_buffer_get_start_iter (notes->details->text_buffer, &start_iter); + gtk_text_buffer_get_end_iter (notes->details->text_buffer, &end_iter); + notes_text = gtk_text_buffer_get_text (notes->details->text_buffer, + &start_iter, + &end_iter, + FALSE); + + caja_file_set_metadata (notes->details->file, + CAJA_METADATA_KEY_ANNOTATION, + NULL, notes_text); + + g_signal_handlers_unblock_matched (notes->details->file, + G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA, + 0, 0, NULL, + G_CALLBACK (load_note_text_from_metadata), + notes); + + set_saved_text (notes, notes_text); +} + +static void +load_note_text_from_metadata (CajaFile *file, + CajaNotesViewer *notes) +{ + char *saved_text; + + g_assert (CAJA_IS_FILE (file)); + g_assert (notes->details->file == file); + + saved_text = caja_file_get_metadata (file, CAJA_METADATA_KEY_ANNOTATION, ""); + + /* This fn is called for any change signal on the file, so make sure that the + * metadata has actually changed. + */ + if (eel_strcmp (saved_text, notes->details->previous_saved_text) != 0) + { + set_saved_text (notes, saved_text); + cancel_pending_save (notes); + + /* Block the handler, so we don't respond to our own change. + */ + g_signal_handlers_block_matched (notes->details->text_buffer, + G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA, + 0, 0, NULL, + G_CALLBACK (on_changed), + notes); + gtk_text_buffer_set_text (notes->details->text_buffer, saved_text, -1); + g_signal_handlers_unblock_matched (notes->details->text_buffer, + G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA, + 0, 0, NULL, + G_CALLBACK (on_changed), + notes); + } + else + { + g_free (saved_text); + } +} + +static void +done_with_file (CajaNotesViewer *notes) +{ + cancel_pending_save (notes); + + if (notes->details->file != NULL) + { + caja_file_monitor_remove (notes->details->file, notes); + g_signal_handlers_disconnect_matched (notes->details->file, + G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA, + 0, 0, NULL, + G_CALLBACK (load_note_text_from_metadata), + notes); + caja_file_unref (notes->details->file); + } +} + +static void +notes_load_metainfo (CajaNotesViewer *notes) +{ + CajaFileAttributes attributes; + + done_with_file (notes); + notes->details->file = caja_file_get_by_uri (notes->details->uri); + + /* Block the handler, so we don't respond to our own change. + */ + g_signal_handlers_block_matched (notes->details->text_buffer, + G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA, + 0, 0, NULL, + G_CALLBACK (on_changed), + notes); + gtk_text_buffer_set_text (notes->details->text_buffer, "", -1); + g_signal_handlers_unblock_matched (notes->details->text_buffer, + G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA, + 0, 0, NULL, + G_CALLBACK (on_changed), + notes); + + if (notes->details->file == NULL) + { + return; + } + + attributes = CAJA_FILE_ATTRIBUTE_INFO; + caja_file_monitor_add (notes->details->file, notes, attributes); + + if (caja_file_check_if_ready (notes->details->file, attributes)) + { + load_note_text_from_metadata (notes->details->file, notes); + } + + g_signal_connect (notes->details->file, "changed", + G_CALLBACK (load_note_text_from_metadata), notes); +} + +static void +loading_uri_callback (CajaWindowInfo *window, + const char *location, + CajaNotesViewer *notes) +{ + if (strcmp (notes->details->uri, location) != 0) + { + notes_save_metainfo (notes); + g_free (notes->details->uri); + notes->details->uri = g_strdup (location); + notes_load_metainfo (notes); + } +} + +static gboolean +on_text_field_focus_out_event (GtkWidget *widget, + GdkEventFocus *event, + gpointer callback_data) +{ + CajaNotesViewer *notes; + + notes = callback_data; + notes_save_metainfo (notes); + return FALSE; +} + +static void +on_changed (GtkEditable *editable, CajaNotesViewer *notes) +{ + schedule_save (notes); +} + +static void +caja_notes_viewer_init (CajaNotesViewer *sidebar) +{ + CajaNotesViewerDetails *details; + CajaIconInfo *info; + + details = g_new0 (CajaNotesViewerDetails, 1); + sidebar->details = details; + + details->uri = g_strdup (""); + + info = caja_icon_info_lookup_from_name ("emblem-note", 16); + details->icon = caja_icon_info_get_pixbuf (info); + + /* create the text container */ + details->text_buffer = gtk_text_buffer_new (NULL); + details->note_text_field = gtk_text_view_new_with_buffer (details->text_buffer); + + gtk_text_view_set_editable (GTK_TEXT_VIEW (details->note_text_field), TRUE); + gtk_text_view_set_wrap_mode (GTK_TEXT_VIEW (details->note_text_field), + GTK_WRAP_WORD); + gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (sidebar), + GTK_POLICY_AUTOMATIC, + GTK_POLICY_AUTOMATIC); + gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (sidebar), + GTK_SHADOW_IN); + gtk_scrolled_window_set_hadjustment (GTK_SCROLLED_WINDOW (sidebar), NULL); + gtk_scrolled_window_set_vadjustment (GTK_SCROLLED_WINDOW (sidebar), NULL); + gtk_container_add (GTK_CONTAINER (sidebar), details->note_text_field); + + g_signal_connect (details->note_text_field, "focus_out_event", + G_CALLBACK (on_text_field_focus_out_event), sidebar); + g_signal_connect (details->text_buffer, "changed", + G_CALLBACK (on_changed), sidebar); + + gtk_widget_show_all (GTK_WIDGET (sidebar)); + +} + +static void +caja_notes_viewer_finalize (GObject *object) +{ + CajaNotesViewer *sidebar; + + sidebar = CAJA_NOTES_VIEWER (object); + + done_with_file (sidebar); + if (sidebar->details->icon != NULL) + { + g_object_unref (sidebar->details->icon); + } + g_free (sidebar->details->uri); + g_free (sidebar->details->previous_saved_text); + g_free (sidebar->details); + + G_OBJECT_CLASS (caja_notes_viewer_parent_class)->finalize (object); +} + + +static void +caja_notes_viewer_class_init (CajaNotesViewerClass *class) +{ + G_OBJECT_CLASS (class)->finalize = caja_notes_viewer_finalize; +} + +static const char * +caja_notes_viewer_get_sidebar_id (CajaSidebar *sidebar) +{ + return CAJA_NOTES_SIDEBAR_ID; +} + +static char * +caja_notes_viewer_get_tab_label (CajaSidebar *sidebar) +{ + return g_strdup (_("Notes")); +} + +static char * +caja_notes_viewer_get_tab_tooltip (CajaSidebar *sidebar) +{ + return g_strdup (_("Show Notes")); +} + +static GdkPixbuf * +caja_notes_viewer_get_tab_icon (CajaSidebar *sidebar) +{ + CajaNotesViewer *notes; + + notes = CAJA_NOTES_VIEWER (sidebar); + + if (notes->details->previous_saved_text != NULL && + notes->details->previous_saved_text[0] != '\0') + { + return g_object_ref (notes->details->icon); + } + + return NULL; +} + +static void +caja_notes_viewer_is_visible_changed (CajaSidebar *sidebar, + gboolean is_visible) +{ + /* Do nothing */ +} + +static void +caja_notes_viewer_sidebar_iface_init (CajaSidebarIface *iface) +{ + iface->get_sidebar_id = caja_notes_viewer_get_sidebar_id; + iface->get_tab_label = caja_notes_viewer_get_tab_label; + iface->get_tab_tooltip = caja_notes_viewer_get_tab_tooltip; + iface->get_tab_icon = caja_notes_viewer_get_tab_icon; + iface->is_visible_changed = caja_notes_viewer_is_visible_changed; +} + +static void +caja_notes_viewer_set_parent_window (CajaNotesViewer *sidebar, + CajaWindowInfo *window) +{ + CajaWindowSlotInfo *slot; + + slot = caja_window_info_get_active_slot (window); + + g_signal_connect_object (window, "loading_uri", + G_CALLBACK (loading_uri_callback), sidebar, 0); + + g_free (sidebar->details->uri); + sidebar->details->uri = caja_window_slot_info_get_current_location (slot); + notes_load_metainfo (sidebar); + + caja_clipboard_set_up_text_view + (GTK_TEXT_VIEW (sidebar->details->note_text_field), + caja_window_info_get_ui_manager (window)); +} + +static CajaSidebar * +caja_notes_viewer_create_sidebar (CajaSidebarProvider *provider, + CajaWindowInfo *window) +{ + CajaNotesViewer *sidebar; + + sidebar = g_object_new (caja_notes_viewer_get_type (), NULL); + caja_notes_viewer_set_parent_window (sidebar, window); + g_object_ref_sink (sidebar); + + return CAJA_SIDEBAR (sidebar); +} + +static GList * +get_property_pages (CajaPropertyPageProvider *provider, + GList *files) +{ + GList *pages; + CajaPropertyPage *page; + CajaFileInfo *file; + char *uri; + CajaNotesViewer *viewer; + + + /* Only show the property page if 1 file is selected */ + if (!files || files->next != NULL) + { + return NULL; + } + + pages = NULL; + + file = CAJA_FILE_INFO (files->data); + uri = caja_file_info_get_uri (file); + + viewer = g_object_new (caja_notes_viewer_get_type (), NULL); + g_free (viewer->details->uri); + viewer->details->uri = uri; + notes_load_metainfo (viewer); + + page = caja_property_page_new + ("CajaNotesViewer::property_page", + gtk_label_new (_("Notes")), + GTK_WIDGET (viewer)); + pages = g_list_append (pages, page); + + return pages; +} + +static void +property_page_provider_iface_init (CajaPropertyPageProviderIface *iface) +{ + iface->get_pages = get_property_pages; +} + +static void +sidebar_provider_iface_init (CajaSidebarProviderIface *iface) +{ + iface->create = caja_notes_viewer_create_sidebar; +} + +static void +caja_notes_viewer_provider_init (CajaNotesViewerProvider *sidebar) +{ +} + +static void +caja_notes_viewer_provider_class_init (CajaNotesViewerProviderClass *class) +{ +} + +void +caja_notes_viewer_register (void) +{ + caja_module_add_type (caja_notes_viewer_provider_get_type ()); +} + |