NodeView.cpp

Go to the documentation of this file.

/*
  SPDX-FileCopyrightText: 2006 Gábor Lehel <illissius@gmail.com>
 
  SPDX-License-Identifier: LGPL-2.0-or-later
*/
#include "NodeView.h"
#include "NodePropertyAction_p.h"
#include "NodeDelegate.h"
#include "NodeViewVisibilityDelegate.h"
#include "kis_node_model.h"
#include "kis_signals_blocker.h"
 
 
#include <kconfig.h>
#include <kconfiggroup.h>
#include <kis_config.h>
#include <kis_icon.h>
#include <ksharedconfig.h>
#include <KisKineticScroller.h>
#include <KoConfig.h>
 
#include <QtDebug>
#include <QContextMenuEvent>
#include <QHeaderView>
#include <QHelpEvent>
#include <QMenu>
#include <QDrag>
#include <QMouseEvent>
#include <QPersistentModelIndex>
#include <QApplication>
#include <QPainter>
#include <QScrollBar>
#include <QScroller>
 
#include "kis_node_view_color_scheme.h"
 
#if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
#define QT6_SHIFT_SELECTION_WORKAROUND
#endif
 
#ifdef HAVE_X11
#define DRAG_WHILE_DRAG_WORKAROUND
#endif
 
#ifdef DRAG_WHILE_DRAG_WORKAROUND
#define DRAG_WHILE_DRAG_WORKAROUND_START() d->isDragging = true
#define DRAG_WHILE_DRAG_WORKAROUND_STOP() d->isDragging = false
#else
#define DRAG_WHILE_DRAG_WORKAROUND_START()
#define DRAG_WHILE_DRAG_WORKAROUND_STOP()
#endif
 
 
class Q_DECL_HIDDEN NodeView::Private
{
public:
    Private(NodeView* _q)
        : delegate(_q, _q)
#ifdef DRAG_WHILE_DRAG_WORKAROUND
        , isDragging(false)
#endif
#ifdef QT6_SHIFT_SELECTION_WORKAROUND
        , shiftClickFix(false)
#endif
    {
    }
    NodeDelegate delegate;
    QPersistentModelIndex hovered;
    QPoint lastPos;
 
#ifdef DRAG_WHILE_DRAG_WORKAROUND
    bool isDragging;
#endif
#ifdef QT6_SHIFT_SELECTION_WORKAROUND
    bool shiftClickFix;
#endif
    bool ignoreDataChanged = false;
};
 
 
NodeView::NodeView(QWidget *parent)
    : QTreeView(parent)
    , m_draggingFlag(false)
    , d(new Private(this))
{
    setItemDelegate(&d->delegate);
 
    setMouseTracking(true);
    setSelectionBehavior(SelectRows);
    setDefaultDropAction(Qt::MoveAction);
    setVerticalScrollMode(QAbstractItemView::ScrollPerItem);
    setSelectionMode(QAbstractItemView::ExtendedSelection);
    setRootIsDecorated(false);
 
    header()->hide();
    setDragEnabled(true);
    setDragDropMode(QAbstractItemView::DragDrop);
    setAcceptDrops(true);
    setDropIndicatorShown(true);
 
    {
        QScroller *scroller = KisKineticScroller::createPreconfiguredScroller(this);
        if (scroller) {
            connect(scroller, SIGNAL(stateChanged(QScroller::State)),
                    this, SLOT(slotScrollerStateChanged(QScroller::State)));
        }
    }
}
 
NodeView::~NodeView()
{
    delete d;
}
 
void NodeView::setModel(QAbstractItemModel *model)
{
    QTreeView::setModel(model);
 
    if (!this->model()->inherits("KisNodeModel") && !this->model()->inherits("KisNodeFilterProxyModel")) {
        qWarning() << "NodeView may not work with" << model->metaObject()->className();
    }
    if (this->model()->columnCount() != 3) {
        qWarning() << "NodeView: expected 2 model columns, got " << this->model()->columnCount();
    }
 
    if (header()->sectionPosition(VISIBILITY_COL) != 0 || header()->sectionPosition(SELECTED_COL) != 1) {
        header()->moveSection(VISIBILITY_COL, 0);
        header()->moveSection(SELECTED_COL, 1);
    }
 
    KisConfig cfg(true);
    if (!cfg.useLayerSelectionCheckbox()) {
        header()->hideSection(SELECTED_COL);
    }
 
    // the default may be too large for our visibility icon
    header()->setMinimumSectionSize(KisNodeViewColorScheme::instance()->visibilityColumnWidth());
}
 
void NodeView::addPropertyActions(QMenu *menu, const QModelIndex &index)
{
    KisBaseNode::PropertyList list = index.data(KisNodeModel::PropertiesRole).value<KisBaseNode::PropertyList>();
    for (int i = 0, n = list.count(); i < n; ++i) {
        if (list.at(i).isMutable) {
            PropertyAction *a = new PropertyAction(i, list.at(i), index, menu);
            connect(a, SIGNAL(toggled(bool,QPersistentModelIndex,int)),
                    this, SLOT(slotActionToggled(bool,QPersistentModelIndex,int)));
            menu->addAction(a);
        }
    }
}
 
void NodeView::updateNode(const QModelIndex &index)
{
    dataChanged(index, index);
}
 
void NodeView::toggleSolo(const QModelIndex &index) {
    d->delegate.toggleSolo(index);
}
 
QItemSelectionModel::SelectionFlags  NodeView::selectionCommand(const QModelIndex &index, const QEvent *event) const {
    //When adding a layer with Shift or Ctrl is held, the selection will expand to add that new layer,
    //So to avoid that we explicitly select the new layer.
    if (!event && QApplication::keyboardModifiers() != Qt::NoModifier
#ifdef QT6_SHIFT_SELECTION_WORKAROUND
        && !d->shiftClickFix
#endif
    ) {
#ifdef QT6_SHIFT_SELECTION_WORKAROUND
        d->shiftClickFix = false;
#endif
        return QItemSelectionModel::ClearAndSelect;
    }
 
#ifdef QT6_SHIFT_SELECTION_WORKAROUND
    //Clear this just in case
    d->shiftClickFix = false;
 
    //Qt6 has a bug/feature? where after you do a shift selection it sends a second selection event with the event argument being null
    //This triggers the logic above, so we explicitly avoid the next null event
    if (event &&
        (event->type() == QEvent::MouseButtonPress || event->type() == QEvent::KeyPress) &&
        QApplication::keyboardModifiers() & Qt::ShiftModifier)
      d->shiftClickFix = true;
#endif
 
    //We still get ctrl click events so we need to ignore those
    if (event &&
        event->type() == QEvent::MouseButtonPress && (static_cast<const QMouseEvent*>(event)->modifiers() & Qt::ControlModifier))
        return QItemSelectionModel::NoUpdate;
 
    return QTreeView::selectionCommand(index, event);
}
 
QModelIndex NodeView::indexAt(const QPoint &point) const
{
    KisNodeViewColorScheme scm;
 
    QModelIndex index = QTreeView::indexAt(point);
    if (!index.isValid()) {
        // Middle is a good position for both LTR and RTL layouts
        // First reset x, then get the x in the middle
        index = QTreeView::indexAt(point - QPoint(point.x(), 0) + QPoint(width() / 2, 0));
    }
 
    return index;
}
 
bool NodeView::viewportEvent(QEvent *e)
{
    if (model()) {
        switch(e->type()) {
        case QEvent::MouseButtonPress: {
            DRAG_WHILE_DRAG_WORKAROUND_STOP();
 
            const QPoint pos = static_cast<QMouseEvent*>(e)->pos();
            d->lastPos = pos;
 
            if (!indexAt(pos).isValid()) {
                return QTreeView::viewportEvent(e);
            }
            QModelIndex index = model()->buddy(indexAt(pos));
            if (d->delegate.editorEvent(e, model(), optionForIndex(index), index)) {
                return true;
            }
        } break;
        case QEvent::MouseButtonRelease: {
            const QPoint pos = static_cast<QMouseEvent*>(e)->pos();
            QModelIndex index = model()->buddy(indexAt(pos));
            if (!indexAt(pos).isValid()) {
                return QTreeView::viewportEvent(e);
            }
            if (d->delegate.editorEvent(e, model(), optionForIndex(index), index)) {
                //Sometimes 2 items become active, to prevent that we explicitly turn off all but the first active item
                std::optional<QModelIndex> active_ind = getActiveItem();
                if (active_ind.has_value()) {
                    setExclusiveActiveItem(active_ind.value());
                }
                return true;
            }
        } break;
        case QEvent::Leave: {
            QEvent e(QEvent::Leave);
            d->delegate.editorEvent(&e, model(), optionForIndex(d->hovered), d->hovered);
            d->hovered = QModelIndex();
        } break;
        case QEvent::MouseMove: {
#ifdef DRAG_WHILE_DRAG_WORKAROUND
            if (d->isDragging) {
                return false;
            }
#endif
 
            const QPoint pos = static_cast<QMouseEvent*>(e)->pos();
            QModelIndex hovered = indexAt(pos);
            if (hovered != d->hovered) {
                if (d->hovered.isValid()) {
                    QEvent e(QEvent::Leave);
                    d->delegate.editorEvent(&e, model(), optionForIndex(d->hovered), d->hovered);
                }
                if (hovered.isValid()) {
                    QEvent e(QEvent::Enter);
                    d->delegate.editorEvent(&e, model(), optionForIndex(hovered), hovered);
                }
                d->hovered = hovered;
            }
            /* This is a workaround for a bug in QTreeView that immediately begins a dragging action
            when the mouse lands on the decoration/icon of a different index and moves 1 pixel or more */
            Qt::MouseButtons buttons = static_cast<QMouseEvent*>(e)->buttons();
            if ((Qt::LeftButton | Qt::MiddleButton) & buttons) {
                if ((pos - d->lastPos).manhattanLength() > qApp->startDragDistance()) {
                    return QTreeView::viewportEvent(e);
                }
                return true;
            }
        } break;
        case QEvent::ToolTip: {
            const QPoint pos = static_cast<QHelpEvent*>(e)->pos();
            if (!indexAt(pos).isValid()) {
                return QTreeView::viewportEvent(e);
            }
            QModelIndex index = model()->buddy(indexAt(pos));
            return d->delegate.editorEvent(e, model(), optionForIndex(index), index);
        } break;
        case QEvent::Resize: {
            scheduleDelayedItemsLayout();
            break;
        }
        default: break;
        }
    }
 
    return QTreeView::viewportEvent(e);
}
 
void NodeView::contextMenuEvent(QContextMenuEvent *e)
{
    QTreeView::contextMenuEvent(e);
    QModelIndex i = indexAt(e->pos());
    if (model())
        i = model()->buddy(i);
    showContextMenu(e->globalPos(), i);
}
 
void NodeView::showContextMenu(const QPoint &globalPos, const QModelIndex &index)
{
    Q_EMIT contextMenuRequested(globalPos, index);
}
 
void NodeView::currentChanged(const QModelIndex &current, const QModelIndex &previous)
{
    QTreeView::currentChanged(current, previous);
    if (current != previous) {
        Q_ASSERT(!current.isValid() || current.model() == model());
        KisSignalsBlocker blocker(this);
        model()->setData(current, true, KisNodeModel::ActiveRole);
    }
}
 
void NodeView::dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector<int> &/*roles*/)
{
    QTreeView::dataChanged(topLeft, bottomRight);
 
    if (d->ignoreDataChanged){
      d->ignoreDataChanged = false;
      return;
    }
 
    for (int x = topLeft.row(); x <= bottomRight.row(); ++x) {
        for (int y = topLeft.column(); y <= bottomRight.column(); ++y) {
            QModelIndex index = topLeft.sibling(x, y);
            if (index.data(KisNodeModel::ActiveRole).toBool()) {
                if (currentIndex() != index) {
                    setCurrentIndex(index);
                }
 
                return;
            }
        }
    }
}
 
void NodeView::selectionChanged(const QItemSelection &selected, const QItemSelection &deselected)
{
    QTreeView::selectionChanged(selected, deselected);
    // XXX: selectedIndexes() does not include hidden (collapsed) items, is this really intended?
    Q_EMIT selectionChanged(selectedIndexes());
}
 
void NodeView::slotActionToggled(bool on, const QPersistentModelIndex &index, int num)
{
    KisBaseNode::PropertyList list = index.data(KisNodeModel::PropertiesRole).value<KisBaseNode::PropertyList>();
    list[num].state = on;
    const_cast<QAbstractItemModel*>(index.model())->setData(index, QVariant::fromValue(list), KisNodeModel::PropertiesRole);
}
 
QStyleOptionViewItem NodeView::optionForIndex(const QModelIndex &index) const
{
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
    QStyleOptionViewItem option = viewOptions();
#else
    QStyleOptionViewItem option;
    initViewItemOption(&option);
#endif
    option.rect = visualRect(index);
    if (index == currentIndex())
        option.state |= QStyle::State_HasFocus;
    return option;
}
 
void NodeView::startDrag(Qt::DropActions supportedActions)
{
    DRAG_WHILE_DRAG_WORKAROUND_START();
    QTreeView::startDrag(supportedActions);
}
 
QPixmap NodeView::createDragPixmap() const
{
    const QModelIndexList selectedIndexes = selectionModel()->selectedIndexes();
    Q_ASSERT(!selectedIndexes.isEmpty());
 
    const int itemCount = selectedIndexes.count();
 
    // If more than one item is dragged, align the items inside a
    // rectangular grid. The maximum grid size is limited to 4 x 4 items.
    int xCount = 2;
    int size = 96;
    if (itemCount > 9) {
        xCount = 4;
        size = KisIconUtils::SizeLarge;
    }
    else if (itemCount > 4) {
        xCount = 3;
        size = KisIconUtils::SizeHuge;
    }
    else if (itemCount < xCount) {
        xCount = itemCount;
    }
 
    int yCount = itemCount / xCount;
    if (itemCount % xCount != 0) {
        ++yCount;
    }
 
    if (yCount > xCount) {
        yCount = xCount;
    }
 
    // Draw the selected items into the grid cells
    QPixmap dragPixmap(xCount * size + xCount - 1, yCount * size + yCount - 1);
    dragPixmap.fill(Qt::transparent);
 
    QPainter painter(&dragPixmap);
    int x = 0;
    int y = 0;
    Q_FOREACH (const QModelIndex &selectedIndex, selectedIndexes) {
        const QImage img = selectedIndex.data(int(KisNodeModel::BeginThumbnailRole) + size).value<QImage>();
        painter.drawPixmap(x, y, QPixmap::fromImage(img.scaled(QSize(size, size), Qt::KeepAspectRatio, Qt::SmoothTransformation)));
 
        x += size + 1;
        if (x >= dragPixmap.width()) {
            x = 0;
            y += size + 1;
        }
        if (y >= dragPixmap.height()) {
            break;
        }
    }
 
    return dragPixmap;
}
 
void NodeView::resizeEvent(QResizeEvent * event)
{
    KisNodeViewColorScheme scm;
    header()->setStretchLastSection(false);
 
    int otherColumnsWidth = scm.visibilityColumnWidth();
 
    // if layer box is enabled subtract its width from the "Default col".
    if (KisConfig(false).useLayerSelectionCheckbox()) {
        otherColumnsWidth += scm.selectedButtonColumnWidth();
    }
    header()->resizeSection(DEFAULT_COL, event->size().width() - otherColumnsWidth);
    header()->resizeSection(SELECTED_COL, scm.selectedButtonColumnWidth());
    header()->resizeSection(VISIBILITY_COL, scm.visibilityColumnWidth());
 
    setIndentation(scm.indentation());
    QTreeView::resizeEvent(event);
}
 
void NodeView::paintEvent(QPaintEvent *event)
{
    event->accept();
    QTreeView::paintEvent(event);
}
 
void NodeView::drawBranches(QPainter *painter, const QRect &rect,
                               const QModelIndex &index) const
{
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
    QStyleOptionViewItem option = viewOptions();
#else
    QStyleOptionViewItem option;
    initViewItemOption(&option);
#endif
    option.rect = rect;
    // This is not really a job for an item delegate, but the logic was already there
    d->delegate.drawBranches(painter, option, index);
}
 
void NodeView::dropEvent(QDropEvent *ev)
{
    QTreeView::dropEvent(ev);
    DRAG_WHILE_DRAG_WORKAROUND_STOP();
}
 
int NodeView::cursorPageIndex() const
{
    QSize size(visualRect(model()->index(0, 0, QModelIndex())).width(), visualRect(model()->index(0, 0, QModelIndex())).height());
    int scrollBarValue = verticalScrollBar()->value();
 
    QPoint cursorPosition = QWidget::mapFromGlobal(QCursor::pos());
 
    int numberRow = (cursorPosition.y() + scrollBarValue) / size.height();
 
    //If cursor is at the half button of the page then the move action is performed after the slide, otherwise it is
    //performed before the page
    if (abs((cursorPosition.y() + scrollBarValue) - size.height()*numberRow) > (size.height()/2)) {
        numberRow++;
    }
 
    if (numberRow > model()->rowCount(QModelIndex())) {
        numberRow = model()->rowCount(QModelIndex());
    }
 
    return numberRow;
}
 
void NodeView::dragEnterEvent(QDragEnterEvent *ev)
{
    DRAG_WHILE_DRAG_WORKAROUND_START();
 
    QVariant data = QVariant::fromValue(
        static_cast<void*>(const_cast<QMimeData*>(ev->mimeData())));
    model()->setData(QModelIndex(), data, KisNodeModel::DropEnabled);
 
    QTreeView::dragEnterEvent(ev);
}
 
void NodeView::dragMoveEvent(QDragMoveEvent *ev)
{
    DRAG_WHILE_DRAG_WORKAROUND_START();
    QTreeView::dragMoveEvent(ev);
}
 
void NodeView::dragLeaveEvent(QDragLeaveEvent *e)
{
    QTreeView::dragLeaveEvent(e);
    DRAG_WHILE_DRAG_WORKAROUND_STOP();
}
 
void NodeView::mousePressEvent(QMouseEvent *e) {
    if (!(e->modifiers() & Qt::ControlModifier)) {
        QTreeView::mousePressEvent(e);
        return;
    }
 
    std::optional<QModelIndex> ind = getActiveItem();
    QTreeView::mousePressEvent(e);
 
    if (ind.has_value()) {
        setExclusiveActiveItem(ind.value());
    }
}
 
bool NodeView::isDragging() const
{
    return m_draggingFlag;
}
 
void NodeView::setDraggingFlag(bool flag)
{
    m_draggingFlag = flag;
}
 
void NodeView::slotUpdateIcons()
{
    d->delegate.slotUpdateIcon();
}
 
void NodeView::slotScrollerStateChanged(QScroller::State state){
    KisKineticScroller::updateCursor(this, state);
}
 
void NodeView::slotConfigurationChanged()
{
    setIndentation(KisNodeViewColorScheme::instance()->indentation());
    updateSelectedCheckboxColumn();
    d->delegate.slotConfigChanged();
}
 
void NodeView::updateSelectedCheckboxColumn()
{
    KisConfig cfg(false);
    if (cfg.useLayerSelectionCheckbox() == !header()->isSectionHidden(SELECTED_COL)) {
        return;
    }
    header()->setSectionHidden(SELECTED_COL, !cfg.useLayerSelectionCheckbox());
    // add/subtract width based on SELECTED_COL section's visibility
    header()->resizeSection(DEFAULT_COL,
                            size().width()
                                + (cfg.useLayerSelectionCheckbox() ? header()->sectionSize(SELECTED_COL)
                                                                   : -header()->sectionSize(SELECTED_COL)));
}
 
std::optional<QModelIndex> NodeView::getActiveItem()
{
    QAbstractItemModel* mdl = model(); 
 
    int rows = mdl->rowCount();
    int clmns = mdl->columnCount();
 
    for (int i = 0; i < rows; i++) {
        for (int j = 0; j < clmns; j++) {
           auto index = mdl->index(i, j);
           if (mdl->data(index, KisNodeModel::ActiveRole).toBool()){
              return index;
           }
        }
    }
 
    return {};
}
 
void NodeView::setExclusiveActiveItem(QModelIndex index)
{
    QAbstractItemModel* mdl = model(); 
 
    int rows = mdl->rowCount();
    int clmns = mdl->columnCount();
 
    for (int i = 0; i < rows; i++) {
        for (int j = 0; j < clmns; j++) {
           QModelIndex ind = mdl->index(i, j);
           
           //Suppress the data changed event, so that it doesn't mess with the selection
           d->ignoreDataChanged = true;
           mdl->setData(ind, false, KisNodeModel::ActiveRole);
        }
    }
 
    d->ignoreDataChanged = true;
    mdl->setData(index, true, KisNodeModel::ActiveRole);
 
    selectionModel()->setCurrentIndex(index, QItemSelectionModel::NoUpdate);
}