sublime_music.ui.common package

Submodules

• sublime_music.ui.common.album_with_songs module
• sublime_music.ui.common.icon_button module
• sublime_music.ui.common.load_error module
• sublime_music.ui.common.rating_button module
• sublime_music.ui.common.song_list_column module
• sublime_music.ui.common.spinner_image module

Module contents

class sublime_music.ui.common.AlbumWithSongs(album, cover_art_size=200, show_artist_name=True)

Bases: gi.overrides.Gtk.Box

Parameters

• album (sublime_music.adapters.api_objects.Album) –

• cover_art_size (int) –

• show_artist_name (bool) –

__init__(album, cover_art_size=200, show_artist_name=True)

Initializer for a GObject based classes with support for property sets through the use of explicit keyword arguments.

Parameters

• album (sublime_music.adapters.api_objects.Album) –

• cover_art_size (int) –

• show_artist_name (bool) –

deselect_all()

offline_mode = True

on_download_all_click(btn)

Parameters

btn (Any) –

on_song_activated(treeview, idx, column)

Parameters

• treeview (Any) –

• idx (gi.overrides.Gtk.TreePath) –

• column (Any) –

on_song_button_press(tree, event)

Parameters

• tree (Any) –

• event (gi.overrides.Gdk.EventButton) –

Return type

bool

on_song_selection_change(event)

Parameters

event (Any) –

play_btn_clicked(btn)

Parameters

btn (Any) –

set_loading(loading)

Parameters

loading (bool) –

shuffle_btn_clicked(btn)

Parameters

btn (Any) –

update(app_config=None, force=False)

Parameters

• app_config (Optional[sublime_music.config.AppConfiguration]) –

• force (bool) –

update_album_songs(album, app_config, force=False, order_token=None, is_partial=False)

Parameters

• album (sublime_music.adapters.api_objects.Album) –

• app_config (Optional[sublime_music.config.AppConfiguration]) –

• force (bool) –

• order_token (Optional[int]) –

• is_partial (bool) –

class sublime_music.ui.common.IconButton(icon_name, tooltip_text='', relief=False, icon_size=<enum GTK_ICON_SIZE_BUTTON of type Gtk.IconSize>, label=None, **kwargs)

Bases: gi.overrides.Gtk.Button

Parameters

• icon_name (Optional[str]) –

• tooltip_text (str) –

• relief (bool) –

• icon_size (gi.repository.Gtk.IconSize) –

• label (str | None) –

__init__(icon_name, tooltip_text='', relief=False, icon_size=<enum GTK_ICON_SIZE_BUTTON of type Gtk.IconSize>, label=None, **kwargs)

Parameters

• icon_name (Optional[str]) –

• tooltip_text (str) –

• relief (bool) –

• icon_size (gi.repository.Gtk.IconSize) –

• label (Optional[str]) –

set_icon(icon_name)

Parameters

icon_name (Optional[str]) –

class sublime_music.ui.common.IconMenuButton(icon_name=None, tooltip_text='', relief=True, icon_size=<enum GTK_ICON_SIZE_BUTTON of type Gtk.IconSize>, label=None, popover=None, **kwargs)

Bases: gi.repository.Gtk.MenuButton

Parameters

• icon_name (Optional[str]) –

• tooltip_text (str) –

• relief (bool) –

• icon_size (gi.repository.Gtk.IconSize) –

• label (str | None) –

• popover (Any) –

__init__(icon_name=None, tooltip_text='', relief=True, icon_size=<enum GTK_ICON_SIZE_BUTTON of type Gtk.IconSize>, label=None, popover=None, **kwargs)

Parameters

• icon_name (Optional[str]) –

• tooltip_text (str) –

• relief (bool) –

• icon_size (gi.repository.Gtk.IconSize) –

• label (Optional[str]) –

• popover (Optional[Any]) –

set_from_file(icon_file)

Parameters

icon_file (Optional[str]) –

set_icon(icon_name)

Parameters

icon_name (Optional[str]) –

class sublime_music.ui.common.IconToggleButton(icon_name, tooltip_text='', relief=False, icon_size=<enum GTK_ICON_SIZE_BUTTON of type Gtk.IconSize>, label=None, **kwargs)

Bases: gi.repository.Gtk.ToggleButton

Parameters

• icon_name (Optional[str]) –

• tooltip_text (str) –

• relief (bool) –

• icon_size (gi.repository.Gtk.IconSize) –

• label (str | None) –

__init__(icon_name, tooltip_text='', relief=False, icon_size=<enum GTK_ICON_SIZE_BUTTON of type Gtk.IconSize>, label=None, **kwargs)

Parameters

• icon_name (Optional[str]) –

• tooltip_text (str) –

• relief (bool) –

• icon_size (gi.repository.Gtk.IconSize) –

• label (Optional[str]) –

get_active(self) → bool

Return type

bool

set_active(self, is_active: bool)

Parameters

active (bool) –

set_icon(icon_name)

Parameters

icon_name (Optional[str]) –

class sublime_music.ui.common.LoadError(entity_name, action, has_data, offline_mode)

Bases: gi.overrides.Gtk.Box

Parameters

• entity_name (str) –

• action (str) –

• has_data (bool) –

• offline_mode (bool) –

__init__(entity_name, action, has_data, offline_mode)

Initializer for a GObject based classes with support for property sets through the use of explicit keyword arguments.

Parameters

• entity_name (str) –

• action (str) –

• has_data (bool) –

• offline_mode (bool) –

class sublime_music.ui.common.RatingButtonBox(icon_rated='star-full', icon_unrated='star-empty', **kwargs)

Bases: gi.overrides.Gtk.Box

A simple GtkBox containing buttons that allow rating something. It doesn’t know what it’s rating just what the rating is when it changed

Parameters

• icon_rated (str) –

• icon_unrated (str) –

MAX_VALUE = 5

__init__(icon_rated='star-full', icon_unrated='star-empty', **kwargs)

Initializer for a GObject based classes with support for property sets through the use of explicit keyword arguments.

Parameters

• icon_rated (str) –

• icon_unrated (str) –

property rating: int | None

validate_rating(rating)

Parameters

rating (int | None) –

class sublime_music.ui.common.SongListColumn(header, text_idx, bold=False, align=0, width=None)

Bases: gi.overrides.Gtk.TreeViewColumn

Parameters

• header (str) –

• text_idx (int) –

• bold (bool) –

• align (float) –

• width (int | None) –

__init__(header, text_idx, bold=False, align=0, width=None)

Represents a column in a song list.

Parameters

• header (str) –

• text_idx (int) –

• bold (bool) –

• align (float) –

• width (Optional[int]) –

class sublime_music.ui.common.SpinnerImage(loading=True, image_name=None, spinner_name=None, image_size=None, **kwargs)

Bases: gi.repository.Gtk.Overlay

Parameters

• loading (bool) –

• image_name (str | None) –

• spinner_name (str | None) –

• image_size (int | None) –

__init__(loading=True, image_name=None, spinner_name=None, image_size=None, **kwargs)

An image with a loading overlay.

Parameters

• loading (bool) –

• image_name (Optional[str]) –

• spinner_name (Optional[str]) –

• image_size (Optional[int]) –

set_from_file(filename)

Set the image to the given filename.

Parameters

filename (Optional[str]) –

set_image_size(size)

Parameters

size (int) –

set_loading(loading_status)

Parameters

loading_status (bool) –