LyricsData Class Reference

#include <libmythmetadata/lyricsdata.h>

Inheritance diagram for LyricsData:

Collaboration diagram for LyricsData:

Public Types
enum	Status : std::uint8_t { STATUS_NOTLOADED = 0, STATUS_SEARCHING, STATUS_FOUND, STATUS_NOTFOUND }

Signals
void	statusChanged (LyricsData::Status status, const QString &message)

Public Member Functions
	LyricsData ()=default
	LyricsData (MusicMetadata *parent)
	LyricsData (MusicMetadata *parent, QString grabber, QString artist, QString album, QString title, bool syncronized)
	~LyricsData () override
QString	grabber (void)
void	setGrabber (const QString &grabber)
QString	artist (void)
void	setArtist (const QString &artist)
QString	album (void)
void	setAlbum (const QString &album)
QString	title (void)
void	setTitle (const QString &title)
LyricsLineMap *	lyrics (void)
void	setLyrics (const QStringList &lyrics)
bool	syncronized (void) const
void	setSyncronized (bool syncronized)
bool	changed (void) const
void	setChanged (bool changed)
Status	getStatus (void)
void	clear (void)
void	clearLyrics (void)
void	findLyrics (const QString &grabber)
void	save (void)
void	customEvent (QEvent *event) override

Private Member Functions
void	loadLyrics (const QString &xmlData)
QString	createLyricsXML (void)

Private Attributes
LyricsLineMap	m_lyricsMap
MusicMetadata *	m_parent {nullptr}
Status	m_status {STATUS_NOTLOADED}
QString	m_grabber
QString	m_artist
QString	m_album
QString	m_title
bool	m_syncronized {false}
bool	m_changed {false}

Friends
class	TestLyrics

Detailed Description

Definition at line 47 of file lyricsdata.h.

Member Enumeration Documentation

Status

enum LyricsData::Status : std::uint8_t

Enumerator
STATUS_NOTLOADED
STATUS_SEARCHING
STATUS_FOUND
STATUS_NOTFOUND

Definition at line 85 of file lyricsdata.h.

Constructor & Destructor Documentation

LyricsData() [1/3]

LyricsData::LyricsData ( )

default

LyricsData() [2/3]

LyricsData::LyricsData ( MusicMetadata *  parent )

inlineexplicit

Definition at line 55 of file lyricsdata.h.

LyricsData() [3/3]

LyricsData::LyricsData ( MusicMetadata *  parent, QString  grabber, QString  artist, QString  album, QString  title, bool  syncronized  )

inline

Definition at line 57 of file lyricsdata.h.

~LyricsData()

LyricsData::~LyricsData ( )

override

Definition at line 22 of file lyricsdata.cpp.

Member Function Documentation

grabber()

QString LyricsData::grabber ( void  )

inline

Definition at line 64 of file lyricsdata.h.

Referenced by EditLyricsDialog::Create(), createLyricsXML(), findLyrics(), LyricsView::showLyrics(), and EditLyricsDialog::somethingChanged().

setGrabber()

void LyricsData::setGrabber ( const QString &  grabber )

inline

Definition at line 65 of file lyricsdata.h.

Referenced by EditLyricsDialog::okPressed().

artist()

QString LyricsData::artist ( void  )

inline

Definition at line 67 of file lyricsdata.h.

Referenced by EditLyricsDialog::Create(), createLyricsXML(), findLyrics(), and EditLyricsDialog::somethingChanged().

setArtist()

void LyricsData::setArtist ( const QString &  artist )

inline

Definition at line 68 of file lyricsdata.h.

Referenced by EditLyricsDialog::okPressed().

album()

QString LyricsData::album ( void  )

inline

Definition at line 70 of file lyricsdata.h.

Referenced by EditLyricsDialog::Create(), createLyricsXML(), findLyrics(), and EditLyricsDialog::somethingChanged().

setAlbum()

void LyricsData::setAlbum ( const QString &  album )

inline

Definition at line 71 of file lyricsdata.h.

Referenced by EditLyricsDialog::okPressed().

title()

QString LyricsData::title ( void  )

inline

Definition at line 73 of file lyricsdata.h.

Referenced by EditLyricsDialog::Create(), createLyricsXML(), findLyrics(), and EditLyricsDialog::somethingChanged().

setTitle()

void LyricsData::setTitle ( const QString &  title )

inline

Definition at line 74 of file lyricsdata.h.

Referenced by EditLyricsDialog::okPressed().

lyrics()

LyricsLineMap* LyricsData::lyrics ( void  )

inline

Definition at line 76 of file lyricsdata.h.

Referenced by EditLyricsDialog::loadLyrics(), loadLyrics(), setLyrics(), LyricsView::showLyrics(), LyricsView::ShowMenu(), and EditLyricsDialog::somethingChanged().

setLyrics()

void LyricsData::setLyrics

(

const QStringList &

lyrics

)

Definition at line 313 of file lyricsdata.cpp.

Referenced by loadLyrics(), and EditLyricsDialog::okPressed().

syncronized()

bool LyricsData::syncronized ( void  ) const

inline

Definition at line 79 of file lyricsdata.h.

Referenced by EditLyricsDialog::Create(), createLyricsXML(), LyricsView::showLyrics(), and EditLyricsDialog::somethingChanged().

setSyncronized()

void LyricsData::setSyncronized ( bool  syncronized )

inline

Definition at line 80 of file lyricsdata.h.

Referenced by EditLyricsDialog::okPressed(), and LyricsView::setLyricTime().

changed()

bool LyricsData::changed ( void  ) const

inline

Definition at line 82 of file lyricsdata.h.

Referenced by LyricsView::findLyrics(), and LyricsView::ShowMenu().

setChanged()

void LyricsData::setChanged ( bool  changed )

inline

Definition at line 83 of file lyricsdata.h.

Referenced by EditLyricsDialog::okPressed(), and LyricsView::setLyricTime().

getStatus()

Status LyricsData::getStatus ( void  )

inline

Definition at line 93 of file lyricsdata.h.

clear()

void LyricsData::clear

(

void

)

Definition at line 27 of file lyricsdata.cpp.

Referenced by LyricsView::customEvent(), findLyrics(), and ~LyricsData().

clearLyrics()

void LyricsData::clearLyrics

(

void

)

Definition at line 38 of file lyricsdata.cpp.

Referenced by clear(), loadLyrics(), and setLyrics().

findLyrics()

void LyricsData::findLyrics

(

const QString &

grabber

)

Definition at line 50 of file lyricsdata.cpp.

Referenced by LyricsView::findLyrics(), and culrcscrapers.darklyrics.lyricsScraper.LyricsFetcher::get_lyrics_from_list().

save()

void LyricsData::save

(

void

)

Definition at line 117 of file lyricsdata.cpp.

Referenced by LyricsView::findLyrics(), EditLyricsDialog::okPressed(), and LyricsView::saveLyrics().

customEvent()

void LyricsData::customEvent ( QEvent *  event )

override

Definition at line 184 of file lyricsdata.cpp.

statusChanged

void LyricsData::statusChanged ( LyricsData::Status  status, const QString &  message  )

signal

Referenced by customEvent(), LyricsView::findLyrics(), and findLyrics().

loadLyrics()

void LyricsData::loadLyrics ( const QString &  xmlData )

private

Definition at line 231 of file lyricsdata.cpp.

Referenced by customEvent().

createLyricsXML()

QString LyricsData::createLyricsXML ( void  )

private

Definition at line 138 of file lyricsdata.cpp.

Referenced by save().

Friends And Related Function Documentation

TestLyrics

friend class TestLyrics

friend

Definition at line 51 of file lyricsdata.h.

Member Data Documentation

m_lyricsMap

LyricsLineMap LyricsData::m_lyricsMap

private

Definition at line 109 of file lyricsdata.h.

Referenced by clearLyrics(), createLyricsXML(), and setLyrics().

m_parent

MusicMetadata* LyricsData::m_parent {nullptr}

private

Definition at line 111 of file lyricsdata.h.

Referenced by customEvent(), findLyrics(), save(), and setLyrics().

m_status

Status LyricsData::m_status {STATUS_NOTLOADED}

private

Definition at line 113 of file lyricsdata.h.

Referenced by clear(), customEvent(), findLyrics(), and loadLyrics().

m_grabber

QString LyricsData::m_grabber

private

Definition at line 115 of file lyricsdata.h.

Referenced by clear(), createLyricsXML(), and loadLyrics().

m_artist

QString LyricsData::m_artist

private

Definition at line 116 of file lyricsdata.h.

Referenced by clear(), createLyricsXML(), and loadLyrics().

m_album

QString LyricsData::m_album

private

Definition at line 117 of file lyricsdata.h.

Referenced by clear(), createLyricsXML(), and loadLyrics().

m_title

QString LyricsData::m_title

private

Definition at line 118 of file lyricsdata.h.

Referenced by clear(), createLyricsXML(), and loadLyrics().

m_syncronized

bool LyricsData::m_syncronized {false}

private

Definition at line 119 of file lyricsdata.h.

Referenced by clear(), createLyricsXML(), loadLyrics(), and setLyrics().

m_changed

bool LyricsData::m_changed {false}

private

Definition at line 120 of file lyricsdata.h.

Referenced by clear(), loadLyrics(), and save().

---

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

• mythtv/libs/libmythmetadata/lyricsdata.h
• mythtv/libs/libmythmetadata/lyricsdata.cpp