LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
IDataFilter Class Referenceabstract

Base interface for data filter plugins. More...

#include "idatafilter.h"

Classes

struct  FilterVariant
 

Public Member Functions

virtual ~IDataFilter ()
 
virtual QString GetFilterVerb () const =0
 
virtual QList< FilterVariantGetFilterVariants () const =0
 

Detailed Description

Base interface for data filter plugins.

Data filter plugins provide some means to manipulate and alter data. Examples of such plugins are image uploaders to various image bins, text finders, etc.

The list of possible data filter variants (that is, image bins supported by a single plugin) is returned from the GetFilterVariants() function.

Plugins implementing this interface are also expected to implement IEntityHandler, considering (and accepting) entities with MIME "x-leechcraft/data-filter-request". Such entities will contain the entity to filter (like, a piece of text or an image) in the Entity::Entity_ field and may contain the "DataFilter" key in the Entity::Additional_ map with the name of the exact filter variant to use (if user has already selected it).

Definition at line 55 of file idatafilter.h.

Constructor & Destructor Documentation

virtual IDataFilter::~IDataFilter ( )
inlinevirtual

Definition at line 65 of file idatafilter.h.

Member Function Documentation

virtual QList<FilterVariant> IDataFilter::GetFilterVariants ( ) const
pure virtual

Referenced by LeechCraft::Util::StdDataFilterMenuCreator::StdDataFilterMenuCreator().

+ Here is the caller graph for this function:

virtual QString IDataFilter::GetFilterVerb ( ) const
pure virtual

The documentation for this class was generated from the following file: