dcategorizedview_p.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-01-16
 * Description : Item view for listing items in a categorized fashion optionally
 *
 * Copyright (C) 2007      by Rafael Fernández López <ereslibre at kde dot org>
 * Copyright (C) 2009-2012 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2011-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_DCATEGORIZED_VIEW_PRIVATE_H
#define DIGIKAM_DCATEGORIZED_VIEW_PRIVATE_H
 
#include "dcategorizedview.h"
 
// C++ includes
 
#include <cmath>
 
// Qt includes
 
#include <QVector>
#include <QPainter>
#include <QScrollBar>
#include <QPaintEvent>
 
// Local includes
 
#include "dcategorizedsortfilterproxymodel.h"
#include "dcategorydrawer.h"
 
#define DOLPHIN_DRAGANDDROP
 
class DCategoryDrawer;
 
namespace Digikam
{
 
class DCategorizedSortFilterProxyModel;
 
class Q_DECL_HIDDEN SparseModelIndexVector : public QVector<QModelIndex>
{
public:
 
    explicit SparseModelIndexVector(int rowCount, QAbstractItemModel* const model_, int column_)
        : QVector<QModelIndex>(rowCount),
          model(model_),
          column(column_)
    {
    }
 
    inline QModelIndex& operator[](int i)
    {
        QModelIndex& index = QVector<QModelIndex>::operator[](i);
 
        if (!index.isValid())
        {
            index = model->index(i, column);
        }
 
        return index;
    }
 
private:
 
    // not to be used
 
    const QModelIndex& operator[](int i) const
    {
        return QVector<QModelIndex>::operator[](i);
    }
 
private:
 
    QAbstractItemModel* model;
    int                 column;
};
 
// ------------------------------------------------------------------------------------
 
class Q_DECL_HIDDEN DCategorizedView::Private
{
public:
 
    explicit Private(DCategorizedView* const listView);
    ~Private();
 
    // Methods
 
    const QModelIndexList& intersectionSet(const QRect& rect);
 
    QRect visualRectInViewport(const QModelIndex& index) const;
 
    QRect visualCategoryRectInViewport(const QString& category) const;
 
    const QRect& cacheIndex(const QModelIndex& index);
 
    const QRect& cacheCategory(const QString& category);
 
    const QRect& cachedRectIndex(const QModelIndex& index);
 
    const QRect& cachedRectCategory(const QString& category);
 
    QRect visualRect(const QModelIndex& index);
 
    QRect categoryVisualRect(const QString& category);
 
    QSize contentsSize();
 
    void drawNewCategory(const QModelIndex& index,
                         int sortRole,
                         const QStyleOption& option,
                         QPainter* painter);
 
    void updateScrollbars();
 
    void drawDraggedItems(QPainter* painter);
 
    void drawDraggedItems();
 
    int categoryUpperBound(SparseModelIndexVector& modelIndexList, int begin, int averageSize = 0);
 
    QItemSelection selectionForRect(const QRect& rect);
 
public:
 
    class Q_DECL_HIDDEN ElementInfo
    {
    public:
 
        explicit ElementInfo()
            : relativeOffsetToCategory(0)
        {
        }
 
        QString category;
        int     relativeOffsetToCategory;
    };
 
public:
 
    DCategorizedView*                 listView;
    DCategoryDrawer*                  categoryDrawer;
    QSize                             biggestItemSize;
 
    bool                              mouseButtonPressed;
    bool                              rightMouseButtonPressed;
    bool                              dragLeftViewport;
    bool                              drawItemsWhileDragging;
    QModelIndex                       hovered;
    QString                           hoveredCategory;
    QPoint                            initialPressPosition;
    QPoint                            mousePosition;
    int                               forcedSelectionPosition;
 
    QVector<ElementInfo>              elementsInfo;
    QHash<int, QRect>                 elementsPosition;
    QHash<QString, QVector<int> >     categoriesIndexes;
    QHash<QString, QRect>             categoriesPosition;
    QStringList                       categories;
    QModelIndexList                   intersectedIndexes;
    QRect                             lastDraggedItemsRect;
    QItemSelection                    lastSelection;
 
    DCategorizedSortFilterProxyModel* proxyModel;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DCATEGORIZED_VIEW_PRIVATE_H