LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
ianemitter.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 INTERFACES_IANEMITTER_H
31 #define INTERFACES_IANEMITTER_H
32 #include <QtPlugin>
33 #include <QVariant>
34 #include <QStringList>
35 
36 namespace LeechCraft
37 {
48  struct ANFieldData
49  {
55  QString ID_;
56 
61  QString Name_;
62 
68  QString Description_;
69 
76  QVariant::Type Type_;
77 
84  QStringList EventTypes_;
85 
92  : Type_ (QVariant::Invalid)
93  {
94  }
95 
106  ANFieldData (const QString& id,
107  const QString& name,
108  const QString& description,
109  QVariant::Type type,
110  QStringList events)
111  : ID_ (id)
112  , Name_ (name)
113  , Description_ (description)
114  , Type_ (type)
115  , EventTypes_ (events)
116  {
117  }
118  };
119 }
120 
135 class Q_DECL_EXPORT IANEmitter
136 {
137 public:
138  virtual ~IANEmitter () {}
139 
155  virtual QList<LeechCraft::ANFieldData> GetANFields () const = 0;
156 };
157 
158 Q_DECLARE_INTERFACE (IANEmitter, "org.Deviant.LeechCraft.IANEmitter/1.0");
160 
161 #endif
A single additional AdvancedNotifications field.
Definition: ianemitter.h:48
ANFieldData(const QString &id, const QString &name, const QString &description, QVariant::Type type, QStringList events)
Constructs field with the given info variables.
Definition: ianemitter.h:106
QVariant::Type Type_
The type of this field.
Definition: ianemitter.h:76
QString Name_
The name of the field.
Definition: ianemitter.h:61
Q_DECLARE_INTERFACE(IColorThemeManager,"org.Deviant.LeechCraft.IColorThemeManager/1.0")
Interface for plugins emitting AdvancedNotifications entries.
Definition: ianemitter.h:135
QString ID_
The field ID.
Definition: ianemitter.h:55
QString Description_
The description of the field.
Definition: ianemitter.h:68
virtual ~IANEmitter()
Definition: ianemitter.h:138
QStringList EventTypes_
The types of the event that contain this field.
Definition: ianemitter.h:84
ANFieldData()
Constructs an empty field info.
Definition: ianemitter.h:91
Q_DECLARE_METATYPE(LeechCraft::IHookProxy_ptr)