1 /***************************************************************************
2 * Copyright (C) 2005-08 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"
27 #include "quasselui.h"
29 class NetworkModelActionProvider : public AbstractActionProvider {
33 NetworkModelActionProvider(QObject *parent = 0);
34 ~NetworkModelActionProvider();
36 // don't change enums without doublechecking masks etc. in code
40 NetworkConnect = 0x01,
41 NetworkDisconnect = 0x02,
56 HideDayChange = 0x0600,
57 HideApplyToAll = 0xf00,
62 ShowChannelList = 0x2000,
63 ShowIgnoreList = 0x3000,
67 NickCtcpWhois = 0x010000,
68 NickCtcpVersion = 0x020000,
69 NickCtcpPing = 0x030000,
70 NickCtcpTime = 0x040000,
71 NickCtcpFinger = 0x050000,
75 NickDevoice = 0x0b0000,
78 NickKickBan = 0x0e0000,
81 // Actions that are handled externally
82 // These emit a signal to the action requester, rather than being handled here
83 ExternalMask = 0xff000000,
84 HideBufferTemporarily = 0x01000000,
85 HideBufferPermanently = 0x02000000
88 inline Action *action(ActionType type) const;
90 //! Provide a list of actions applying to the given item
92 * Note that this list ist not persistent, hence it should only be used immediately after
93 * calling this function (e.g. in a context menu). Optionally one can provide a QObject and a slot
94 * (that should take a QAction * as parameter) that is invoked for actions that require external
96 * @param index The item index in the NetworkModel
97 * @param receiver The optional object that is notified for actions that need to be handled externally.
98 * The action type will be stored in the QAction's data().
99 * @param slot The receiving slot name; should be "mySlot" rather than SLOT(mySlot(QAction *))
100 * @return A list of actions applying to the given item
102 void addActions(QMenu *, const QModelIndex &index, QObject *receiver = 0, const char *slot = 0, bool allowBufferHide = false);
103 void addActions(QMenu *, const QList<QModelIndex> &indexList, QObject *receiver = 0, const char *slot = 0, bool allowBufferHide = false);
104 void addActions(QMenu *, BufferId id, QObject *receiver = 0, const char *slot = 0);
105 void addActions(QMenu *, MessageFilter *filter, QObject *receiver = 0, const char *slot = 0);
108 void showChannelList(NetworkId);
109 void showIgnoreList(NetworkId);
112 inline ActionCollection *actionCollection() const;
115 void actionTriggered(QAction *);
118 enum ItemActiveState {
119 InactiveState = 0x01,
124 Q_DECLARE_FLAGS(ItemActiveStates, ItemActiveState)
127 void registerAction(ActionType type, const QString &text, bool checkable = false);
128 void registerAction(ActionType type, const QPixmap &icon, const QString &text, bool checkable = false);
130 void handleNetworkAction(ActionType, QAction *);
131 void handleBufferAction(ActionType, QAction *);
132 void handleHideAction(ActionType, QAction *);
133 void handleNickAction(ActionType, QAction *);
134 void handleGeneralAction(ActionType, QAction *);
135 void handleExternalAction(ActionType, QAction *);
137 bool checkRequirements(const QModelIndex &index, ItemActiveStates requiredActiveState = QFlags<ItemActiveState>(ActiveState | InactiveState));
138 Action * addAction(ActionType, QMenu *, bool condition = true);
139 Action * addAction(Action * , QMenu *, bool condition = true);
140 Action * addAction(ActionType, QMenu *, const QModelIndex &index, ItemActiveStates requiredActiveState = QFlags<ItemActiveState>(ActiveState | InactiveState));
141 Action * addAction(Action * , QMenu *, const QModelIndex &index, ItemActiveStates requiredActiveState = QFlags<ItemActiveState>(ActiveState | InactiveState));
143 void addHideEventsMenu(QMenu *, BufferId bufferId);
144 void addHideEventsMenu(QMenu *, MessageFilter *msgFilter);
145 void addHideEventsMenu(QMenu *, int filter);
147 void addNetworkItemActions(QMenu *, const QModelIndex &);
148 void addBufferItemActions(QMenu *, const QModelIndex &, bool isCustomBufferView = false);
149 void addIrcUserActions(QMenu *, IrcUser *ircUser, bool isNickView = true);
151 NetworkModel *_model;
153 ActionCollection *_actionCollection;
154 QHash<ActionType, Action *> _actionByType;
156 Action *_hideEventsMenuAction;
158 QList<QModelIndex> _indexList;
159 MessageFilter *_messageFilter;
165 ActionCollection *NetworkModelActionProvider::actionCollection() const { return _actionCollection; }
166 Action *NetworkModelActionProvider::action(ActionType type) const { return _actionByType.value(type, 0); }