kde-playground/kdepim/knode/kncleanup.h

/*
    KNode, the KDE newsreader
    Copyright (c) 1999-2005 the KNode authors.
    See file AUTHORS for details

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    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, US
*/

#ifndef KNCLEANUP_H
#define KNCLEANUP_H

#include "knarticlecollection.h"
#include "kngroup.h"

#include <QList>
#include <KDialog>

class QProgressBar;
class QCloseEvent;
class QLabel;

class KNFolder;

namespace KNode {
class Cleanup;
}


/** This class handles group expiration and folder compaction. */
class KNCleanUp {

  public:
    KNCleanUp();
    ~KNCleanUp();

    /**
     * Add a collection to handle.
     */
    void appendCollection( KNArticleCollection::Ptr c )
      { mColList.append( c ); }
    void start();
    void reset();

    void expireGroup( KNGroup::Ptr g, bool showResult = false );
    /** Compacts the given folder, ie. remove all deleted messages from the
     * mbox file.
     * @param f The folder to compact.
     */
    void compactFolder( KNFolder::Ptr f );

  protected:

    /** Cleanup progress dialog. */
    class ProgressDialog : public KDialog  {

      public:
        /** Creates a new progress dialog.
         * @param steps The number of progress steps.
         * @param parent The parent widget.
         */
        explicit ProgressDialog( int steps, QWidget *parent = 0 );
        ~ProgressDialog();

        /** Shows a message in the progress dialog.
         * @param s The message to show.
         */
        void showMessage(const QString &s);
        /** Increments the progress counter by one. */
        void doProgress();

      protected:
        void closeEvent(QCloseEvent *e);

        QLabel *m_sg;
        QProgressBar *mProgressBar;
    };

    ProgressDialog *d_lg;
    KNArticleCollection::List mColList;

};

#endif