kdirlister.h

/* This file is part of the KDE project
   Copyright (C) 1999 David Faure <faure@kde.org>
                 2001, 2002, 2004, 2005 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 "tdefileitem.h"
#include "kdirnotify.h"
 
#include <tqstring.h>
#include <tqstringlist.h>
 
#include <kurl.h>
 
namespace TDEIO { class Job; class LocalURLJob; class ListJob; }

class TDEIO_EXPORT KDirLister : public TQObject
{
  class KDirListerPrivate;
  friend class KDirListerPrivate;
  friend class KDirListerCache;
 
  TQ_OBJECT
  TQ_PROPERTY( bool autoUpdate READ autoUpdate WRITE setAutoUpdate )
  TQ_PROPERTY( bool showingDotFiles READ showingDotFiles WRITE setShowingDotFiles )
  TQ_PROPERTY( bool dirOnlyMode READ dirOnlyMode WRITE setDirOnlyMode )
  TQ_PROPERTY( bool autoErrorHandlingEnabled READ autoErrorHandlingEnabled )
  TQ_PROPERTY( TQString nameFilter READ nameFilter WRITE setNameFilter )
  TQ_PROPERTY( TQStringList mimeFilter READ mimeFilters WRITE setMimeFilter RESET clearMimeFilter )
 
public:
  KDirLister( bool _delayedMimeTypes = false );

  virtual ~KDirLister();

  virtual bool openURL( const KURL& _url, bool _keep = false, bool _reload = false );

  virtual void stop();

  virtual void stop( const KURL& _url );

  bool autoUpdate() const;

  virtual void setAutoUpdate( bool enable );

  bool autoErrorHandlingEnabled() const;

  void setAutoErrorHandlingEnabled( bool enable, TQWidget *parent );

  bool showingDotFiles() const;

  virtual void setShowingDotFiles( bool _showDotFiles );

  bool dirOnlyMode() const;

  virtual void setDirOnlyMode( bool dirsOnly );

  const KURL& url() const;

  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;
#ifndef KDE_NO_COMPAT
  KFileItem *find( const KURL& _url ) const;
#endif

  virtual KFileItem *findByName( const TQString& name ) const;

  virtual void setNameFilter( const TQString &filter );

  const TQString& nameFilter() const;

  virtual void setMimeFilter( const TQStringList &mimeList );

  void setMimeExcludeFilter(const TQStringList &mimeList );
 

  virtual void clearMimeFilter();

  const TQStringList& mimeFilters() const;

  bool matchesFilter( const TQString& name ) const;

  bool matchesMimeFilter( const TQString& mime ) const;

  void setMainWindow( TQWidget *window );

  TQWidget *mainWindow();

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

  KFileItemList items( WhichItems which = FilteredItems ) const;

  KFileItemList itemsForDir( const KURL& dir,
                             WhichItems which = FilteredItems ) const;
 
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 itemsFilteredByMime( const KFileItemList& items );

  void deleteItem( KFileItem *_fileItem );

  void refreshItems( const KFileItemList& items );

  void infoMessage( const TQString& msg );

  void percent( int percent );

  void totalSize( TDEIO::filesize_t size );

  void processedSize( TDEIO::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 TQString& name, const TQPtrList<TQRegExp>& filters ) const;

  virtual bool doMimeFilter( const TQString& mime, const TQStringList& filters ) const;

  bool doMimeExcludeFilter( const TQString& mimeExclude, const TQStringList& filters ) const;

  virtual bool validURL( const KURL& ) const;

  virtual void handleError( TDEIO::Job * );
 
protected:
  virtual void virtual_hook( int id, void *data );
 
private slots:
  void slotInfoMessage( TDEIO::Job *, const TQString& );
  void slotPercent( TDEIO::Job *, unsigned long );
  void slotTotalSize( TDEIO::Job *, TDEIO::filesize_t );
  void slotProcessedSize( TDEIO::Job *, TDEIO::filesize_t );
  void slotSpeed( TDEIO::Job *, unsigned long );
  void slotOpenURLGotLocalURL( TDEIO::LocalURLJob*, const KURL&, bool );
  void slotLocalURLKIODestroyed( );
 
private:
  void jobStarted( TDEIO::ListJob * );
  void connectJob( TDEIO::ListJob * );
  void jobDone( TDEIO::ListJob * );
 
  uint numJobs();
 
public:
  void emitCompleted( const KURL& _url );
 
private:
  virtual void addNewItem( const KFileItem *item );
  virtual void addNewItems( const KFileItemList& items );
  /*virtual*/ void aboutToRefreshItem( const KFileItem *item );  // TODO: KDE 4.0 make virtual
  virtual void addRefreshItem( const KFileItem *item );
  virtual void emitItems();
  virtual void emitDeleteItem( KFileItem *item );
 
  KDirListerPrivate *d;
};
 
#endif