bookmarksmenu.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2017-05-15
 * Description : menu to manage bookmarks
 *
 * Copyright (C) 2017-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_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
{
 
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:
 
    virtual bool prePopulated();
 
    virtual void postPopulated();
 
    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;
};
 
// ---------------------------------------------------------------------------
 
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