alexandria-book-collection-manager 0.6.9.pre1

data/lib/alexandria/ui/init.rb

@@ -0,0 +1,93 @@
+# Copyright (C) 2004-2006 Laurent Sansonetti
+# Copyright (C) 2008 Joseph Method
+# 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.
+
+class CellRendererToggle < Gtk::CellRendererToggle
+  attr_accessor :text
+  type_register
+  install_property(GLib::Param::String.new(
+        'text',
+        'text',
+        'Some damn value',
+        '',
+        GLib::Param::READABLE | GLib::Param::WRITABLE))
+end
+
+class Gtk::ActionGroup
+  def [](x)
+    get_action(x)
+  end
+end
+
+class Gtk::IconView
+  def freeze
+    @old_model = model
+    self.model = nil
+  end
+
+  def unfreeze
+    self.model = @old_model
+  end
+end
+
+class Gtk::TreeView
+  def freeze
+    @old_model = model
+    self.model = nil
+  end
+
+  def unfreeze
+    self.model = @old_model
+  end
+end
+
+class Alexandria::Library
+  def action_name
+    'MoveIn' + name.gsub(/\s/, '')
+  end
+end
+
+class Alexandria::BookProviders::AbstractProvider
+  def action_name
+    'At' + name
+  end
+end
+
+module Pango
+  def self.ellipsizable?
+    @ellipsizable ||= Pango.constants.include?('ELLIPSIZE_END')
+  end
+end
+
+module Alexandria
+  module UI
+    def self.display_help(parent = nil, section = nil)
+      section_index = ''
+      if section
+        section_index = "##{section}"
+      end
+      exec("gnome-help ghelp:alexandria#{section_index}") if fork.nil?
+    rescue
+      log.error(self) { 'Unable to load help browser' }
+      ErrorDialog.new(parent, _('Unable to launch the help browser'),
+                      _('Could not display help for Alexandria. ' \
+                        'There was an error launching the system ' \
+                        'help browser.'))
+    end
+  end
+end

data/lib/alexandria/ui/libraries_combo.rb

@@ -0,0 +1,75 @@
+# Copyright (C) 2004-2006 Laurent Sansonetti
+#
+# 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.
+
+# Ideally this would be a subclass of GtkComboBox, but...
+class Gtk::ComboBox
+  include GetText
+  extend GetText
+  GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: 'UTF-8')
+
+  def populate_with_libraries(libraries, selected_library)
+    libraries_names = libraries.map(&:name)
+    if selected_library
+      libraries_names.delete selected_library.name
+      libraries_names.unshift selected_library.name
+    end
+    clear
+    set_row_separator_func do |_model, iter|
+      iter[1] == '-'
+    end
+    self.model = Gtk::ListStore.new(Gdk::Pixbuf, String, TrueClass)
+    libraries_names.each do |library_name|
+      iter = model.append
+      iter[0] = Alexandria::UI::Icons::LIBRARY_SMALL
+      iter[1] = library_name
+      iter[2] = false
+    end
+    model.append[1] = '-'
+    iter = model.append
+    iter[0] = Alexandria::UI::Icons::LIBRARY_SMALL
+    iter[1] = _('New Library')
+    iter[2] = true
+    renderer = Gtk::CellRendererPixbuf.new
+    pack_start(renderer, false)
+    set_attributes(renderer, pixbuf: 0)
+    renderer = Gtk::CellRendererText.new
+    pack_start(renderer, true)
+    set_attributes(renderer, text: 1)
+    self.active = 0
+    # self.sensitive = libraries.length > 1
+    # This prohibits us from adding a "New Library" from this combo
+    # when we only have a single library
+  end
+
+  def selection_from_libraries(libraries)
+    iter = active_iter
+    is_new = false
+    library = nil
+    if iter[2]
+      name = Alexandria::Library.generate_new_name(libraries)
+      library = Alexandria::Library.load(name)
+      libraries << library
+      is_new = true
+    else
+      library = libraries.find do |x|
+        x.name == active_iter[1]
+      end
+    end
+    raise unless library
+    [library, is_new]
+  end
+end

data/lib/alexandria/ui/listview.rb

@@ -0,0 +1,310 @@
+# Copyright (C) 2004-2006 Laurent Sansonetti
+# Copyright (C) 2008 Joseph Method
+# Copyright (C) 2010 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 aso
+# 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
+    include Logging
+    include GetText
+    GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: 'UTF-8')
+    class ListViewManager
+      include Logging
+      include GetText
+      include DragAndDropable
+      BOOKS_TARGET_TABLE = [['ALEXANDRIA_BOOKS', Gtk::Drag::TARGET_SAME_APP, 0]]
+
+      MAX_RATING_STARS = 5
+      module Columns
+        COVER_LIST, COVER_ICON, TITLE, TITLE_REDUCED, AUTHORS,
+          ISBN, PUBLISHER, PUBLISH_DATE, EDITION, RATING, IDENT,
+          NOTES, REDD, OWN, WANT, TAGS, LOANED_TO = (0..17).to_a
+      end
+
+      def initialize(_listview, parent)
+        @parent = parent
+        @prefs = @parent.prefs
+        @listview = @parent.listview
+        @listview_model = @parent.listview_model
+        @filtered_model = @parent.filtered_model
+        @model = @parent.model
+        @actiongroup = @parent.actiongroup
+        setup_books_listview
+      end
+
+      def setup_title_column
+        title = _('Title')
+        log.debug { 'Create listview column for %s' % title }
+        column = Gtk::TreeViewColumn.new(title)
+        column.widget = Gtk::Label.new(title).show
+        renderer = Gtk::CellRendererPixbuf.new
+        column.pack_start(renderer, false)
+        column.set_cell_data_func(renderer) do |_col, cell, _model, iter|
+          iter = @listview_model.convert_iter_to_child_iter(iter)
+          iter = @filtered_model.convert_iter_to_child_iter(iter)
+          cell.pixbuf = iter[Columns::COVER_LIST]
+        end
+        renderer = Gtk::CellRendererText.new
+        renderer.ellipsize = Pango::ELLIPSIZE_END if Pango.ellipsizable?
+        # Editable tree views are behaving strangely
+        # make_renderer_editable renderer
+
+        column.pack_start(renderer, true)
+
+        column.set_cell_data_func(renderer) do |_col, cell, _model, iter|
+          iter = @listview_model.convert_iter_to_child_iter(iter)
+          iter = @filtered_model.convert_iter_to_child_iter(iter)
+          cell.text, cell.editable = iter[Columns::TITLE], false # true
+        end
+
+        column.sort_column_id = Columns::TITLE
+        column.resizable = true
+        @listview.append_column(column)
+      end
+
+      def make_renderer_editable(renderer)
+        renderer.signal_connect('editing_started') do |_cell, entry, _path_string|
+          log.debug { 'editing_started' }
+          entry.complete_titles
+        end
+
+        renderer.signal_connect('edited') do |_cell, path_string, new_string|
+          log.debug { 'edited' }
+          path = Gtk::TreePath.new(path_string)
+          path = @listview_model.convert_path_to_child_path(path)
+          path = @filtered_model.convert_path_to_child_path(path)
+          iter = @listview.model.get_iter(path)
+          book = @parent.book_from_iter(@parent.selected_library, iter)
+          book.title = new_string
+          @listview.freeze
+          @iconview.freeze
+          @parent.fill_iter_with_book(iter, book)
+          @iconview.unfreeze
+          @listview.unfreeze
+        end
+      end
+
+      TEXT_COLUMNS = [
+        [_('Authors'), Columns::AUTHORS],
+        [_('ISBN'), Columns::ISBN],
+        [_('Publisher'), Columns::PUBLISHER],
+        [_('Publish Year'), Columns::PUBLISH_DATE],
+        [_('Binding'), Columns::EDITION],
+        [_('Loaned To'), Columns::LOANED_TO]
+      ]
+      CHECK_COLUMNS = [
+        [_('Read'), Columns::REDD],
+        [_('Own'), Columns::OWN],
+        [_('Want'), Columns::WANT]
+      ]
+
+      def setup_books_listview
+        log.debug { 'setup_books_listview' }
+        @listview.model = @listview_model
+        setup_title_column
+        TEXT_COLUMNS.each do |title, iterid|
+          setup_text_column title, iterid
+        end
+        CHECK_COLUMNS.each do |title, iterid|
+          setup_check_column title, iterid
+        end
+        setup_rating_column
+        @listview.selection.mode = Gtk::SELECTION_MULTIPLE
+        @listview.selection.signal_connect('changed') do
+          log.debug { 'changed' }
+          @parent.on_books_selection_changed
+        end
+        setup_tags_column
+        setup_listview_hack
+        setup_view_source_dnd(@listview)
+      end
+
+      def setup_tags_column
+        # adding tags column...
+        title = _('Tags')
+        log.debug { 'Create listview column for tags...' }
+        renderer = Gtk::CellRendererText.new
+        renderer.ellipsize = Pango::ELLIPSIZE_END if Pango.ellipsizable?
+        column = Gtk::TreeViewColumn.new(title, renderer,
+                                         text: Columns::TAGS)
+        column.widget = Gtk::Label.new(title).show
+        column.sort_column_id = Columns::TAGS
+        column.resizable = true
+        @listview.append_column(column)
+      end
+
+      def setup_listview_hack
+        @listview.signal_connect('row-activated') do
+          # Dirty hack to avoid the beginning of a drag within this
+          # handler.
+          log.debug { 'row-activated' }
+          Gtk.timeout_add(100) do
+            @actiongroup['Properties'].activate
+            false
+          end
+        end
+      end
+
+      def setup_rating_column
+        title = _('Rating')
+        log.debug { 'Create listview column for %s...' % title }
+        column = Gtk::TreeViewColumn.new(title)
+        column.widget = Gtk::Label.new(title).show
+        column.sizing = Gtk::TreeViewColumn::FIXED
+        column.fixed_width = column.min_width = column.max_width =
+          (Icons::STAR_SET.width + 1) * MAX_RATING_STARS
+        MAX_RATING_STARS.times do |i|
+          renderer = Gtk::CellRendererPixbuf.new
+          column.pack_start(renderer, false)
+          column.set_cell_data_func(renderer) do |_col, cell, _model, iter|
+            iter = @listview_model.convert_iter_to_child_iter(iter)
+            iter = @filtered_model.convert_iter_to_child_iter(iter)
+            rating = (iter[Columns::RATING] - MAX_RATING_STARS).abs
+            cell.pixbuf = rating >= i.succ ?
+              Icons::STAR_SET : Icons::STAR_UNSET
+          end
+        end
+        column.sort_column_id = Columns::RATING
+        column.resizable = false
+        @listview.append_column(column)
+      end
+
+      def setup_check_column(title, iterid)
+        renderer = CellRendererToggle.new
+        renderer.activatable = true
+        renderer.signal_connect('toggled') do |_rndrr, path|
+          begin
+            tree_path = Gtk::TreePath.new(path)
+            child_path = @listview_model.convert_path_to_child_path(tree_path)
+            if child_path
+              unfiltered_path = @filtered_model.convert_path_to_child_path(child_path)
+              # FIX this sometimes returns a nil path for iconview...
+              if unfiltered_path
+                iter = @model.get_iter(unfiltered_path)
+                if iter
+                  book = @parent.book_from_iter(@parent.selected_library, iter)
+                  toggle_state = case iterid
+                                 when Columns::REDD then book.redd
+                                 when Columns::OWN then book.own
+                                 when Columns::WANT then book.want
+                                 end
+                  # invert toggle_state
+                  unless iterid == Columns::WANT && book.own
+                    toggle_state = !toggle_state
+                    case iterid
+                    when Columns::REDD then book.redd = toggle_state
+                    when Columns::OWN then book.own = toggle_state
+                    when Columns::WANT then book.want = toggle_state
+                    end
+                    iter[iterid] = toggle_state
+                    lib = @parent.selected_library
+                    lib.save(book)
+                  end
+                end
+              end
+
+            end
+          rescue => e
+            log.error { "toggle failed for path #{path} #{e}\n" + e.backtrace.join("\n") }
+          end
+
+        end
+        column = Gtk::TreeViewColumn.new(title, renderer, text: iterid)
+        column.widget = Gtk::Label.new(title).show
+        column.sort_column_id = iterid
+        column.resizable = true
+        log.debug { 'Create listview column for %s...' % title }
+        setup_column = proc do |iter, cell, col|
+          state = iter[col]
+          cell.set_active(state)
+          cell.activatable = true
+        end
+        log.debug { "Setting cell_data_func for #{renderer}" }
+        column.set_cell_data_func(renderer) do |_col, cell, _model, iter|
+          iter = @listview_model.convert_iter_to_child_iter(iter)
+          iter = @filtered_model.convert_iter_to_child_iter(iter)
+          case iterid
+          when 12
+            setup_column.call(iter, cell, Columns::REDD)
+          when 13
+            setup_column.call(iter, cell, Columns::OWN)
+          when 14
+            setup_column.call(iter, cell, Columns::WANT)
+            own_state = iter[Columns::OWN]
+            cell.inconsistent = own_state
+          end
+        end
+        log.debug { "append_column #{column}" }
+        @listview.append_column(column)
+      end
+
+      def setup_text_column(title, iterid)
+        log.debug { 'Create listview column for %s...' % title }
+        renderer = Gtk::CellRendererText.new
+        renderer.ellipsize = Pango::ELLIPSIZE_END if Pango.ellipsizable?
+        column = Gtk::TreeViewColumn.new(title, renderer,
+                                         text: iterid)
+        column.widget = Gtk::Label.new(title).show
+        column.sort_column_id = iterid
+        column.resizable = true
+        @listview.append_column(column)
+      end
+
+      def setup_listview_columns_visibility
+        log.debug { 'setup_listview_columns_visibility' }
+        # Show or hide list view columns according to the preferences.
+        cols_visibility = [
+          @prefs.col_authors_visible,
+          @prefs.col_isbn_visible,
+          @prefs.col_publisher_visible,
+          @prefs.col_publish_date_visible,
+          @prefs.col_edition_visible,
+          @prefs.col_loaned_to_visible,
+          @prefs.col_redd_visible,
+          @prefs.col_own_visible,
+          @prefs.col_want_visible,
+          @prefs.col_rating_visible,
+          @prefs.col_tags_visible
+        ]
+        cols = @listview.columns[1..-1] # skip "Title"
+        cols.each_index do |i|
+          cols[i].visible = cols_visibility[i]
+        end
+        log.debug { 'Columns visibility: ' + cols.map { |col| "#{col.title} #{col.visible?}" }.join(', ') }
+      end
+
+      # Sets the width of each column based on any respective
+      # preference value stored.
+      def setup_listview_columns_width
+        log.debug { "setup_listview_columns_width #{@prefs.cols_width}" }
+        if @prefs.cols_width
+          cols_width = YAML.load(@prefs.cols_width)
+          log.debug { "cols_width: #{cols_width.inspect }" }
+          @listview.columns.each do |c|
+            if cols_width.key?(c.title)
+              log.debug { "#{c.title} : #{cols_width[c.title]}" }
+              c.sizing = Gtk::TreeViewColumn::FIXED
+              c.fixed_width = cols_width[c.title]
+            end
+          end
+        end
+        log.debug { 'Columns width: ' + @listview.columns.map { |col| "#{col.title} #{col.width}" }.join(', ') }
+      end
+    end
+  end
+end