Merge pull request mixxxdj#12744 from ronso0/lib-played-text-color

Tracks: custom text color for played tracks (qss)

res/skins/Deere/style.qss

@@ -254,11 +254,14 @@ WTrackTableView,
 WTrackTableView QCheckBox:focus {
   outline: 1px solid #D6D6D6;
 }
-/* This uses a custom qproperty to set the focus border
-  for Color and Cover Art cells, 1px solid, sharp corners.
-  See src/library/tableitemdelegate.cpp */
 WTrackTableView {
+  /* This uses a custom qproperty to set the focus border
+     for Color and Cover Art cells, 1px solid, sharp corners.
+     See src/library/tableitemdelegate.cpp */
   qproperty-focusBorderColor: #D6D6D6;
+  /* This is the color used to paint the text of played tracks.
+     BaseTrackTableModel::data() uses this to override Qt::ForegroundRole (QBrush). */
+  qproperty-playedInactiveColor: #555;
 }
 
 WTrackTableView:focus,

res/skins/LateNight/style_classic.qss

@@ -2121,7 +2121,13 @@ WTrackTableView QCheckBox:focus {
   for Color and Cover Art cells, 1px solid, sharp corners.
   See src/library/tableitemdelegate.cpp */
 WTrackTableView {
+  /* This uses a custom qproperty to set the focus border
+     for Color and Cover Art cells, 1px solid, sharp corners.
+     See src/library/tableitemdelegate.cpp */
   qproperty-focusBorderColor: #fff;
+  /* This is the color used to paint the text of played tracks.
+     BaseTrackTableModel::data() uses this to override Qt::ForegroundRole (QBrush). */
+  qproperty-playedInactiveColor: #555;
 }
 
 WLibrarySidebar {

res/skins/LateNight/style_palemoon.qss

@@ -2587,11 +2587,14 @@ WTrackTableView,
 WTrackTableView QCheckBox:focus {
   outline: 1px solid #fff;
 }
-/* This uses a custom qproperty to set the focus border
-  for Color and Cover Art cells, 1px solid, sharp corners.
-  See src/library/tableitemdelegate.cpp */
 WTrackTableView {
+  /* This uses a custom qproperty to set the focus border
+     for Color and Cover Art cells, 1px solid, sharp corners.
+     See src/library/tableitemdelegate.cpp */
   qproperty-focusBorderColor: #fff;
+  /* This is the color used to paint the text of played tracks.
+     BaseTrackTableModel::data() uses this to override Qt::ForegroundRole (QBrush). */
+  qproperty-playedInactiveColor: #555;
 }
 
 /* Table cell in edit mode */

res/skins/Shade/style.qss

@@ -526,7 +526,13 @@ WTrackTableView QCheckBox:focus {
   for Color and Cover Art cells, 1px solid, sharp corners.
   See src/library/tableitemdelegate.cpp */
 WTrackTableView {
+  /* This uses a custom qproperty to set the focus border
+     for Color and Cover Art cells, 1px solid, sharp corners.
+     See src/library/tableitemdelegate.cpp */
   qproperty-focusBorderColor: #c9c9c9;
+  /* This is the color used to paint the text of played tracks.
+     BaseTrackTableModel::data() uses this to override Qt::ForegroundRole (QBrush). */
+  qproperty-playedInactiveColor: #555;
 }
 
   /* Table cell in edit mode */

res/skins/Shade/style_dark.qss

@@ -198,7 +198,13 @@ WTrackTableView QCheckBox:focus {
   for Color and Cover Art cells, 1px solid, sharp corners.
   See src/library/tableitemdelegate.cpp */
 WTrackTableView {
+  /* This uses a custom qproperty to set the focus border
+     for Color and Cover Art cells, 1px solid, sharp corners.
+     See src/library/tableitemdelegate.cpp */
   qproperty-focusBorderColor: #ccc;
+  /* This is the color used to paint the text of played tracks.
+     BaseTrackTableModel::data() uses this to override Qt::ForegroundRole (QBrush). */
+  qproperty-playedInactiveColor: #555;
 }
 
   /* Table cell in edit mode */

res/skins/Tango/style.qss

@@ -2615,7 +2615,13 @@ WTrackTableView QCheckBox:focus {
   for Color and Cover Art cells, 1px solid, sharp corners.
   See src/library/tableitemdelegate.cpp */
 WTrackTableView {
+  /* This uses a custom qproperty to set the focus border
+     for Color and Cover Art cells, 1px solid, sharp corners.
+     See src/library/tableitemdelegate.cpp */
   qproperty-focusBorderColor: #fff;
+  /* This is the color used to paint the text of played tracks.
+     BaseTrackTableModel::data() uses this to override Qt::ForegroundRole (QBrush). */
+  qproperty-playedInactiveColor: #555;
 }
 
   /* Table cell in edit mode */

src/library/basetracktablemodel.cpp

@@ -125,7 +125,8 @@ BaseTrackTableModel::BaseTrackTableModel(
           TrackModel(cloneDatabase(pTrackCollectionManager), settingsNamespace),
           m_pTrackCollectionManager(pTrackCollectionManager),
           m_previewDeckGroup(PlayerManager::groupForPreviewDeck(0)),
-          m_backgroundColorOpacity(WLibrary::kDefaultTrackTableBackgroundColorOpacity) {
+          m_backgroundColorOpacity(WLibrary::kDefaultTrackTableBackgroundColorOpacity),
+          m_playedInactiveColor(QColor::fromRgb(WTrackTableView::kDefaultPlayedInactiveColorHex)) {
     connect(&pTrackCollectionManager->internalCollection()->getTrackDAO(),
             &TrackDAO::forceModelUpdate,
             this,
@@ -396,6 +397,15 @@ QAbstractItemDelegate* BaseTrackTableModel::delegateForColumn(
         return nullptr;
     }
     m_backgroundColorOpacity = pTableView->getBackgroundColorOpacity();
+    // This is the color used for the text of played tracks.
+    // data() uses this to compose the ForegroundRole QBrush if 'played' is checked.
+    m_playedInactiveColor = pTableView->getPlayedInactiveColor();
+    connect(pTableView,
+            &WTrackTableView::playedInactiveColorChanged,
+            this,
+            [this](QColor col) {
+                m_playedInactiveColor = col;
+            });
     if (index == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_RATING)) {
         return new StarDelegate(pTableView);
     } else if (index == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_BPM)) {
@@ -450,6 +460,16 @@ QVariant BaseTrackTableModel::data(
         DEBUG_ASSERT(m_backgroundColorOpacity <= 1.0);
         bgColor.setAlphaF(static_cast<float>(m_backgroundColorOpacity));
         return QBrush(bgColor);
+    } else if (role == Qt::ForegroundRole) {
+        // Custom text color for played tracks
+        auto playedRaw = rawSiblingValue(
+                index,
+                ColumnCache::COLUMN_LIBRARYTABLE_PLAYED);
+        if (!playedRaw.isNull() &&
+                playedRaw.canConvert<bool>() &&
+                playedRaw.toBool()) {
+            return QVariant::fromValue(m_playedInactiveColor);
+        }
     }
 
     // Only retrieve a value for supported roles

src/library/basetracktablemodel.h

@@ -268,6 +268,7 @@ class BaseTrackTableModel : public QAbstractTableModel, public TrackModel {
     const QString m_previewDeckGroup;
 
     double m_backgroundColorOpacity;
+    QColor m_playedInactiveColor;
 
     ColumnCache m_columnCache;
 

src/library/bpmdelegate.cpp

@@ -92,6 +92,28 @@ void BPMDelegate::paintItem(QPainter* painter,const QStyleOptionViewItem &option
     QStyleOptionViewItem opt = option;
     initStyleOption(&opt, index);
 
+    // The checkbox uses the QTableView's qss style, therefore it's not picking
+    //  up the 'played' text color via ForegroundRole from BaseTrackTableModel::data().
+    // Enforce it with an explicit stylesheet. Note: the stylesheet persists so
+    // we need to reset it to normal/highlighted.
+    QColor textColor;
+    auto dat = index.data(Qt::ForegroundRole);
+    if (dat.canConvert<QColor>()) {
+        textColor = dat.value<QColor>();
+    } else {
+        if (option.state & QStyle::State_Selected) {
+            textColor = option.palette.color(QPalette::Normal, QPalette::HighlightedText);
+        } else {
+            textColor = option.palette.color(QPalette::Normal, QPalette::Text);
+            // qWarning() << "     !! BPM col:" << textColor.name(QColor::HexRgb);
+        }
+    }
+    if (textColor.isValid()) {
+        m_pCheckBox->setStyleSheet(QStringLiteral(
+                "#LibraryBPMButton::item { color: %1; }")
+                                           .arg(textColor.name(QColor::HexRgb)));
+    }
+
     QStyle* style = m_pTableView->style();
     if (style != nullptr) {
         style->drawControl(QStyle::CE_ItemViewItem, &opt, painter, m_pCheckBox);

src/library/colordelegate.cpp

@@ -28,6 +28,6 @@ void ColorDelegate::paintItem(
 
     // Draw a border if the color cell has focus
     if (option.state & QStyle::State_HasFocus) {
-        drawBorder(painter, m_pFocusBorderColor, option.rect);
+        drawBorder(painter, m_focusBorderColor, option.rect);
     }
 }

src/library/coverartdelegate.cpp

@@ -168,6 +168,6 @@ void CoverArtDelegate::paintItem(
 
     // Draw a border if the cover art cell has focus
     if (option.state & QStyle::State_HasFocus) {
-        drawBorder(painter, m_pFocusBorderColor, option.rect);
+        drawBorder(painter, m_focusBorderColor, option.rect);
     }
 }

src/library/stardelegate.cpp

@@ -44,7 +44,7 @@ QWidget* StarDelegate::createEditor(QWidget* parent,
     initStyleOption(&newOption, index);
 
     StarEditor* editor =
-            new StarEditor(parent, m_pTableView, index, newOption, m_pFocusBorderColor);
+            new StarEditor(parent, m_pTableView, index, newOption, m_focusBorderColor);
     connect(editor,
             &StarEditor::editingFinished,
             this,

src/library/stareditor.cpp

@@ -28,7 +28,7 @@ StarEditor::StarEditor(QWidget* parent,
           m_pTableView(pTableView),
           m_index(index),
           m_styleOption(option),
-          m_pFocusBorderColor(focusBorderColor),
+          m_focusBorderColor(focusBorderColor),
           m_starCount(StarRating::kMinStarCount) {
     DEBUG_ASSERT(m_pTableView);
     setMouseTracking(true);
@@ -93,7 +93,7 @@ void StarEditor::paintEvent(QPaintEvent*) {
 
     // Draw a border if the color cell is selected
     if (m_styleOption.state & QStyle::State_HasFocus) {
-        TableItemDelegate::drawBorder(&painter, m_pFocusBorderColor, m_styleOption.rect);
+        TableItemDelegate::drawBorder(&painter, m_focusBorderColor, m_styleOption.rect);
     }
 }
 

src/library/stareditor.h

@@ -46,7 +46,7 @@ class StarEditor : public QWidget {
     QTableView* m_pTableView;
     QModelIndex m_index;
     QStyleOptionViewItem m_styleOption;
-    QColor m_pFocusBorderColor;
+    QColor m_focusBorderColor;
     StarRating m_starRating;
     int m_starCount;
 };

src/library/tableitemdelegate.cpp

@@ -16,7 +16,16 @@ TableItemDelegate::TableItemDelegate(QTableView* pTableView)
         // WTrackTableView {
         //   qproperty-focusBorderColor: red;
         // }
-        m_pFocusBorderColor = pTrackTableView->getFocusBorderColor();
+        m_focusBorderColor = pTrackTableView->getFocusBorderColor();
+        // For some reason the color is not initialized from the stylesheet for
+        // some WTrackTableViews (in DlgAutoDJ, DlgAnalysis, ...)
+        // Listen to the property changed signal.
+        connect(pTrackTableView,
+                &WTrackTableView::focusBorderColorChanged,
+                this,
+                [this](QColor col) {
+                    m_focusBorderColor = col;
+                });
     }
 }
 
@@ -39,7 +48,20 @@ void TableItemDelegate::paint(
     if (option.state & QStyle::State_Selected) {
         painter->setBrush(option.palette.color(cg, QPalette::HighlightedText));
     } else {
-        painter->setBrush(option.palette.color(cg, QPalette::Text));
+        // This gets the custom 'played' text color from BaseTrackTableModel
+        // depending on check state of the 'played' column.
+        // Note that we need to do this again in BPMDelegate which uses the
+        // style of the TableView.
+        auto playedColorData = index.data(Qt::ForegroundRole);
+        if (playedColorData.canConvert<QColor>()) {
+            QColor playedColor = playedColorData.value<QColor>();
+            // for the star rating polygons
+            painter->setBrush(playedColor);
+            // for the 'location' text
+            painter->setPen(playedColor);
+        } else {
+            painter->setBrush(option.palette.color(cg, QPalette::Text));
+        }
     }
 
     QStyle* style = m_pTableView->style();

src/library/tableitemdelegate.h

@@ -36,6 +36,6 @@ class TableItemDelegate : public QStyledItemDelegate {
     // Having this here avoids including QTableView there.
     int columnWidth(const QModelIndex &index) const;
 
-    QColor m_pFocusBorderColor;
+    QColor m_focusBorderColor;
     QTableView* m_pTableView;
 };

src/widget/wtracktableview.cpp

@@ -38,9 +38,6 @@ const ConfigKey kVScrollBarPosConfigKey{
         QStringLiteral("[Library]"),
         QStringLiteral("VScrollBarPos")};
 
-// Default color for the focus border of TableItemDelegates
-const QColor kDefaultFocusBorderColor = Qt::white;
-
 } // anonymous namespace
 
 WTrackTableView::WTrackTableView(QWidget* parent,
@@ -52,7 +49,9 @@ WTrackTableView::WTrackTableView(QWidget* parent,
           m_pConfig(pConfig),
           m_pLibrary(pLibrary),
           m_backgroundColorOpacity(backgroundColorOpacity),
-          m_pFocusBorderColor(kDefaultFocusBorderColor),
+          // Default color for the focus border of TableItemDelegates
+          m_focusBorderColor(Qt::white),
+          m_playedInactiveColor(QColor::fromRgb(kDefaultPlayedInactiveColorHex)),
           m_sorting(sorting),
           m_selectionChangedSinceLastGuiTick(true),
           m_loadCachedOnly(false) {

src/widget/wtracktableview.h

@@ -51,13 +51,29 @@ class WTrackTableView : public WLibraryTableView {
         return m_backgroundColorOpacity;
     }
 
-    Q_PROPERTY(QColor focusBorderColor MEMBER m_pFocusBorderColor DESIGNABLE true);
+    Q_PROPERTY(QColor focusBorderColor
+                    MEMBER m_focusBorderColor
+                            NOTIFY focusBorderColorChanged
+                                    DESIGNABLE true);
     QColor getFocusBorderColor() const {
-        return m_pFocusBorderColor;
+        return m_focusBorderColor;
+    }
+
+    // Default color for played tracks' text color. #555555, bit darker than Qt::darkgray.
+    // BaseTrackTableModel uses this for the ForegroundRole of played tracks.
+    static constexpr uint kDefaultPlayedInactiveColorHex = 555555;
+    Q_PROPERTY(QColor playedInactiveColor
+                    MEMBER m_playedInactiveColor
+                            NOTIFY playedInactiveColorChanged
+                                    DESIGNABLE true);
+    QColor getPlayedInactiveColor() const {
+        return m_playedInactiveColor;
     }
 
   signals:
     void trackMenuVisible(bool visible);
+    void focusBorderColorChanged(QColor col);
+    void playedInactiveColorChanged(QColor col);
 
   public slots:
     void loadTrackModel(QAbstractItemModel* model, bool restoreState = false);
@@ -124,7 +140,8 @@ class WTrackTableView : public WLibraryTableView {
     parented_ptr<WTrackMenu> m_pTrackMenu;
 
     const double m_backgroundColorOpacity;
-    QColor m_pFocusBorderColor;
+    QColor m_focusBorderColor;
+    QColor m_playedInactiveColor;
     bool m_sorting;
 
     // Control the delay to load a cover art.