File indexing completed on 2024-04-28 04:58:27

 /* This file is part of the KDE project
     SPDX-FileCopyrightText: 2000 David Faure <faure@kde.org>
     SPDX-FileCopyrightText: 2000 Carsten Pfeiffer <pfeiffer@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-only
 */
 
 #ifndef KONQ_SIDEBARTREE_H
 #define KONQ_SIDEBARTREE_H
 
 #include <k3listview.h>
 #include "kf5compat.h" //For NavigationExtension
 #include "konq_sidebartreetoplevelitem.h"
 #include <QMap>
 #include <QPoint>
 #include <Qt3Support/Q3StrList>
 
 //Added by qt3to4:
 #include <QPixmap>
 #include <QByteRef>
 #include <QKeyEvent>
 #include <Qt3Support/Q3PtrList>
 #include <QEvent>
 
 class KonqSidebarOldTreeModule;
 class KonqSidebarTreeModule;
 class KonqSidebarTreeItem;
 class KActionCollection;
 
 class QTimer;
 
 class KonqSidebarTree_Internal;
 
 enum ModuleType { VIRT_Link = 0,  // a single .desktop file
                   VIRT_Folder = 1
                 }; // a directory which is parsed for .desktop files
 
 typedef KonqSidebarTreeModule *(*getModule)(KonqSidebarTree *, const bool);
 
 struct DirTreeConfigData { // TODO make base class with two subclasses?
     QUrl dir; // only used for VIRT_Folder
     ModuleType type;
     QString relDir; // only used for VIRT_Folder
 };
 
 enum DropAcceptType {
     SidebarTreeMode, // used if the drop is accepted by a KonqSidebarTreeItem. otherwise
     K3ListViewMode    // use K3ListView's dnd implementation. accepts mime types set with setDropFormats()
 };
 
 /**
  * The multi-purpose tree view.
  * It parses its configuration (desktop files), each one corresponding to
  * a toplevel item, and creates the modules that will handle the contents
  * of those items.
  */
 class KonqSidebarTree : public K3ListView // PORTING NOTE: DO NOT PORT TO QTreeWidget. See http://kde.aliax.net/mockups/konqueror/ first.
 {
     Q_OBJECT
 public:
     KonqSidebarTree(KonqSidebarOldTreeModule *parent, QWidget *parentWidget, ModuleType moduleType, const QString &path);
     virtual ~KonqSidebarTree();
 
     void followURL(const QUrl &url);
 
     /**
      * @return the current (i.e. selected) item
      */
     KonqSidebarTreeItem *currentItem() const;
 
     void startAnimation(KonqSidebarTreeItem *item, const char *iconBaseName = "kde", uint iconCount = 6, const QPixmap *originalPixmap = 0L);
     void stopAnimation(KonqSidebarTreeItem *item);
 
     KonqSidebarOldTreeModule *sidebarModule()
     {
         return m_sidebarModule;
     }
 
     KActionCollection *actionCollection()
     {
         return m_collection;
     }
 
     void lockScrolling(bool lock)
     {
         m_scrollingLocked = lock;
     }
 
     bool isOpeningFirstChild() const
     {
         return m_bOpeningFirstChild;
     }
 
     void enableActions(bool copy, bool cut, bool paste);
 
     void itemDestructed(KonqSidebarTreeItem *item);
 
     void setDropFormats(const QStringList &formats);   // used in K3ListView mode
 
     // Show context menu for toplevel items
     void showToplevelContextMenu();
 
     // Add an URL
     void addUrl(KonqSidebarTreeTopLevelItem *item, const QUrl &url);
 
 public slots:
     // Connected to KDirNotify dbus signals
     void slotFilesAdded(const QString &dir);
     void slotFilesRemoved(const QStringList &urls);
     void slotFilesChanged(const QStringList &urls);
 
     virtual void setContentsPos(int x, int y);
 
 protected:
     virtual void contentsDragEnterEvent(QDragEnterEvent *e);
     virtual void contentsDragMoveEvent(QDragMoveEvent *e);
     virtual void contentsDragLeaveEvent(QDragLeaveEvent *e);
     virtual void contentsDropEvent(QDropEvent *ev);
     virtual bool acceptDrag(QDropEvent *e) const; // used in K3ListView mode
 
     virtual bool eventFilter(QObject *obj, QEvent *ev);
     virtual void leaveEvent(QEvent *);
 
     virtual Q3DragObject *dragObject();
 
 private slots:
     void slotDoubleClicked(Q3ListViewItem *item);
     void slotExecuted(Q3ListViewItem *item);
     void slotMouseButtonPressed(int _button, Q3ListViewItem *_item, const QPoint &, int col);
     void slotMouseButtonClicked(int _button, Q3ListViewItem *_item, const QPoint &, int col);
     void slotSelectionChanged();
 
     void slotAnimation();
 
     void slotAutoOpenFolder();
 
     void rescanConfiguration();
 
     void slotItemRenamed(Q3ListViewItem *, const QString &, int);
 
     void slotCreateFolder();
     void slotDelete();
     void slotTrash();
     void slotRename();
     void slotProperties();
     void slotOpenNewWindow();
     void slotOpenTab();
     void slotCopyLocation();
 
 private:
     void clearTree();
     void scanDir(KonqSidebarTreeItem *parent, const QString &path, bool isRoot = false);
     void loadTopLevelGroup(KonqSidebarTreeItem *parent, const QString &path);
     void loadTopLevelItem(KonqSidebarTreeItem *parent, const QString &path);
 
     void loadModuleFactories();
 
     bool overrideShortcut(const QKeyEvent *e);
 
 private:
     Q3PtrList<KonqSidebarTreeTopLevelItem> m_topLevelItems;
     KonqSidebarTreeTopLevelItem *m_currentTopLevelItem;
 
     Q3PtrList<KonqSidebarTreeModule> m_lstModules;
 
     KonqSidebarOldTreeModule *m_sidebarModule;
 
     struct AnimationInfo {
         AnimationInfo(const char *_iconBaseName, uint _iconCount, const QPixmap &_originalPixmap)
             : iconBaseName(_iconBaseName), iconCount(_iconCount), iconNumber(1), originalPixmap(_originalPixmap) {}
         AnimationInfo() : iconCount(0) {}
         QByteArray iconBaseName;
         uint iconCount;
         uint iconNumber;
         QPixmap originalPixmap;
     };
     typedef QMap<KonqSidebarTreeItem *, AnimationInfo> MapCurrentOpeningFolders;
     MapCurrentOpeningFolders m_mapCurrentOpeningFolders;
 
     QTimer *m_animationTimer;
 
     Q3ListViewItem *m_currentBeforeDropItem; // The item that was current before the drag-enter event happened
     Q3ListViewItem *m_dropItem; // The item we are moving the mouse over (during a drag)
     Q3StrList m_lstDropFormats;
 
     QTimer *m_autoOpenTimer;
 
     // The base URL for our configuration directory
     //QUrl m_dirtreeDir;
     DirTreeConfigData m_dirtreeDir;
 
     bool m_scrollingLocked;
 
     getModule getPluginFactory(const QString &name);
 
     QMap<QString, QString>   pluginInfo;
     QMap<QString, getModule> pluginFactories;
 
     bool m_bOpeningFirstChild;
     KActionCollection *m_collection;
 
     KonqSidebarTree_Internal *d;
 
 Q_SIGNALS:
     void copy();
     void cut();
     void paste();
 
 #ifndef Q_MOC_RUN
 #undef signals
 #define signals public
 #endif
 signals:
 #ifndef Q_MOC_RUN
 #undef signals
 #define signals protected
 #endif
     void openUrlRequest(const QUrl &url, const KParts::OpenUrlArguments &args = KParts::OpenUrlArguments(),
                         const BrowserArguments &browserArgs = BrowserArguments());
     void createNewWindow(const QUrl &url, const KParts::OpenUrlArguments &args = KParts::OpenUrlArguments(),
                          const BrowserArguments &browserArgs = BrowserArguments());
 };
 
 #endif // KONQ_SIDEBARTREE_H