LeechCraft Azoth  0.6.70-13907-g785196c688
Modular multiprotocol IM plugin for LeechCraft
ihaveconsole.h
Go to the documentation of this file.
1 /**********************************************************************
2  * LeechCraft - modular cross-platform feature rich internet client.
3  * Copyright (C) 2006-2014 Georg Rudoy
4  *
5  * Boost Software License - Version 1.0 - August 17th, 2003
6  *
7  * Permission is hereby granted, free of charge, to any person or organization
8  * obtaining a copy of the software and accompanying documentation covered by
9  * this license (the "Software") to use, reproduce, display, distribute,
10  * execute, and transmit the Software, and to prepare derivative works of the
11  * Software, and to permit third-parties to whom the Software is furnished to
12  * do so, all subject to the following:
13  *
14  * The copyright notices in the Software and this entire statement, including
15  * the above license grant, this restriction and the following disclaimer,
16  * must be included in all copies of the Software, in whole or in part, and
17  * all derivative works of the Software, unless such copies or derivative
18  * works are solely in the form of machine-executable object code generated by
19  * a source language processor.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24  * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25  * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  **********************************************************************/
29 
30 #ifndef PLUGINS_AZOTH_INTERFACES_IHAVECONSOLE_H
31 #define PLUGINS_AZOTH_INTERFACES_IHAVECONSOLE_H
32 #include <QMetaType>
33 
34 namespace LC
35 {
36 namespace Azoth
37 {
52  class IHaveConsole
53  {
54  public:
55  virtual ~IHaveConsole () {}
56 
59  enum class PacketFormat
60  {
65  XML,
66 
72  PlainText,
73 
78  Binary
79  };
80 
83  enum class PacketDirection
84  {
87  In,
88 
91  Out
92  };
93 
98  virtual PacketFormat GetPacketFormat () const = 0;
99 
115  virtual void SetConsoleEnabled (bool enabled) = 0;
116  protected:
134  virtual void gotConsolePacket (const QByteArray& packet,
135  PacketDirection direction, const QString& hrEntryId) = 0;
136  };
137 }
138 }
139 
140 Q_DECLARE_INTERFACE (LC::Azoth::IHaveConsole,
141  "org.Deviant.LeechCraft.Azoth.IHaveConsole/1.0")
142 
143 #endif
LC::Azoth::IHaveConsole::SetConsoleEnabled
virtual void SetConsoleEnabled(bool enabled)=0
Enables or disables the console.
LC::Azoth::IHaveConsole::GetPacketFormat
virtual PacketFormat GetPacketFormat() const =0
Returns the packet format used in this account.
LC::Azoth::IHaveConsole::gotConsolePacket
virtual void gotConsolePacket(const QByteArray &packet, PacketDirection direction, const QString &hrEntryId)=0
Notifies about new packet.
LC::Azoth::IHaveConsole::PacketFormat
PacketFormat
Defines the format of the packets in this protocol.
Definition: ihaveconsole.h:141
LC::Azoth::IHaveConsole::PacketFormat::PlainText
@ PlainText
Plain text packets (like in IRC).
LC::Azoth::IHaveConsole
Interface for accounts that support protocol consoles.
Definition: ihaveconsole.h:107
LC::Azoth::IHaveConsole::~IHaveConsole
virtual ~IHaveConsole()
Definition: ihaveconsole.h:136
LC::Azoth::IHaveConsole::PacketDirection
PacketDirection
Defines the direction of a packet.
Definition: ihaveconsole.h:165
LC::Azoth::IHaveConsole::PacketFormat::XML
@ XML
XML packets (like in XMPP).
LC::Azoth::IHaveConsole::PacketDirection::In
@ In
Incoming packet.
LC
Definition: activityinfo.h:35
LC::Azoth::IHaveConsole::PacketDirection::Out
@ Out
Outgoing packet.
LC::Azoth::IHaveConsole::PacketFormat::Binary
@ Binary
Binary packets (like in Oscar).