Inheritance diagram for coverart_widgets.AbstractView:

Public Member Functions
def	__init__
def	initialise
def	do_update_toolbar
def	display_notification
def	resize_icon
def	get_selected_objects
def	selectionchanged_callback
def	select_and_scroll_to_path
def	scroll_to_album
def	set_popup_menu
def	grab_focus
def	switch_to_view
def	get_view_icon_name
def	get_default_manager
def	switch_to_coverpane
Public Attributes
	source
	plugin
	popup
Static Public Attributes
	view = None
	panedposition = PanedCollapsible.Paned.DEFAULT
	use_plugin_window = True

Detailed Description

intention is to document 'the must have' methods all views should define
N.B. this is preliminary and will change as and when
coverflow view is added with lessons learned

Definition at line 1251 of file coverart_widgets.py.

Member Function Documentation

def coverart_widgets.AbstractView.do_update_toolbar	(	self,
		args
	)

    called when update-toolbar signal is emitted
    by default the toolbar objects are made visible

Reimplemented in coverart_artistview.ArtistView.

Definition at line 1279 of file coverart_widgets.py.

def coverart_widgets.AbstractView.get_default_manager ( self )

every view should have a default manager
for example an AlbumManager or ArtistManager
by default - use the AlbumManager from the source

Reimplemented in coverart_artistview.ArtistView.

Definition at line 1387 of file coverart_widgets.py.

def coverart_widgets.AbstractView.get_selected_objects ( self )

finds what has been selected

returns an array of `Album`

Reimplemented in coverart_coverflowview.CoverFlowView, coverart_listview.ListView, coverart_playsourceview.PlaySourceView, and coverart_queueview.QueueView.

Definition at line 1332 of file coverart_widgets.py.

def coverart_widgets.AbstractView.get_view_icon_name ( self )

every view should have an icon - subject to removal
since we'll probably just have text buttons for the view

Reimplemented in coverart_artistview.ArtistView, coverart_covericonview.CoverIconView, and coverart_coverflowview.CoverFlowView.

Definition at line 1380 of file coverart_widgets.py.

def coverart_widgets.AbstractView.grab_focus ( self )

ensures main view object retains the focus

Reimplemented in coverart_covericonview.CoverIconView, and coverart_coverflowview.CoverFlowView.

Definition at line 1367 of file coverart_widgets.py.

def coverart_widgets.AbstractView.resize_icon	(	self,
		cover_size
	)

resize the view main picture icon

:param cover_size: `int` icon size

Reimplemented in coverart_covericonview.CoverIconView.

Definition at line 1324 of file coverart_widgets.py.

def coverart_widgets.AbstractView.scroll_to_album	(	self,
		album
	)

scroll to the album in the view

Reimplemented in coverart_artistview.ArtistView, and coverart_coverflowview.CoverFlowView.

Definition at line 1352 of file coverart_widgets.py.

def coverart_widgets.AbstractView.select_and_scroll_to_path	(	self,
		path
	)

find a path and highlight (select) that object

Reimplemented in coverart_coverflowview.CoverFlowView.

Definition at line 1346 of file coverart_widgets.py.

def coverart_widgets.AbstractView.selectionchanged_callback	(	self,
		args
	)

callback when a selection has changed

Definition at line 1340 of file coverart_widgets.py.

def coverart_widgets.AbstractView.set_popup_menu	(	self,
		popup
	)

define the popup menu (right click) used for the view

Definition at line 1361 of file coverart_widgets.py.

def coverart_widgets.AbstractView.switch_to_coverpane	(	self,
		cover_search_pane
	)

called from the source to update the coverpane when
it is switched from the track pane

Reimplemented in coverart_artistview.ArtistView.

Definition at line 1396 of file coverart_widgets.py.

def coverart_widgets.AbstractView.switch_to_view	(	self,
		source,
		album
	)

ensures that when the user toggles to a view stuff remains
consistent

Reimplemented in coverart_artistview.ArtistView, coverart_covericonview.CoverIconView, coverart_coverflowview.CoverFlowView, coverart_listview.ListView, coverart_playsourceview.PlaySourceView, and coverart_queueview.QueueView.

Definition at line 1373 of file coverart_widgets.py.

The documentation for this class was generated from the following file:

/home/foss/Downloads/coverart-browser/coverart_widgets.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation