MythTV  master
Public Member Functions | Protected Member Functions | Private Slots | Private Member Functions | Private Attributes | List of all members
LyricsView Class Reference

#include <lyricsview.h>

Inheritance diagram for LyricsView:
Inheritance graph
Collaboration diagram for LyricsView:
Collaboration graph

Public Member Functions

 LyricsView (MythScreenStack *parent, MythScreenType *parentScreen)
 ~LyricsView (void) override
bool Create (void) override
bool keyPressEvent (QKeyEvent *event) override
 Key event handler. More...
void ShowMenu (void) override
- Public Member Functions inherited from MythScreenType
 MythScreenType (MythScreenStack *parent, const QString &name, bool fullscreen=true)
 ~MythScreenType () override
bool gestureEvent (MythGestureEvent *event) override
 Mouse click/movement handler, receives mouse gesture events from the QCoreApplication event loop. More...
void doInit (void)
void LoadInForeground (void)
bool IsInitialized (void) const
 Has Init() been called on this screen? More...
bool IsFullscreen (void) const
void SetFullscreen (bool full)
MythUITypeGetFocusWidget (void) const
bool SetFocusWidget (MythUIType *widget=nullptr)
virtual bool NextPrevWidgetFocus (bool up_or_down)
void BuildFocusList (void)
MythScreenStackGetScreenStack () const
virtual void aboutToHide (void)
virtual void aboutToShow (void)
bool IsDeleting (void) const
void SetDeleting (bool deleting)
bool IsLoading (void) const
bool IsLoaded (void) const
MythPainterGetPainter (void) override
- Public Member Functions inherited from MythUIComposite
 MythUIComposite (QObject *parent, const QString &name)
 ~MythUIComposite () override=default
virtual void SetTextFromMap (const InfoMap &infoMap)
virtual void ResetMap (const InfoMap &infoMap)
- Public Member Functions inherited from MythUIType
 MythUIType (QObject *parent, const QString &name)
virtual void Reset (void)
 Reset the widget to it's original state, should not reset changes made by the theme. More...
void AddChild (MythUIType *child)
 Add a child UIType. More...
MythUITypeGetChild (const QString &name) const
 Get a named child of this UIType. More...
MythUITypeGetChildAt (const QPoint &p, bool recursive=true, bool focusable=true) const
 Return the first MythUIType at the given coordinates. More...
QList< MythUIType * > * GetAllChildren (void)
 Return a list of all child widgets. More...
void DeleteChild (const QString &name)
 Delete a named child of this UIType. More...
void DeleteChild (MythUIType *child)
 Delete the given UIType if it is a child of this UIType. More...
void DeleteAllChildren (void)
 Delete all child widgets. More...
bool NeedsRedraw (void) const
void ResetNeedsRedraw (void)
void SetRedraw (void)
void SetChildNeedsRedraw (MythUIType *child)
bool CanTakeFocus (void) const
 Return if this widget can accept input focus. More...
void SetCanTakeFocus (bool set=true)
 Set whether this widget can take focus. More...
void SetFocusOrder (int order)
bool IsEnabled (void) const
void SetEnabled (bool enable)
bool MoveToTop (void)
bool MoveChildToTop (MythUIType *child)
void ActivateAnimations (MythUIAnimation::Trigger trigger)
QList< MythUIAnimation * > * GetAnimations (void)
virtual void Pulse (void)
 Pulse is called 70 times a second to trigger a single frame of an animation. More...
void Draw (MythPainter *p, int xoffset, int yoffset, int alphaMod=255, QRect clipRect=QRect())
void SetPosition (int x, int y)
 Convenience method, calls SetPosition(const MythPoint&) Override that instead to change functionality. More...
virtual void SetPosition (const MythPoint &point)
virtual MythPoint GetPosition (void) const
virtual void SetSize (const QSize &size)
virtual void SetMinSize (const MythPoint &size)
 Set the minimum size of this widget, for widgets which can be rescaled. More...
virtual QSize GetMinSize (void) const
virtual void SetArea (const MythRect &rect)
virtual void AdjustMinArea (int delta_x, int delta_y, int delta_w, int delta_h)
 Adjust the size of a sibling. More...
virtual void VanishSibling (void)
virtual void SetMinAreaParent (MythRect actual_area, MythRect allowed_area, MythUIType *child)
 Adjust the size of sibling objects within the button. More...
virtual void SetMinArea (const MythRect &rect)
 Set the minimum area based on the given size. More...
virtual MythRect GetArea (void) const
 If the object has a minimum area defined, return it, other wise return the default area. More...
virtual MythRect GetFullArea (void) const
virtual void RecalculateArea (bool recurse=true)
void ExpandArea (const MythRect &rect)
virtual QRegion GetDirtyArea (void) const
bool IsVisible (bool recurse=false) const
virtual void SetVisible (bool visible)
void MoveTo (QPoint destXY, QPoint speedXY)
void AdjustAlpha (int mode, int alphachange, int minalpha=0, int maxalpha=255)
void SetAlpha (int newalpha)
int GetAlpha (void) const
virtual void mediaEvent (MythMediaEvent *event)
 Media/Device status event handler, received from MythMediaMonitor. More...
MythFontPropertiesGetFont (const QString &text) const
bool AddFont (const QString &text, MythFontProperties *fontProp)
void SetHelpText (const QString &text)
QString GetHelpText (void) const
void SetXMLLocation (const QString &filename, int where)
QString GetXMLLocation (void) const
void SetXMLName (const QString &name)
QString GetXMLName (void) const
bool IsDeferredLoading (bool recurse=false) const
void SetDeferLoad (bool defer)
virtual void LoadNow (void)
 Cause images in this and child widgets to be loaded. More...
bool ContainsPoint (const QPoint &point) const
 Check if the given point falls within this widgets area. More...
void SetPainter (MythPainter *painter)
void SetCentre (UIEffects::Centre centre)
void SetZoom (float zoom)
void SetHorizontalZoom (float zoom)
void SetVerticalZoom (float zoom)
void SetAngle (float angle)
void SetDependIsDefault (bool isDefault)
void SetReverseDependence (MythUIType *dependee, bool reverse)
void SetDependsMap (QMap< QString, QString > dependsMap)
QMap< QString, QString > GetDependsMap () const

Protected Member Functions

void customEvent (QEvent *event) override
- Protected Member Functions inherited from MusicCommon
 MusicCommon (MythScreenStack *parent, MythScreenType *parentScreen, const QString &name)
 ~MusicCommon (void) override
bool CreateCommon (void)
void switchView (MusicView view)
void customEvent (QEvent *event) override
bool keyPressEvent (QKeyEvent *e) override
 Key event handler. More...
void ShowMenu (void) override
void showExitMenu (void)
void showPlaylistOptionsMenu (bool addMainMenu=false)
void init (bool startPlayback=true)
void updateProgressBar (void)
void updateTrackInfo (MusicMetadata *mdata)
void updateUIPlaylist (void)
void updatePlaylistStats (void)
void updateUIPlayedList (void)
void updateRepeatMode (void)
void updateShuffleMode (bool updateUIList=false)
void changeVolume (bool up) const
void toggleMute (void) const
void updateVolume (void)
void startVisualizer (void)
void stopVisualizer (void)
void cycleVisualizer (void)
void switchVisualizer (const QString &visual)
void switchVisualizer (int visual)
bool restorePosition (int trackID)
- Protected Member Functions inherited from MythScreenType
 MythScreenType (MythUIType *parent, const QString &name, bool fullscreen=true)
void CopyFrom (MythUIType *base) override
 Copy this widgets state from another. More...
void CreateCopy (MythUIType *parent) override
 Copy the state of this widget to the one given, it must be of the same type. More...
bool ParseElement (const QString &filename, QDomElement &element, bool showWarnings) override
 Parse the xml definition of this widget setting the state of the object accordingly. More...
virtual void Load (void)
 Load data which will ultimately be displayed on-screen or used to determine what appears on-screen (See Warning) More...
virtual void Init (void)
 Used after calling Load() to assign data to widgets and other UI initilisation which is prohibited in Load() More...
void LoadInBackground (const QString &message="")
void ReloadInBackground (void)
void OpenBusyPopup (const QString &message="")
void CloseBusyPopup (void)
void SetBusyPopupMessage (const QString &message)
void ResetBusyPopup (void)
- Protected Member Functions inherited from MythUIType
 ~MythUIType () override
void customEvent (QEvent *event) override
virtual void DrawSelf (MythPainter *p, int xoffset, int yoffset, int alphaMod, QRect clipRect)
void AddFocusableChildrenToList (QMap< int, MythUIType * > &focusList)
void HandleAlphaPulse ()
 Handle one frame of an alpha (transparency) change animation. More...
void HandleMovementPulse ()
 Handle one frame of a movement animation. More...
int CalcAlpha (int alphamod) const
void ConnectDependants (bool recurse=false)
virtual void Finalize (void)
 Perform any post-xml parsing initialisation tasks. More...

Private Slots

void setLyricTime (void)
void editFinished (bool result)
void lyricStatusChanged (LyricsData::Status status, const QString &message)

Private Member Functions

void findLyrics (const QString &grabber="ALL")
void showLyrics (void)
void saveLyrics (void)
void editLyrics (void)
void showMessage (const QString &message)
MythMenucreateFindLyricsMenu (void)

Private Attributes

MythUIButtonListm_lyricsList {nullptr}
MythUITextm_statusText {nullptr}
MythUIStateTypem_loadingState {nullptr}
MythUITextm_bufferStatus {nullptr}
MythUIProgressBarm_bufferProgress {nullptr}
LyricsDatam_lyricData {nullptr}
bool m_autoScroll {true}

Additional Inherited Members

- Public Slots inherited from MythScreenType
virtual void Close ()
- Public Slots inherited from MythUIType
void LoseFocus ()
bool TakeFocus ()
void Activate ()
void Hide (void)
void Show (void)
void Refresh (void)
void UpdateDependState (bool isDefault)
void UpdateDependState (MythUIType *dependee, bool isDefault)
- Signals inherited from MythScreenType
void Exiting ()
- Signals inherited from MythUIType
void RequestUpdate ()
void RequestUpdate (const QRect &)
void RequestRegionUpdate (const QRect &)
void TakingFocus ()
void LosingFocus ()
void Showing ()
void Hiding ()
void Enabling ()
void Disabling ()
void FinishedMoving ()
void FinishedFading ()
void DependChanged (bool isDefault)
- Static Public Member Functions inherited from XMLParseBase
static QString getFirstText (QDomElement &element)
static bool parseBool (const QString &text)
static bool parseBool (QDomElement &element)
static MythPoint parsePoint (const QString &text, bool normalize=true)
static MythPoint parsePoint (QDomElement &element, bool normalize=true)
static QSize parseSize (const QString &text, bool normalize=true)
static QSize parseSize (QDomElement &element, bool normalize=true)
static MythRect parseRect (const QString &text, bool normalize=true)
static MythRect parseRect (QDomElement &element, bool normalize=true)
static int parseAlignment (const QString &text)
static int parseAlignment (QDomElement &element)
static QBrush parseGradient (const QDomElement &element)
static QString parseText (QDomElement &element)
static MythUITypeGetGlobalObjectStore (void)
static void ClearGlobalObjectStore (void)
static void ParseChildren (const QString &filename, QDomElement &element, MythUIType *parent, bool showWarnings)
static MythUITypeParseUIType (const QString &filename, QDomElement &element, const QString &type, MythUIType *parent, MythScreenType *screen, bool showWarnings, QMap< QString, QString > &parentDependsMap)
static bool WindowExists (const QString &xmlfile, const QString &windowname)
static bool LoadWindowFromXML (const QString &xmlfile, const QString &windowname, MythUIType *parent)
static bool LoadBaseTheme (void)
static bool LoadBaseTheme (const QString &baseTheme)
static bool CopyWindowFromBase (const QString &windowname, MythScreenType *win)
- Protected Slots inherited from MusicCommon
void viewExited (void)
static void play (void)
void stop (void)
static void pause (void)
void previous (void)
void next (void)
void seekforward (void)
void seekback (void)
void seek (int pos)
void stopAll (void)
static void changeRating (bool increase)
void searchButtonList (void)
MythMenucreateMainMenu (void)
MythMenucreateSubMenu (void)
MythMenucreatePlaylistMenu (void)
MythMenucreatePlayerMenu (void)
MythMenucreateQuickPlaylistsMenu (void)
MythMenucreateRepeatMenu (void)
MythMenucreateShuffleMenu (void)
MythMenucreateVisualizerMenu (void)
MythMenucreatePlaylistOptionsMenu (void)
void playlistItemClicked (MythUIButtonListItem *item)
static void playlistItemVisible (MythUIButtonListItem *item)
void fromCD (void)
void allTracks (void)
void byArtist (void)
void byAlbum (void)
void byGenre (void)
void byYear (void)
void byTitle (void)
void doUpdatePlaylist (void)
- Static Protected Member Functions inherited from MusicCommon
static QString getTimeString (int exTime, int maxTime)
static void setTrackOnLCD (MusicMetadata *mdata)
static void editTrackInfo (MusicMetadata *mdata)
static void showTrackInfo (MusicMetadata *mdata)
static void changeSpeed (bool up)
static void toggleUpmix (void)
static void showVolume (void)
static void showSpeed (bool show)
static void playFirstTrack ()
- Static Protected Member Functions inherited from MythUIType
static int NormX (int width)
static int NormY (int height)
- Protected Attributes inherited from MusicCommon
MythScreenTypem_parentScreen {nullptr}
MusicView m_currentView
MainVisualm_mainvisual {nullptr}
bool m_fullscreenBlank {false}
bool m_cycleVisualizer {false}
bool m_randomVisualizer {false}
QStringList m_visualModes
unsigned int m_currentVisual {0}
bool m_moveTrackMode {false}
bool m_movingTrack {false}
bool m_controlVolume {true}
int m_currentTrack {0}
int m_currentTime {0}
int m_maxTime {0}
uint m_playlistTrackCount {0}
uint m_playlistPlayedTime {0}
uint m_playlistMaxTime {0}
PlaylistOptions m_playlistOptions {PL_REPLACE, PL_CURRENT}
QString m_whereClause
QList< int > m_songList
MythUITextm_timeText {nullptr}
MythUITextm_infoText {nullptr}
MythUITextm_visualText {nullptr}
MythUITextm_noTracksText {nullptr}
MythUIStateTypem_shuffleState {nullptr}
MythUIStateTypem_repeatState {nullptr}
MythUIStateTypem_movingTracksState {nullptr}
MythUIStateTypem_ratingState {nullptr}
MythUIProgressBarm_trackProgress {nullptr}
MythUITextm_trackProgressText {nullptr}
MythUITextm_trackSpeedText {nullptr}
MythUIStateTypem_trackState {nullptr}
MythUIStateTypem_muteState {nullptr}
MythUITextm_volumeText {nullptr}
MythUIProgressBarm_playlistProgress {nullptr}
MythUIButtonm_prevButton {nullptr}
MythUIButtonm_rewButton {nullptr}
MythUIButtonm_pauseButton {nullptr}
MythUIButtonm_playButton {nullptr}
MythUIButtonm_stopButton {nullptr}
MythUIButtonm_ffButton {nullptr}
MythUIButtonm_nextButton {nullptr}
MythUIImagem_coverartImage {nullptr}
MythUIButtonListm_currentPlaylist {nullptr}
MythUIButtonListm_playedTracksList {nullptr}
MythUIVideom_visualizerVideo {nullptr}
- Protected Attributes inherited from MythScreenType
bool m_FullScreen {false}
bool m_IsDeleting {false}
QSemaphore m_LoadLock {1}
volatile bool m_IsLoading {false}
volatile bool m_IsLoaded {false}
bool m_IsInitialized {false}
MythUITypem_CurrentFocusWidget {nullptr}
QMap< int, MythUIType * > m_FocusWidgetList
MythScreenStackm_ScreenStack {nullptr}
MythUIBusyDialogm_BusyPopup {nullptr}
QRegion m_SavedMask
- Protected Attributes inherited from MythUIType
QList< MythUIType * > m_ChildrenList
QMap< QString, QString > m_dependsMap
QList< QPair< MythUIType *, bool > > m_dependsValue
QList< int > m_dependOperator
bool m_Visible {true}
bool m_HasFocus {false}
bool m_CanHaveFocus {false}
bool m_Enabled {true}
bool m_EnableInitiator {false}
bool m_Initiator {false}
bool m_Vanish {false}
bool m_Vanished {false}
bool m_IsDependDefault {false}
QMap< MythUIType *, boolm_ReverseDepend
int m_focusOrder {0}
MythRect m_Area {0,0,0,0}
MythRect m_MinArea {0,0,0,0}
MythPoint m_MinSize
QRegion m_DirtyRegion {0,0,0,0}
bool m_NeedsRedraw {false}
UIEffects m_Effects
int m_AlphaChangeMode {0}
int m_AlphaChange {0}
int m_AlphaMin {0}
int m_AlphaMax {255}
bool m_Moving {false}
QPoint m_XYDestination {0,0}
QPoint m_XYSpeed {0,0}
FontMapm_Fonts {nullptr}
MythUITypem_Parent {nullptr}
MythPainterm_Painter {nullptr}
QList< MythUIAnimation * > m_animations
QString m_helptext
QString m_xmlName
QString m_xmlLocation
bool m_deferload {false}
QColor m_BorderColor {Qt::black}

Detailed Description

Definition at line 17 of file lyricsview.h.

Constructor & Destructor Documentation

◆ LyricsView()

LyricsView::LyricsView ( MythScreenStack parent,
MythScreenType parentScreen 

Definition at line 39 of file lyricsview.cpp.

◆ ~LyricsView()

LyricsView::~LyricsView ( void  )

Definition at line 47 of file lyricsview.cpp.

Member Function Documentation

◆ Create()

bool LyricsView::Create ( void  )

Reimplemented from MythScreenType.

Definition at line 58 of file lyricsview.cpp.

◆ keyPressEvent()

bool LyricsView::keyPressEvent ( QKeyEvent *  event)

Key event handler.

eventKeypress event

Reimplemented from MythScreenType.

Definition at line 274 of file lyricsview.cpp.

◆ ShowMenu()

void LyricsView::ShowMenu ( void  )

Reimplemented from MythScreenType.

Definition at line 220 of file lyricsview.cpp.

◆ customEvent()

void LyricsView::customEvent ( QEvent *  event)

Definition at line 95 of file lyricsview.cpp.

◆ findLyrics()

void LyricsView::findLyrics ( const QString &  grabber = "ALL")

Definition at line 351 of file lyricsview.cpp.

Referenced by Create(), and customEvent().

◆ showLyrics()

void LyricsView::showLyrics ( void  )

Definition at line 439 of file lyricsview.cpp.

Referenced by editFinished(), and lyricStatusChanged().

◆ saveLyrics()

void LyricsView::saveLyrics ( void  )

Definition at line 463 of file lyricsview.cpp.

Referenced by customEvent().

◆ editLyrics()

void LyricsView::editLyrics ( void  )

Definition at line 469 of file lyricsview.cpp.

Referenced by customEvent(), and keyPressEvent().

◆ showMessage()

void LyricsView::showMessage ( const QString &  message)

Definition at line 422 of file lyricsview.cpp.

Referenced by lyricStatusChanged(), and showLyrics().

◆ createFindLyricsMenu()

MythMenu * LyricsView::createFindLyricsMenu ( void  )

Definition at line 257 of file lyricsview.cpp.

Referenced by ShowMenu().

◆ setLyricTime

void LyricsView::setLyricTime ( void  )

Definition at line 329 of file lyricsview.cpp.

Referenced by Create(), and keyPressEvent().

◆ editFinished

void LyricsView::editFinished ( bool  result)

Definition at line 484 of file lyricsview.cpp.

Referenced by editLyrics().

◆ lyricStatusChanged

void LyricsView::lyricStatusChanged ( LyricsData::Status  status,
const QString &  message 

Definition at line 388 of file lyricsview.cpp.

Referenced by findLyrics().

Member Data Documentation

◆ m_lyricsList

MythUIButtonList* LyricsView::m_lyricsList {nullptr}

Definition at line 47 of file lyricsview.h.

Referenced by Create(), customEvent(), findLyrics(), keyPressEvent(), setLyricTime(), and showLyrics().

◆ m_statusText

MythUIText* LyricsView::m_statusText {nullptr}

Definition at line 48 of file lyricsview.h.

Referenced by Create(), and showMessage().

◆ m_loadingState

MythUIStateType* LyricsView::m_loadingState {nullptr}

Definition at line 49 of file lyricsview.h.

Referenced by Create(), findLyrics(), lyricStatusChanged(), and showLyrics().

◆ m_bufferStatus

MythUIText* LyricsView::m_bufferStatus {nullptr}

Definition at line 50 of file lyricsview.h.

Referenced by Create(), and customEvent().

◆ m_bufferProgress

MythUIProgressBar* LyricsView::m_bufferProgress {nullptr}

Definition at line 51 of file lyricsview.h.

Referenced by Create(), and customEvent().

◆ m_lyricData

LyricsData* LyricsView::m_lyricData {nullptr}

◆ m_autoScroll

bool LyricsView::m_autoScroll {true}

Definition at line 55 of file lyricsview.h.

Referenced by customEvent(), keyPressEvent(), setLyricTime(), showLyrics(), and ShowMenu().

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