File indexing completed on 2025-01-19 03:58:03

 /* ============================================================
  *
  * This file is a part of digiKam project
  * https://www.digikam.org
  *
  * Date        : 2017-05-15
  * Description : menu to manage bookmarks
  *
  * SPDX-FileCopyrightText: 2017-2024 by Gilles Caulier <caulier dot gilles at gmail dot com>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
  *
  * ============================================================ */
 
 #ifndef DIGIKAM_BOOKMARKS_MENU_H
 #define DIGIKAM_BOOKMARKS_MENU_H
 
 // Qt includes
 
 #include <QMenu>
 #include <QList>
 #include <QAction>
 #include <QWidget>
 #include <QModelIndex>
 #include <QAbstractItemModel>
 
 // Local includes
 
 #include "bookmarksmngr.h"
 
 namespace Digikam
 {
 
 /**
  * A QMenu that is dynamically populated from a QAbstractItemModel
  */
 class ModelMenu : public QMenu
 {
     Q_OBJECT
 
 public:
 
     explicit ModelMenu(QWidget* const parent = nullptr);
     ~ModelMenu() override;
 
     void setModel(QAbstractItemModel* model);
     QAbstractItemModel* model() const;
 
     void setMaxRows(int max);
     int maxRows() const;
 
     void setFirstSeparator(int offset);
     int firstSeparator() const;
 
     void setRootIndex(const QModelIndex& index);
     QModelIndex rootIndex() const;
 
     void setHoverRole(int role);
     int hoverRole() const;
 
     void setSeparatorRole(int role);
     int separatorRole() const;
 
     QAction* makeAction(const QIcon& icon, const QString& text, QObject* const parent);
 
 Q_SIGNALS:
 
     void activated(const QModelIndex& index);
     void hovered(const QString& text);
 
 protected:
 
     /// add any actions before the tree, return true if any actions are added.
     virtual bool prePopulated();
 
     /// add any actions after the tree
     virtual void postPopulated();
 
     /// put all of the children of parent into menu up to max
     void createMenu(const QModelIndex& parent, int max, QMenu* parentMenu = nullptr, QMenu* menu = nullptr);
 
 private Q_SLOTS:
 
     void slotAboutToShow();
     void slotTriggered(QAction* action);
     void slotHovered(QAction* action);
 
 private:
 
     QAction* makeAction(const QModelIndex& index);
 
 private:
 
     class Private;
     Private* const d;
 };
 
 // ---------------------------------------------------------------------------
 
 /**
  * Menu that is dynamically populated from the bookmarks
  */
 class BookmarksMenu : public ModelMenu
 {
     Q_OBJECT
 
 public:
 
     explicit BookmarksMenu(BookmarksManager* const mngr, QWidget* const parent = nullptr);
     ~BookmarksMenu() override;
 
     void setInitialActions(const QList<QAction*>& actions);
 
 Q_SIGNALS:
 
     void openUrl(const QUrl& url);
 
 protected:
 
     bool prePopulated() override;
 
 private Q_SLOTS:
 
     void slotActivated(const QModelIndex& index);
 
 private:
 
     class Private;
     Private* const d;
 };
 
 } // namespace Digikam
 
 #endif // DIGIKAM_BOOKMARKS_MENU_H