tdepim/kmail/bodyvisitor.h

/*  -*- mode: C++; c-file-style: "gnu" -*-
 *
 *  This file is part of KMail, the KDE mail client.
 *  Copyright (c) 2003 Carsten Burghardt <burghardt@kde.org>
 *
 *  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 bodyiterator_h
#define bodyiterator_h

#include <tqptrlist.h>
#include <tqstringlist.h>

class KMMessagePart;

namespace KMail {

  class AttachmentStrategy;

  // Base class
  class BodyVisitor
  {
    public:
      BodyVisitor();
      virtual ~BodyVisitor();

      /** Register the parts that should be visited */
      void visit( KMMessagePart * part );
      void visit( TQPtrList<KMMessagePart> & list );

      /** Returns a list of parts that should be loaded */
      TQPtrList<KMMessagePart> partsToLoad();

      /** Decides whether a part should be loaded.
          This needs to be implemented by a subclass */
      virtual bool addPartToList( KMMessagePart * part ) = 0;

    protected:
      /** 
       * Checks if one of the parents needs loaded children
       * This is e.g. needed for multipart/signed where all parts have to be loaded 
       */
      static bool parentNeedsLoading( KMMessagePart * part );
      
    protected:
      TQPtrList<KMMessagePart> mParts;
      TQStringList mBasicList;
  };

  // Factory to create a visitor according to the Attachment Strategy 
  class BodyVisitorFactory
  {
    public:
      static BodyVisitor* getVisitor( const AttachmentStrategy* strategy );
  };

  // Visitor for smart attachment display
  class BodyVisitorSmart: public BodyVisitor
  {
    public:
      BodyVisitorSmart();

      bool addPartToList( KMMessagePart * part );
  };
  
  // Visitor for inline attachment display
  class BodyVisitorInline: public BodyVisitor
  {
    public:
      BodyVisitorInline();

      bool addPartToList( KMMessagePart * part );
  };
  
  // Visitor for hidden attachment display
  class BodyVisitorHidden: public BodyVisitor
  {
    public:
      BodyVisitorHidden();

      bool addPartToList( KMMessagePart * part );
  };

}

#endif