LeechCraft Azoth  0.6.70-13907-g785196c688
Modular multiprotocol IM plugin for LeechCraft
ihistoryplugin.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 #pragma once
31 
32 #include <QList>
33 #include <QVariantMap>
34 #include <util/sll/eitherfwd.h>
35 #include "imessage.h"
36 
37 template<typename>
38 class QFuture;
39 
40 class QDateTime;
41 
42 class QObject;
43 
44 namespace LC
45 {
46 namespace Azoth
47 {
48  class IAccount;
49 
52  struct HistoryItem
53  {
56  QDateTime Date_;
57 
61 
64  QString Message_;
65 
68  QString Variant_;
69 
73 
76  QString RichMessage_;
77 
82  };
83 
91  {
92  public:
93  virtual ~IHistoryPlugin () {}
94 
103  virtual bool IsHistoryEnabledFor (QObject *entry) const = 0;
104 
120  virtual void RequestLastMessages (QObject *entry, int num) = 0;
121 
122  using MaxTimestampResult_t = Util::Either<QString, QDateTime>;
123 
125 
136  virtual void AddRawMessages (const QString& accountId,
137  const QString& entryId,
138  const QString& visibleName,
139  const QList<HistoryItem>& items) = 0;
140  protected:
155  virtual void gotLastMessages (QObject *entry, const QList<QObject*>& messages) = 0;
156  };
157 }
158 }
159 
160 Q_DECLARE_INTERFACE (LC::Azoth::IHistoryPlugin,
161  "org.Deviant.LeechCraft.Azoth.IHistoryPlugin/1.0")
QList
Definition: iaccountactionsprovider.h:37
LC::Azoth::IMessage::EscapePolicy
EscapePolicy
Definition: imessage.h:187
LC::Azoth::IHistoryPlugin::AddRawMessages
virtual void AddRawMessages(const QString &accountId, const QString &entryId, const QString &visibleName, const QList< HistoryItem > &items)=0
Adds a set of messages to the history.
LC::Azoth::HistoryItem::Date_
QDateTime Date_
The timestamp of the message.
Definition: ihistoryplugin.h:56
LC::Azoth::IHistoryPlugin::RequestLastMessages
virtual void RequestLastMessages(QObject *entry, int num)=0
Requests last messages for the given entry.
LC::Azoth::HistoryItem::RichMessage_
QString RichMessage_
The rich message contents, if any.
Definition: ihistoryplugin.h:76
LC::Azoth::IHistoryPlugin::RequestMaxTimestamp
virtual QFuture< MaxTimestampResult_t > RequestMaxTimestamp(IAccount *acc)=0
LC::Azoth::IHistoryPlugin::~IHistoryPlugin
virtual ~IHistoryPlugin()
Definition: ihistoryplugin.h:93
LC::Azoth::IMessage::Direction
Direction
Represents the direction of the message.
Definition: imessage.h:71
LC::Azoth::IHistoryPlugin::IsHistoryEnabledFor
virtual bool IsHistoryEnabledFor(QObject *entry) const =0
Whether history is enabled for the given entry.
LC::Azoth::HistoryItem
Describes a single chat log item.
Definition: ihistoryplugin.h:53
LC::Azoth::HistoryItem::Variant_
QString Variant_
The variant of the other entry.
Definition: ihistoryplugin.h:68
LC::Azoth::IHistoryPlugin::MaxTimestampResult_t
Util::Either< QString, QDateTime > MaxTimestampResult_t
Definition: ihistoryplugin.h:122
LC::Azoth::IHistoryPlugin::gotLastMessages
virtual void gotLastMessages(QObject *entry, const QList< QObject * > &messages)=0
Notifies about last messages for the given entry.
LC::Azoth::IHistoryPlugin
Interface for plugins storing chat history.
Definition: ihistoryplugin.h:91
LC::Azoth::HistoryItem::Dir_
IMessage::Direction Dir_
The direction of the message.
Definition: ihistoryplugin.h:60
LC
Definition: activityinfo.h:35
LC::Azoth::HistoryItem::Message_
QString Message_
The message itself.
Definition: ihistoryplugin.h:64
QFuture
Definition: ihaveserverhistory.h:42
LC::Azoth::HistoryItem::EscPolicy_
IMessage::EscapePolicy EscPolicy_
Whether the message should be HTML-escaped when displayed to the user.
Definition: ihistoryplugin.h:81
LC::Azoth::HistoryItem::Type_
IMessage::Type Type_
The message type.
Definition: ihistoryplugin.h:72
imessage.h
LC::Azoth::IAccount
Interface representing a single account.
Definition: iaccount.h:120
LC::Azoth::IMessage::Type
Type
Represents possible message types.
Definition: imessage.h:84