LeechCraft Azoth  0.6.70-14771-g9d21b0f8ad
Modular multiprotocol IM plugin for LeechCraft
iproxyobject.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  * Distributed under the Boost Software License, Version 1.0.
6  * (See accompanying file LICENSE or copy at https://www.boost.org/LICENSE_1_0.txt)
7  **********************************************************************/
8 
9 #pragma once
10 
11 #include <optional>
12 #include <QString>
13 #include "azothcommon.h"
14 #include "ihaveavatars.h"
15 
16 class QObject;
17 
18 template<typename>
19 class QFuture;
20 
21 namespace LC
22 {
23 namespace Util
24 {
25  class ResourceLoader;
26 }
27 
28 namespace Azoth
29 {
31  {
32  public:
33  virtual ~IFormatterProxyObject () {}
34 
49  virtual QList<QColor> GenerateColors (const QString& scheme, QColor bg) const = 0;
50 
61  virtual QString GetNickColor (const QString& nick, const QList<QColor>& colors) const = 0;
62 
72  virtual QString FormatDate (QDateTime date, QObject *message) const = 0;
73 
85  virtual QString FormatNickname (QString nick, QObject *message, const QString& color) const = 0;
86 
102  virtual QString FormatBody (QString body, QObject *message, const QList<QColor>& coloring) const = 0;
103 
111  virtual void PreprocessMessage (QObject *message) = 0;
112 
113  virtual void FormatLinks (QString& body) = 0;
114 
115  virtual QStringList FindLinks (const QString&) = 0;
116  };
117 
119  {
120  protected:
121  virtual ~IAvatarsManager () {}
122  public:
123  virtual QFuture<QImage> GetAvatar (QObject *entryObj, IHaveAvatars::Size size) = 0;
124 
125  virtual QFuture<std::optional<QByteArray>> GetStoredAvatarData (const QString& entryId, IHaveAvatars::Size size) = 0;
126  };
127 
129  {
130  public:
131  virtual ~IProxyObject () {}
132 
134  {
138  };
139 
147  virtual QObject* GetSettingsManager () = 0;
148 
167  virtual void SetPassword (const QString& password, QObject *account) = 0;
168 
200  virtual QString GetAccountPassword (QObject *account, bool useStored = true) = 0;
201 
206  virtual bool IsAutojoinAllowed () = 0;
207 
212  virtual QString StateToString (State state) const = 0;
213 
220  virtual QString AuthStatusToString (AuthStatus status) const = 0;
221 
234  virtual AuthStatus AuthStatusFromString (const QString& str) const = 0;
235 
245  virtual QObject* GetAccount (const QString& accID) const = 0;
246 
251  virtual QList<QObject*> GetAllAccounts () const = 0;
252 
264  virtual QObject* GetEntry (const QString& entryID, const QString& accID = {}) const = 0;
265 
277  virtual void OpenChat (const QString& entryID,
278  const QString& accID,
279  const QString& message = QString (),
280  const QString& variant = QString ()) const = 0;
281 
282  virtual QWidget* FindOpenedChat (const QString& entryID, const QByteArray& accID) const = 0;
283 
284  virtual Util::ResourceLoader* GetResourceLoader (PublicResourceLoader loader) const = 0;
285 
286  virtual QIcon GetIconForState (State state) const = 0;
287 
288  virtual QObject* CreateCoreMessage (const QString& body,
289  const QDateTime& date,
290  IMessage::Type type,
292  QObject *other,
293  QObject *parent = nullptr) = 0;
294 
295  virtual QString ToPlainBody (QString body) = 0;
296 
297  virtual bool IsMessageRead (QObject *msgObj) = 0;
298 
299  virtual void MarkMessagesAsRead (QObject *entryObject) = 0;
300 
313  virtual QString PrettyPrintDateTime (const QDateTime& datetime) = 0;
314 
323  virtual std::optional<CustomStatus> FindCustomStatus (const QString& name) const = 0;
324 
335  virtual QStringList GetCustomStatusNames () const = 0;
336 
337  virtual void RedrawItem (QObject*) const = 0;
338 
339  virtual QObject* GetFirstUnreadMessage (QObject *entryObj) const = 0;
340 
341  virtual QImage GetDefaultAvatar (int size = -1) const = 0;
342 
344 
346  };
347 }
348 }
349 
350 Q_DECLARE_INTERFACE (LC::Azoth::IProxyObject,
351  "org.LeechCraft.Azoth.IProxyObject/1.0")
virtual QFuture< std::optional< QByteArray > > GetStoredAvatarData(const QString &entryId, IHaveAvatars::Size size)=0
virtual QFuture< QImage > GetAvatar(QObject *entryObj, IHaveAvatars::Size size)=0
virtual void PreprocessMessage(QObject *message)=0
Preprocesses the message before displaying it.
virtual QString FormatNickname(QString nick, QObject *message, const QString &color) const =0
Formats the nickname for the given message and color.
virtual QList< QColor > GenerateColors(const QString &scheme, QColor bg) const =0
Generates the nickname colors for the given scheme.
virtual QStringList FindLinks(const QString &)=0
virtual QString FormatDate(QDateTime date, QObject *message) const =0
Formats the date for the given message.
virtual void FormatLinks(QString &body)=0
virtual QString GetNickColor(const QString &nick, const QList< QColor > &colors) const =0
Returns the color for the given nick and color set.
virtual QString FormatBody(QString body, QObject *message, const QList< QColor > &coloring) const =0
Formats the body for the given message.
Size
The size of the avatar.
Definition: ihaveavatars.h:29
Type
Represents possible message types.
Definition: imessage.h:63
Direction
Represents the direction of the message.
Definition: imessage.h:50
virtual void SetPassword(const QString &password, QObject *account)=0
Stores the password for the given account.
virtual QString ToPlainBody(QString body)=0
virtual void MarkMessagesAsRead(QObject *entryObject)=0
virtual QStringList GetCustomStatusNames() const =0
Returns the names of all available custom statuses.
virtual AuthStatus AuthStatusFromString(const QString &str) const =0
Converts string representation to AuthStatus element.
virtual IFormatterProxyObject & GetFormatterProxy()=0
virtual bool IsMessageRead(QObject *msgObj)=0
virtual IAvatarsManager * GetAvatarsManager()=0
virtual QObject * GetEntry(const QString &entryID, const QString &accID={}) const =0
Returns the entry object for the given entry ID.
virtual QObject * GetFirstUnreadMessage(QObject *entryObj) const =0
virtual bool IsAutojoinAllowed()=0
Queries whether autojoin is allowed.
virtual QString StateToString(State state) const =0
Returns a human-readable string for the given state.
virtual QList< QObject * > GetAllAccounts() const =0
Returns all the accounts registered in Azoth.
virtual void OpenChat(const QString &entryID, const QString &accID, const QString &message=QString(), const QString &variant=QString()) const =0
Opens the chat with the given entry.
virtual QWidget * FindOpenedChat(const QString &entryID, const QByteArray &accID) const =0
virtual QObject * CreateCoreMessage(const QString &body, const QDateTime &date, IMessage::Type type, IMessage::Direction dir, QObject *other, QObject *parent=nullptr)=0
virtual void RedrawItem(QObject *) const =0
virtual QString AuthStatusToString(AuthStatus status) const =0
Returns serialized name of the authorization status.
virtual QIcon GetIconForState(State state) const =0
virtual QObject * GetSettingsManager()=0
Returns the Core's settings manager object.
virtual std::optional< CustomStatus > FindCustomStatus(const QString &name) const =0
Tries to find a cusotm status under the given name.
virtual QString GetAccountPassword(QObject *account, bool useStored=true)=0
Retrieves password for the given account, asking user if needed.
virtual QImage GetDefaultAvatar(int size=-1) const =0
virtual Util::ResourceLoader * GetResourceLoader(PublicResourceLoader loader) const =0
virtual QObject * GetAccount(const QString &accID) const =0
Returns the account object for the given account ID.
virtual QString PrettyPrintDateTime(const QDateTime &datetime)=0
Formats the datetime according to current locale.
State
Describes possible presence states of an account or a contact.
Definition: azothcommon.h:23