Communi  3.4.0
A cross-platform IRC framework written with Qt
ircfilter.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2008-2015 The Communi Project
3 
4  You may use this file under the terms of BSD license as follows:
5 
6  Redistribution and use in source and binary forms, with or without
7  modification, are permitted provided that the following conditions are met:
8  * Redistributions of source code must retain the above copyright
9  notice, this list of conditions and the following disclaimer.
10  * Redistributions in binary form must reproduce the above copyright
11  notice, this list of conditions and the following disclaimer in the
12  documentation and/or other materials provided with the distribution.
13  * Neither the name of the copyright holder nor the names of its
14  contributors may be used to endorse or promote products derived
15  from this software without specific prior written permission.
16 
17  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR
21  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28 
29 #ifndef IRCFILTER_H
30 #define IRCFILTER_H
31 
32 #include <IrcGlobal>
33 #include <QtCore/qobject.h>
34 
35 IRC_BEGIN_NAMESPACE
36 
37 class IrcMessage;
38 class IrcCommand;
39 
40 class IRC_CORE_EXPORT IrcMessageFilter
41 {
42 public:
43  virtual ~IrcMessageFilter() { }
44  virtual bool messageFilter(IrcMessage* message) = 0;
45 };
46 
47 class IRC_CORE_EXPORT IrcCommandFilter
48 {
49 public:
50  virtual ~IrcCommandFilter() { }
51  virtual bool commandFilter(IrcCommand* command) = 0;
52 };
53 
54 IRC_END_NAMESPACE
55 
56 // TODO: fixme
57 #ifdef IRC_NAMESPACE
58 using IRC_NAMESPACE::IrcMessageFilter;
59 using IRC_NAMESPACE::IrcCommandFilter;
60 #endif
61 
62 Q_DECLARE_INTERFACE(IrcMessageFilter, "Communi.IrcMessageFilter")
63 Q_DECLARE_INTERFACE(IrcCommandFilter, "Communi.IrcCommandFilter")
64 
65 #endif // IRCFILTER_H
Provides an interface for filtering commands.
Definition: ircfilter.h:47
Provides an interface for filtering messages.
Definition: ircfilter.h:40
Provides the most common commands.
Definition: irccommand.h:43
virtual ~IrcMessageFilter()
Definition: ircfilter.h:43
The base class of all messages.
Definition: ircmessage.h:47
virtual ~IrcCommandFilter()
Definition: ircfilter.h:50