abstractalbumtreeview.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-03-25
 * Description : Tree View for album models
 *
 * Copyright (C) 2009-2010 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2010-2011 by Andi Clemens <andi dot clemens at gmail dot com>
 * Copyright (C) 2009-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_ABSTRACT_ALBUM_TREE_VIEW_H
#define DIGIKAM_ABSTRACT_ALBUM_TREE_VIEW_H
 
// Qt includes
 
#include <QTreeView>
 
// Local includes
 
#include "albummanager.h"
#include "albummodel.h"
#include "albumfiltermodel.h"
#include "albumpointer.h"
#include "statesavingobject.h"
 
namespace Digikam
{
 
class ContextMenuHelper;
class TagModificationHelper;
 
// NOTE: This structure name can be in conflict with QAbstractItemView::State. FIXME later.
struct State;
 
class AbstractAlbumTreeView : public QTreeView,
                              public StateSavingObject
{
    Q_OBJECT
 
public:
 
    enum Flag
    {
        CreateDefaultModel,
 
        CreateDefaultFilterModel,
 
        CreateDefaultDelegate,
 
        ShowCountAccordingToSettings,
 
        AlwaysShowInclusiveCounts,
 
        DefaultFlags = CreateDefaultFilterModel | CreateDefaultDelegate | ShowCountAccordingToSettings
    };
    Q_DECLARE_FLAGS(Flags, Flag)
 
public:
 
    AbstractAlbumTreeView(QWidget* const parent, Flags flags);
    ~AbstractAlbumTreeView()                                                    override;
 
    AbstractSpecificAlbumModel* albumModel() const;
    AlbumFilterModel* albumFilterModel()     const;
 
    void setExpandOnSingleClick(const bool doThat);
 
    void setExpandNewCurrentItem(const bool doThat);
 
    void setSelectAlbumOnClick(const bool selectOnClick);
 
    void setEnableContextMenu(const bool enable);
 
    void setSelectOnContextMenu(const bool select);
 
    void setContextMenuIcon(const QPixmap& pixmap);
    void setContextMenuTitle(const QString& title);
 
    QModelIndex indexVisuallyAt(const QPoint& p);
 
    bool expandMatches(const QModelIndex& index);
 
 
    void doLoadState()                                                          override;
    void doSaveState()                                                          override;
 
 
    void setAlbumManagerCurrentAlbum(const bool setCurrentAlbum);
 
    class ContextMenuElement
    {
    public:
 
        ContextMenuElement()                    = default;
        virtual ~ContextMenuElement()           = default;
 
        virtual void addActions(AbstractAlbumTreeView* view,
                                ContextMenuHelper& cmh,
                                Album* album)   = 0;
 
    private:
 
        Q_DISABLE_COPY(ContextMenuElement)
    };
 
    void addContextMenuElement(ContextMenuElement* const element);
    void removeContextMenuElement(ContextMenuElement* const element);
    QList<ContextMenuElement*> contextMenuElements() const;
 
    template<class A>
    QList<A*> currentAlbums();
 
    bool viewportEvent(QEvent* event)                                           override;
 
    QList<Album*> selectedItems();
 
public Q_SLOTS:
 
    void setSearchTextSettings(const SearchTextSettings& settings);
 
    void setCurrentAlbums(const QList<Album*>& albums, bool selectInAlbumManager = true);
 
    void adaptColumnsToContent();
 
    void scrollToSelectedAlbum();
 
    void expandEverything(const QModelIndex& index);
 
    void slotExpandNode();
 
    void slotCollapseNode();
 
    void slotCollapseAllNodes();
 
Q_SIGNALS:
 
    void currentAlbumChanged(Album* currentAlbum);
 
    void selectedAlbumsChanged(const QList<Album*>& selectedAlbums);
 
protected Q_SLOTS:
 
    virtual void slotRootAlbumAvailable();
 
    void slotSearchTextSettingsChanged(bool wasSearching, bool searching);
    void slotSearchTextSettingsAboutToChange(bool searched, bool willSearch);
    void slotCurrentChanged();
    void slotSelectionChanged();
 
    void albumSettingsChanged();
 
protected:
 
 
    // Context menu handling
 
    virtual bool showContextMenuAt(QContextMenuEvent* event, Album* albumForEvent);
 
    virtual QPixmap contextMenuIcon()  const;
 
    virtual QString contextMenuTitle() const;
 
    virtual void addCustomContextMenuActions(ContextMenuHelper& cmh, Album* album);
 
    virtual void handleCustomContextMenuAction(QAction* action,
                                               const AlbumPointer<Album>& album);
 
 
 
 
    void mousePressEvent(QMouseEvent* e)                                        override;
 
    void rowsInserted(const QModelIndex& index, int start, int end)             override;
    void rowsAboutToBeRemoved(const QModelIndex& parent, int start, int end)    override;
    void startDrag(Qt::DropActions supportedActions)                            override;
    void dragEnterEvent(QDragEnterEvent* e)                                     override;
    void dragMoveEvent(QDragMoveEvent* e)                                       override;
    void dragLeaveEvent(QDragLeaveEvent* e)                                     override;
    void dropEvent(QDropEvent* e)                                               override;
 
    virtual void middleButtonPressed(Album* a);
    virtual QPixmap pixmapForDrag(const QStyleOptionViewItem& option, QList<QModelIndex> indexes);
 
    void setAlbumFilterModel(AlbumFilterModel* const filterModel);
    void setAlbumModel(AbstractSpecificAlbumModel* const model);
 
 
protected:
 
    AbstractSpecificAlbumModel* m_albumModel;
    AlbumFilterModel*           m_albumFilterModel;
    AlbumModelDragDropHandler*  m_dragDropHandler;
 
    int                         m_lastScrollBarValue;
    bool                        m_checkOnMiddleClick;
    bool                        m_restoreCheckState;
    Flags                       m_flags;
 
private:
 
    void saveStateRecursive(const QModelIndex& index,
                            QList<int>& selection, QList<int>& expansion);
 
    void restoreStateForHierarchy(const QModelIndex& index,
                                  const QMap<int, Digikam::State>& stateStore);
 
    void restoreState(const QModelIndex& index,
                      const QMap<int, Digikam::State>& stateStore);
 
    void contextMenuEvent(QContextMenuEvent* event)                             override;
 
private Q_SLOTS:
 
    void adaptColumnsOnDataChange(const QModelIndex& topLeft, const QModelIndex& bottomRight);
 
    void adaptColumnsOnRowChange(const QModelIndex& parent, int start, int end);
 
    void adaptColumnsOnLayoutChange();
 
    void currentAlbumChangedForBackupSelection(Album* currentAlbum);
 
    void slotScrollBarValueChanged(int value);
    void slotScrollBarActionTriggered(int action);
 
private:
 
    class Private;
    Private* d;
};
 
} // namespace Digikam
 
Q_DECLARE_OPERATORS_FOR_FLAGS(Digikam::AbstractAlbumTreeView::Flags)
 
#endif // DIGIKAM_ABSTRACT_ALBUM_TREE_VIEW_H