Merge pull request #4034 from Holzhaus/sidebar-icon-name

SidebarModel: Add basic support for icon names

src/library/analysisfeature.cpp

@@ -48,9 +48,8 @@ AnalyzerModeFlags getAnalyzerModeFlags(
 AnalysisFeature::AnalysisFeature(
         Library* pLibrary,
         UserSettingsPointer pConfig)
-        : LibraryFeature(pLibrary, pConfig),
+        : LibraryFeature(pLibrary, pConfig, QStringLiteral("prepare")),
           m_baseTitle(tr("Analyze")),
-          m_icon(":/images/library/ic_library_prepare.svg"),
           m_pTrackAnalysisScheduler(TrackAnalysisScheduler::NullPointer()),
           m_pSidebarModel(make_parented<TreeItemModel>(this)),
           m_pAnalysisView(nullptr),

src/library/analysisfeature.h

@@ -27,10 +27,6 @@ class AnalysisFeature : public LibraryFeature {
         return m_title;
     }
 
-    QIcon getIcon() override {
-        return m_icon;
-    }
-
     bool dropAccept(const QList<QUrl>& urls, QObject* pSource) override;
     bool dragMoveAccept(const QUrl& url) override;
     void bindLibraryWidget(WLibrary* libraryWidget,
@@ -65,7 +61,6 @@ class AnalysisFeature : public LibraryFeature {
     void setTitleProgress(int currentTrackNumber, int totalTracksCount);
 
     const QString m_baseTitle;
-    const QIcon m_icon;
 
     TrackAnalysisScheduler::Pointer m_pTrackAnalysisScheduler;
 

src/library/autodj/autodjfeature.cpp

@@ -48,15 +48,14 @@ namespace {
 AutoDJFeature::AutoDJFeature(Library* pLibrary,
         UserSettingsPointer pConfig,
         PlayerManagerInterface* pPlayerManager)
-        : LibraryFeature(pLibrary, pConfig),
+        : LibraryFeature(pLibrary, pConfig, QStringLiteral("autodj")),
           m_pTrackCollection(pLibrary->trackCollectionManager()->internalCollection()),
           m_playlistDao(m_pTrackCollection->getPlaylistDAO()),
           m_iAutoDJPlaylistId(findOrCrateAutoDjPlaylistId(m_playlistDao)),
           m_pAutoDJProcessor(nullptr),
           m_pSidebarModel(make_parented<TreeItemModel>(this)),
           m_pAutoDJView(nullptr),
-          m_autoDjCratesDao(m_iAutoDJPlaylistId, pLibrary->trackCollectionManager(), m_pConfig),
-          m_icon(":/images/library/ic_library_autodj.svg") {
+          m_autoDjCratesDao(m_iAutoDJPlaylistId, pLibrary->trackCollectionManager(), m_pConfig) {
     qRegisterMetaType<AutoDJProcessor::AutoDJState>("AutoDJState");
     m_pAutoDJProcessor = new AutoDJProcessor(this,
             m_pConfig,
@@ -111,10 +110,6 @@ QVariant AutoDJFeature::title() {
     return tr("Auto DJ");
 }
 
-QIcon AutoDJFeature::getIcon() {
-    return m_icon;
-}
-
 void AutoDJFeature::bindLibraryWidget(
         WLibrary* libraryWidget,
         KeyboardEventFilter* keyboard) {

src/library/autodj/autodjfeature.h

@@ -1,7 +1,6 @@
 #pragma once
 
 #include <QAction>
-#include <QIcon>
 #include <QList>
 #include <QModelIndex>
 #include <QObject>
@@ -35,7 +34,6 @@ class AutoDJFeature : public LibraryFeature {
     virtual ~AutoDJFeature();
 
     QVariant title() override;
-    QIcon getIcon() override;
 
     bool dropAccept(const QList<QUrl>& urls, QObject* pSource) override;
     bool dragMoveAccept(const QUrl& url) override;
@@ -84,7 +82,6 @@ class AutoDJFeature : public LibraryFeature {
     // auto-DJ list.
     QAction *m_pRemoveCrateFromAutoDj;
 
-    QIcon m_icon;
     QPointer<WLibrarySidebar> m_pSidebarWidget;
 
   private slots:

src/library/banshee/bansheefeature.cpp

@@ -17,10 +17,9 @@ const QString BansheeFeature::BANSHEE_MOUNT_KEY = "mixxx.BansheeFeature.mount";
 QString BansheeFeature::m_databaseFile;
 
 BansheeFeature::BansheeFeature(Library* pLibrary, UserSettingsPointer pConfig)
-        : BaseExternalLibraryFeature(pLibrary, pConfig),
+        : BaseExternalLibraryFeature(pLibrary, pConfig, QStringLiteral("banshee")),
           m_pSidebarModel(make_parented<TreeItemModel>(this)),
-          m_cancelImport(false),
-          m_icon(":/images/library/ic_library_banshee.svg") {
+          m_cancelImport(false) {
     Q_UNUSED(pConfig);
     m_pBansheePlaylistModel = new BansheePlaylistModel(
             this, m_pLibrary->trackCollectionManager(), &m_connection);
@@ -59,10 +58,6 @@ QVariant BansheeFeature::title() {
     return m_title;
 }
 
-QIcon BansheeFeature::getIcon() {
-    return m_icon;
-}
-
 void BansheeFeature::activate() {
     //qDebug("BansheeFeature::activate()");
 

src/library/banshee/bansheefeature.h

@@ -24,7 +24,6 @@ class BansheeFeature : public BaseExternalLibraryFeature {
     static void prepareDbPath(UserSettingsPointer pConfig);
 
     virtual QVariant title();
-    virtual QIcon getIcon();
 
     virtual TreeItemModel* sidebarModel() const;
 
@@ -50,7 +49,6 @@ class BansheeFeature : public BaseExternalLibraryFeature {
     QFuture<TreeItem*> m_future;
     QString m_title;
     bool m_cancelImport;
-    QIcon m_icon;
 
     static QString m_databaseFile;
 

src/library/baseexternallibraryfeature.cpp

@@ -18,8 +18,9 @@ const mixxx::Logger kLogger("BaseExternalLibraryFeature");
 
 BaseExternalLibraryFeature::BaseExternalLibraryFeature(
         Library* pLibrary,
-        UserSettingsPointer pConfig)
-        : LibraryFeature(pLibrary, pConfig),
+        UserSettingsPointer pConfig,
+        const QString& iconName)
+        : LibraryFeature(pLibrary, pConfig, iconName),
           m_pTrackCollection(pLibrary->trackCollectionManager()->internalCollection()) {
     m_pAddToAutoDJAction = make_parented<QAction>(tr("Add to Auto DJ Queue (bottom)"), this);
     connect(m_pAddToAutoDJAction,

src/library/baseexternallibraryfeature.h

@@ -16,7 +16,8 @@ class BaseExternalLibraryFeature : public LibraryFeature {
   public:
     BaseExternalLibraryFeature(
             Library* pLibrary,
-            UserSettingsPointer pConfig);
+            UserSettingsPointer pConfig,
+            const QString& iconName);
     ~BaseExternalLibraryFeature() override = default;
 
   public slots:

src/library/browse/browsefeature.cpp

@@ -31,13 +31,12 @@ BrowseFeature::BrowseFeature(
         Library* pLibrary,
         UserSettingsPointer pConfig,
         RecordingManager* pRecordingManager)
-        : LibraryFeature(pLibrary, pConfig),
+        : LibraryFeature(pLibrary, pConfig, QString("computer")),
           m_pTrackCollection(pLibrary->trackCollectionManager()->internalCollection()),
           m_browseModel(this, pLibrary->trackCollectionManager(), pRecordingManager),
           m_proxyModel(&m_browseModel),
           m_pSidebarModel(new FolderTreeModel(this)),
-          m_pLastRightClickedItem(nullptr),
-          m_icon(":/images/library/ic_library_computer.svg") {
+          m_pLastRightClickedItem(nullptr) {
     connect(this,
             &BrowseFeature::requestAddDir,
             pLibrary,
@@ -214,10 +213,6 @@ void BrowseFeature::slotRemoveQuickLink() {
     saveQuickLinks();
 }
 
-QIcon BrowseFeature::getIcon() {
-    return m_icon;
-}
-
 TreeItemModel* BrowseFeature::sidebarModel() const {
     return m_pSidebarModel;
 }

src/library/browse/browsefeature.h

@@ -30,23 +30,22 @@ class BrowseFeature : public LibraryFeature {
             RecordingManager* pRecordingManager);
     virtual ~BrowseFeature();
 
-    QVariant title();
-    QIcon getIcon();
+    QVariant title() override;
 
     void bindLibraryWidget(WLibrary* libraryWidget,
-                    KeyboardEventFilter* keyboard);
-    void bindSidebarWidget(WLibrarySidebar* pSidebarWidget);
+            KeyboardEventFilter* keyboard) override;
+    void bindSidebarWidget(WLibrarySidebar* pSidebarWidget) override;
 
-    TreeItemModel* sidebarModel() const;
+    TreeItemModel* sidebarModel() const override;
 
   public slots:
     void slotAddQuickLink();
     void slotRemoveQuickLink();
     void slotAddToLibrary();
-    void activate();
-    void activateChild(const QModelIndex& index);
-    void onRightClickChild(const QPoint& globalPos, const QModelIndex& index);
-    void onLazyChildExpandation(const QModelIndex& index);
+    void activate() override;
+    void activateChild(const QModelIndex& index) override;
+    void onRightClickChild(const QPoint& globalPos, const QModelIndex& index) override;
+    void onLazyChildExpandation(const QModelIndex& index) override;
     void slotLibraryScanStarted();
     void slotLibraryScanFinished();
 
@@ -73,6 +72,5 @@ class BrowseFeature : public LibraryFeature {
     TreeItem* m_pLastRightClickedItem;
     TreeItem* m_pQuickLinkItem;
     QStringList m_quickLinkList;
-    QIcon m_icon;
     QPointer<WLibrarySidebar> m_pSidebarWidget;
 };

src/library/itunes/itunesfeature.cpp

@@ -63,10 +63,9 @@ QString localhost_token() {
 } // anonymous namespace
 
 ITunesFeature::ITunesFeature(Library* pLibrary, UserSettingsPointer pConfig)
-        : BaseExternalLibraryFeature(pLibrary, pConfig),
+        : BaseExternalLibraryFeature(pLibrary, pConfig, QStringLiteral("itunes")),
           m_pSidebarModel(make_parented<TreeItemModel>(this)),
-          m_cancelImport(false),
-          m_icon(":/images/library/ic_library_itunes.svg") {
+          m_cancelImport(false) {
     QString tableName = "itunes_library";
     QString idColumn = "id";
     QStringList columns;
@@ -153,10 +152,6 @@ QVariant ITunesFeature::title() {
     return m_title;
 }
 
-QIcon ITunesFeature::getIcon() {
-    return m_icon;
-}
-
 void ITunesFeature::bindSidebarWidget(WLibrarySidebar* pSidebarWidget) {
     // store the sidebar widget pointer for later use in onRightClick()
     m_pSidebarWidget = pSidebarWidget;

src/library/itunes/itunesfeature.h

@@ -25,7 +25,6 @@ class ITunesFeature : public BaseExternalLibraryFeature {
     static bool isSupported();
 
     QVariant title() override;
-    QIcon getIcon() override;
     void bindSidebarWidget(WLibrarySidebar* pSidebarWidget) override;
 
     TreeItemModel* sidebarModel() const override;
@@ -70,5 +69,4 @@ class ITunesFeature : public BaseExternalLibraryFeature {
 
     QSharedPointer<BaseTrackCache> m_trackSource;
     QPointer<WLibrarySidebar> m_pSidebarWidget;
-    QIcon m_icon;
 };

src/library/libraryfeature.cpp

@@ -15,15 +15,21 @@
 namespace {
 
 const mixxx::Logger kLogger("LibraryFeature");
+const QString kIconPath = QStringLiteral(":/images/library/ic_library_%1.svg");
 
 } // anonymous namespace
 
 LibraryFeature::LibraryFeature(
         Library* pLibrary,
-        UserSettingsPointer pConfig)
+        UserSettingsPointer pConfig,
+        const QString& iconName)
         : QObject(pLibrary),
           m_pLibrary(pLibrary),
-          m_pConfig(pConfig) {
+          m_pConfig(pConfig),
+          m_iconName(iconName) {
+    if (!m_iconName.isEmpty()) {
+        m_icon = QIcon(kIconPath.arg(m_iconName));
+    }
 }
 
 QStringList LibraryFeature::getPlaylistFiles(QFileDialog::FileMode mode) const {

src/library/libraryfeature.h

@@ -29,11 +29,25 @@ class LibraryFeature : public QObject {
   public:
     LibraryFeature(
             Library* pLibrary,
-            UserSettingsPointer pConfig);
+            UserSettingsPointer pConfig,
+            const QString& iconName);
     ~LibraryFeature() override = default;
 
     virtual QVariant title() = 0;
-    virtual QIcon getIcon() = 0;
+
+    /// Returns the icon name.
+    ///
+    /// This is useful for QML skins that need to build a URL anyway and may use their own icon theme.
+    QString iconName() const {
+        return m_iconName;
+    }
+
+    /// Returns the icon.
+    ///
+    /// This is used by legacy QWidget skins that display a QIcon directly.
+    QIcon icon() const {
+        return m_icon;
+    }
 
     virtual bool dropAccept(const QList<QUrl>& urls, QObject* pSource) {
         Q_UNUSED(urls);
@@ -134,4 +148,7 @@ class LibraryFeature : public QObject {
 
   private:
     QStringList getPlaylistFiles(QFileDialog::FileMode mode) const;
+
+    QString m_iconName;
+    QIcon m_icon;
 };

src/library/mixxxlibraryfeature.cpp

@@ -69,10 +69,9 @@ const QStringList DEFAULT_COLUMNS = {
 
 MixxxLibraryFeature::MixxxLibraryFeature(Library* pLibrary,
         UserSettingsPointer pConfig)
-        : LibraryFeature(pLibrary, pConfig),
+        : LibraryFeature(pLibrary, pConfig, QStringLiteral("tracks")),
           kMissingTitle(tr("Missing Tracks")),
           kHiddenTitle(tr("Hidden Tracks")),
-          m_icon(":/images/library/ic_library_tracks.svg"),
           m_pTrackCollection(pLibrary->trackCollectionManager()->internalCollection()),
           m_pLibraryTableModel(nullptr),
           m_pSidebarModel(make_parented<TreeItemModel>(this)),
@@ -145,10 +144,6 @@ QVariant MixxxLibraryFeature::title() {
     return tr("Tracks");
 }
 
-QIcon MixxxLibraryFeature::getIcon() {
-    return m_icon;
-}
-
 TreeItemModel* MixxxLibraryFeature::sidebarModel() const {
     return m_pSidebarModel;
 }

src/library/mixxxlibraryfeature.h

@@ -34,7 +34,6 @@ class MixxxLibraryFeature final : public LibraryFeature {
     ~MixxxLibraryFeature() override = default;
 
     QVariant title() override;
-    QIcon getIcon() override;
     bool dropAccept(const QList<QUrl>& urls, QObject* pSource) override;
     bool dragMoveAccept(const QUrl& url) override;
     TreeItemModel* sidebarModel() const override;
@@ -67,7 +66,6 @@ class MixxxLibraryFeature final : public LibraryFeature {
   private:
     const QString kMissingTitle;
     const QString kHiddenTitle;
-    const QIcon m_icon;
     TrackCollection* const m_pTrackCollection;
 
     QSharedPointer<BaseTrackCache> m_pBaseTrackCache;

src/library/recording/recordingfeature.cpp

@@ -18,20 +18,15 @@ const QString kViewName = QStringLiteral("Recording");
 RecordingFeature::RecordingFeature(Library* pLibrary,
         UserSettingsPointer pConfig,
         RecordingManager* pRecordingManager)
-        : LibraryFeature(pLibrary, pConfig),
+        : LibraryFeature(pLibrary, pConfig, QStringLiteral("recordings")),
           m_pRecordingManager(pRecordingManager),
-          m_icon(":/images/library/ic_library_recordings.svg"),
           m_pSidebarModel(new FolderTreeModel(this)) {
 }
 
 QVariant RecordingFeature::title() {
     return QVariant(tr("Recordings"));
 }
 
-QIcon RecordingFeature::getIcon() {
-    return m_icon;
-}
-
 TreeItemModel* RecordingFeature::sidebarModel() const {
     return m_pSidebarModel;
 }

src/library/recording/recordingfeature.h

@@ -20,7 +20,6 @@ class RecordingFeature final : public LibraryFeature {
     ~RecordingFeature() override = default;
 
     QVariant title() override;
-    QIcon getIcon() override;
 
     void bindLibraryWidget(WLibrary* libraryWidget,
                     KeyboardEventFilter* keyboard) override;
@@ -37,7 +36,6 @@ class RecordingFeature final : public LibraryFeature {
 
   private:
     RecordingManager* const m_pRecordingManager;
-    const QIcon m_icon;
 
     FolderTreeModel* m_pSidebarModel;
 };