alexandria-book-collection-manager 0.6.9.pre1

data/lib/alexandria/ui/dndable.rb

@@ -0,0 +1,81 @@
+# Copyright (C) 2004-2006 Laurent Sansonetti
+# Copyright (C) 2008 Joseph Method
+#
+# Alexandria 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.
+#
+# Alexandria 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 Alexandria; see the file COPYING.  If not,
+# write to the Free Software Foundation, Inc., 51 Franklin Street,
+# Fifth Floor, Boston, MA 02110-1301 USA.
+
+module Alexandria
+  module UI
+    BOOKS_TARGET_TABLE = [['ALEXANDRIA_BOOKS', Gtk::Drag::TARGET_SAME_APP, 0]]
+
+    module DragAndDropable
+      BADGE_MARKUP = "<span weight=\"heavy\" foreground=\"white\">%d</span>"
+
+      def setup_view_source_dnd(view)
+        # better be Loggable!
+        log.info { 'setup_view_source_dnd for %s' % view }
+        view.signal_connect_after('drag-begin') do |_widget, drag_context|
+          n_books = @parent.selected_books.length
+          if n_books > 1
+            # Render generic book icon.
+            pixmap, mask = Icons::BOOK_ICON.render_pixmap_and_mask(255)
+
+            # Create number badge.
+            context = Gdk::Pango.context
+            layout = Pango::Layout.new(context)
+            layout.markup = BADGE_MARKUP % n_books
+            width, height = layout.pixel_size
+            x = Icons::BOOK_ICON.width - width - 11
+            y = Icons::BOOK_ICON.height - height - 11
+
+            # Draw a red ellipse where the badge number should be.
+            red_gc = Gdk::GC.new(pixmap)
+            red_gc.rgb_fg_color = Gdk::Color.parse('red')
+            red_gc.rgb_bg_color = Gdk::Color.parse('red')
+            pixmap.draw_arc(red_gc,
+                            true,
+                            x - 5, y - 2,
+                            width + 9, height + 4,
+                            0, 360 * 64)
+
+            # Draw the number badge.
+            pixmap.draw_layout(Gdk::GC.new(pixmap), x, y, layout)
+
+            # And set the drag icon.
+            Gtk::Drag.set_icon(drag_context,
+                               pixmap.colormap,
+                               pixmap,
+                               mask,
+                               10,
+                               10)
+          end
+        end
+
+        view.signal_connect('drag-data-get') do |_widget, _drag_context, selection_data, _info, _time|
+
+          idents = @parent.selected_books.map(&:ident)
+          unless idents.empty?
+            selection_data.set(Gdk::Selection::TYPE_STRING,
+                               idents.join(','))
+          end
+        end
+
+        view.enable_model_drag_source(Gdk::Window::BUTTON1_MASK,
+                                      Alexandria::UI::BOOKS_TARGET_TABLE,
+                                      Gdk::DragContext::ACTION_MOVE)
+      end
+    end
+  end
+end

data/lib/alexandria/ui/gtk_thread_help.rb

@@ -0,0 +1,88 @@
+# -*- ruby -*-
+#--
+# Copyright (C) 2010 Cathal Mc Ginley
+# Modifications Copyright (C) 2011 Matijs van Zuijlen
+#
+# This file is part of Alexandria, a GNOME book collection manager.
+#
+# Alexandria 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.
+#
+# Alexandria 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 Alexandria; see the file COPYING. If not, write to the Free
+# Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301 USA.
+#++
+
+# Taken from a tip on the ruby-gnome2 website
+# http://ruby-gnome2.sourceforge.jp/hiki.cgi?tips_threads
+
+# First, force all your your Ruby threads to start from within the
+# main loop using the standard Gtk.init method. You can call Gtk.init
+# as many times as necessary. For example:
+#
+# Gtk.init_add do
+#   DBus.start_listener
+#   false
+# end
+
+require 'gtk2'
+require 'monitor'
+
+module Gtk
+  GTK_PENDING_BLOCKS = []
+  GTK_PENDING_BLOCKS_LOCK = Monitor.new
+
+  def self.queue(&block)
+    if Thread.current == Thread.main
+      block.call
+    else
+      GTK_PENDING_BLOCKS_LOCK.synchronize do
+        GTK_PENDING_BLOCKS << block
+      end
+    end
+  end
+
+  # an optional addition from http://www.ruby-forum.com/topic/125038
+  # "I call Gtk.thread_flush right after killing a thread when I ever
+  # happen to need kill a thread" -- Mathieu Blondel
+
+  #     def self.thread_flush
+  #         if PENDING_CALLS_MUTEX.try_lock
+  #             for closure in PENDING_CALLS
+  #                 closure.call
+  #             end
+  #             PENDING_CALLS.clear
+  #             PENDING_CALLS_MUTEX.unlock
+  #         end
+  #     end
+
+  def self.main_with_queue(timeout = 100) # millis
+    Gtk.timeout_add(timeout) do
+      GTK_PENDING_BLOCKS_LOCK.synchronize do
+        for block in GTK_PENDING_BLOCKS
+          block.call
+        end
+        GTK_PENDING_BLOCKS.clear
+      end
+      true
+    end
+    Gtk.main
+  end
+end
+
+# Usage is very simple:
+
+# Start your Gtk application by calling Gtk.main_with_queue rather
+# than Gtk.main. The "timeout" argument is in milliseconds, and it is
+# the maximum time that can pass until queued blocks get called: 100
+# should be fine.
+
+# Whenever you need to queue a call, use Gtk.queue. For example:

data/lib/alexandria/ui/icons.rb

@@ -0,0 +1,100 @@
+# Copyright (C) 2004-2006 Laurent Sansonetti
+# Copyright (C) 2014 Matijs van Zuijlen
+#
+# Alexandria 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.
+#
+# Alexandria 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 Alexandria; see the file COPYING.  If not,
+# write to the Free Software Foundation, Inc., 51 Franklin Street,
+# Fifth Floor, Boston, MA 02110-1301 USA.
+
+class Gdk::Pixbuf
+  def tag(tag_pixbuf)
+    # Computes some tweaks.
+    tweak_x = tag_pixbuf.width / 3
+    tweak_y = tag_pixbuf.height / 3
+
+    # Creates the destination pixbuf.
+    new_pixbuf = Gdk::Pixbuf.new(Gdk::Pixbuf::COLORSPACE_RGB,
+                                 true,
+                                 8,
+                                 width + tweak_x,
+                                 height + tweak_y)
+
+    # Fills with blank.
+    new_pixbuf.fill!(0)
+
+    # Copies the current pixbuf there (south-west).
+    copy_area(0, 0,
+                   width, height,
+                   new_pixbuf,
+                   0, tweak_y)
+
+    # Copies the tag pixbuf there (north-est).
+    tag_pixbuf_x = width - (tweak_x * 2)
+    new_pixbuf.composite!(tag_pixbuf,
+                          0, 0,
+                          tag_pixbuf.width + tag_pixbuf_x,
+                          tag_pixbuf.height,
+                          tag_pixbuf_x, 0,
+                          1, 1,
+                          Gdk::Pixbuf::INTERP_HYPER, 255)
+    new_pixbuf
+  end
+end
+
+module Alexandria
+  module UI
+    module Icons
+      ICONS_DIR = File.join(Alexandria::Config::DATA_DIR, 'icons')
+      def self.init
+        load_icon_images
+      end
+
+      # loads icons from icons_dir location and gives them as uppercase constants to
+      # Alexandria::UI::Icons namespace, e.g., Icons::STAR_SET
+      def self.load_icon_images
+        Dir.entries(ICONS_DIR).each do |file|
+          next unless file =~ /\.png$/    # skip non '.png' files
+          # Don't use upcase and use tr instead
+          # For example in Turkish the upper case of 'i' is still 'i'.
+          name = File.basename(file, '.png').tr('a-z', 'A-Z')
+          const_set(name, Gdk::Pixbuf.new(File.join(ICONS_DIR, file)))
+        end
+      end
+
+      def self.cover(library, book)
+        begin
+          return BOOK_ICON if library.nil?
+          filename = library.cover(book)
+          if File.exist?(filename)
+            return Gdk::Pixbuf.new(filename)
+          end
+        rescue => err
+          # report load error; FIX should go to a Logger...
+          puts err.message
+          puts err.backtrace.join("\n> ")
+          puts "Failed to load Gdk::Pixbuf, please ensure that from #{filename} is a valid image file"
+        end
+        BOOK_ICON
+      end
+
+      def self.blank?(filename)
+        pixbuf = Gdk::Pixbuf.new(filename)
+        pixbuf.width == 1 and pixbuf.height == 1
+      rescue => err
+        puts err.message
+        puts err.backtrace.join("\n> ")
+        true
+      end
+    end
+  end
+end

data/lib/alexandria/ui/iconview.rb

@@ -0,0 +1,91 @@
+# Copyright (C) 2004-2006 Laurent Sansonetti
+# Copyright (C) 2008 Joseph Method
+#
+# Alexandria 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.
+#
+# Alexandria 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 Alexandria; see the file COPYING.  If not,
+# write to the Free Software Foundation, Inc., 51 Franklin Street,
+# Fifth Floor, Boston, MA 02110-1301 USA.
+
+require 'alexandria/ui/iconview_tooltips'
+
+module Alexandria
+  module UI
+    module Columns
+      COVER_LIST, COVER_ICON, TITLE, TITLE_REDUCED, AUTHORS,
+        ISBN, PUBLISHER, PUBLISH_DATE, EDITION, RATING, IDENT,
+        NOTES, REDD, OWN, WANT, TAGS = (0..16).to_a
+    end
+
+    class IconViewManager
+      ICON_WIDTH = 60
+      include Logging
+      include GetText
+      include DragAndDropable
+      def initialize(_iconview, parent)
+        @parent = parent
+        @iconview = @parent.iconview
+        @tooltips = IconViewTooltips.new(@iconview)
+        @iconview_model = @parent.iconview_model
+        @filtered_model = @parent.filtered_model
+        @actiongroup = @parent.actiongroup
+        setup_books_iconview
+      end
+
+      def setup_books_iconview
+        log.info { "setup_books_iconview #{@iconview_model.inspect}" }
+        @iconview.model = @iconview_model
+        log.info { "now @iconview.model = #{@iconview.model.inspect}" }
+        @iconview.selection_mode = Gtk::SELECTION_MULTIPLE
+        @iconview.text_column = Columns::TITLE_REDUCED
+        @iconview.pixbuf_column = Columns::COVER_ICON
+        @iconview.orientation = Gtk::ORIENTATION_VERTICAL
+        @iconview.row_spacing = 4
+        @iconview.column_spacing = 16
+        @iconview.item_width = ICON_WIDTH + 16
+
+        @iconview.signal_connect('selection-changed') do
+          log.debug { 'selection-changed' }
+          @tooltips.hide_tooltip
+          @parent.on_books_selection_changed
+        end
+
+        @iconview.signal_connect('item-activated') do
+          log.debug { 'item-activated' }
+          # Dirty hack to avoid the beginning of a drag within this
+          # handler.
+          @tooltips.hide_tooltip
+          Gtk.timeout_add(100) do
+            @actiongroup['Properties'].activate
+            false
+          end
+        end
+
+        # DND support for Gtk::IconView is shipped since GTK+ 2.8.0.
+        if @iconview.respond_to?(:enable_model_drag_source)
+          setup_view_source_dnd(@iconview)
+        end
+      end
+
+      ICONS_SORTS = [
+        Columns::TITLE, Columns::AUTHORS, Columns::ISBN,
+        Columns::PUBLISHER, Columns::EDITION, Columns::RATING, Columns::REDD, Columns::OWN, Columns::WANT
+      ]
+      def setup_books_iconview_sorting
+        mode = ICONS_SORTS[@prefs.arrange_icons_mode]
+        @iconview_model.set_sort_column_id(mode,
+                                           @prefs.reverse_icons ? Gtk::SORT_DESCENDING : Gtk::SORT_ASCENDING)
+        @filtered_model.refilter    # force redraw
+      end
+    end
+  end
+end

data/lib/alexandria/ui/iconview_tooltips.rb

@@ -0,0 +1,162 @@
+# -*- ruby -*-
+#
+# Copyright (C) 2007 kksou
+# Copyright (C) 2008,2009 Cathal Mc Ginley
+# Modifications Copyright (C) 2011 Matijs van Zuijlen
+#
+# Alexandria 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.
+#
+# Alexandria 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 Alexandria; see the file COPYING.  If not,
+# write to the Free Software Foundation, Inc., 51 Franklin Street,
+# Fifth Floor, Boston, MA 02110-1301 USA.
+
+# Please retain the following note:
+#
+# Based upon Recipe 168 - "How to display tooltips in GtkTreeView - Part 3"
+# from the "php-gtk2 Cookbook" website, by kksou.
+# http://www.kksou.com/php-gtk2/articles/display-tooltips-in-GtkTreeView---Part-3---no-hardcoding-of-header-height.php
+#
+# Ported to ruby-gtk2 (and modified for IconView) by Cathal Mc Ginley
+
+require 'cgi'
+
+class IconViewTooltips
+  include Alexandria::Logging
+
+  def initialize(view)
+    @tooltip_window = Gtk::Window.new(Gtk::Window::POPUP)
+    @tooltip_window.name = 'gtk-tooltips'
+    @tooltip_window.resizable = false
+    @tooltip_window.border_width = 4
+    @tooltip_window.app_paintable = true
+
+    @tooltip_window.signal_connect('expose_event') { |window, event|
+      on_expose(window, event) }
+
+    @tooltip_window.signal_connect('leave_notify_event') { |vw, event|
+      on_leave(vw, event) }
+
+    @label = Gtk::Label.new('')
+    @label.wrap = true
+    @label.set_alignment(0.5, 0.5)
+    @label.use_markup = true
+    @label.show
+
+    @tooltip_window.add(@label)
+    set_view(view)
+  end
+
+  def set_view(view)
+    view.signal_connect('motion_notify_event') { |vw, event|
+      on_motion(vw, event) }
+    view.signal_connect('leave_notify_event') { |vw, event|
+      on_leave(vw, event) }
+  end
+
+  def on_expose(window, _event)
+    # this paints a nice outline around the label
+    size = window.size_request
+    window.style.paint_flat_box(window.window,
+                                Gtk::STATE_NORMAL,
+                                Gtk::SHADOW_OUT,
+                                nil,
+                                @tooltip_window,
+                                'tooltip',
+                                0, 0, size[0], size[1])
+    # must return nil so the label contents get drawn correctly
+    nil
+  end
+
+  def label_for_book(title, authors, publisher, year)
+    # This is much too complex... but it works for now!
+    html = ''
+    if title.size > 0
+      html += "<b>#{CGI.escapeHTML(title)}</b>"
+      if authors.size > 0
+        html += "\n"
+      end
+    end
+    if authors.size > 0
+      html += "<i>#{CGI.escapeHTML(authors)}</i>"
+    end
+    if (title.size > 0) or (authors.size > 0)
+      html += "\n"
+    end
+
+    html += '<small>'
+    if publisher and publisher.size > 0
+      html += "#{CGI.escapeHTML(publisher)}"
+    end
+
+    if year and year.size > 0
+      if publisher and publisher.size > 0
+        html += ' '
+      end
+      html += "(#{year})"
+    end
+
+    html + '</small>'
+  end
+
+  def on_motion(view, event)
+    tree_path = view.get_path(event.x, event.y)
+    # TODO translate path a few times, for sorting & filtering...
+    # hmmm, actually seems to work. Report a bug if you can spot a failure
+    if tree_path
+      iter = view.model.get_iter(tree_path)
+      if @latest_iter.nil?
+        @latest_iter = iter
+
+        @tooltip_timeout_id = Gtk.timeout_add(250) do
+          if @latest_iter == iter
+
+            title = iter[2] # HACK hardcoded, should use column names...
+            authors = iter[4]
+            publisher = iter[6]
+            year = iter[7]
+            @label.markup = label_for_book(title, authors, publisher, year)
+            ## "<b>#{title}</b>\n<i>#{authors}</i>\n<small>#{publisher} <i>(#{year})</i></small>"
+            size = @tooltip_window.size_request
+            @tooltip_window.move(event.x_root - size[0],
+                                 event.y_root + 12)
+            @tooltip_window.show
+            # don't run again
+            false
+          else
+            @tooltip_timeout_id = nil
+          end
+        end
+
+      elsif @latest_iter != iter
+        hide_tooltip
+      end
+
+    else
+      hide_tooltip
+    end
+  end
+
+  def hide_tooltip
+    unless @tooltip_window.nil?
+      @tooltip_window.hide
+      if @tooltip_timeout_id
+        Gtk.timeout_remove(@tooltip_timeout_id)
+        @tooltip_timeout_id = nil
+      end
+      @latest_iter = nil
+    end
+  end
+
+  def on_leave(_view, _event)
+    @tooltip_window.hide
+  end
+end