iradiostationprovider.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 <memory>
#include <functional>
#include <boost/variant.hpp>
#include <QMap>
#include <QMetaType>
#include <QtPlugin>

class QModelIndex;
class QAbstractItemModel;

namespace Media
{
    class IRadioStation;
    typedef std::shared_ptr<IRadioStation> IRadioStation_ptr;

    using ActionFunctor_f = boost::variant<std::function<void (QModelIndex)>, std::function<void ()>>;

    enum RadioType
    {
        None,

        SimilarArtists,

        GlobalTag,

        Predefined,

        CustomAddableStreams,

        TracksList,

        SingleTrack,

        TracksRoot,

        RadioAction
    };

    enum RadioItemRole
    {
        ItemType = Qt::UserRole + 1,

        RadioID,

        PluginID,

        TracksInfos,

        ActionFunctor,

        MaxRadioRole
    };

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

        virtual IRadioStation_ptr GetRadioStation (const QModelIndex& item, const QString& query) = 0;

        virtual QList<QAbstractItemModel*> GetRadioListItems () const = 0;

        virtual void RefreshItems (const QList<QModelIndex>&) = 0;
    };
}

Q_DECLARE_METATYPE (Media::ActionFunctor_f)

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