itemviewcategorized.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 : Qt item view for images
 *
 * 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_ITEM_VIEW_CATEGORIZED_H
#define DIGIKAM_ITEM_VIEW_CATEGORIZED_H
 
// Local includes
 
#include "digikam_export.h"
#include "dcategorizedview.h"
#include "dragdropimplementations.h"
 
class QSortFilterProxyModel;
 
namespace Digikam
{
 
class DItemDelegate;
class ItemViewToolTip;
 
class DIGIKAM_EXPORT ItemViewCategorized : public DCategorizedView,
                                           public DragDropViewImplementation
{
    Q_OBJECT
 
public:
 
    explicit ItemViewCategorized(QWidget* const parent = nullptr);
    ~ItemViewCategorized() override;
 
    DItemDelegate* delegate()                                                       const;
    int            numberOfSelectedIndexes()                                        const;
 
    void toFirstIndex();
    void toLastIndex();
    void toNextIndex();
    void toPreviousIndex();
    void toIndex(const QModelIndex& index);
    void awayFromSelection();
 
    void setScrollCurrentToCenter(bool enabled);
 
    void scrollToRelaxed(const QModelIndex& index, ScrollHint hint = EnsureVisible);
 
    void invertSelection();
    void setSelectedIndexes(const QList<QModelIndex>& indexes);
 
    void setToolTipEnabled(bool enabled);
    bool isToolTipEnabled()                                                         const;
 
    void setSpacing(int spacing);
 
    void setUsePointingHandCursor(bool useCursor);
 
    void setScrollStepGranularity(int factor);
 
    virtual QSortFilterProxyModel* filterModel()                                    const = 0;
    void scrollTo(const QModelIndex& index, ScrollHint hint = EnsureVisible)              override;
 
public Q_SLOTS:
 
    void showIndexNotification(const QModelIndex& index, const QString& message);
    void hideIndexNotification();
 
    void cut()   override { DragDropViewImplementation::cut();   }
    void copy()  override { DragDropViewImplementation::copy();  }
    void paste() override { DragDropViewImplementation::paste(); }
 
Q_SIGNALS:
 
    void selectionChanged();
 
    void selectionCleared();
 
    void zoomOutStep();
    void zoomInStep();
 
    void clicked(const QMouseEvent* e, const QModelIndex& index);
    void entered(const QMouseEvent* e, const QModelIndex& index);
 
    void viewportClicked(const QMouseEvent* e);
 
    void keyPressed(QKeyEvent* e);
 
 
protected Q_SLOTS:
 
    void slotActivated(const QModelIndex& index);
    void slotClicked(const QModelIndex& index);
    void slotEntered(const QModelIndex& index);
    void layoutAboutToBeChanged();
    void layoutWasChanged();
 
    virtual void slotThemeChanged();
    virtual void slotSetupChanged();
 
protected:
 
    void encodeIsCutSelection(QMimeData* mime, bool isCutSelection);
    bool decodeIsCutSelection(const QMimeData* mimeData);
 
    void setToolTip(ItemViewToolTip* tip);
    void setItemDelegate(DItemDelegate* delegate);
    void updateDelegateSizes();
    void userInteraction();
 
    QModelIndex indexForCategoryAt(const QPoint& pos) const;
 
    void contextMenuEvent(QContextMenuEvent* event)                                       override;
    void keyPressEvent(QKeyEvent* event)                                                  override;
    void leaveEvent(QEvent* event)                                                        override;
    void mouseMoveEvent(QMouseEvent* event)                                               override;
    void mousePressEvent(QMouseEvent* event)                                              override;
    void mouseReleaseEvent(QMouseEvent* event)                                            override;
    void resizeEvent(QResizeEvent* e)                                                     override;
    void reset()                                                                          override;
    void rowsAboutToBeRemoved(const QModelIndex& parent, int start, int end)              override;
    void rowsInserted(const QModelIndex& parent, int start, int end)                      override;
    void rowsRemoved(const QModelIndex& parent, int start, int end)                       override;
    void selectionChanged(const QItemSelection&, const QItemSelection&)                   override;
    bool viewportEvent(QEvent* event)                                                     override;
    void wheelEvent(QWheelEvent* event)                                                   override;
    QModelIndex moveCursor(CursorAction cursorAction, Qt::KeyboardModifiers modifiers)    override;
 
    virtual void showContextMenuOnIndex(QContextMenuEvent* event, const QModelIndex& index);
    virtual void showContextMenu(QContextMenuEvent* event);
    virtual void indexActivated(const QModelIndex& index, Qt::KeyboardModifiers modifiers);
 
    virtual bool showToolTip(const QModelIndex& index,
                             QStyleOptionViewItem& option,
                             QHelpEvent* e = nullptr);
 
    DECLARE_VIEW_DRAG_DROP_METHODS(DCategorizedView)
 
    
    QModelIndex mapIndexForDragDrop(const QModelIndex& index)                       const override;
    QPixmap     pixmapForDrag(const QList<QModelIndex>& indexes)                    const override;
 
    virtual QModelIndex nextIndexHint(const QModelIndex& indexToAnchor,
                                      const QItemSelectionRange& removed)           const;
 
private Q_SLOTS:
 
    void slotGridSizeChanged(const QSize&);
 
private:
 
    // Disable
    ItemViewCategorized(const ItemViewCategorized&)            = delete;
    ItemViewCategorized& operator=(const ItemViewCategorized&) = delete;
 
private:
 
    void ensureSelectionAfterChanges();
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_ITEM_VIEW_CATEGORIZED_H