LeechCraft  0.6.70-10870-g558588d6ec
Modular cross-platform feature rich live environment.
idatafilter.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 <functional>
33 #include <QtPlugin>
34 #include <QString>
35 #include <QList>
36 #include <QIcon>
37 #include <QMetaType>
38 
50 typedef std::function<void (QVariant)> DataFilterCallback_f;
51 
90 class Q_DECL_EXPORT IDataFilter
91 {
92 public:
97  {
103  QByteArray ID_;
104 
107  QString Name_;
108 
111  QString Description_;
112 
115  QIcon Icon_;
116  };
117 
118  virtual ~IDataFilter () {}
119 
129  virtual QString GetFilterVerb () const = 0;
130 
142  virtual QList<FilterVariant> GetFilterVariants (const QVariant& data) const = 0;
143 };
144 
146 Q_DECLARE_INTERFACE (IDataFilter, "org.Deviant.LeechCraft.IDataFilter/1.0")
virtual ~IDataFilter()
Definition: idatafilter.h:118
Base interface for data filter plugins.
Definition: idatafilter.h:90
QString Name_
The human-readable name of the filter variant.
Definition: idatafilter.h:107
QString Description_
The description of the filter variant.
Definition: idatafilter.h:111
Q_DECLARE_METATYPE(QVariantList *)
QIcon Icon_
The icon representing the filter variant.
Definition: idatafilter.h:115
QByteArray ID_
The ID of this filter variant.
Definition: idatafilter.h:103
std::function< void(QVariant)> DataFilterCallback_f
The type to be used as a data filter callback.
Definition: idatafilter.h:50
Describes a single filter variant supported by this data filter.
Definition: idatafilter.h:96