LeechCraft  0.6.70-10870-g558588d6ec
Modular cross-platform feature rich live environment.
iinfo.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 <memory>
33 #include <QString>
34 #include <QStringList>
35 #include <QtPlugin>
36 #include "structures.h"
37 
38 class ICoreProxy;
39 typedef std::shared_ptr<ICoreProxy> ICoreProxy_ptr;
40 
68 class Q_DECL_EXPORT IInfo
69 {
70 public:
88  virtual void Init (ICoreProxy_ptr proxy) = 0;
89 
98  virtual void SecondInit () = 0;
99 
114  virtual QByteArray GetUniqueID () const = 0;
115 
128  virtual QString GetName () const = 0;
129 
141  virtual QString GetInfo () const = 0;
142 
160  virtual QStringList Provides () const
161  {
162  return QStringList ();
163  }
164 
188  virtual QStringList Needs () const
189  {
190  return QStringList ();
191  }
192 
215  virtual QStringList Uses () const
216  {
217  return QStringList ();
218  }
219 
236  virtual void SetProvider (QObject* object,
237  const QString& feature)
238  {
239  Q_UNUSED (object);
240  Q_UNUSED (feature);
241  }
242 
253  virtual void Release () = 0;
254 
267  virtual QIcon GetIcon () const = 0;
268 
279  virtual ~IInfo () {}
280 
295  virtual void couldHandle (const LeechCraft::Entity& entity, bool *could)
296  {
297  Q_UNUSED (entity);
298  Q_UNUSED (could);
299  }
300 
320  virtual void gotEntity (const LeechCraft::Entity& entity)
321  {
322  Q_UNUSED (entity);
323  }
324 
351  virtual void delegateEntity (const LeechCraft::Entity& entity,
352  int *id, QObject **provider)
353  {
354  Q_UNUSED (entity);
355  Q_UNUSED (id);
356  Q_UNUSED (provider);
357  }
358 };
359 
360 Q_DECLARE_INTERFACE (IInfo, "org.Deviant.LeechCraft.IInfo/1.0")
361 
362 #define CURRENT_API_LEVEL 20
363 
364 #define LC_EXPORT_PLUGIN(name,file) \
365  extern "C"\
366  {\
367  Q_DECL_EXPORT quint64 GetAPILevels ()\
368  {\
369  return CURRENT_API_LEVEL;\
370  }\
371  }
372 
373 #define LC_PLUGIN_METADATA(id) Q_PLUGIN_METADATA (IID id)
Proxy class for the communication with LeechCraft.
Definition: icoreproxy.h:67
virtual void delegateEntity(const LeechCraft::Entity &entity, int *id, QObject **provider)
This signal is emitted by plugin to delegate the entity to an another plugin.
Definition: iinfo.h:351
std::shared_ptr< ICoreProxy > ICoreProxy_ptr
Definition: iinfo.h:38
virtual QStringList Provides() const
Returns the list of provided features.
Definition: iinfo.h:160
std::shared_ptr< ICoreProxy > ICoreProxy_ptr
Definition: icoreproxy.h:225
virtual void couldHandle(const LeechCraft::Entity &entity, bool *could)
This signal is emitted by plugin to query if the given entity could be handled.
Definition: iinfo.h:295
virtual QStringList Uses() const
Returns the list of used features.
Definition: iinfo.h:215
virtual ~IInfo()
Virtual destructor.
Definition: iinfo.h:279
virtual void gotEntity(const LeechCraft::Entity &entity)
This signal is emitted by plugin to notify the Core and other plugins about an entity.
Definition: iinfo.h:320
Required interface for every plugin.
Definition: iinfo.h:68
A message used for inter-plugin communication.
Definition: structures.h:119
virtual void SetProvider(QObject *object, const QString &feature)
Sets the provider plugin for a given feature.
Definition: iinfo.h:236
virtual QStringList Needs() const
Returns the list of needed features.
Definition: iinfo.h:188