src: Yearly copyright bump
[quassel.git] / src / uisupport / contextmenuactionprovider.h
index bdac641..5a1a18a 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-09 by the Quassel Project                          *
+ *   Copyright (C) 2005-2020 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
-#ifndef CONTEXTMENUACTIONPROVIDER_H
-#define CONTEXTMENUACTIONPROVIDER_H
+#pragma once
+
+#include "uisupport-export.h"
+
+#include <functional>
 
 #include "networkmodelcontroller.h"
 
-class ContextMenuActionProvider : public NetworkModelController {
-  Q_OBJECT
+class UISUPPORT_EXPORT ContextMenuActionProvider : public NetworkModelController
+{
+    Q_OBJECT
 
 public:
-  ContextMenuActionProvider(QObject *parent = 0);
-  virtual ~ContextMenuActionProvider();
-
-  //! Provide a list of actions applying to the given item
-  /**
-   * Note that this list ist not persistent, hence it should only be used immediately after
-   * calling this function (e.g. in a context menu). Optionally one can provide a QObject and a slot
-   * (that should take a QAction * as parameter) that is invoked for actions that require external
-   * handling.
-   * @param index The item index in the NetworkModel
-   * @param receiver The optional object that is notified for actions that need to be handled externally.
-   *                 The action type will be stored in the QAction's data().
-   * @param slot     The receiving slot name; should be "mySlot" rather than SLOT(mySlot(QAction *))
-   * @return A list of actions applying to the given item
-   */
-  void addActions(QMenu *, const QModelIndex &index, QObject *receiver = 0, const char *slot = 0, bool allowBufferHide = false);
-  void addActions(QMenu *, const QList<QModelIndex> &indexList, QObject *receiver = 0, const char *slot = 0, bool allowBufferHide = false);
-  void addActions(QMenu *, BufferId id, QObject *receiver = 0, const char *slot = 0);
-  void addActions(QMenu *, MessageFilter *filter, BufferId msgBuffer, QObject *receiver = 0, const char *slot = 0);
-  void addActions(QMenu *, MessageFilter *filter, BufferId msgBuffer, const QString &chanOrNick, QObject *receiver = 0, const char *slot = 0);
+    ContextMenuActionProvider(QObject* parent = nullptr);
+    ~ContextMenuActionProvider() override;
 
-private:
+    //! Provide a list of actions applying to the given item
+    /**
+     * Note that this list ist not persistent, hence it should only be used immediately after
+     * calling this function (e.g. in a context menu). Optionally one can provide a QObject and a slot
+     * (that should take a QAction * as parameter) that is invoked for actions that require external
+     * handling.
+     * @param index The item index in the NetworkModel
+     * @param receiver The optional object that is notified for actions that need to be handled externally.
+     *                 The action type will be stored in the QAction's data().
+     * @param slot     The receiving slot
+     * @return A list of actions applying to the given item
+     */
+    template<typename Receiver, typename Slot>
+    void addActions(QMenu* menu, const QModelIndex& index, Receiver* receiver, Slot slot, bool isCustomBufferView = false)
+    {
+        addActions(menu, index, buildActionSlot(receiver, std::move(slot)), isCustomBufferView);
+    }
+    void addActions(QMenu* menu, const QModelIndex& index, ActionSlot = {}, bool isCustomBufferView = false);
 
-  void addActions(QMenu *, const QList<QModelIndex> &indexList, MessageFilter *filter, const QString &chanOrNick,
-                  QObject *receiver, const char *slot, bool allowBufferHide);
+    template<typename Receiver, typename Slot>
+    void addActions(QMenu* menu, const QList<QModelIndex>& indexList, Receiver* receiver, Slot slot, bool isCustomBufferView = false)
+    {
+        addActions(menu, indexList, buildActionSlot(receiver, std::move(slot)), isCustomBufferView);
+    }
+    void addActions(QMenu* menu, const QList<QModelIndex>& indexList, ActionSlot = {}, bool isCustomBufferView = false);
 
-  Action * addAction(ActionType, QMenu *, bool condition = true);
-  Action * addAction(Action * , QMenu *, bool condition = true);
-  Action * addAction(ActionType, QMenu *, const QModelIndex &index, ItemActiveStates requiredActiveState = QFlags<ItemActiveState>(ActiveState | InactiveState));
-  Action * addAction(Action * , QMenu *, const QModelIndex &index, ItemActiveStates requiredActiveState = QFlags<ItemActiveState>(ActiveState | InactiveState));
+    template<typename Receiver, typename Slot>
+    void addActions(QMenu* menu, BufferId id, Receiver* receiver, Slot slot)
+    {
+        addActions(menu, id, buildActionSlot(receiver, std::move(slot)));
+    }
+    void addActions(QMenu* menu, BufferId id, ActionSlot = {});
 
-  void addHideEventsMenu(QMenu *, BufferId bufferId);
-  void addHideEventsMenu(QMenu *, MessageFilter *msgFilter);
-  void addHideEventsMenu(QMenu *, int filter = -1);
+    template<typename Receiver, typename Slot>
+    void addActions(QMenu* menu, MessageFilter* filter, BufferId msgBuffer, Receiver* receiver, Slot slot)
+    {
+        addActions(menu, filter, msgBuffer, buildActionSlot(receiver, std::move(slot)));
+    }
+    void addActions(QMenu* menu, MessageFilter* filter, BufferId msgBuffer, ActionSlot = {});
 
-  void addNetworkItemActions(QMenu *, const QModelIndex &);
-  void addBufferItemActions(QMenu *, const QModelIndex &, bool isCustomBufferView = false);
-  void addIrcUserActions(QMenu *, const QModelIndex &);
+    template<typename Receiver, typename Slot>
+    void addActions(QMenu* menu, MessageFilter* filter, BufferId msgBuffer, const QString& chanOrNick, Receiver* receiver, Slot slot)
+    {
+        addActions(menu, filter, msgBuffer, chanOrNick, buildActionSlot(receiver, std::move(slot)));
+    }
+    void addActions(QMenu* menu, MessageFilter* filter, BufferId msgBuffer, const QString& chanOrNick, ActionSlot = {});
 
-  Action *_hideEventsMenuAction;
-  Action *_nickCtcpMenuAction;
-  Action *_nickModeMenuAction;
-};
+private:
+    void addActions(QMenu* menu,
+                    const QList<QModelIndex>& indexList,
+                    MessageFilter* filter,
+                    const QString& chanOrNick,
+                    ActionSlot actionSlot,
+                    bool isCustomBufferView);
 
-#endif
+    Action* addAction(ActionType, QMenu*, bool condition = true);
+    Action* addAction(Action*, QMenu*, bool condition = true);
+    Action* addAction(ActionType,
+                      QMenu*,
+                      const QModelIndex& index,
+                      ItemActiveStates requiredActiveState = QFlags<ItemActiveState>(ActiveState | InactiveState));
+    Action* addAction(Action*,
+                      QMenu*,
+                      const QModelIndex& index,
+                      ItemActiveStates requiredActiveState = QFlags<ItemActiveState>(ActiveState | InactiveState));
+
+    void addHideEventsMenu(QMenu*, BufferId bufferId);
+    void addHideEventsMenu(QMenu*, MessageFilter* msgFilter);
+    void addHideEventsMenu(QMenu*, int filter = -1);
+    void addIgnoreMenu(QMenu* menu, const QString& hostmask, const QMap<QString, bool>& ignoreMap);
+
+    void addNetworkItemActions(QMenu*, const QModelIndex&);
+    void addBufferItemActions(QMenu*, const QModelIndex&, bool isCustomBufferView = false);
+    void addIrcUserActions(QMenu*, const QModelIndex&);
+
+    Action* _hideEventsMenuAction;
+    Action* _nickCtcpMenuAction;
+    Action* _nickModeMenuAction;
+    Action* _nickIgnoreMenuAction;
+    QList<QAction*> _ignoreDescriptions;
+};