tdefiletreebranch.h

 
/* This file is part of the KDE project
   Copyright (C) 2000 David Faure <faure@kde.org>
                 2000 Carsten Pfeiffer <pfeiffer@kde.org>
                 2001 Klaas Freitag <freitag@suse.de>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.
 
   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 TDEFILE_TREE_BRANCH_H
#define TDEFILE_TREE_BRANCH_H
 
#include <tqdict.h>
#include <tqlistview.h>
 
#include <tdefileitem.h>
#include <tdeio/global.h>
#include <kdirlister.h>
#include <tdeio/job.h>
#include <tdefiletreeviewitem.h>
 
class KURL;
class KFileTreeView;
 
 
class TDEIO_EXPORT KFileTreeBranch : public KDirLister
{
   TQ_OBJECT
public:
   KFileTreeBranch( KFileTreeView*, const KURL& url, const TQString& name,
                    const TQPixmap& pix, bool showHidden = false,
            KFileTreeViewItem *branchRoot = 0 );
 
   KURL     rootUrl() const { return( m_startURL ); }
 
   virtual void     setRoot( KFileTreeViewItem *r ){ m_root = r; };
 
   KFileTreeViewItem *root( ) { return( m_root );}
 
   TQString      name() const { return( m_name ); }
 
   virtual void         setName( const TQString n ) { m_name = n; };
 
   /*
    * returns the current root item pixmap set in the constructor. The root
    * item pixmap defaults to the icon for directories.
    * @see openPixmap()
    */
   const TQPixmap& pixmap(){ return(m_rootIcon); }
 
   /*
    * returns the current root item pixmap set by setOpenPixmap()
    * which is displayed if the branch is expanded.
    * The root item pixmap defaults to the icon for directories.
    * @see pixmap()
    * Note that it depends on KFileTreeView::showFolderOpenPximap weather
    * open pixmap are displayed or not.
    */
   const TQPixmap& openPixmap() { return(m_openRootIcon); }
 
   bool showExtensions( ) const;
 
   void setOpen( bool setopen = true )
      { if( root() ) root()->setOpen( setopen ); }
 
   void setChildRecurse( bool t=true );
 
   bool childRecurse()
      { return m_recurseChildren; }
 
public slots:
   virtual bool populate( const KURL &url, KFileTreeViewItem* currItem );
 
   virtual void setShowExtensions( bool visible = true );
 
   void setOpenPixmap( const TQPixmap& pix );
 
protected:
   virtual KFileTreeViewItem *createTreeViewItem( KFileTreeViewItem *parent,
                          KFileItem *fileItem );
 
public:
   virtual KFileTreeViewItem *findTVIByURL( const KURL& );
 
signals:
   void populateFinished( KFileTreeViewItem * );
 
   void newTreeViewItems( KFileTreeBranch*, const KFileTreeViewItemList& );
 
   void directoryChildCount( KFileTreeViewItem* item, int count );
 
private slots:
   void slotRefreshItems( const KFileItemList& );
   void addItems( const KFileItemList& );
   void slCompleted( const KURL& );
   void slotCanceled( const KURL& );
   void slotListerStarted( const KURL& );
   void slotDeleteItem( KFileItem* );
   void slotDirlisterClear();
   void slotDirlisterClearURL( const KURL& url );
   void slotRedirect( const KURL& oldUrl, const KURL&newUrl );
 
private:
   KFileTreeViewItem    *parentKFTVItem( KFileItem *item );
   static void           deleteChildrenOf( TQListViewItem *parent );
 
   KFileTreeViewItem    *m_root;
   KURL         m_startURL;
   TQString         m_name;
   TQPixmap         m_rootIcon;
   TQPixmap              m_openRootIcon;
 
   /* this list holds the url's which children are opened. */
   KURL::List           m_openChildrenURLs;
 
 
   /* The next two members are used for caching purposes in findTVIByURL. */
   KURL                 m_lastFoundURL;
   KFileTreeViewItem   *m_lastFoundItem;
 
   bool                 m_recurseChildren :1;
   bool                 m_showExtensions  :1;
 
protected:
   virtual void virtual_hook( int id, void* data );
private:
   class KFileTreeBranchPrivate;
   KFileTreeBranchPrivate *d;
};
 
 
typedef TQPtrList<KFileTreeBranch> KFileTreeBranchList;
 
typedef TQPtrListIterator<KFileTreeBranch> KFileTreeBranchIterator;
 
#endif