tdefiletreeview.h

/* This file is part of the KDE project
   Copyright (C) 2000 David Faure <faure@kde.org>
                 2000 Carsten Pfeiffer <pfeiffer@kde.org>
         2002 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_VIEW_H
#define TDEFILE_TREE_VIEW_H
 
#include <tqmap.h>
#include <tqpoint.h>
#include <tqpixmap.h>
#include <tqstrlist.h>
#include <tqtooltip.h>
 
#include <tdelistview.h>
#include <kdirnotify.h>
#include <tdeio/job.h>
#include <tdefiletreeviewitem.h>
#include <tdefiletreebranch.h>
 
class TQTimer;
 
 
 
class TDEIO_EXPORT KFileTreeViewToolTip : public TQToolTip
{
public:
    KFileTreeViewToolTip( TQListView *view ) : TQToolTip( view ), m_view( view ) {}
 
protected:
    virtual void maybeTip( const TQPoint & );
 
private:
    TQListView *m_view;
};
 

class TDEIO_EXPORT KFileTreeView : public TDEListView
{
    TQ_OBJECT
public:
    KFileTreeView( TQWidget *parent, const char *name = 0 );
    virtual ~KFileTreeView();

    KFileTreeViewItem * currentKFileTreeViewItem() const;

    KURL currentURL() const;

   KFileTreeBranch* addBranch( const KURL &path, const TQString& name, bool showHidden = false );

   virtual KFileTreeBranch* addBranch( const KURL &path, const TQString& name ,
                       const TQPixmap& pix, bool showHidden = false  );

   virtual KFileTreeBranch* addBranch( KFileTreeBranch * );

   virtual bool removeBranch( KFileTreeBranch *branch );

   KFileTreeBranch *branch( const TQString& searchName );
 

   KFileTreeBranchList& branches();

   virtual void setDirOnlyMode( KFileTreeBranch *branch, bool );

   KFileTreeViewItem *findItem( KFileTreeBranch* brnch, const TQString& relUrl );

   KFileTreeViewItem *findItem( const TQString& branchName, const TQString& relUrl );

   bool showFolderOpenPixmap() const { return m_wantOpenFolderPixmaps; };
 
public slots:

   virtual void setShowFolderOpenPixmap( bool showIt = true )
      { m_wantOpenFolderPixmaps = showIt; }
 
protected:
 
   virtual bool acceptDrag(TQDropEvent* event) const;
    virtual TQDragObject * dragObject();
 
    virtual void startAnimation( KFileTreeViewItem* item, const char * iconBaseName = "kde", uint iconCount = 6 );
    virtual void stopAnimation( KFileTreeViewItem* item );
    virtual void contentsDragEnterEvent( TQDragEnterEvent *e );
    virtual void contentsDragMoveEvent( TQDragMoveEvent *e );
    virtual void contentsDragLeaveEvent( TQDragLeaveEvent *e );
    virtual void contentsDropEvent( TQDropEvent *ev );
 
protected slots:
    virtual void slotNewTreeViewItems( KFileTreeBranch*,
                       const KFileTreeViewItemList& );
 
    virtual void slotSetNextUrlToSelect( const KURL &url )
      { m_nextUrlToSelect = url; }
 
    virtual TQPixmap itemIcon( KFileTreeViewItem*, int gap = 0 ) const;
 
private slots:
    void slotExecuted( TQListViewItem * );
    void slotExpanded( TQListViewItem * );
    void slotCollapsed( TQListViewItem *item );
 
    void slotSelectionChanged();
 
    void slotAnimation();
 
    void slotAutoOpenFolder();
 
    void slotOnItem( TQListViewItem * );
    void slotItemRenamed(TQListViewItem*, const TQString &, int);
 
   void slotPopulateFinished( KFileTreeViewItem* );
 
 
signals:
 
   void onItem( const TQString& );
   /* New signals if you like it ? */
   void dropped( TQWidget*, TQDropEvent* );
   void dropped( TQWidget*, TQDropEvent*, KURL::List& );
   void dropped( KURL::List&, KURL& );
   // The drop event allows to differentiate between move and copy
   void dropped( TQWidget*, TQDropEvent*, KURL::List&, KURL& );
 
   void dropped( TQDropEvent *e, TQListViewItem * after);
   void dropped(KFileTreeView *, TQDropEvent *, TQListViewItem *);
   void dropped(TQDropEvent *e, TQListViewItem * parent, TQListViewItem * after);
   void dropped(KFileTreeView *, TQDropEvent *, TQListViewItem *, TQListViewItem *);
 
protected:
   KURL m_nextUrlToSelect;
 
 
private:
    // Returns whether item is still a valid item in the tree
    bool isValidItem( TQListViewItem *item);
    void clearTree();
 
 
   /* List that holds the branches */
    KFileTreeBranchList m_branches;
 
 
    struct AnimationInfo
    {
        AnimationInfo( const char * _iconBaseName, uint _iconCount, const TQPixmap & _originalPixmap )
            : iconBaseName(_iconBaseName), iconCount(_iconCount), iconNumber(1), originalPixmap(_originalPixmap) {}
        AnimationInfo() : iconCount(0) {}
        TQCString iconBaseName;
        uint iconCount;
        uint iconNumber;
        TQPixmap originalPixmap;
    };
    typedef TQMap<KFileTreeViewItem *, AnimationInfo> MapCurrentOpeningFolders;
    MapCurrentOpeningFolders m_mapCurrentOpeningFolders;
 
 
    TQTimer *m_animationTimer;
 
    TQPoint m_dragPos;
    bool m_bDrag;
 
   bool m_wantOpenFolderPixmaps; // Flag weather the folder should have open-folder pixmaps
 
    TQListViewItem *m_currentBeforeDropItem; // The item that was current before the drag-enter event happened
    TQListViewItem *m_dropItem; // The item we are moving the mouse over (during a drag)
    TQStrList m_lstDropFormats;
   TQPixmap  m_openFolderPixmap;
    TQTimer *m_autoOpenTimer;
 
    KFileTreeViewToolTip m_toolTip;
 
 
protected:
   virtual void virtual_hook( int id, void* data );
private:
   class KFileTreeViewPrivate;
   KFileTreeViewPrivate *d;
};
 
#endif