contextmenuhelper.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-02-15
 * Description : contextmenu helper class
 *
 * Copyright (C) 2009-2010 by Andi Clemens <andi dot clemens at gmail dot com>
 * Copyright (C) 2010-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_CONTEXT_MENU_HELPER_H
#define DIGIKAM_CONTEXT_MENU_HELPER_H
 
// Qt includes
 
#include <QObject>
#include <QList>
#include <QUrl>
 
// Local includes
 
#include "digikam_export.h"
#include "digikam_config.h"
#include "coredbalbuminfo.h"
 
class QAction;
class QMenu;
class QPoint;
class QString;
 
namespace Digikam
{
 
class AbstractCheckableAlbumModel;
class Album;
class AlbumIconItem;
class AlbumModificationHelper;
class ItemInfo;
class ItemFilterModel;
class PAlbum;
class TagModificationHelper;
class TAlbum;
 
class DIGIKAM_GUI_EXPORT ContextMenuHelper : public QObject      // clazy:exclude=ctor-missing-parent-argument
{
    Q_OBJECT
 
public:
 
    typedef const QList<qlonglong> imageIds;
 
public:
 
    explicit ContextMenuHelper(QMenu* const parent);   // clazy:exclude=ctor-missing-parent-argument
    ~ContextMenuHelper() override;
 
    void addAction(const QString& name, bool addDisabled = false);
 
    void addAction(QAction* const action, bool addDisabled = false);
 
    void addAction(QAction* const action, QObject* const recv, const char* const slot, bool addDisabled = false);
 
    void addStandardActionCut(QObject* const recv, const char* const slot);
 
    void addStandardActionCopy(QObject* const recv, const char* const slot);
 
    void addStandardActionPaste(QObject* const recv, const char* const slot);
 
    void addStandardActionItemDelete(QObject* const recv, const char* const slot, int quantity = 1);
 
    void addIQSAction(QObject* const recv, const char* const slot);
 
    void addStandardActionLightTable();
 
    void addStandardActionThumbnail(const imageIds& ids, Album* const album);
 
    void addOpenAndNavigateActions(const imageIds& ids, bool lightTable = false);
 
    void addServicesMenu(const QList<QUrl>& selectedItems);
 
    void addGotoMenu(const imageIds& ids);
 
    void addQueueManagerMenu();
 
    void addActionNewTag(TagModificationHelper* const helper, TAlbum* const parentTag = nullptr);
    void addActionDeleteTag(TagModificationHelper* const helper, TAlbum* const tag);
    void addActionDeleteTags(TagModificationHelper* const helper, const QList<TAlbum*>& tags);
    void addActionEditTag(TagModificationHelper* const helper, TAlbum* const tag);
 
    void addActionDeleteFaceTag(TagModificationHelper* const helper, TAlbum* const tag);
    void addActionDeleteFaceTags(TagModificationHelper* const helper, const QList<TAlbum*>& tags);
 
    void addActionTagToFaceTag(TagModificationHelper* const helper, TAlbum* const tag);
    void addActionTagsToFaceTags(TagModificationHelper* const helper, const QList<TAlbum*>& tags);
 
    void addActionNewAlbum(AlbumModificationHelper* const helper, PAlbum* const parentAlbum = nullptr);
    void addActionDeleteAlbum(AlbumModificationHelper* const helper, PAlbum* const album);
    void addActionEditAlbum(AlbumModificationHelper* const helper, PAlbum* const album);
    void addActionRenameAlbum(AlbumModificationHelper* const helper, PAlbum* const album);
    void addActionResetAlbumIcon(AlbumModificationHelper* const helper, PAlbum* const album);
 
    void addAssignTagsMenu(const imageIds& ids);
 
    void addRemoveTagsMenu(const imageIds& ids);
 
    void addCreateTagFromAddressbookMenu();
 
    void addLabelsAction();
 
    void addGroupMenu(const imageIds& ids, const QList<QAction*>& extraMenuItems = QList<QAction*>());
    void addGroupActions(const imageIds& ids);
 
    void setItemFilterModel(ItemFilterModel* const model);
 
    void addAlbumCheckUncheckActions(Album* const album);
 
    void setAlbumModel(AbstractCheckableAlbumModel* const model);
 
    void addImportMenu();
 
    void addExportMenu();
 
    void addSubMenu(QMenu* subMenu);
 
    void addSeparator();
 
    QAction* exec(const QPoint& pos, QAction* const at = nullptr);
 
Q_SIGNALS:
 
    void signalSetThumbnail(const ItemInfo&);
    void signalGotoAlbum(const ItemInfo&);
    void signalGotoDate(const ItemInfo&);
    void signalGotoTag(int);
    void signalAssignTag(int);
    void signalRemoveTag(int);
    void signalAssignPickLabel(int);
    void signalAssignColorLabel(int);
    void signalAssignRating(int);
    void signalAddToExistingQueue(int);
    void signalAddNewTagFromABCMenu(const QString&);
    void signalPopupTagsView();
    void signalCreateGroup();
    void signalCreateGroupByTime();
    void signalCreateGroupByFilename();
    void signalCreateGroupByTimelapse();
    void signalUngroup();
    void signalRemoveFromGroup();
 
private Q_SLOTS:
 
    void slotOpenWith();
    void slotOpenWith(QAction* action);
    void slotOpenInFileManager();
    void slotOpenImageFile();
    void slotDeselectAllAlbumItems();
    void slotOpenGroups();
    void slotCloseGroups();
    void slotOpenAllGroups();
    void slotCloseAllGroups();
    void slotSelectChildren();
    void slotDeselectChildren();
    void slotSelectParents();
    void slotDeselectParents();
 
private:
 
    void setGroupsOpen(bool open);
    void setSelectedIds(const imageIds& ids);
    void setSelectedItems(const QList<QUrl>& urls);
 
    bool imageIdsHaveSameCategory(const imageIds& ids, DatabaseItem::Category category);
    QList<QAction*> groupMenuActions(const imageIds& ids);
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_CONTEXT_MENU_HELPER_H