LeechCraft  0.6.70-10870-g558588d6ec
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 <boost/optional.hpp>
33 #include <QStringList>
34 
35 namespace Media
36 {
41  struct LyricsQuery
42  {
45  QString Artist_;
46 
49  QString Album_;
50 
53  QString Title_;
54 
57  boost::optional<int> Year_;
58 
61  boost::optional<int> Track_;
62  };
63 
69  {
72  NoOption = 0x0,
73 
76  Refresh = 0x1
77  };
78 
81  Q_DECLARE_FLAGS (QueryOptions, QueryOption);
82 
91  {
94  QString ProviderName_;
95 
98  QString Lyrics_;
99  };
100 
109  {
113 
120  };
121 
134  class Q_DECL_EXPORT ILyricsFinder
135  {
136  public:
137  virtual ~ILyricsFinder () {}
138 
144  virtual void RequestLyrics (const LyricsQuery& query, QueryOptions options = NoOption) = 0;
145  protected:
154  virtual void gotLyrics (const LyricsResults& results) = 0;
155  };
156 }
157 
158 Q_DECLARE_INTERFACE (Media::ILyricsFinder, "org.LeechCraft.Media.ILyricsFinder/1.0")
QString ProviderName_
The name of the provider lyrics were fetched from.
Definition: ilyricsfinder.h:94
QString Album_
The album this track is on.
Definition: ilyricsfinder.h:49
QueryOption
Describes the various lyrics request options.
Definition: ilyricsfinder.h:68
QString Title_
The title of the track.
Definition: ilyricsfinder.h:53
boost::optional< int > Year_
The year of the album the track is on.
Definition: ilyricsfinder.h:57
Q_DECLARE_FLAGS(QueryOptions, QueryOption)
Typedef for QFlags<QueryOption>.
Describes a lyrics search request.
Definition: ilyricsfinder.h:41
Describes the result set for a given lyrics query.
Interface for plugins supporting finding lyrics.
Refresh any cached data.
Definition: ilyricsfinder.h:76
QList< LyricsResultItem > Items_
The list of found items for the Query_.
boost::optional< int > Track_
The track number.
Definition: ilyricsfinder.h:61
LyricsQuery Query_
The original query these results are for.
Default lyrics search request.
Definition: ilyricsfinder.h:72
Describes a single lyrics result item.
Definition: ilyricsfinder.h:90
QString Lyrics_
The HTML-formatted lyrics string.
Definition: ilyricsfinder.h:98
QString Artist_
The artist preforming the track.
Definition: ilyricsfinder.h:45