kmail/headerstyle.h

   1 /*  -*- c++ -*-
   2     headerstyle.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 __KMAIL_HEADERSTYLE_H__
  33 #define __KMAIL_HEADERSTYLE_H__
  34
  35 class QString;
  36 class KMMessage;
  37
  38 namespace KMail {
  39
  40   class HeaderStrategy;
  41
  42   /** This class encapsulates the visual appearance of message
  43       headers. Together with HeaderStrategy, which determines
  44       which of the headers present in the message be shown, it is
  45       responsible for the formatting of message headers.
  46
  47       @short Encapsulates visual appearance of message headers.
  48       @author Marc Mutz <mutz@kde.org>
  49       @see HeaderStrategy
  50   **/
  51   class HeaderStyle {
  52   protected:
  53     HeaderStyle();
  54     virtual ~HeaderStyle();
  55
  56   public:
  57     //
  58     // Factory methods:
  59     //
  60     enum Type { Brief, Plain, Fancy };
  61
  62     static const HeaderStyle * create( Type type );
  63     static const HeaderStyle * create( const QString & type );
  64
  65     static const HeaderStyle * brief();
  66     static const HeaderStyle * plain();
  67     static const HeaderStyle * fancy();
  68
  69     //
  70     // Methods for handling the styles:
  71     //
  72     virtual const char * name() const = 0;
  73     virtual const HeaderStyle * next() const = 0;
  74     virtual const HeaderStyle * prev() const = 0;
  75
  76     //
  77     // HeaderStyle interface:
  78     //
  79     virtual QString format( const KMMessage * message,
  80                             const KMail::HeaderStrategy * strategy,
  81                             const QString & vCardName,
  82                             bool printing=false ) const = 0;
  83   };
  84
  85 } // namespace KMail
  86
  87 #endif // __KMAIL_HEADERSTYLE_H__