Prettify qDebug() output for events
[quassel.git] / src / common / event.h
1 /***************************************************************************
2  *   Copyright (C) 2005-2010 by the Quassel Project                        *
3  *   devel@quassel-irc.org                                                 *
4  *                                                                         *
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.                                           *
9  *                                                                         *
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.                          *
14  *                                                                         *
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  ***************************************************************************/
20
21 #ifndef EVENT_H
22 #define EVENT_H
23
24 #include <QDebug>
25
26 #include "eventmanager.h"
27
28 class Event {
29
30 public:
31   explicit Event(EventManager::EventType type = EventManager::Invalid);
32   virtual ~Event() {};
33
34   inline EventManager::EventType type() const { return _type; }
35
36   inline void setFlag(EventManager::EventFlag flag) { _flags |= flag; }
37   inline void setFlags(EventManager::EventFlags flags) { _flags = flags; }
38
39   inline EventManager::EventFlags flags() const { return _flags; }
40
41   inline void stop() { setFlag(EventManager::Stopped); }
42   inline bool isStopped() { return _flags.testFlag(EventManager::Stopped); }
43
44   //inline void setData(const QVariant &data) { _data = data; }
45   //inline QVariant data() const { return _data; }
46
47 protected:
48   virtual inline QString className() const { return "Event"; }
49   virtual inline void debugInfo(QDebug &dbg) const { Q_UNUSED(dbg); }
50
51 private:
52   EventManager::EventType _type;
53   EventManager::EventFlags _flags;
54   //QVariant _data;
55
56   friend QDebug operator<<(QDebug dbg, Event *e);
57 };
58
59 QDebug operator<<(QDebug dbg, Event *e);
60
61 /*******/
62
63 #endif