LeechCraft  0.6.70-6645-gcd10d7e
Modular cross-platform feature rich live environment.
ilyricsfinder.h
Go to the documentation of this file.
1 /**********************************************************************
2  * LeechCraft - modular cross-platform feature rich internet client.
3  * Copyright (C) 2006-2014 Georg Rudoy
4  *
5  * Boost Software License - Version 1.0 - August 17th, 2003
6  *
7  * Permission is hereby granted, free of charge, to any person or organization
8  * obtaining a copy of the software and accompanying documentation covered by
9  * this license (the "Software") to use, reproduce, display, distribute,
10  * execute, and transmit the Software, and to prepare derivative works of the
11  * Software, and to permit third-parties to whom the Software is furnished to
12  * do so, all subject to the following:
13  *
14  * The copyright notices in the Software and this entire statement, including
15  * the above license grant, this restriction and the following disclaimer,
16  * must be included in all copies of the Software, in whole or in part, and
17  * all derivative works of the Software, unless such copies or derivative
18  * works are solely in the form of machine-executable object code generated by
19  * a source language processor.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24  * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25  * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  **********************************************************************/
29 
30 #pragma once
31 
32 #include <QStringList>
33 
34 namespace Media
35 {
40  struct LyricsQuery
41  {
44  QString Artist_;
45 
48  QString Album_;
49 
52  QString Title_;
53 
57  {
58  }
59 
66  LyricsQuery (const QString& artist, const QString& album, const QString& title)
67  : Artist_ (artist)
68  , Album_ (album)
69  , Title_ (title)
70  {
71  }
72  };
73 
79  {
82  NoOption = 0x0,
83 
86  Refresh = 0x1
87  };
88 
97  {
100  QString ProviderName_;
101 
104  QString Lyrics_;
105  };
106 
115  {
119 
126  };
127 
130  Q_DECLARE_FLAGS (QueryOptions, QueryOption);
131 
144  class Q_DECL_EXPORT ILyricsFinder
145  {
146  public:
147  virtual ~ILyricsFinder () {}
148 
154  virtual void RequestLyrics (const LyricsQuery& query, QueryOptions options = NoOption) = 0;
155  protected:
164  virtual void gotLyrics (const LyricsResults& results) = 0;
165  };
166 }
167 
168 Q_DECLARE_INTERFACE (Media::ILyricsFinder, "org.LeechCraft.Media.ILyricsFinder/1.0");
QString ProviderName_
The name of the provider lyrics were fetched from.
QString Album_
The album this track is on.
Definition: ilyricsfinder.h:48
QueryOption
Describes the various lyrics request options.
Definition: ilyricsfinder.h:78
QString Title_
The title of the track.
Definition: ilyricsfinder.h:52
Q_DECLARE_FLAGS(QueryOptions, QueryOption)
Typedef for QFlags<QueryOption>.
Describes a lyrics search request.
Definition: ilyricsfinder.h:40
LyricsQuery(const QString &artist, const QString &album, const QString &title)
Constructs a search request for the given track data.
Definition: ilyricsfinder.h:66
Describes the result set for a given lyrics query.
Interface for plugins supporting finding lyrics.
Refresh any cached data.
Definition: ilyricsfinder.h:86
LyricsQuery()
Constructs an empty request.
Definition: ilyricsfinder.h:56
QList< LyricsResultItem > Items_
The list of found items for the Query_.
LyricsQuery Query_
The original query these results are for.
Default lyrics search request.
Definition: ilyricsfinder.h:82
Describes a single lyrics result item.
Definition: ilyricsfinder.h:96
QString Lyrics_
The HTML-formatted lyrics string.
Q_DECLARE_INTERFACE(Media::ILyricsFinder,"org.LeechCraft.Media.ILyricsFinder/1.0")
QString Artist_
The artist preforming the track.
Definition: ilyricsfinder.h:44