Module: Alexandria::UI::Icons

Includes:
Logging
Defined in:
lib/alexandria/ui/icons.rb

Constant Summary collapse

ICONS_DIR = 
File.join(Alexandria::Config::DATA_DIR, "icons")

Class Method Summary collapse

Methods included from Logging

included, #log

Class Method Details

.blank?(filename) ⇒ Boolean

Returns:

  • (Boolean) 


78
79
80
81
 
# File 'lib/alexandria/ui/icons.rb', line 78

def self.blank?(filename)
  pixbuf = GdkPixbuf::Pixbuf.new(file: filename)
  (pixbuf.width == 1) && (pixbuf.height == 1)
end

.cover(library, book) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/alexandria/ui/icons.rb', line 30

def self.cover(library, book)
  begin
    return BOOK_ICON if library.nil?

    filename = library.cover(book)
    return GdkPixbuf::Pixbuf.new(file: filename) if File.exist?(filename)
  rescue GdkPixbuf::PixbufError
    log.error do
      "Failed to load GdkPixbuf::Pixbuf, " \
        "please ensure that #{filename} is a valid image file"
    end
  end
  BOOK_ICON
end

.init ⇒ Object 



13
14
15
 
# File 'lib/alexandria/ui/icons.rb', line 13

def self.init
  load_icon_images
end

.load_icon_images ⇒ Object

loads icons from icons_dir location and gives them as uppercase constants to Alexandria::UI::Icons namespace, e.g., Icons::STAR_SET



19
20
21
22
23
24
25
26
27
28
 
# File 'lib/alexandria/ui/icons.rb', line 19

def self.load_icon_images
  Dir.entries(ICONS_DIR).each do |file|
    next unless file.end_with?(".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, GdkPixbuf::Pixbuf.new(file: File.join(ICONS_DIR, file)))
  end
end

.tag_icon(icon_pixbuf, tag_pixbuf) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/alexandria/ui/icons.rb', line 45

def self.tag_icon(icon_pixbuf, tag_pixbuf)
  # Computes some tweaks.
  tweak_x = tag_pixbuf.width / 3
  tweak_y = tag_pixbuf.height / 3

  # Creates the destination pixbuf.
  new_pixbuf = GdkPixbuf::Pixbuf.new(colorspace: :rgb,
                                     has_alpha: true,
                                     bits_per_sample: 8,
                                     width: icon_pixbuf.width + tweak_x,
                                     height: icon_pixbuf.height + tweak_y)

  # Fills with blank.
  new_pixbuf.fill!(0)

  # Copies the current pixbuf there (south-west).
  icon_pixbuf.copy_area(0, 0,
                        icon_pixbuf.width, icon_pixbuf.height,
                        new_pixbuf,
                        0, tweak_y)

  # Copies the tag pixbuf there (north-est).
  tag_pixbuf_x = icon_pixbuf.width - (tweak_x * 2)
  new_pixbuf.composite!(tag_pixbuf,
                        dest_x: 0, dest_y: 0,
                        dest_width: tag_pixbuf.width + tag_pixbuf_x,
                        dest_height: tag_pixbuf.height,
                        offset_x: tag_pixbuf_x, offset_y: 0,
                        scale_x: 1, scale_y: 1,
                        interpolation_type: :hyper, overall_alpha: 255)
  new_pixbuf
end