kis_filter.h

/*
 *  Copyright (c) 2004 Cyrille Berger <cberger@cberger.net>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
#ifndef _KIS_FILTER_H_
#define _KIS_FILTER_H_
 
#include <list>
 
#include <tqstring.h>
 
#include <ksharedptr.h>
#include <tdelocale.h>
 
#include "kis_types.h"
#include "kis_filter_registry.h"
#include "kis_id.h"
#include "kis_paint_device.h"
#include "kis_progress_subject.h"
#include "kis_filter_configuration.h"
#include "kis_colorspace.h"
#include "koffice_export.h"
 
class KisColorSpace;
class KisPreviewDialog;
class KisProgressDisplayInterface;
class KisFilterConfigWidget;
class TQWidget;

class KRITACORE_EXPORT KisFilter : public KisProgressSubject, public TDEShared {
    TQ_OBJECT
  
public:

    KisFilter(const KisID& id, const TQString & category, const TQString & entry);
    virtual ~KisFilter() {}
 
public:
 
    virtual void setProgressDisplay(KisProgressDisplayInterface * progressDisplay);
 
    virtual void process(KisPaintDeviceSP src, KisPaintDeviceSP dst, KisFilterConfiguration*, const TQRect&) = 0;
 
public:
     virtual KisFilterConfiguration * configuration(TQWidget*);

    virtual KisFilterConfiguration * configuration();

    virtual bool supportsPainting() { return false; };

    virtual bool supportsPreview() { return false; };

    // XXX: This uses supportsPreview() for backwards compatibility
    virtual bool supportsAdjustmentLayers() { return supportsPreview(); };

    virtual std::list<KisFilterConfiguration*> listOfExamplesConfiguration(KisPaintDeviceSP )
    { std::list<KisFilterConfiguration*> list; list.insert(list.begin(), 0); return list; }

    virtual bool supportsIncrementalPainting() { return true; };

    virtual bool supportsThreading() { return true; };

    virtual int overlapMarginNeeded(KisFilterConfiguration* = 0) const { return 0; };

    virtual TQRect enlargeRect(TQRect rect, KisFilterConfiguration* = 0) const;

    virtual ColorSpaceIndependence colorSpaceIndependence() { return TO_RGBA8; };

    virtual bool workWith(KisColorSpace*) { return true; }
 
    virtual void enableProgress();
    virtual void disableProgress();
 
    bool autoUpdate();
 
    // Unique identification for this filter
    inline const KisID id() const { return m_id; };
    // Which submenu in the filters menu does filter want to go?
 
    inline TQString menuCategory() const { return m_category; };
    // The i18n'ed string this filter wants to show itself in the menu
 
    inline TQString menuEntry() const { return m_entry; };

    virtual KisFilterConfigWidget * createConfigurationWidget(TQWidget * parent, KisPaintDeviceSP dev);
 
    virtual void cancel() { m_cancelRequested = true; }
 
    virtual void setAutoUpdate(bool set);
    bool progressEnabled() const { return m_progressEnabled; }
    inline bool cancelRequested() const { return m_progressEnabled && m_cancelRequested; }
 
protected slots:
 
    // Convenience functions for progress display.
    void setProgressTotalSteps(TQ_INT32 totalSteps);
    void setProgress(TQ_INT32 progress);
    void incProgress();
    void setProgressStage(const TQString& stage, TQ_INT32 progress);
    void setProgressDone();
    inline TQ_INT32 progress() { return m_progressSteps; }
private:
    bool m_cancelRequested;
    bool m_progressEnabled;
    bool m_autoUpdate;
 
protected:
    TQ_INT32 m_progressTotalSteps;
    TQ_INT32 m_lastProgressPerCent;
    TQ_INT32 m_progressSteps;
 
    KisID m_id;
    KisProgressDisplayInterface * m_progressDisplay;
    TQString m_category; // The category in the filter menu this filter fits
    TQString m_entry; // the i18n'ed accelerated menu text
 
};
 
 
#endif