CustomItemDelegate.h

Go to the documentation of this file.

/*-
 * Copyright (c) 2022-23 Simon Peter <probono@puredarwin.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */
 
#ifndef CUSTOMITEMDELEGATE_H
#define CUSTOMITEMDELEGATE_H
 
#include <QStyledItemDelegate>
#include <QFileSystemModel>
#include <QObject>
#include <QAction>
#include <QMenu>
#include <QMimeData>
#include "CustomFileSystemModel.h"
#include <QTimeLine>
#include <QItemSelectionModel>
#include <QStandardItemModel>
#include "CustomFileIconProvider.h"
#include <QAbstractProxyModel>
#include <QLineEdit>
 
enum CustomItemDelegateRole {
    DelegatePositionRole = Qt::UserRole + 1
};
 
class CustomItemDelegate : public QStyledItemDelegate
{
Q_OBJECT
 
public:
    explicit CustomItemDelegate(QObject* parent = nullptr, QAbstractProxyModel* fileSystemModel = nullptr);
 
    // Destructor
    ~CustomItemDelegate();
 
    void paint(QPainter *painter, const QStyleOptionViewItem &option,
               const QModelIndex &index) const override;
 
    // void installEventFilterOnView(QAbstractItemView* view);
 
    // bool eventFilter(QObject* object, QEvent* event) override;
 
    void setSelectionModel(QItemSelectionModel* selectionModel);
 
    QSize sizeHint(const QStyleOptionViewItem& option, const QModelIndex& index) const override {
        // Get the current size
        QSize size = QStyledItemDelegate::sizeHint(option, index);
        return QSize(option.rect.width(), size.height());
    }
 
public slots:
    void animationValueChanged(double value);
 
    void animationFinished();
 
    void stopAnimation();
 
    void startAnimation(const QModelIndex& index);
 
    bool isAnimationRunning() const;
 
    // The following are used to implement a custom editor for the delegate
    // (when the user clicks on an item to rename it)
 
    QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, const QModelIndex& index) const override;
 
    void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const override;
 
signals:
    void fileDropped(const QString& filePath, const QPoint& iconPosition);
 
protected:
    // Override the editorEvent() function to handle right-click events for the context menu
    bool editorEvent(QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option,
                     const QModelIndex &index) override;
 
private:
    // Private member variable to hold a pointer to the QFileSystemModel object
    QAbstractProxyModel *m_fileSystemModel;
 
    // We use this to flash the icon if the item was double-clicked
    bool iconShown = false;
    bool iconVisible = false;
    int flashCount = 0;
 
    // Context menu
    // It is generally not a good idea to create a context menu in an ItemDelegate object,
    // because the ItemDelegate object is responsible for drawing the items in the view,
    // and it is not responsible for handling user interactions with the items.
    // We should probably fix this in a future version of the application.
    QMenu menu;
 
    QTimeLine* animationTimeline;
 
    qreal currentAnimationValue;
 
    // Member variables to store the current index and option
    mutable QModelIndex m_currentIndex;
    QModelIndex m_animatedIndex; // The index of the item that should currently be animated
    mutable QStyleOptionViewItem m_currentOption;
 
    QItemSelectionModel* m_selectionModel;
 
private slots:
    // Slot to handle drag enter events
    // void onDragEnterEvent(QDragEnterEvent* event);
 
    // Slot to handle drop events
    // void onDropEvent(QDropEvent* event);
};
 
#endif // CUSTOMITEMDELEGATE_H