filterlog.h

/*
    This file is part of KMail.
    Copyright (c) 2003 Andreas Gungl <a.gungl@gmx.de>
 
    KMail 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.
 
    KMail 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 TQt library by Trolltech AS, Norway (or with modified versions
    of TQt that use the same license as TQt), 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
    TQt.  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 KMAIL_FILTERLOG_H
#define KMAIL_FILTERLOG_H
 
#include <tqobject.h>
#include <tqstringlist.h>
#include <tqstylesheet.h>
 
namespace KMail {
 
  class FilterLog : public TQObject
  {
    TQ_OBJECT
  
 
    public:
      static FilterLog * instance();
      
      enum ContentType 
      { 
        meta          = 1, 
        patternDesc   = 2, 
        ruleResult    = 4, 
        patternResult = 8, 
        appliedAction = 16
      };
      
      
      bool isLogging() { return mLogging; };
      void setLogging( bool active )
      {
        mLogging = active; 
        emit logStateChanged();
      };
      
      
      void setMaxLogSize( long size = -1 );
      long getMaxLogSize() { return mMaxLogSize; };
      
      
      void setContentTypeEnabled( ContentType contentType, bool b )
      { 
        if ( b )
          mAllowedTypes |= contentType;
        else
          mAllowedTypes &= ~contentType;
        emit logStateChanged();
      };
 
      bool isContentTypeEnabled( ContentType contentType )
      { 
        return mAllowedTypes & contentType; 
      };
 
      
      void add( TQString logEntry, ContentType contentType );
      void addSeparator() { add( "------------------------------", meta ); };
      void clear() 
      {
        mLogEntries.clear(); 
        mCurrentLogSize = 0;
        emit logShrinked();
      };
      
      
      const TQStringList & getLogEntries() { return mLogEntries; };
      void dump();
      bool saveToFile( TQString fileName );
      
      virtual ~FilterLog();
      
      static TQString recode( const TQString & plain ) { return TQStyleSheet::escape(plain); };
      
    signals:
      void logEntryAdded( TQString );
      void logShrinked();
      void logStateChanged();
 
    protected:
      FilterLog();
      
      TQStringList mLogEntries;
      
      bool mLogging;
      
      long mMaxLogSize;
      long mCurrentLogSize;
      
      int mAllowedTypes;
      
      void checkLogSize();
      
    private:
      static FilterLog * mSelf;
  };
 
} // namespace KMail
 
#endif // KMAIL_FILTERLOG_H