CoverArt Browser  v2.0
Browse your cover-art albums in Rhythmbox
coverart_album.AlbumsModel Class Reference

List of all members.

Public Member Functions

def __init__
def store
def add
def remove
def contains
def get
def get_from_dbentry
def get_all
def get_from_path
def get_from_ext_db_key
def get_path
def find_first_visible
def show
def sort
def replace_filter
def remove_filter
def clear_filters
def do_filter_changed
def recreate_text

Static Public Attributes

dictionary columns = {'tooltip': 0, 'pixbuf': 1, 'album': 2, 'markup': 3, 'show': 4}

Detailed Description

Model that contains albums, keeps them sorted, filtered and provides an
external `Gtk.TreeModel` interface to use as part of a Gtk interface.

The `Gtk.TreeModel` haves the following structure:
column 0 -> string containing the album name and artist
column 1 -> pixbuf of the album's cover.
column 2 -> instance of the album itself.
column 3 -> markup text showed under the cover.
column 4 -> boolean that indicates if the row should be shown

Definition at line 703 of file coverart_album.py.


Member Function Documentation

def coverart_album.AlbumsModel.add (   self,
  album 
)
Add an album to the model.

:param album: `Album` to be added to the model.

Definition at line 826 of file coverart_album.py.

Clears all filters on the model.

Definition at line 1080 of file coverart_album.py.

def coverart_album.AlbumsModel.contains (   self,
  album_name,
  album_artist 
)
Indicates if the model contains a specific album.

:param album_name: `str` name of the album.

Definition at line 873 of file coverart_album.py.

def coverart_album.AlbumsModel.get (   self,
  album_name,
  album_artist 
)
Returns the requested album.

:param album_name: `str` name of the album.

Definition at line 882 of file coverart_album.py.

Returns a collection of all the albums in this model.

Definition at line 903 of file coverart_album.py.

def coverart_album.AlbumsModel.get_from_dbentry (   self,
  entry 
)
Returns the album containing the track corresponding to rhythmdbentry

:param entry: `RhythmDBEntry`

Definition at line 890 of file coverart_album.py.

Returns the requested album.

:param key: ext_db_key

Definition at line 917 of file coverart_album.py.

def coverart_album.AlbumsModel.get_from_path (   self,
  path 
)
Returns an album referenced by a `Gtk.TreeModel` path.

:param path: `Gtk.TreePath` referencing the album.

Definition at line 909 of file coverart_album.py.

Forces the recreation and update of the markup text for each album.

Definition at line 1102 of file coverart_album.py.

def coverart_album.AlbumsModel.remove (   self,
  album 
)
Removes this album from the model.

:param album: `Album` to be removed from the model.

Definition at line 856 of file coverart_album.py.

def coverart_album.AlbumsModel.remove_filter (   self,
  filter_key,
  refilter = True 
)
Removes a filter by it's filter_key

:param filter_key: `str` key of the filter method to use. This should
    be one of the available keys on the `AlbumFilters` class.
:param refilter: `bool` indicating whether to force a refilter and
emit the 'filter-changed' signal(True) or not(False).

Definition at line 1065 of file coverart_album.py.

def coverart_album.AlbumsModel.replace_filter (   self,
  filter_key,
  filter_arg = None,
  refilter = True 
)
Adds or replaces a filter by it's filter_key.

:param filter_key: `str` key of the filter method to use. This should
    be one of the available keys on the `AlbumFilters` class.
:param filter_arg: `object` any object that the correspondant filter
    method may need to perform the filtering process.
:param refilter: `bool` indicating whether to force a refilter and
emit the 'filter-changed' signal(True) or not(False).

Definition at line 1049 of file coverart_album.py.

def coverart_album.AlbumsModel.show (   self,
  album,
  show 
)
Unfilters an album, making it visible to the publicly available model's
`Gtk.TreeModel`

:param album: `Album` to show or hide.
:param show: `bool` indcating whether to show(True) or hide(False) the
    album.

Definition at line 961 of file coverart_album.py.

Changes the sorting strategy for the model.

Definition at line 992 of file coverart_album.py.


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