class ViewLyrics(EventPlugin, UserInterfacePlugin):
"""The plugin for viewing lyrics in the main window."""
PLUGIN_ID = 'View Lyrics'
PLUGIN_NAME = _('View Lyrics')
PLUGIN_DESC = _('Automatically displays tag or file-based lyrics '
'in a sidebar.')
PLUGIN_ICON = Icons.FORMAT_JUSTIFY_FILL
def enabled(self):
self.scrolled_window = Gtk.ScrolledWindow()
self.scrolled_window.set_policy(Gtk.PolicyType.AUTOMATIC,
Gtk.PolicyType.AUTOMATIC)
self.adjustment = self.scrolled_window.get_vadjustment()
self.textview = Gtk.TextView()
self.textbuffer = self.textview.get_buffer()
self._italics = self.textbuffer.create_tag("italic", style="italic",
foreground="grey")
self.textview.set_editable(False)
self.textview.set_cursor_visible(False)
self.textview.set_wrap_mode(Gtk.WrapMode.WORD)
self.textview.set_justification(Gtk.Justification.CENTER)
self.textview.connect('key-press-event', self.key_press_event_cb)
add_css(self.textview, "* { padding: 6px; }")
vbox = Gtk.VBox()
vbox.pack_start(self.textview, True, True, 0)
self._edit_button = Button("Edit Lyrics", Icons.EDIT)
hbox = Gtk.HBox()
hbox.pack_end(self._edit_button, False, False, 3)
vbox.pack_start(hbox, False, False, 3)
self.scrolled_window.add(vbox)
self.textview.show()
self.scrolled_window.show()
self._sig = None
cur = app.player.info
if cur is not None:
cur = SongWrapper(cur)
self.plugin_on_song_started(cur)
def create_sidebar(self):
vbox = Gtk.VBox(margin=0)
vbox.pack_start(self.scrolled_window, True, True, 0)
vbox.show_all()
return vbox
def disabled(self):
self.textview.destroy()
self.scrolled_window.destroy()
def plugin_on_song_started(self, song):
"""Called when a song is started. Loads the lyrics.
If there are lyrics associated with `song`, load them into the
lyrics viewer. Otherwise, hides the lyrics viewer.
"""
lyrics = None
if song is not None:
print_d("Looking for lyrics for %s" % song("~filename"))
lyrics = song("~lyrics")
if lyrics:
self.textbuffer.set_text(lyrics)
self.adjustment.set_value(0) # Scroll to the top.
self.textview.show()
else:
title = _("No lyrics found for\n %s") % song("~basename")
self._set_italicised(title)
def edit(widget):
print_d("Launching lyrics editor for %s" % song("~filename"))
assert isinstance(song, SongWrapper)
information = Information(app.librarian, [song._song])
information.get_child()._switch_to_lyrics()
information.show()
if self._sig:
self._edit_button.disconnect(self._sig)
self._sig = self._edit_button.connect('clicked', edit)
def _set_italicised(self, title):
self.textbuffer.set_text(title)
start = self.textbuffer.get_start_iter()
end = self.textbuffer.get_end_iter()
self.textbuffer.remove_all_tags(start, end)
self.textbuffer.apply_tag(self._italics, start, end)
def plugin_on_changed(self, songs):
cur = app.player.info
if cur:
fn = cur("~filename")
for s in songs:
if s("~filename") == fn:
print_d("Active song changed, reloading lyrics")
self.plugin_on_song_started(SongWrapper(cur))
else:
self._set_italicised(_("No active song"))
def key_press_event_cb(self, widget, event):
"""Handles up/down "key-press-event" in the lyrics view."""
adj = self.scrolled_window.get_vadjustment().props
if event.keyval == Gdk.KEY_Up:
adj.value = max(adj.value - adj.step_increment, adj.lower)
elif event.keyval == Gdk.KEY_Down:
adj.value = min(adj.value + adj.step_increment,
adj.upper - adj.page_size)
elif event.keyval == Gdk.KEY_Page_Up:
adj.value = max(adj.value - adj.page_increment, adj.lower)
elif event.keyval == Gdk.KEY_Page_Down:
adj.value = min(adj.value + adj.page_increment,
adj.upper - adj.page_size)
elif event.keyval == Gdk.KEY_Home:
adj.value = adj.lower
elif event.keyval == Gdk.KEY_End:
adj.value = adj.upper - adj.page_size
else:
return False
return True
class ViewLyrics(EventPlugin, UserInterfacePlugin):
"""The plugin for viewing lyrics in the main window."""
PLUGIN_ID = 'View Lyrics'
PLUGIN_NAME = _('View Lyrics')
PLUGIN_DESC = _('Automatically displays tag or file-based lyrics '
'in a sidebar.')
PLUGIN_ICON = Icons.FORMAT_JUSTIFY_FILL
def enabled(self):
self.scrolled_window = Gtk.ScrolledWindow()
self.scrolled_window.set_policy(Gtk.PolicyType.AUTOMATIC,
Gtk.PolicyType.AUTOMATIC)
self.adjustment = self.scrolled_window.get_vadjustment()
self.textview = Gtk.TextView()
self.textbuffer = self.textview.get_buffer()
self._italics = self.textbuffer.create_tag("italic",
style="italic",
foreground="grey")
self.textview.set_editable(False)
self.textview.set_cursor_visible(False)
self.textview.set_wrap_mode(Gtk.WrapMode.WORD)
self.textview.set_justification(Gtk.Justification.CENTER)
self.textview.connect('key-press-event', self.key_press_event_cb)
add_css(self.textview, "* { padding: 6px; }")
vbox = Gtk.VBox()
vbox.pack_start(self.textview, True, True, 0)
self._edit_button = Button("Edit Lyrics", Icons.EDIT)
hbox = Gtk.HBox()
hbox.pack_end(self._edit_button, False, False, 3)
vbox.pack_start(hbox, False, False, 3)
self.scrolled_window.add(vbox)
self.textview.show()
self.scrolled_window.show()
self._sig = None
cur = app.player.info
if cur is not None:
cur = SongWrapper(cur)
self.plugin_on_song_started(cur)
def create_sidebar(self):
vbox = Gtk.VBox(margin=0)
vbox.pack_start(self.scrolled_window, True, True, 0)
vbox.show_all()
return vbox
def disabled(self):
self.textview.destroy()
self.scrolled_window.destroy()
def plugin_on_song_started(self, song):
"""Called when a song is started. Loads the lyrics.
If there are lyrics associated with `song`, load them into the
lyrics viewer. Otherwise, hides the lyrics viewer.
"""
lyrics = None
if song is not None:
print_d("Looking for lyrics for %s" % song("~filename"))
lyrics = song("~lyrics")
if lyrics:
self.textbuffer.set_text(lyrics)
self.adjustment.set_value(0) # Scroll to the top.
self.textview.show()
else:
title = _("No lyrics found for\n %s") % song("~basename")
self._set_italicised(title)
def edit(widget):
print_d("Launching lyrics editor for %s" % song("~filename"))
assert isinstance(song, SongWrapper)
information = Information(app.librarian, [song._song])
information.get_child()._switch_to_lyrics()
information.show()
if self._sig:
self._edit_button.disconnect(self._sig)
self._sig = self._edit_button.connect('clicked', edit)
def _set_italicised(self, title):
self.textbuffer.set_text(title)
start = self.textbuffer.get_start_iter()
end = self.textbuffer.get_end_iter()
self.textbuffer.remove_all_tags(start, end)
self.textbuffer.apply_tag(self._italics, start, end)
def plugin_on_changed(self, songs):
cur = app.player.info
if cur:
fn = cur("~filename")
for s in songs:
if s("~filename") == fn:
print_d("Active song changed, reloading lyrics")
self.plugin_on_song_started(SongWrapper(cur))
else:
self._set_italicised(_("No active song"))
def key_press_event_cb(self, widget, event):
"""Handles up/down "key-press-event" in the lyrics view."""
adj = self.scrolled_window.get_vadjustment().props
if event.keyval == Gdk.KEY_Up:
adj.value = max(adj.value - adj.step_increment, adj.lower)
elif event.keyval == Gdk.KEY_Down:
adj.value = min(adj.value + adj.step_increment,
adj.upper - adj.page_size)
elif event.keyval == Gdk.KEY_Page_Up:
adj.value = max(adj.value - adj.page_increment, adj.lower)
elif event.keyval == Gdk.KEY_Page_Down:
adj.value = min(adj.value + adj.page_increment,
adj.upper - adj.page_size)
elif event.keyval == Gdk.KEY_Home:
adj.value = adj.lower
elif event.keyval == Gdk.KEY_End:
adj.value = adj.upper - adj.page_size
else:
return False
return True
