dolphin/src/applyviewpropsjob.h
David Faure 81fcd720a2 Use KFileItem by value rather than by pointer
- in KDirModel::itemForIndex, as noted there as a TODO
 - in dolphin, everywhere.

svn path=/trunk/KDE/kdebase/apps/; revision=699691
2007-08-13 21:57:20 +00:00

86 lines
3.3 KiB
C++

/***************************************************************************
* Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at> *
* *
* The code is based on kdelibs/kio/kio/directorysizejob.* *
* (C) 2006 by David Faure <faure@kde.org> *
* *
* 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. *
* *
* This program 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 *
***************************************************************************/
#ifndef APPLYVIEWPROPSJOB_H
#define APPLYVIEWPROPSJOB_H
#include <kio/job.h>
#include <kfileitem.h>
#include <kurl.h>
class ViewProperties;
/**
* @brief Applies view properties recursively to directories.
*
* Usage:
* \code
* KJob* job = new ApplyViewPropsJob(dir, viewProps);
* connect(job, SIGNAL(result(KJob*)),
* this, SLOT(slotResult(KJob*)));
* \endcode
*
* To be able to show a progress of the operation, the following steps
* are recommended:
* - Use a DirectorySizeJob to count the number of directories.
* - Use a timer to show the current count of directories by invoking
* DirectorySizeJob::totalSubdirs() until the result signal is emitted.
* - Use the ApplyViewPropsJob.
* - Use a timer to show the progress by invoking ApplyViwePropsJob::progress().
* In combination with the total directory count it is possible to show a
* progress bar now.
*/
class ApplyViewPropsJob : public KIO::Job
{
Q_OBJECT
public:
/**
* @param dir Directory where the view properties should be applied to
* (including sub directories).
* @param viewProps View properties for the directory \a dir including its
* sub directories.
*/
ApplyViewPropsJob(const KUrl& dir, const ViewProperties& viewProps);
virtual ~ApplyViewPropsJob();
int progress() const
{
return m_progress;
}
private:
void startNextJob(const KUrl & url);
private slots:
virtual void slotResult(KJob* job);
void slotEntries(KIO::Job*, const KIO::UDSEntryList&);
void processNextItem();
private:
ViewProperties* m_viewProps;
int m_currentItem;
int m_progress;
KUrl m_dir;
};
#endif