itemcategorizedview.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-04-22
 * Description : Qt model-view for items
 *
 * Copyright (C) 2009-2012 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2017      by Simon Frei <freisim93 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_CATEGORIZED_VIEW_H
#define DIGIKAM_ITEM_CATEGORIZED_VIEW_H
 
// Local includes
 
#include "iteminfo.h"
#include "itemviewcategorized.h"
#include "thumbnailsize.h"
#include "iccsettingscontainer.h"
 
namespace Digikam
{
 
class Album;
class ItemAlbumModel;
class ItemAlbumFilterModel;
class ItemModel;
class ItemFilterModel;
class ImageSortFilterModel;
class ItemDelegate;
class ItemDelegateOverlay;
class ItemThumbnailModel;
 
class ItemCategorizedView : public ItemViewCategorized
{
    Q_OBJECT
 
public:
 
    explicit ItemCategorizedView(QWidget* const parent = nullptr);
    ~ItemCategorizedView()                                                                override;
 
    void setModels(ItemModel* model, ImageSortFilterModel* filterModel);
 
    ItemModel*            imageModel()                                              const;
    ImageSortFilterModel* imageSortFilterModel()                                    const;
 
    QItemSelectionModel*  getSelectionModel()                                       const;
 
    ItemFilterModel*      imageFilterModel()                                        const;
 
    ItemThumbnailModel*   imageThumbnailModel()                                     const;
 
    ItemAlbumModel*       imageAlbumModel()                                         const;
    ItemAlbumFilterModel* imageAlbumFilterModel()                                   const;
 
    ItemDelegate*         delegate()                                                const;
 
    Album*                currentAlbum()                                            const;
    ItemInfo              currentInfo()                                             const;
    QUrl                  currentUrl()                                              const;
 
    ItemInfoList          allItemInfos()                                            const;
    QList<QUrl>           allUrls()                                                 const;
    ItemInfoList          selectedItemInfos()                                       const;
    ItemInfoList          selectedItemInfosCurrentFirst()                           const;
 
    void toIndex(const QUrl& url);
 
    ItemInfo nextInOrder(const ItemInfo& startingPoint, int nth);
 
    ItemInfo previousInfo(const ItemInfo& info)
    {
        return nextInOrder(info, -1);
    }
 
    ItemInfo nextInfo(const ItemInfo& info)
    {
        return nextInOrder(info, 1);
    }
 
    QModelIndex indexForInfo(const ItemInfo& info)                                  const;
 
    ThumbnailSize thumbnailSize()                                                   const;
 
    virtual void setThumbnailSize(const ThumbnailSize& size);
 
    Album* albumAt(const QPoint& pos)                                               const;
 
    void addOverlay(ItemDelegateOverlay* overlay, ItemDelegate* delegate = nullptr);
 
    void removeOverlay(ItemDelegateOverlay* overlay);
 
    void addSelectionOverlay(ItemDelegate* delegate = nullptr);
 
public Q_SLOTS:
 
    void openAlbum(const QList<Album*>& album);
 
    void setThumbnailSize(int size);
 
    void setCurrentWhenAvailable(qlonglong imageId);
 
    void setCurrentUrlWhenAvailable(const QUrl& url);
 
    void setCurrentUrl(const QUrl& url);
 
    void setCurrentInfo(const ItemInfo& info);
 
    void setSelectedUrls(const QList<QUrl>& urlList);
 
    void setSelectedItemInfos(const QList<ItemInfo>& infos);
 
    void hintAt(const ItemInfo& info);
 
Q_SIGNALS:
 
    void currentChanged(const ItemInfo& info);
 
    void selected(const QList<ItemInfo>& newSelectedInfos);
 
    void deselected(const QList<ItemInfo>& nowDeselectedInfos);
 
    void imageActivated(const ItemInfo& info);
 
    void modelChanged();
 
protected Q_SLOTS:
 
    void slotItemInfosAdded();
    void slotCurrentUrlTimer();
 
protected:
 
    void installDefaultModels();
 
    // reimplemented from parent class
 
    QSortFilterProxyModel*       filterModel()                                      const override;
    AbstractItemDragDropHandler* dragDropHandler()                                  const override;
    QModelIndex                  nextIndexHint(const QModelIndex& indexToAnchor,
                                               const QItemSelectionRange& removed)  const override;
 
    void setItemDelegate(ItemDelegate* delegate);
    void indexActivated(const QModelIndex& index, Qt::KeyboardModifiers modifiers)        override;
    void currentChanged(const QModelIndex& index, const QModelIndex& previous)            override;
    void selectionChanged(const QItemSelection&, const QItemSelection&)                   override;
    void updateGeometries()                                                               override;
 
    virtual void activated(const ItemInfo& info, Qt::KeyboardModifiers modifiers);
    virtual void showContextMenuOnInfo(QContextMenuEvent* event, const ItemInfo& info);
    void showContextMenuOnIndex(QContextMenuEvent* event, const QModelIndex& index)       override;
 
    ItemInfo     imageInfo(const QModelIndex& index)                                const;
    ItemInfoList imageInfos(const QList<QModelIndex>& indexes)                      const;
 
private Q_SLOTS:
 
    void slotIccSettingsChanged(const ICCSettingsContainer&, const ICCSettingsContainer&);
    void slotFileChanged(const QString& filePath);
    void slotDelayedEnter();
 
private:
 
    void scrollToStoredItem();
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_ITEM_CATEGORIZED_VIEW_H