1 /***************************************************************************
2 * Copyright (C) 2005-09 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
21 #ifndef NETWORKMODELACTIONPROVIDER_H
22 #define NETWORKMODELACTIONPROVIDER_H
25 #include "actioncollection.h"
26 #include "messagefilter.h"
28 class ContextMenuActionProvider : public QObject {
32 ContextMenuActionProvider(QObject *parent = 0);
33 ~ContextMenuActionProvider();
35 // don't change enums without doublechecking masks etc. in code
39 NetworkConnect = 0x01,
40 NetworkDisconnect = 0x02,
46 BufferSwitchTo = 0x30,
56 HideDayChange = 0x0600,
57 HideUseDefaults = 0xe00,
58 HideApplyToAll = 0xf00,
63 ShowChannelList = 0x2000,
64 ShowIgnoreList = 0x3000,
70 NickSwitchTo = 0x030000,
71 NickCtcpVersion = 0x040000,
72 NickCtcpPing = 0x050000,
73 NickCtcpTime = 0x060000,
74 NickCtcpFinger = 0x070000,
78 NickDevoice = 0x0b0000,
81 NickKickBan = 0x0e0000,
83 // Actions that are handled externally
84 // These emit a signal to the action requester, rather than being handled here
85 ExternalMask = 0xff000000,
86 HideBufferTemporarily = 0x01000000,
87 HideBufferPermanently = 0x02000000
90 inline Action *action(ActionType type) const;
92 //! Provide a list of actions applying to the given item
94 * Note that this list ist not persistent, hence it should only be used immediately after
95 * calling this function (e.g. in a context menu). Optionally one can provide a QObject and a slot
96 * (that should take a QAction * as parameter) that is invoked for actions that require external
98 * @param index The item index in the NetworkModel
99 * @param receiver The optional object that is notified for actions that need to be handled externally.
100 * The action type will be stored in the QAction's data().
101 * @param slot The receiving slot name; should be "mySlot" rather than SLOT(mySlot(QAction *))
102 * @return A list of actions applying to the given item
104 void addActions(QMenu *, const QModelIndex &index, QObject *receiver = 0, const char *slot = 0, bool allowBufferHide = false);
105 void addActions(QMenu *, const QList<QModelIndex> &indexList, QObject *receiver = 0, const char *slot = 0, bool allowBufferHide = false);
106 void addActions(QMenu *, BufferId id, QObject *receiver = 0, const char *slot = 0);
107 void addActions(QMenu *, MessageFilter *filter, BufferId msgBuffer, QObject *receiver = 0, const char *slot = 0);
108 void addActions(QMenu *, MessageFilter *filter, BufferId msgBuffer, const QString &chanOrNick, QObject *receiver = 0, const char *slot = 0);
111 void showChannelList(NetworkId);
112 void showIgnoreList(NetworkId);
115 inline ActionCollection *actionCollection() const;
118 void actionTriggered(QAction *);
121 enum ItemActiveState {
122 InactiveState = 0x01,
127 Q_DECLARE_FLAGS(ItemActiveStates, ItemActiveState)
130 void registerAction(ActionType type, const QString &text, bool checkable = false);
131 void registerAction(ActionType type, const QPixmap &icon, const QString &text, bool checkable = false);
133 void handleNetworkAction(ActionType, QAction *);
134 void handleBufferAction(ActionType, QAction *);
135 void handleHideAction(ActionType, QAction *);
136 void handleNickAction(ActionType, QAction *);
137 void handleGeneralAction(ActionType, QAction *);
138 void handleExternalAction(ActionType, QAction *);
140 void addActions(QMenu *, const QList<QModelIndex> &indexList, MessageFilter *filter, const QString &chanOrNick,
141 QObject *receiver, const char *slot, bool allowBufferHide);
143 bool checkRequirements(const QModelIndex &index, ItemActiveStates requiredActiveState = QFlags<ItemActiveState>(ActiveState | InactiveState));
144 Action * addAction(ActionType, QMenu *, bool condition = true);
145 Action * addAction(Action * , QMenu *, bool condition = true);
146 Action * addAction(ActionType, QMenu *, const QModelIndex &index, ItemActiveStates requiredActiveState = QFlags<ItemActiveState>(ActiveState | InactiveState));
147 Action * addAction(Action * , QMenu *, const QModelIndex &index, ItemActiveStates requiredActiveState = QFlags<ItemActiveState>(ActiveState | InactiveState));
149 void addHideEventsMenu(QMenu *, BufferId bufferId);
150 void addHideEventsMenu(QMenu *, MessageFilter *msgFilter);
151 void addHideEventsMenu(QMenu *, int filter = -1);
153 void addNetworkItemActions(QMenu *, const QModelIndex &);
154 void addBufferItemActions(QMenu *, const QModelIndex &, bool isCustomBufferView = false);
155 void addIrcUserActions(QMenu *, const QModelIndex &);
157 QString nickName(const QModelIndex &index) const;
158 BufferId findQueryBuffer(const QModelIndex &index, const QString &predefinedNick = QString()) const;
159 BufferId findQueryBuffer(NetworkId, const QString &nickName) const;
160 void removeBuffers(const QModelIndexList &indexList);
162 NetworkModel *_model;
164 ActionCollection *_actionCollection;
165 QHash<ActionType, Action *> _actionByType;
167 Action *_hideEventsMenuAction;
168 Action *_nickCtcpMenuAction;
169 Action *_nickModeMenuAction;
171 QList<QModelIndex> _indexList;
172 MessageFilter *_messageFilter;
173 QString _contextItem; ///< Channel name or nick to provide context menu for
179 ActionCollection *ContextMenuActionProvider::actionCollection() const { return _actionCollection; }
180 Action *ContextMenuActionProvider::action(ActionType type) const { return _actionByType.value(type, 0); }