ilyricsfinder.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Boost Software License - Version 1.0 - August 17th, 2003
 *
 * Permission is hereby granted, free of charge, to any person or organization
 * obtaining a copy of the software and accompanying documentation covered by
 * this license (the "Software") to use, reproduce, display, distribute,
 * execute, and transmit the Software, and to prepare derivative works of the
 * Software, and to permit third-parties to whom the Software is furnished to
 * do so, all subject to the following:
 *
 * The copyright notices in the Software and this entire statement, including
 * the above license grant, this restriction and the following disclaimer,
 * must be included in all copies of the Software, in whole or in part, and
 * all derivative works of the Software, unless such copies or derivative
 * works are solely in the form of machine-executable object code generated by
 * a source language processor.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 **********************************************************************/

#pragma once

#include <QStringList>

namespace Media
{
    struct LyricsQuery
    {
        QString Artist_;

        QString Album_;

        QString Title_;

        LyricsQuery ()
        {
        }

        LyricsQuery (const QString& artist, const QString& album, const QString& title)
        : Artist_ (artist)
        , Album_ (album)
        , Title_ (title)
        {
        }
    };

    enum QueryOption
    {
        NoOption = 0x0,

        Refresh = 0x1
    };

    struct LyricsResultItem
    {
        QString ProviderName_;

        QString Lyrics_;
    };

    struct LyricsResults
    {
        LyricsQuery Query_;

        QList<LyricsResultItem> Items_;
    };

    Q_DECLARE_FLAGS (QueryOptions, QueryOption);

    class Q_DECL_EXPORT ILyricsFinder
    {
    public:
        virtual ~ILyricsFinder () {}

        virtual void RequestLyrics (const LyricsQuery& query, QueryOptions options = NoOption) = 0;
    protected:
        virtual void gotLyrics (const LyricsResults& results) = 0;
    };
}

Q_DECLARE_INTERFACE (Media::ILyricsFinder, "org.LeechCraft.Media.ILyricsFinder/1.0")