messageviewer/headerstrategy.h

   1 /*  -*- c++ -*-
   2     headerstrategy.h
   3
   4     This file is part of KMail, the KDE mail client.
   5     Copyright (c) 2003 Marc Mutz <mutz@kde.org>
   6
   7     KMail is free software; you can redistribute it and/or modify it
   8     under the terms of the GNU General Public License, version 2, as
   9     published by the Free Software Foundation.
  10
  11     KMail is distributed in the hope that it will be useful, but
  12     WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14     General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  19
  20     In addition, as a special exception, the copyright holders give
  21     permission to link the code of this program with any edition of
  22     the Qt library by Trolltech AS, Norway (or with modified versions
  23     of Qt that use the same license as Qt), and distribute linked
  24     combinations including the two.  You must obey the GNU General
  25     Public License in all respects for all of the code used other than
  26     Qt.  If you modify this file, you may extend this exception to
  27     your version of the file, but you are not obligated to do so.  If
  28     you do not wish to do so, delete this exception statement from
  29     your version.
  30 */
  31
  32 #ifndef __MESSAGEVIEWER_HEADERSTRATEGY_H__
  33 #define __MESSAGEVIEWER_HEADERSTRATEGY_H__
  34
  35 #include "messageviewer_export.h"
  36
  37 class QString;
  38 class QStringList;
  39
  40 namespace MessageViewer {
  41
  42 class MESSAGEVIEWER_EXPORT HeaderStrategy
  43 {
  44 protected:
  45   HeaderStrategy();
  46   virtual ~HeaderStrategy();
  47
  48 public:
  49   //
  50   // Factory methods:
  51   //
  52   enum Type { All, Rich, Standard, Brief, Custom };
  53
  54   static const HeaderStrategy * create( Type type );
  55   static const HeaderStrategy * create( const QString & type );
  56
  57   static const HeaderStrategy * all();
  58   static const HeaderStrategy * rich();
  59   static const HeaderStrategy * standard();
  60   static const HeaderStrategy * brief();
  61   static const HeaderStrategy * custom();
  62
  63   //
  64   // Methods for handling the strategies:
  65   //
  66   virtual const char * name() const = 0;
  67   virtual const HeaderStrategy * next() const = 0;
  68   virtual const HeaderStrategy * prev() const = 0;
  69
  70   //
  71   // HeaderStrategy interface:
  72   //
  73   enum DefaultPolicy { Display, Hide };
  74
  75   virtual QStringList headersToDisplay() const;
  76   virtual QStringList headersToHide() const;
  77   virtual DefaultPolicy defaultPolicy() const = 0;
  78   virtual bool showHeader( const QString & header ) const;
  79 };
  80
  81 }
  82
  83 #endif // __MESSAGEVIEWER_HEADERSTRATEGY_H__