stationlistmodel.h

Go to the documentation of this file.

/*
    Copyright (C) 2008-2010  Lukas Sommer < SommerLuk at gmail dot com >

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License as
    published by the Free Software Foundation; either version 2 of
    the License or (at your option) version 3 or any later version
    accepted by the membership of KDE e.V. (or its successor approved
    by the membership of KDE e.V.), which shall act as a proxy
    defined in Section 14 of version 3 of the license.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef STATIONLISTMODEL_H
#define STATIONLISTMODEL_H

#include <QAbstractItemModel>
#include <QList>
#include <QPointer>
#include <QXmlStreamWriter>
#include <phonon/mediaobject.h>
#include <phonon/path.h>
#include <phonon/audiooutput.h>
#include "folderpropertiesdialog.h"
#include "listensupport.h"
#include "radiostation.h"
#include "stationlistitem.h"

class stationlistWidget;

class stationlistModel : public QAbstractItemModel
{

     Q_OBJECT

     Q_PROPERTY(quint64 bandwidth READ bandwidth)

     
     Q_PROPERTY(QList<radioStation *> selectedStreams READ selectedStreams)

     Q_PROPERTY(int numberOfActiveStreams READ numberOfActiveStreams)

  public:
     explicit stationlistModel(stationlistWidget *parent,
                               QWidget *mainWidget = 0);

     virtual ~stationlistModel();

     enum columnInfoType{
       columnHeaderTitle,
       columnHeaderToolTip,
       columnHeaderWhatsThis,
       columnWidth,
       setColumnWidth,
       columnVisibility,
       setColumnVisibility,
       columnData
     };

     quint64 bandwidth() const;

     virtual int columnCount(const QModelIndex & parent = QModelIndex()) const;

     QVariant columnInfo(const columnInfoType type,
                         const int column,
                         const radioStation *stream = 0,
                         const quint64 value = (-1)) const;

     virtual QVariant data (const QModelIndex & index, int role = Qt::DisplayRole) const;

     virtual bool dropMimeData(const QMimeData *data,
                               Qt::DropAction action,
                               int row,
                               int column,
                               const QModelIndex & parent);

     virtual Qt::ItemFlags flags(const QModelIndex & index) const;

     virtual QVariant headerData(int section, Qt::Orientation orientation, int role) const;

     virtual QModelIndex index (int row,
                                int column,
                                const QModelIndex & parent = QModelIndex()) const;

     listenSupport listen;

     virtual QStringList mimeTypes () const;

     int numberOfActiveStreams() const;

     virtual QModelIndex parent(const QModelIndex & index) const;

     virtual bool queryClose();

     virtual void readProperties(const KConfigGroup & m_configGroup);

     virtual bool removeRows(int row, int count, const QModelIndex & parent = QModelIndex());

     virtual int rowCount(const QModelIndex & parent = QModelIndex()) const;

     virtual void saveProperties(KConfigGroup & m_configGroup);

     QList<radioStation *> selectedStreams() const;

     virtual void sort (int column, Qt::SortOrder order = Qt::AscendingOrder);

  signals:
     void bandwidthChanged();
     void numberOfActiveStreamsChanged();
     void numberOfActiveStreamsIsZero();
     void relayportChanged();
     void selectedStreamsChanged();
     void statusChanged();

  public slots:
     void addNewFolder();
     void addNewFolderInFolder();
     void addNewStation();
     void addNewStationInFolder();
     void enableListeningIn();
     void disableListeningIn();
     void paste();
     void pasteSelection(const QModelIndex & index);
     void record();
     void showConfigDialog();
     void stopRecording();

  protected:
     QPointer<stationlistWidget> view;

  private:
     enum mode {
       add,
       move
     };
     void helper_addNewFolder(const QModelIndex & index);
     void helper_addNewStation(const QModelIndex & index);
     void helper_connectSignalsAndSlots(radioStation *m_stream);
     QList<QUrl> helper_convertToUrl(const QMimeData *data);
     stationlistItem *helper_createStreamItem(radioStation *stream);
     void helper_deleteRadiostationobjectAndRemoveConfigfiles(radioStation *station);
     void helper_deleteRadiostationobjectAndRemoveConfigfiles(stationlistItem *item);
     bool helper_firstIsAfterSecond(stationlistItem *firstItem,
                                    stationlistItem *secondItem,
                                    int column,
                                    Qt::SortOrder order);
     bool helper_firstIsAfterSecond(const PropertyValue & firstValue,
                                    const PropertyValue & secondValue,
                                    Qt::SortOrder order);
     bool helper_hasStreams(stationlistItem *item);
     QList<radioStation *> helper_listOfAllStreams(stationlistItem *parentItem);
     void helper_insertItems(QList<stationlistItem *> itemList,
                             const QModelIndex &parent,
                             int row);
     void helper_insertItem(stationlistItem * item, const QModelIndex &parent, int row);
     bool helper_isInTree(stationlistItem *child, stationlistItem *parent);
     bool helper_isNumericValue(const QVariant & value);
     void helper_moveItems(const QModelIndex &oldParent,
                           int first,
                           int last,
                           const QModelIndex &newParent,
                           int newRow);
     QList<stationlistItem *> helper_removeItems(const QModelIndex &parent, int first, int last);
     void helper_selectAndScrollTo(const QModelIndexList & modelIndexList);
     QString helper_stationlistXmlFilepath();
     qlonglong helper_toLongLong(const PropertyValue & value);
     void helper_writeStationList();
     stationlistItem *item(const QModelIndex & index) const;
     quint64 internal_bandwidth;
     int internal_numberOfActiveStreams;
     QList<radioStation *> internal_selectedStreams;
     QStringList *m_listOfStreamsOfWhichTheUserWantsThatTheyRip;
     QPointer<QWidget> m_mainWidget;
     QModelIndex modelindexOfItem(stationlistItem *item, int column);
     stationlistItem *rootItem;
     void sortChildItems(stationlistItem *parent, int column, Qt::SortOrder order);
     void writeItemToFile(stationlistItem *item, QXmlStreamWriter &file);

  private slots:
     void recalculate_numberOfActiveStreams_and_bandwidth();
     void recalculateSelectedStreams();
     void reloadBitrate(void *stationIndex);
     void reloadDataSize(void *stationIndex);
     void reloadMetaInterval(void *stationIndex);
     void reloadMetaInterval_milliSeconds(void *stationIndex);
     void reloadRelayPort(void *stationIndex);
     void reloadServerName(void *stationIndex);
     void reloadSong(void *stationIndex);
     void reloadStatus(void *stationIndex);
     void reloadStreamName(void *stationIndex);
     void reloadUri(void *stationIndex);
     void rememberListOfStreamsWhichTheUserWantsToRip_ifNotYetDone();

};

#endif