qspotifytracklist.h

/****************************************************************************
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Yoann Lopes (yoann.lopes@nokia.com)
**
** This file is part of the MeeSpot project.
** 
** Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions
** are met:
** 
** Redistributions of source code must retain the above copyright notice,
** this list of conditions and the following disclaimer.
** 
** Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in the
** documentation and/or other materials provided with the distribution.
** 
** Neither the name of Nokia Corporation and its Subsidiary(-ies) nor the names of its
** contributors may be used to endorse or promote products derived from
** this software without specific prior written permission.
** 
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
** FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
** TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
** PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
** LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
** NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/


#ifndef QSPOTIFYTRACKLIST_H
#define QSPOTIFYTRACKLIST_H

#include "qspotifytrack.h"
#include "listmodels/listmodelbase.h"

class QSpotifyTrackList : public ListModelBase<QSpotifyTrack>
{
    Q_OBJECT
public:
    enum Roles{
        NameRole = Qt::UserRole+1,
        ArtistsRole,
        AlbumRole,
        AlbumCoverRole,
        DiscNumberRole,
        DurationRole,
        DurationMsRole,
        ErrorRole,
        DiscIndexRole,
        IsAvailableRole,
        IsStarredRole,
        PopularityRole,
        IsCurrentPlayingTrackRole,
        SeenRole,
        CreatorRole,
        CreationDateRole,
        AlbumObjectRole,
        ArtistObjectRole,
        OfflineStatusRole,
        RawPtrRole
    };

    QSpotifyTrackList(QObject *parent = nullptr);

    QVariant data(const QModelIndex &index, int role) const;
    QHash<int, QByteArray> roleNames() const { return m_roles; }

    void play();
    Q_INVOKABLE void playTrack(int index);

    int totalDuration() const;

    int indexOf(QSpotifyTrack *ptr) const
    { return m_dataList.indexOf(ptr); }

    void replace(int i, QSpotifyTrack *ptr)
    { m_dataList.replace(i, ptr); }

    int removeAll(QSpotifyTrack *ptr);

protected:
    int nextAvailable(int i);
    int previousAvailable(int i);

private:
    void playCurrentTrack();
    QHash<int, QByteArray> m_roles;

    friend class QSpotifyTrack;
    friend class QSpotifyPlaylist;
    friend class QSpotifySearch;
    friend class QSpotifyPlayQueue;
    friend class QSpotifyAlbumBrowse;
    friend class QSpotifyArtistBrowse;
    friend class QSpotifyUser;
    friend class QSpotifyToplist;
};

#endif // QSPOTIFYTRACKLIST_H