kfiletreebranch.h

Go to the documentation of this file.

/* 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 kfile_tree_branch_h
#define kfile_tree_branch_h

class QColorGroup;

#include <Qt3Support/Q3ListView>

#include <kfileitem.h>
#include <kio/global.h>
#include <kdirlister.h>
#include <kio/job.h>
#include <k3filetreeviewitem.h>

class KUrl;
class K3FileTreeView;


class KDE3SUPPORT_EXPORT KFileTreeBranch : public KDirLister
{
   Q_OBJECT
public:
   KFileTreeBranch( K3FileTreeView*, const KUrl& url, const QString& name,
                    const QPixmap& pix, bool showHidden = false,
            K3FileTreeViewItem *branchRoot = 0 );

   KUrl rootUrl() const;

   virtual void setRoot( K3FileTreeViewItem *r );

   K3FileTreeViewItem *root( );

   QString name() const;

   virtual void setName( const QString n );

   /*
    * returns the current root item pixmap set in the constructor. The root
    * item pixmap defaults to the icon for directories.
    * @see openPixmap()
    */
   QPixmap pixmap() const;

   /*
    * 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 K3FileTreeView::showFolderOpenPximap weather
    * open pixmap are displayed or not.
    */
   QPixmap openPixmap() const;

   bool showExtensions( ) const;

   void setOpen( bool setopen = true );

   void setChildRecurse( bool t=true );

   bool childRecurse();

public Q_SLOTS:
   virtual bool populate( const KUrl &url, K3FileTreeViewItem* currItem );

   virtual void setShowExtensions( bool visible = true );

   void setOpenPixmap( const QPixmap& pix );

protected:
   virtual K3FileTreeViewItem *createTreeViewItem( K3FileTreeViewItem *parent,
                          const KFileItem &fileItem );

public:
   virtual K3FileTreeViewItem *findTVIByUrl( const KUrl& );

Q_SIGNALS:
   void populateFinished( K3FileTreeViewItem * );

   void newTreeViewItems( KFileTreeBranch*, const K3FileTreeViewItemList& );

   void directoryChildCount( K3FileTreeViewItem* item, int count );

private Q_SLOTS:
   void slotRefreshItems( const QList<QPair<KFileItem, KFileItem> >& );
   void addItems( const KFileItemList& );
   void slCompleted( const KUrl& );
   void slotCanceled( const KUrl& );
   void slotListerStarted( const KUrl& );
   void slotDeleteItem( const KFileItem& );
   void slotDirlisterClear();
   void slotDirlisterClearUrl( const KUrl& url );
   void slotRedirect( const KUrl& oldUrl, const KUrl&newUrl );

private:
   K3FileTreeViewItem    *parentKFTVItem( const KFileItem &item );
   static void           deleteChildrenOf( Q3ListViewItem *parent );
   K3FileTreeViewItem* treeItemForFileItem(const KFileItem &it);

   K3FileTreeViewItem   *m_root;
   KUrl         m_startURL;
   QString      m_name;
   QPixmap      m_rootIcon;
   QPixmap              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;
   K3FileTreeViewItem   *m_lastFoundItem;

   bool                 m_recurseChildren :1;
   bool                 m_showExtensions  :1;

private:
   class KFileTreeBranchPrivate;
   KFileTreeBranchPrivate *d;
};


typedef Q3PtrList<KFileTreeBranch> KFileTreeBranchList;

typedef Q3PtrListIterator<KFileTreeBranch> KFileTreeBranchIterator;

#endif