messageviewer/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 __MESSAGEVIEWER_HEADERSTYLE_H__
  33 #define __MESSAGEVIEWER_HEADERSTYLE_H__
  34
  35 #include "messageviewer_export.h"
  36
  37 #include <KMime/Message>
  38
  39 class QByteArray;
  40 class QString;
  41 class KDateTime;
  42
  43 namespace MessageViewer {
  44
  45 class HeaderStrategy;
  46 class NodeHelper;
  47
  48 /** This class encapsulates the visual appearance of message
  49     headers. Together with HeaderStrategy, which determines
  50     which of the headers present in the message be shown, it is
  51     responsible for the formatting of message headers.
  52
  53     @short Encapsulates visual appearance of message headers.
  54     @author Marc Mutz <mutz@kde.org>
  55     @see HeaderStrategy
  56 **/
  57 class MESSAGEVIEWER_EXPORT HeaderStyle {
  58 protected:
  59   HeaderStyle();
  60   virtual ~HeaderStyle();
  61
  62 public:
  63   //
  64   // Factory methods:
  65   //
  66   enum Type {
  67     Brief,
  68     Plain,
  69     Fancy,
  70     Enterprise
  71 #ifdef KDEPIM_MOBILE_UI
  72     , Mobile
  73 #endif
  74   };
  75
  76   static HeaderStyle * create( Type type );
  77   static HeaderStyle * create( const QString & type );
  78
  79   static HeaderStyle * brief();
  80   static HeaderStyle * plain();
  81   static HeaderStyle * fancy();
  82   static HeaderStyle * enterprise();
  83 #ifdef KDEPIM_MOBILE_UI
  84   static HeaderStyle * mobile();
  85 #endif
  86
  87   //
  88   // Methods for handling the styles:
  89   //
  90   virtual const char * name() const = 0;
  91   virtual HeaderStyle * next() const = 0;
  92   virtual HeaderStyle * prev() const = 0;
  93
  94   //
  95   // HeaderStyle interface:
  96   //
  97   virtual QString format( KMime::Message *message ) const = 0;
  98
  99   void setMessagePath( const QString &path ) { mMessagePath = path; }
 100   QString messagePath() const { return mMessagePath; }
 101
 102   void setHeaderStrategy( const HeaderStrategy *strategy ) { mStrategy = strategy; }
 103   const HeaderStrategy* headerStrategy() const { return mStrategy; }
 104
 105   void setVCardName( const QString &vCardName ) { mVCardName = vCardName; }
 106   QString vCardName() const { return mVCardName; }
 107
 108   void setPrinting( bool printing ) { mPrinting = printing; }
 109   bool isPrinting() const { return mPrinting; }
 110
 111   void setTopLevel( bool topLevel ) { mTopLevel = topLevel; }
 112   bool isTopLevel() const { return mTopLevel; }
 113
 114   void setNodeHelper( NodeHelper *nodeHelper ) { mNodeHelper = nodeHelper; }
 115   NodeHelper* nodeHelper() const { return mNodeHelper; }
 116
 117   void setAllowAsync( bool allowAsync ) { mAllowAsync = allowAsync; }
 118   bool allowAsync() const { return mAllowAsync; }
 119
 120   void setSourceObject( QObject *sourceObject ) { mSourceObject = sourceObject; }
 121   QObject* sourceObject() const { return mSourceObject; }
 122
 123   static QString dateStr(const KDateTime &dateTime);
 124   static QByteArray dateShortStr(const KDateTime &dateTime);
 125
 126 private:
 127
 128   QString mMessagePath;
 129   const HeaderStrategy *mStrategy;
 130   QString mVCardName;
 131   bool mPrinting;
 132   bool mTopLevel;
 133   NodeHelper *mNodeHelper;
 134   bool mAllowAsync;
 135   QObject *mSourceObject;
 136 };
 137 }
 138
 139 #endif // __MESSAGEVIEWER_HEADERSTYLE_H__