File indexing completed on 2025-01-19 03:57:33

 /* ============================================================
  *
  * This file is a part of digiKam project
  * https://www.digikam.org
  *
  * Date        : 2012-07-13
  * Description : Qt categorized item view for showfoto items
  *
  * SPDX-FileCopyrightText: 2013 by Mohamed_Anwer <m_dot_anwer at gmx dot com>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
  *
  * ============================================================ */
 
 #ifndef SHOW_FOTO_CATEGORIZED_VIEW_H
 #define SHOW_FOTO_CATEGORIZED_VIEW_H
 
 // Local includes
 
 #include "itemviewcategorized.h"
 #include "showfotoitemmodel.h"
 #include "showfotofiltermodel.h"
 #include "showfotothumbnailmodel.h"
 #include "showfotoiteminfo.h"
 #include "itemdelegateoverlay.h"
 
 namespace ShowFoto
 {
 
 class ShowfotoDelegate;
 
 class ShowfotoCategorizedView : public ItemViewCategorized
 {
 public:
 
     Q_OBJECT
 
 public:
 
     explicit ShowfotoCategorizedView(QWidget* const parent = nullptr);
     ~ShowfotoCategorizedView() override;
 
     void setModels(ShowfotoItemModel* model, ShowfotoSortFilterModel* filterModel);
 
     ShowfotoItemModel*          showfotoItemModel()                     const;
     ShowfotoSortFilterModel*    showfotoSortFilterModel()               const;
 
     QItemSelectionModel*        getSelectionModel()                     const;
 
     /// Returns any ShowfotoFilterModel in chain. May not be sourceModel()
     ShowfotoFilterModel*        showfotoFilterModel()                   const;
 
     /// Returns 0 if the ShowfotoItemModel is not an ShowfotoThumbnailModel
     ShowfotoThumbnailModel*     showfotoThumbnailModel()                const;
 
     ShowfotoDelegate*           delegate()                              const;
 
     ShowfotoItemInfo            currentInfo()                           const;
     QUrl                        currentUrl()                            const;
 
     QList<ShowfotoItemInfo>     selectedShowfotoItemInfos()             const;
     QList<ShowfotoItemInfo>     selectedShowfotoItemInfosCurrentFirst() const;
     QList<QUrl>                 selectedUrls()                          const;
 
     QList<ShowfotoItemInfo>     showfotoItemInfos()                     const;
     QList<QUrl>                 urls()                                  const;
 
     /**
      * Selects the index as current and scrolls to it
      */
     void toIndex(const QUrl& url);
 
     /**
      * Returns the n-th info after the given one.
      * Specifically, return the previous info for nth = -1
      * and the next info for n = 1.
      * Returns a null info if either startingPoint or the nth info are
      * not contained in the model
      */
     ShowfotoItemInfo nextInOrder(const ShowfotoItemInfo& startingPoint, int nth);
 
     ShowfotoItemInfo previousInfo(const ShowfotoItemInfo& info);
     ShowfotoItemInfo nextInfo(const ShowfotoItemInfo& info);
 
     /**
      * Add and remove an overlay. It will as well be removed automatically when destroyed.
      * Unless you pass a different delegate, the current delegate will be used.
      */
     void addOverlay(ItemDelegateOverlay* overlay, ShowfotoDelegate* delegate = nullptr);
     void removeOverlay(ItemDelegateOverlay* overlay);
 
     // TODO: Implement This
 /*
     void addSelectionOverlay(ShowfotoDelegate* delegate = 0);
 */
     ThumbnailSize thumbnailSize() const;
 
     virtual void setThumbnailSize(const ThumbnailSize& size);
 
 public Q_SLOTS:
 
     void setThumbnailSize(int size);
 
     /**
      * Scroll the view to the given item when it becomes available
      */
     void setCurrentWhenAvailable(qlonglong ShowfotoItemId);
 
     /**
      * Set as current item the item identified by its file url
      */
     void setCurrentUrl(const QUrl& url);
 
     /**
      * Set as current item the item identified by the ShowfotoItemInfo
      */
     void setCurrentInfo(const ShowfotoItemInfo& info);
 
     /**
      * Set selected items identified by their file urls
      */
     void setSelectedUrls(const QList<QUrl>& urlList);
 
     /**
      * Set selected items
      */
     void setSelectedShowfotoItemInfos(const QList<ShowfotoItemInfo>& infos);
 
     /**
      * Does something to gain attention for info, but not changing current selection
      */
     void hintAt(const ShowfotoItemInfo& info);
 
 Q_SIGNALS:
 
     void currentChanged(const ShowfotoItemInfo& info);
 
     /**
      * Emitted when new items are selected. The parameter includes only the newly selected infos,
      * there may be other already selected infos.
      */
     void selected(const QList<ShowfotoItemInfo>& newSelectedInfos);
 
     /**
      * Emitted when items are deselected. There may be other selected infos left.
      * This signal is not emitted when the model is reset; then only selectionCleared is emitted.
      */
     void deselected(const QList<ShowfotoItemInfo>& nowDeselectedInfos);
 
     /**
      * Emitted when the given ShowfotoItemInfo is activated. Info is never null.
      */
     void showfotoItemInfoActivated(const ShowfotoItemInfo& info);
 
     /**
      * Emitted when a new model is set.
      */
     void modelChanged();
 
 protected:
 
     /// reimplemented from parent class
     QSortFilterProxyModel*       filterModel()                                                                       const override;
     AbstractItemDragDropHandler* dragDropHandler()                                                                   const override;
     QModelIndex                  nextIndexHint(const QModelIndex& indexToAnchor, const QItemSelectionRange& removed) const override;
 
     void setItemDelegate(ShowfotoDelegate* delegate);
     void indexActivated(const QModelIndex& index, Qt::KeyboardModifiers modifiers)                                         override;
     void currentChanged(const QModelIndex& index, const QModelIndex& previous)                                             override;
     void paintEvent(QPaintEvent* e)                                                                                        override;
     void selectionChanged(const QItemSelection&, const QItemSelection&)                                                    override;
     void updateGeometries()                                                                                                override;
 
     /// Reimplement these in a subclass
     virtual void activated(const ShowfotoItemInfo& info, Qt::KeyboardModifiers modifiers);
     virtual void showContextMenuOnInfo(QContextMenuEvent* event, const ShowfotoItemInfo& info);
     void showContextMenuOnIndex(QContextMenuEvent* event, const QModelIndex& index) override;
 
 private Q_SLOTS:
 
     void slotFileChanged(const QString& filePath);
     void slotDelayedEnter();
 
 private:
 
     void scrollToStoredItem();
 
 private:
 
     // Disable
     ShowfotoCategorizedView(const ShowfotoCategorizedView&)            = delete;
     ShowfotoCategorizedView& operator=(const ShowfotoCategorizedView&) = delete;
 
 private:
 
     class Private;
     Private* const d;
 };
 
 } // namespace Showfoto
 
 #endif // SHOW_FOTO_CATEGORIZED_VIEW_H