LeechCraft Azoth  0.6.70-11552-gf61ee51c3d
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  * 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 <boost/optional.hpp>
33 #include <QString>
34 #include "azothcommon.h"
35 #include "ihaveavatars.h"
36 
37 class QObject;
38 class QWebFrame;
39 
40 template<typename>
41 class QFuture;
42 
43 namespace LeechCraft
44 {
45 namespace Util
46 {
47  class ResourceLoader;
48 }
49 
50 namespace Azoth
51 {
53  {
54  public:
55  virtual ~IFormatterProxyObject () {}
56 
71  virtual QList<QColor> GenerateColors (const QString& scheme, QColor bg) const = 0;
72 
83  virtual QString GetNickColor (const QString& nick, const QList<QColor>& colors) const = 0;
84 
94  virtual QString FormatDate (QDateTime date, QObject *message) const = 0;
95 
107  virtual QString FormatNickname (QString nick, QObject *message, const QString& color) const = 0;
108 
124  virtual QString FormatBody (QString body, QObject *message, const QList<QColor>& coloring) const = 0;
125 
133  virtual void PreprocessMessage (QObject *message) = 0;
134 
135  virtual void FormatLinks (QString& body) = 0;
136 
137  virtual QStringList FindLinks (const QString&) = 0;
138  };
139 
141  {
142  protected:
143  virtual ~IAvatarsManager () {}
144  public:
145  virtual QFuture<QImage> GetAvatar (QObject *entryObj, IHaveAvatars::Size size) = 0;
146 
147  virtual QFuture<boost::optional<QByteArray>> GetStoredAvatarData (const QString& entryId, IHaveAvatars::Size size) = 0;
148  };
149 
151  {
152  public:
153  virtual ~IProxyObject () {}
154 
156  {
160  };
161 
169  virtual QObject* GetSettingsManager () = 0;
170 
189  virtual void SetPassword (const QString& password, QObject *account) = 0;
190 
222  virtual QString GetAccountPassword (QObject *account, bool useStored = true) = 0;
223 
228  virtual bool IsAutojoinAllowed () = 0;
229 
234  virtual QString StateToString (State state) const = 0;
235 
242  virtual QString AuthStatusToString (AuthStatus status) const = 0;
243 
256  virtual AuthStatus AuthStatusFromString (const QString& str) const = 0;
257 
267  virtual QObject* GetAccount (const QString& accID) const = 0;
268 
273  virtual QList<QObject*> GetAllAccounts () const = 0;
274 
286  virtual QObject* GetEntry (const QString& entryID, const QString& accID = {}) const = 0;
287 
299  virtual void OpenChat (const QString& entryID,
300  const QString& accID,
301  const QString& message = QString (),
302  const QString& variant = QString ()) const = 0;
303 
304  virtual QWidget* FindOpenedChat (const QString& entryID, const QByteArray& accID) const = 0;
305 
306  virtual Util::ResourceLoader* GetResourceLoader (PublicResourceLoader loader) const = 0;
307 
308  virtual QIcon GetIconForState (State state) const = 0;
309 
310  virtual QObject* CreateCoreMessage (const QString& body,
311  const QDateTime& date,
312  IMessage::Type type,
314  QObject *other,
315  QObject *parent = nullptr) = 0;
316 
317  virtual QString ToPlainBody (QString body) = 0;
318 
319  virtual bool IsMessageRead (QObject *msgObj) = 0;
320 
321  virtual void MarkMessagesAsRead (QObject *entryObject) = 0;
322 
335  virtual QString PrettyPrintDateTime (const QDateTime& datetime) = 0;
336 
345  virtual boost::optional<CustomStatus> FindCustomStatus (const QString& name) const = 0;
346 
357  virtual QStringList GetCustomStatusNames () const = 0;
358 
359  virtual void RedrawItem (QObject*) const = 0;
360 
361  virtual QObject* GetFirstUnreadMessage (QObject *entryObj) const = 0;
362 
363  virtual QImage GetDefaultAvatar (int size = -1) const = 0;
364 
365  virtual IFormatterProxyObject& GetFormatterProxy () = 0;
366 
367  virtual IAvatarsManager* GetAvatarsManager () = 0;
368  };
369 }
370 }
371 
372 Q_DECLARE_INTERFACE (LeechCraft::Azoth::IProxyObject,
373  "org.LeechCraft.Azoth.IProxyObject/1.0")
virtual QObject * GetFirstUnreadMessage(QObject *entryObj) const =0
virtual QString StateToString(State state) const =0
Returns a human-readable string for the given state.
virtual QIcon GetIconForState(State state) const =0
virtual QString FormatDate(QDateTime date, QObject *message) const =0
Formats the date for the given message.
virtual QString AuthStatusToString(AuthStatus status) const =0
Returns serialized name of the authorization status.
virtual QString GetNickColor(const QString &nick, const QList< QColor > &colors) const =0
Returns the color for the given nick and color set.
virtual QStringList GetCustomStatusNames() const =0
Returns the names of all available custom statuses.
virtual boost::optional< CustomStatus > FindCustomStatus(const QString &name) const =0
Tries to find a cusotm status under the given name.
virtual void RedrawItem(QObject *) const =0
virtual bool IsMessageRead(QObject *msgObj)=0
State
Describes possible presence states of an account or a contact.
Definition: azothcommon.h:43
virtual QString PrettyPrintDateTime(const QDateTime &datetime)=0
Formats the datetime according to current locale.
virtual QFuture< boost::optional< QByteArray > > GetStoredAvatarData(const QString &entryId, IHaveAvatars::Size size)=0
virtual QWidget * FindOpenedChat(const QString &entryID, const QByteArray &accID) const =0
virtual QList< QObject * > GetAllAccounts() const =0
Returns all the accounts registered in Azoth.
virtual IFormatterProxyObject & GetFormatterProxy()=0
virtual void MarkMessagesAsRead(QObject *entryObject)=0
virtual QFuture< QImage > GetAvatar(QObject *entryObj, IHaveAvatars::Size size)=0
virtual void SetPassword(const QString &password, QObject *account)=0
Stores the password for the given account.
virtual Util::ResourceLoader * GetResourceLoader(PublicResourceLoader loader) const =0
Size
The size of the avatar.
Definition: ihaveavatars.h:49
virtual QStringList FindLinks(const QString &)=0
virtual void FormatLinks(QString &body)=0
virtual bool IsAutojoinAllowed()=0
Queries whether autojoin is allowed.
virtual QString GetAccountPassword(QObject *account, bool useStored=true)=0
Retrieves password for the given account, asking user if needed.
virtual QString FormatNickname(QString nick, QObject *message, const QString &color) const =0
Formats the nickname for the given message and color.
Direction
Represents the direction of the message.
Definition: imessage.h:70
virtual void PreprocessMessage(QObject *message)=0
Preprocesses the message before displaying it.
Type
Represents possible message types.
Definition: imessage.h:83
virtual QList< QColor > GenerateColors(const QString &scheme, QColor bg) const =0
Generates the nickname colors for the given scheme.
virtual QImage GetDefaultAvatar(int size=-1) const =0
virtual IAvatarsManager * GetAvatarsManager()=0
virtual QObject * CreateCoreMessage(const QString &body, const QDateTime &date, IMessage::Type type, IMessage::Direction dir, QObject *other, QObject *parent=nullptr)=0
virtual QObject * GetEntry(const QString &entryID, const QString &accID={}) const =0
Returns the entry object for the given entry ID.
virtual QString ToPlainBody(QString body)=0
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 QObject * GetSettingsManager()=0
Returns the Core&#39;s settings manager object.
virtual QString FormatBody(QString body, QObject *message, const QList< QColor > &coloring) const =0
Formats the body for the given message.
virtual AuthStatus AuthStatusFromString(const QString &str) const =0
Converts string representation to AuthStatus element.
virtual QObject * GetAccount(const QString &accID) const =0
Returns the account object for the given account ID.