filterlog.h

Go to the documentation of this file.

/*
  Copyright (c) 2003 Andreas Gungl <a.gungl@gmx.de>

  This program is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License, version 2, as
  published by the Free Software Foundation.

  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

  In addition, as a special exception, the copyright holders give
  permission to link the code of this program with any edition of
  the Qt library by Trolltech AS, Norway (or with modified versions
  of Qt that use the same license as Qt), and distribute linked
  combinations including the two.  You must obey the GNU General
  Public License in all respects for all of the code used other than
  Qt.  If you modify this file, you may extend this exception to
  your version of the file, but you are not obligated to do so.  If
  you do not wish to do so, delete this exception statement from
  your version.
*/

#ifndef MAILCOMMON_FILTERLOG_H
#define MAILCOMMON_FILTERLOG_H

#include "../mailcommon_export.h"

#include <QObject>
#include <QStringList>
#include <QTextDocument>

namespace MailCommon {

class MAILCOMMON_EXPORT FilterLog : public QObject
{
    Q_OBJECT

public:
    virtual ~FilterLog();

    static FilterLog *instance();

    enum ContentType {
        Meta               = 1, 
        PatternDescription = 2, 
        RuleResult         = 4, 
        PatternResult      = 8, 
        AppliedAction      = 16 
    };

    void setLogging( bool active );

    bool isLogging() const;

    void setMaxLogSize( long size = -1 );

    long maxLogSize() const;

    void setContentTypeEnabled( ContentType type, bool enabled );

    bool isContentTypeEnabled( ContentType type ) const;

    void add( const QString &entry, ContentType type );

    void addSeparator();

    void clear();

    QStringList logEntries() const;

    bool saveToFile( const QString &fileName ) const;

    static QString recode( const QString &plain );

    void dump();

Q_SIGNALS:
    void logEntryAdded( const QString &entry );

    void logShrinked();

    void logStateChanged();

private:
    //@cond PRIVATE
    FilterLog();

    class Private;
    Private *const d;
    //@endcond
};

}

#endif