LeechCraft Azoth  %{LEECHCRAFT_VERSION}
Modular multiprotocol IM plugin for LeechCraft
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator
iproxyobject.h
Go to the documentation of this file.
1 /**********************************************************************
2  * LeechCraft - modular cross-platform feature rich internet client.
3  * Copyright (C) 2006-2013 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_IPROXYOBJECT_H
31 #define PLUGINS_AZOTH_INTERFACES_IPROXYOBJECT_H
32 #include <QString>
33 #include "azothcommon.h"
34 
35 class QObject;
36 class QWebFrame;
37 
38 namespace LeechCraft
39 {
40 namespace Util
41 {
42  class ResourceLoader;
43 }
44 
45 namespace Azoth
46 {
48  {
49  public:
50  virtual ~IProxyObject () {}
51 
53  {
57  };
58 
66  virtual QObject* GetSettingsManager () = 0;
67 
89  virtual QString GetPassword (QObject *account) = 0;
90 
109  virtual void SetPassword (const QString& password, QObject *account) = 0;
110 
142  virtual QString GetAccountPassword (QObject *account, bool useStored = true) = 0;
143 
148  virtual bool IsAutojoinAllowed () = 0;
149 
154  virtual QString StateToString (State state) const = 0;
155 
162  virtual QString AuthStatusToString (AuthStatus status) const = 0;
163 
176  virtual AuthStatus AuthStatusFromString (const QString& str) const = 0;
177 
187  virtual QObject* GetAccount (const QString& accID) const = 0;
188 
193  virtual QList<QObject*> GetAllAccounts () const = 0;
194 
203  virtual QObject* GetEntry (const QString& entryID, const QString& accID) const = 0;
204 
216  virtual void OpenChat (const QString& entryID,
217  const QString& accID,
218  const QString& message = QString (),
219  const QString& variant = QString ()) const = 0;
220 
232  virtual QList<QColor> GenerateColors (const QString& scheme) const = 0;
233 
244  virtual QString GetNickColor (const QString& nick, const QList<QColor>& colors) const = 0;
245 
255  virtual QString FormatDate (QDateTime date, QObject *message) const = 0;
256 
268  virtual QString FormatNickname (QString nick, QObject *message, const QString& color) const = 0;
269 
279  virtual QString FormatBody (QString body, QObject *message) const = 0;
280 
288  virtual void PreprocessMessage (QObject *message) = 0;
289 
290  virtual Util::ResourceLoader* GetResourceLoader (PublicResourceLoader loader) const = 0;
291 
292  virtual QIcon GetIconForState (State state) const = 0;
293 
294  virtual void FormatLinks (QString& body) = 0;
295  };
296 }
297 }
298 
300  "org.Deviant.LeechCraft.Plugins.Azoth.Plugins.IProxyObject/1.0");
301 
302 #endif
virtual QString StateToString(State state) const =0
Returns a human-readable string for the given state.
virtual void PreprocessMessage(QObject *message)=0
Preprocesses the message before displaying it.
virtual QIcon GetIconForState(State state) const =0
virtual QString GetPassword(QObject *account)=0
Retrieves the password for the given account.
virtual QString FormatBody(QString body, QObject *message) const =0
Formats the body for the given message.
virtual QString AuthStatusToString(AuthStatus status) const =0
Returns serialized name of the authorization status.
Q_DECLARE_INTERFACE(LeechCraft::Azoth::IAccount,"org.Deviant.LeechCraft.Azoth.IAccount/1.0")
virtual QString GetNickColor(const QString &nick, const QList< QColor > &colors) const =0
Returns the color for the given nick and color set.
virtual void FormatLinks(QString &body)=0
virtual QObject * GetEntry(const QString &entryID, const QString &accID) const =0
Returns the entry object for the given entry ID.
virtual QList< QObject * > GetAllAccounts() const =0
Returns all the accounts registered in Azoth.
virtual void SetPassword(const QString &password, QObject *account)=0
Stores the password for the given account.
virtual Util::ResourceLoader * GetResourceLoader(PublicResourceLoader loader) const =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.
virtual QList< QColor > GenerateColors(const QString &scheme) const =0
Generates the nickname colors for the given scheme.
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 QString FormatDate(QDateTime date, QObject *message) const =0
Formats the date for the given message.
virtual QObject * GetSettingsManager()=0
Returns the Core&#39;s settings manager object.
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.