libs/flake/KoFilterEffectFactoryBase.h

0001 /* This file is part of the KDE project
0002  * Copyright (c) 2009 Jan Hambrecht <jaham@gmx.net>
0003  *
0004  * This library is free software; you can redistribute it and/or
0005  * modify it under the terms of the GNU Lesser General Public
0006  * License as published by the Free Software Foundation; either
0007  * version 2.1 of the License, or (at your option) any later version.
0008  *
0009  * This library is distributed in the hope that it will be useful,
0010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012  * Library General Public License for more details.
0013  *
0014  * You should have received a copy of the GNU Lesser General Public License
0015  * along with this library; see the file COPYING.LIB.  If not, write to
0016  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
0017  * Boston, MA 02110-1301, USA.
0018  */
0019
0020 #ifndef KOFILTEREFFECTFACTORY_H
0021 #define KOFILTEREFFECTFACTORY_H
0022
0023 #include "flake_export.h"
0024
0025 class KoFilterEffect;
0026 class KoFilterEffectConfigWidgetBase;
0027 class QString;
0028
0029 /// API docs go here
0030 class FLAKE_EXPORT KoFilterEffectFactoryBase
0031 {
0032 public:
0033
0034     /**
0035     * Create the new factory
0036     * @param id a string that will be used internally for referencing the filter effect
0037     * @param name the user visible name of the filter effect this factory creates
0038     */
0039     KoFilterEffectFactoryBase(const QString &id, const QString &name);
0040     virtual ~KoFilterEffectFactoryBase();
0041
0042     /**
0043     * Returns the id for the filter this factory creates.
0044     * @return the id for the filter this factory creates
0045     */
0046     QString id() const;
0047
0048     /**
0049     * Returns the user visible (and translated) name to be seen by the user.
0050     * @return the user visible (and translated) name to be seen by the user
0051     */
0052     QString name() const;
0053
0054     /**
0055     * This method should be implemented by factories to create a filter effect.
0056     * @return a new filter effect
0057     */
0058     virtual KoFilterEffect *createFilterEffect() const = 0;
0059
0060     /**
0061      * This method should be implemented by factories to create a filter effect config widget.
0062      * @return the filter effect options widget
0063      */
0064     virtual KoFilterEffectConfigWidgetBase *createConfigWidget() const = 0;
0065
0066 private:
0067     class Private;
0068     Private * const d;
0069 };
0070
0071 #endif // KOFILTEREFFECTFACTORY_H