kdirlister.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 1999 David Faure <faure@kde.org>
                 2001, 2002, 2004-2006 Michael Brade <brade@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef kdirlister_h
#define kdirlister_h

#include "kfileitem.h"
#include "kdirnotify.h"

#include <QtCore/QString>
#include <QtCore/QStringList>

#include <kurl.h>

class KJob;
namespace KIO { class Job; class ListJob; }

class KIO_EXPORT KDirLister : public QObject
{
  friend class KDirListerCache;
  friend struct KDirListerCacheDirectoryData;

  Q_OBJECT
  Q_PROPERTY( bool autoUpdate READ autoUpdate WRITE setAutoUpdate )
  Q_PROPERTY( bool showingDotFiles READ showingDotFiles WRITE setShowingDotFiles )
  Q_PROPERTY( bool dirOnlyMode READ dirOnlyMode WRITE setDirOnlyMode )
  Q_PROPERTY( bool autoErrorHandlingEnabled READ autoErrorHandlingEnabled )
  Q_PROPERTY( bool delayedMimeTypes READ delayedMimeTypes WRITE setDelayedMimeTypes )
  Q_PROPERTY( QString nameFilter READ nameFilter WRITE setNameFilter )
  Q_PROPERTY( QStringList mimeFilter READ mimeFilters WRITE setMimeFilter RESET clearMimeFilter )

public:
  enum OpenUrlFlag
  {
    NoFlags = 0x0,   

    Keep = 0x1,      

    Reload = 0x2     
  };

  Q_DECLARE_FLAGS(OpenUrlFlags, OpenUrlFlag)

  
  KDirLister( QObject* parent = 0 );

  virtual ~KDirLister();

  virtual bool openUrl( const KUrl& _url, OpenUrlFlags _flags = NoFlags );

  virtual void stop();

  virtual void stop( const KUrl& _url );

  bool delayedMimeTypes() const;

  void setDelayedMimeTypes( bool delayedMimeTypes );


  bool autoUpdate() const;

  virtual void setAutoUpdate( bool enable );

  bool autoErrorHandlingEnabled() const;

  void setAutoErrorHandlingEnabled( bool enable, QWidget *parent );

  bool showingDotFiles() const;

  virtual void setShowingDotFiles( bool _showDotFiles );

  bool dirOnlyMode() const;

  virtual void setDirOnlyMode( bool dirsOnly );

  KUrl url() const;

  KUrl::List directories() const;

  virtual void emitChanges();

  virtual void updateDirectory( const KUrl& _dir );

  bool isFinished() const;

  KFileItem rootItem() const;

  virtual KFileItem findByUrl( const KUrl& _url ) const;

  virtual KFileItem findByName( const QString& name ) const;

  virtual void setNameFilter( const QString &filter );

  QString nameFilter() const;

  virtual void setMimeFilter( const QStringList &mimeList );

  void setMimeExcludeFilter(const QStringList &mimeList );


  virtual void clearMimeFilter();

  QStringList mimeFilters() const;

  bool matchesFilter( const QString& name ) const;

  bool matchesMimeFilter( const QString& mime ) const;

  void setMainWindow( QWidget *window );

  QWidget *mainWindow();

  enum WhichItems
  {
      AllItems = 0,
      FilteredItems = 1
  };

  KFileItemList items( WhichItems which = FilteredItems ) const;

  KFileItemList itemsForDir( const KUrl& dir,
                             WhichItems which = FilteredItems ) const;

    static KFileItem cachedItemForUrl(const KUrl& url);

Q_SIGNALS:

  void started( const KUrl& _url );

  void completed();

  void completed( const KUrl& _url );

  void canceled();

  void canceled( const KUrl& _url );

  void redirection( const KUrl& _url );

  void redirection( const KUrl& oldUrl, const KUrl& newUrl );

  void clear();

  void clear( const KUrl& _url );

  void newItems( const KFileItemList& items );

  void itemsAdded(const KUrl& directoryUrl, const KFileItemList& items);

  void itemsFilteredByMime( const KFileItemList& items );

  QT_MOC_COMPAT void deleteItem( const KFileItem &_fileItem ); // KDE5: remove, and port to itemsDeleted

  void itemsDeleted( const KFileItemList& items );

  void refreshItems( const QList<QPair<KFileItem, KFileItem> >& items );

  void infoMessage( const QString& msg );

  void percent( int percent );

  void totalSize( KIO::filesize_t size );

  void processedSize( KIO::filesize_t size );

  void speed( int bytes_per_second );

protected:
  enum Changes { NONE=0, NAME_FILTER=1, MIME_FILTER=2, DOT_FILES=4, DIR_ONLY_MODE=8 };

  virtual bool matchesFilter( const KFileItem& ) const;

  virtual bool matchesMimeFilter( const KFileItem& ) const;

  virtual bool doNameFilter( const QString& name, const QList<QRegExp>& filters ) const;

  virtual bool doMimeFilter( const QString& mime, const QStringList& filters ) const;

  virtual void handleError( KIO::Job * );

private:
  class Private;
  Private* const d;
  friend class Private;

  Q_PRIVATE_SLOT( d, void _k_slotInfoMessage( KJob*, const QString& ) )
  Q_PRIVATE_SLOT( d, void _k_slotPercent( KJob*, unsigned long ) )
  Q_PRIVATE_SLOT( d, void _k_slotTotalSize( KJob*, qulonglong ) )
  Q_PRIVATE_SLOT( d, void _k_slotProcessedSize( KJob*, qulonglong ) )
  Q_PRIVATE_SLOT( d, void _k_slotSpeed( KJob*, unsigned long ) )
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KDirLister::OpenUrlFlags)

#endif