#include <PlaylistHandler.h>

Detailed Description

Global handler for playlists.

Public Types
enum	PlaylistIndex : uint8_t { Current =0, Active }
	The PlaylistIndex enum.

Signals
void	sig_playlist_created (PlaylistPtr pl)
	emitted when new playlist has been created More...

void	sig_cur_track_idx_changed (int track_idx, int playlist_idx)
	emitted when current track index has changed More...

void	sig_new_playlist_added (PlaylistPtr pl)
	emitted when new playlist has been added More...

void	sig_playlist_name_changed (int idx)
	emitted when playlist name has changed More...

void	sig_saved_playlists_changed ()
	emitted when saved playlists have changed

void	sig_playlist_idx_changed (int idx)

void	sig_track_deletion_requested (const MetaDataList &v_md, Library::TrackDeletionMode deletion_mode)

Public Member Functions
void	clear_playlist (int pl_idx)
	clears the current visible playlist More...

void	play_next (const MetaDataList &v_md)
	insert tracks to active playlist after current playback position More...

void	insert_tracks (const MetaDataList &v_md, int idx, int pl_idx)
	insert tracks into a playlist at a given index More...

void	append_tracks (const MetaDataList &v_md, int pl_idx)
	append tracks at a given playlist index More...

void	move_rows (const IndexSet &indexes, int tgt_idx, int pl_idx)
	move rows within playlist More...

void	remove_rows (const IndexSet &indexes, int pl_idx)
	remove rows from playlist More...

void	change_track (int track_idx, int pl_idx)
	change the track in a given playlist More...

int	active_index () const
	get active playlist index More...

int	current_index () const

void	set_current_index (int pl_idx)

PlaylistConstPtr	playlist (int pl_idx) const
	get specific playlist at given index More...

void	delete_playlist (int pl_idx)
	delete the given playlist from database More...

void	close_playlist (int pl_idx)
	close playlist More...

void	reset_playlist (int pl_idx)
	reload playlist from db More...

QString	request_new_playlist_name () const
	Request a new name for the playlist (usually new %1 is returned) More...

void	save_all_playlists ()
	save all playlists to database. This could be done in destructor

DBInterface::SaveAsAnswer	save_playlist (int pl_idx)
	save playlist to database, overwrite old one More...

DBInterface::SaveAsAnswer	save_playlist_as (int pl_idx, const QString &name, bool force_override)
	Save playlist under new name. More...

DBInterface::SaveAsAnswer	rename_playlist (int pl_idx, const QString &name)
	rename playlist More...

void	save_playlist_to_file (int pl_idx, const QString &filename, bool relative)
	save a playlist to file More...

Public Slots
int	load_old_playlists ()
	load playlists of last session from database More...

int	create_playlist (const MetaDataList &v_md, const QString &name=QString(), bool temporary=true, Playlist::Type type=Playlist::Type::Std)
	create a new playlist More...

int	create_playlist (const QStringList &path_list, const QString &name=QString(), bool temporary=true, Playlist::Type type=Playlist::Type::Std)
	create a new playlist (overloaded) More...

int	create_playlist (const QString &dir, const QString &name=QString(), bool temporary=true, Playlist::Type type=Playlist::Type::Std)
	create a new playlist (overloaded) More...

int	create_playlist (const CustomPlaylist &pl)
	create a new playlist (overloaded) More...

int	create_empty_playlist (bool override_current=false)
	create a new empty playlist More...

int	create_empty_playlist (const QString &name)

void	delete_tracks (const IndexSet &rows, Library::TrackDeletionMode deletion_mode)

Protected Attributes
Settings *	_settings =nullptr

Member Function Documentation

◆ active_index()

int Playlist::Handler::active_index ( ) const

get active playlist index

Returns

◆ append_tracks()

void Playlist::Handler::append_tracks	(	const MetaDataList &	v_md,
		int	pl_idx
	)

append tracks at a given playlist index

Parameters

v_md	track list
pl_idx	playlist index

◆ change_track()

void Playlist::Handler::change_track	(	int	track_idx,
		int	pl_idx
	)

change the track in a given playlist

Parameters

idx	track index
pl_idx	playlist index

◆ clear_playlist()

void Playlist::Handler::clear_playlist ( int pl_idx )

clears the current visible playlist

Parameters

pl_idx playlist index

◆ close_playlist()

void Playlist::Handler::close_playlist ( int pl_idx )

close playlist

Parameters

pl_idx playlist index

◆ create_empty_playlist

int Playlist::Handler::create_empty_playlist ( bool override_current = false )

slot

create a new empty playlist

Parameters

name	new playlist name. If no name given, current playlist will be overwritten

Returns: new playlist index

◆ create_playlist [1/4]

int Playlist::Handler::create_playlist	(	const MetaDataList &	v_md,
		const QString &	name = `QString()`,
		bool	temporary = `true`,
		Playlist::Type	type = `Playlist::Type::Std`
	)

slot

create a new playlist

Parameters

v_md	track list
name	new playlist name. If no name given, current playlist will be overwritten
temporary	is the playlist temporary or persistent?
type	deprecated

Returns: new playlist index

◆ create_playlist [2/4]

int Playlist::Handler::create_playlist	(	const QStringList &	path_list,
		const QString &	name = `QString()`,
		bool	temporary = `true`,
		Playlist::Type	type = `Playlist::Type::Std`
	)

slot

create a new playlist (overloaded)

Parameters

pathlist	paths, may contain files or directories
name	new playlist name. If no name given, current playlist will be overwritten
temporary	is the playlist temporary or persistent?
type	deprecated

Returns: new playlist index

◆ create_playlist [3/4]

int Playlist::Handler::create_playlist	(	const QString &	dir,
		const QString &	name = `QString()`,
		bool	temporary = `true`,
		Playlist::Type	type = `Playlist::Type::Std`
	)

slot

create a new playlist (overloaded)

Parameters

dir	directory path
name	new playlist name. If no name given, current playlist will be overwritten
temporary	is the playlist temporary or persistent?
type	deprecated

Returns: new playlist index

◆ create_playlist [4/4]

int Playlist::Handler::create_playlist ( const CustomPlaylist & pl )

slot

create a new playlist (overloaded)

Parameters

pl	a CustomPlaylist object fetched from database

Returns: new playlist index

◆ delete_playlist()

void Playlist::Handler::delete_playlist ( int pl_idx )

delete the given playlist from database

Parameters

pl_idx playlist index

◆ insert_tracks()

void Playlist::Handler::insert_tracks	(	const MetaDataList &	v_md,
		int	idx,
		int	pl_idx
	)

insert tracks into a playlist at a given index

Parameters

v_md	track list
idx	track index within playlist
pl_idx	playlist index

◆ load_old_playlists

int Playlist::Handler::load_old_playlists ( )

slot

load playlists of last session from database

Returns: number of playlists fetched

◆ move_rows()

void Playlist::Handler::move_rows	(	const IndexSet &	indexes,
		int	tgt_idx,
		int	pl_idx
	)

move rows within playlist

Parameters

idx_list	list of row indices to be moved
tgt_idx	target index where rows should be moved
pl_idx	playlist index

◆ play_next()

void Playlist::Handler::play_next ( const MetaDataList & v_md )

insert tracks to active playlist after current playback position

Parameters

v_md	list of tracks

◆ playlist()

PlaylistConstPtr Playlist::Handler::playlist ( int pl_idx ) const

get specific playlist at given index

Parameters

pl_idx playlist index

Returns: read only pointer object to a playlist, may be nullptr

◆ remove_rows()

void Playlist::Handler::remove_rows	(	const IndexSet &	indexes,
		int	pl_idx
	)

remove rows from playlist

Parameters

indexes	list of row indices to be removed
pl_idx	playlist index

◆ rename_playlist()

DBInterface::SaveAsAnswer Playlist::Handler::rename_playlist	(	int	pl_idx,
		const QString &	name
	)

rename playlist

Parameters

pl_idx	playlist index
name	new playlist name

Returns

◆ request_new_playlist_name()

QString Playlist::Handler::request_new_playlist_name ( ) const

Request a new name for the playlist (usually new %1 is returned)

Returns: playlist name

◆ reset_playlist()

void Playlist::Handler::reset_playlist ( int pl_idx )

reload playlist from db

Parameters

pl_idx playlist index

◆ save_playlist()

DBInterface::SaveAsAnswer Playlist::Handler::save_playlist ( int pl_idx )

save playlist to database, overwrite old one

Parameters

pl_idx playlist index

Returns: SaveAnswer

◆ save_playlist_as()

DBInterface::SaveAsAnswer Playlist::Handler::save_playlist_as	(	int	pl_idx,
		const QString &	name,
		bool	force_override
	)

Save playlist under new name.

Parameters

pl_idx	playlist index
name	new playlist name
force_override	override if name exists

Returns: AlreadyThere if name exists and force_override is false

◆ save_playlist_to_file()

void Playlist::Handler::save_playlist_to_file	(	int	pl_idx,
		const QString &	filename,
		bool	relative
	)

save a playlist to file

Parameters

filename,if	filename does not end with m3u, extension is appended automatically
relative	relative paths in m3u file

◆ sig_cur_track_idx_changed

void Playlist::Handler::sig_cur_track_idx_changed	(	int	track_idx,
		int	playlist_idx
	)

signal

emitted when current track index has changed

Parameters

track_idx	index in playlist
playlist_idx	index of playlist

◆ sig_new_playlist_added

void Playlist::Handler::sig_new_playlist_added ( PlaylistPtr pl )

signal

emitted when new playlist has been added

Parameters

pl	reference to new playlist

◆ sig_playlist_created

void Playlist::Handler::sig_playlist_created ( PlaylistPtr pl )

signal

emitted when new playlist has been created

Parameters

pl	Playlist, usually current one

◆ sig_playlist_name_changed

void Playlist::Handler::sig_playlist_name_changed ( int idx )

signal

emitted when playlist name has changed

Parameters

idx	index of playlist

Inheritance diagram for Playlist::Handler:

Detailed Description

Public Types

Signals

Public Member Functions

Public Slots

Protected Attributes

Member Function Documentation

◆ active_index()

◆ append_tracks()

◆ change_track()

◆ clear_playlist()

◆ close_playlist()

◆ create_empty_playlist

◆ create_playlist [1/4]

◆ create_playlist [2/4]

◆ create_playlist [3/4]

◆ create_playlist [4/4]

◆ delete_playlist()

◆ insert_tracks()

◆ load_old_playlists

◆ move_rows()

◆ play_next()

◆ playlist()

◆ remove_rows()

◆ rename_playlist()

◆ request_new_playlist_name()

◆ reset_playlist()

◆ save_playlist()

◆ save_playlist_as()

◆ save_playlist_to_file()

◆ sig_cur_track_idx_changed

◆ sig_new_playlist_added

◆ sig_playlist_created

◆ sig_playlist_name_changed