#include "widget/wlibrarytableview.h" #include #include #include #include #include #include #include #include "moc_wlibrarytableview.cpp" #include "util/math.h" #include "widget/wtracktableviewheader.h" class QFocusEvent; namespace { // number of entries in the model cache constexpr int kModelCacheSize = 1000; } // namespace WLibraryTableView::WLibraryTableView(QWidget* parent, UserSettingsPointer pConfig) : QTableView(parent), m_prevRow(-1), m_prevColumn(-1), m_pConfig(pConfig), m_modelStateCache(kModelCacheSize) { // Setup properties for table // Editing starts when clicking on an already selected item. setEditTriggers(QAbstractItemView::SelectedClicked|QAbstractItemView::EditKeyPressed); //Enable selection by rows and extended selection (ctrl/shift click) setSelectionBehavior(QAbstractItemView::SelectRows); setSelectionMode(QAbstractItemView::ExtendedSelection); setWordWrap(false); setShowGrid(false); setCornerButtonEnabled(false); setSortingEnabled(true); // Used by delegates (e.g. StarDelegate) to tell when the mouse enters a // cell. setMouseTracking(true); //Work around a Qt bug that lets you make your columns so wide you //can't reach the divider to make them small again. setHorizontalScrollMode(QAbstractItemView::ScrollPerPixel); verticalHeader()->hide(); setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn); setAlternatingRowColors(true); connect(verticalScrollBar(), &QScrollBar::valueChanged, this, &WLibraryTableView::scrollValueChanged); setTabKeyNavigation(false); } WLibraryTableView::~WLibraryTableView() { } void WLibraryTableView::saveTrackModelState( const QAbstractItemModel* model, const QString& key) { //qDebug() << "saveTrackModelState:" << model << key; VERIFY_OR_DEBUG_ASSERT(model) { return; } VERIFY_OR_DEBUG_ASSERT(!key.isEmpty()) { return; } ModelState* state = m_modelStateCache.take(key); if (!state) { state = new ModelState(); } state->verticalScrollPosition = verticalScrollBar()->value(); state->horizontalScrollPosition = horizontalScrollBar()->value(); state->selectedRows = selectionModel()->selectedRows(); const QModelIndex currIndex = selectionModel()->currentIndex(); if (currIndex.isValid()) { state->currentIndex = currIndex; } else { state->currentIndex = QModelIndex(); } m_modelStateCache.insert(key, state, 1); } bool WLibraryTableView::restoreTrackModelState( const QAbstractItemModel* model, const QString& key) { //qDebug() << "restoreTrackModelState:" << model << key; //qDebug() << m_modelStateCache.keys(); if (model == nullptr) { return false; } ModelState* state = m_modelStateCache.take(key); if (!state) { // No previous state for model key, // reset scroll bars and current index verticalScrollBar()->setValue(0); horizontalScrollBar()->setValue(0); setCurrentIndex(QModelIndex()); return false; } verticalScrollBar()->setValue(state->verticalScrollPosition); horizontalScrollBar()->setValue(state->horizontalScrollPosition); // Build a selection range rather than selecting each track individually, // which can lag the GUI by spamming selectionChanged() handlers. QItemSelectionModel* pSelectionModel = selectionModel(); pSelectionModel->clearSelection(); QItemSelection newSelection; QModelIndexList selectedRows = state->selectedRows; QModelIndex topLeft; QModelIndex bottomRight; if (!selectedRows.isEmpty()) { // In saveTrackModelState() we fill state->selectedRows with the sorted // rows, hence no need to sort here. for (const QModelIndex& index : std::as_const(selectedRows)) { if (!topLeft.isValid()) { // start new range. only done once for first row topLeft = index; bottomRight = index; continue; } if (index.row() == bottomRight.row() + 1) { // continuous range bottomRight = index; continue; } else { // prev index was end of range, add current range to selection // and start a new one newSelection.select(topLeft, bottomRight); topLeft = index; bottomRight = index; } } // If we reached end, submit the last selection if (bottomRight == selectedRows.last()) { newSelection.select(topLeft, bottomRight); } } pSelectionModel->select(newSelection, QItemSelectionModel::Select | QItemSelectionModel::Rows); QModelIndex currIndex = state->currentIndex; restoreCurrentIndex(currIndex); // reinsert the state into the cache m_modelStateCache.insert(key, state, 1); return true; } void WLibraryTableView::saveCurrentIndex() { QItemSelectionModel* pSelectionModel = selectionModel(); if (!pSelectionModel) { return; } QModelIndexList indices = pSelectionModel->selectedRows(); if (indices.isEmpty()) { return; } m_prevRow = indices.first().row(); m_prevColumn = currentIndex().isValid() ? currentIndex().column() : columnAt(0); } void WLibraryTableView::restoreCurrentIndex(const QModelIndex& index) { QItemSelectionModel* pSelectionModel = selectionModel(); if (!pSelectionModel) { return; } int row = index.isValid() ? index.row() : m_prevRow; int col = index.isValid() ? index.column() : m_prevColumn; if (model()->rowCount() == 0 || row < 0 || col < 0) { // nothing to select return; } if (model()->rowCount() < row + 1) { // select last row row = model()->rowCount() - 1; } if (isColumnHidden(col)) { // select first column col = columnAt(0); } QModelIndex idx = model()->index(row, col); if (idx.isValid()) { pSelectionModel->setCurrentIndex(idx, QItemSelectionModel::NoUpdate); scrollTo(idx); } m_prevRow = -1; m_prevColumn = -1; } void WLibraryTableView::setTrackTableFont(const QFont& font) { setFont(font); QFontMetrics metrics(font); verticalHeader()->setMinimumSectionSize(metrics.height()); // Resize the 'Played' checkbox and the BPM lock icon. // Note: this works well for library font sizes up to ~200% of the original // system font's size (that set with Qt5 Settings respectively). Above that, // the indicators start to overlap the item text because the painter rectangle // is not resized (also depending on the system font size). setStyleSheet(QStringLiteral( "WTrackTableView::indicator," "#LibraryBPMButton::indicator {" "height: %1px;" "width: %1px;}") .arg(metrics.height() * 0.7)); // Apply the font to the header as well. // Note: remember to also apply the font to new headers created in // WTrackTableView::loadTrackModel() // Note: since WTrackTableViewHeader::setFont() does not override // QHeaderView::setFont() we need to cast to WTrackTableViewHeader WTrackTableViewHeader* pHeader = qobject_cast(horizontalHeader()); if (pHeader) { pHeader->setFont(font); } else { // _Might_ happen in case we did not yet WTrackTableView::loadTrackModel() // hence might not have a WTrackTableViewHeader yet but still default QHeaderView. // Header height will not be adjusted correctly now, only after loading the model. horizontalHeader()->setFont(font); } } void WLibraryTableView::setTrackTableRowHeight(int rowHeight) { verticalHeader()->setDefaultSectionSize(math_max( rowHeight, verticalHeader()->minimumSectionSize())); } void WLibraryTableView::setSelectedClick(bool enable) { if (enable) { setEditTriggers(QAbstractItemView::SelectedClicked|QAbstractItemView::EditKeyPressed); } else { setEditTriggers(QAbstractItemView::EditKeyPressed); } } void WLibraryTableView::saveCurrentViewState() { const QAbstractItemModel* currentModel = model(); QString key = getModelStateKey(); if (!currentModel || key.isEmpty()) { return; } saveTrackModelState(currentModel, key); } bool WLibraryTableView::restoreCurrentViewState() { const QAbstractItemModel* currentModel = model(); QString key = getModelStateKey(); if (!currentModel || key.isEmpty()) { return false; } return restoreTrackModelState(currentModel, key); } void WLibraryTableView::focusInEvent(QFocusEvent* event) { QTableView::focusInEvent(event); if (event->reason() == Qt::TabFocusReason || event->reason() == Qt::BacktabFocusReason || event->reason() == Qt::OtherFocusReason) { // On FocusIn caused by a tab action with no focused item, select the // current or first track which can then instantly be loaded to a deck. // This is especially helpful if the table has only one track, which can // not be selected with up/down buttons, either physical or emulated via // [Library],MoveVertical controls. See #9548 if (model() && model()->rowCount() > 0) { if (selectionModel()->hasSelection()) { DEBUG_ASSERT(!selectionModel()->selectedIndexes().isEmpty()); if (!currentIndex().isValid() || !selectionModel()->isSelected(currentIndex())) { // Reselect the first selected index selectRow(selectionModel()->selectedIndexes().first().row()); } } else { if (!currentIndex().isValid()) { // Select the first row if no row is focused selectRow(0); DEBUG_ASSERT(currentIndex().row() == 0); // Unfortunately, even though we now have a valid currentIndex(), // that would still not be selected by now if we're here because of // the first Qt::BacktabFocusReason to tracks in this session. (Qt 5.12.8) // So let's use the currentIndex below. } // Select the row of the currently focused index. // For some reason selectRow(currentIndex().row()) would not // select for the first Qt::BacktabFocusReason in a session // even though currentIndex() is valid. selectionModel()->select(currentIndex(), QItemSelectionModel::Select | QItemSelectionModel::Rows); } DEBUG_ASSERT(currentIndex().isValid()); DEBUG_ASSERT(selectionModel()->isSelected(currentIndex())); // scrollTo() doesn't always seem to work!? scrollTo(currentIndex()); } } } QModelIndex WLibraryTableView::moveCursor(CursorAction cursorAction, Qt::KeyboardModifiers modifiers) { QAbstractItemModel* pModel = model(); if (pModel) { switch (cursorAction) { // The up and down cursor keys should wrap the list around. This // behavior also applies to the `[Library],MoveVertical` action that is // usually bound to the library browse encoder on controllers. Otherwise // browsing a key-sorted library list requires either a serious workout // or the user needs to reach for the mouse or keyboard when moving // between 12/C#m/E and 1/G#m/B. This is very similar to // WTrackTableView::moveSelection(), except that it doesn't actually // modify the selection. It simply returns a new cursor that the // keyboard event handler in `QAbstractItemView` uses to either move the // cursor, move the selection, or extend the selection depending on // which modifier keys are held down. // Note: Shift modifier prevents wrap-around. case QAbstractItemView::MoveUp: case QAbstractItemView::MoveDown: { const QModelIndex current = currentIndex(); if (current.isValid()) { const int row = currentIndex().row(); const int column = currentIndex().column(); if (cursorAction == QAbstractItemView::MoveDown) { if (row + 1 < pModel->rowCount()) { return pModel->index(row + 1, column); } else if (!modifiers.testFlag(Qt::ShiftModifier)) { return pModel->index(0, column); } } else { if (row - 1 >= 0) { return pModel->index(row - 1, column); } else if (!modifiers.testFlag(Qt::ShiftModifier)) { return pModel->index(pModel->rowCount() - 1, column); } } } else { // If the cursor does not yet exist (because the view has not // yet been interacted with) then this selects the first or last // row const int row = cursorAction == QAbstractItemView::MoveUp ? pModel->rowCount() - 1 : 0; // Selecting a hidden column doesn't work, so we'll need to find // the first non-hidden column here int column = 0; while (isColumnHidden(column) && column < pModel->columnCount()) { column++; } return pModel->index(row, column); } } break; // Make the home and end keys move to the first and last row rather than // the first and last column (QAbstractItemView default) case QAbstractItemView::MoveHome: case QAbstractItemView::MoveEnd: { const QModelIndex current = currentIndex(); // We don't want to change the selected column if a column has // already been selected int column = current.column(); if (!current.isValid()) { // Selecting a hidden column doesn't work, so we'll need to find // the first non-hidden column here int column = 0; while (isColumnHidden(column) && column < pModel->columnCount()) { column++; } } if (cursorAction == QAbstractItemView::MoveHome) { return pModel->index(0, column); } else { return pModel->index(pModel->rowCount() - 1, column); } } break; case QAbstractItemView::MoveLeft: case QAbstractItemView::MoveRight: if (modifiers & Qt::ControlModifier) { // Ignore, so it can be handled by WLibrary::keyEvent // to navigate to the sidebar return currentIndex(); } break; default: break; } } return QTableView::moveCursor(cursorAction, modifiers); } void WLibraryTableView::dataChanged( const QModelIndex& topLeft, const QModelIndex& bottomRight, const QVector& roles) { for (const auto& role : roles) { // Note: At this point the tooltip is already showing // "Fetching image ..." or still in an effect progress. // QToolTip::isVisible() is false for the later. if (role == Qt::ToolTipRole) { QPoint globalPos = QCursor::pos(); QWidget* pViewPort = QApplication::widgetAt(globalPos); if (pViewPort) { QPoint viewPortPos = pViewPort->mapFromGlobal(globalPos); if (indexAt(viewPortPos) == topLeft) { QHelpEvent toolTipEvent(QEvent::ToolTip, pViewPort->mapFromGlobal(globalPos), globalPos); viewportEvent(&toolTipEvent); } } } } QAbstractItemView::dataChanged(topLeft, bottomRight, roles); };