src/dolphinpart.h

   1 /* This file is part of the KDE project
   2    Copyright (c) 2007 David Faure <faure@kde.org>
   3
   4    This library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Library General Public
   6    License as published by the Free Software Foundation; either
   7    version 2 of the License, or (at your option) any later version.
   8
   9    This library is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Library General Public License for more details.
  13
  14    You should have received a copy of the GNU Library General Public License
  15    along with this library; see the file COPYING.LIB.  If not, write to
  16    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17    Boston, MA 02110-1301, USA.
  18 */
  19
  20 #ifndef DOLPHINPART_H
  21 #define DOLPHINPART_H
  22
  23 #include <kparts/part.h>
  24 #include <kparts/browserextension.h>
  25 #include <kparts/fileinfoextension.h>
  26 #include <kparts/listingextension.h>
  27
  28 #include <QItemSelectionModel>
  29
  30 class KNewFileMenu;
  31 class DolphinViewActionHandler;
  32 class QActionGroup;
  33 class KAction;
  34 class KFileItemList;
  35 class KFileItem;
  36 class DolphinPartBrowserExtension;
  37 class DolphinSortFilterProxyModel;
  38 class DolphinRemoteEncoding;
  39 class DolphinModel;
  40 class KDirLister;
  41 class DolphinView;
  42 class KAboutData;
  43
  44 class DolphinPart : public KParts::ReadOnlyPart
  45 {
  46     Q_OBJECT
  47     // Used by konqueror. Technically it means "we want undo enabled if
  48     // there are things in the undo history and the current part is a dolphin part".
  49     // Even though it's konqueror doing the undo...
  50     Q_PROPERTY( bool supportsUndo READ supportsUndo )
  51
  52     Q_PROPERTY( QString currentViewMode READ currentViewMode WRITE setCurrentViewMode )
  53
  54     // Used by konqueror when typing something like /home/dfaure/*.diff in the location bar
  55     Q_PROPERTY( QString nameFilter READ nameFilter WRITE setNameFilter )
  56
  57     // Used by konqueror to implement the --select command-line option
  58     Q_PROPERTY( KUrl::List filesToSelect READ filesToSelect WRITE setFilesToSelect )
  59
  60 public:
  61     explicit DolphinPart(QWidget* parentWidget, QObject* parent, const QVariantList& args);
  62     ~DolphinPart();
  63
  64     static KAboutData* createAboutData();
  65
  66     /**
  67      * Standard KParts::ReadOnlyPart openUrl method.
  68      * Called by Konqueror to view a directory in DolphinPart.
  69      */
  70     virtual bool openUrl(const KUrl& url);
  71
  72     /// see the supportsUndo property
  73     bool supportsUndo() const { return true; }
  74
  75     /**
  76      * Used by konqueror for setting the view mode
  77      * @param viewModeName internal name for the view mode, like "icons"
  78      * Those names come from the Actions line in dolphinpart.desktop,
  79      * and have to match the name of the KActions.
  80      */
  81     void setCurrentViewMode(const QString& viewModeName);
  82
  83     /**
  84      * Used by konqueror for displaying the current view mode.
  85      * @see setCurrentViewMode
  86      */
  87     QString currentViewMode() const;
  88
  89     /// Returns the view owned by this part; used by DolphinPartBrowserExtension
  90     DolphinView* view() { return m_view; }
  91
  92     /**
  93      * Sets a name filter, like *.diff
  94      */
  95     void setNameFilter(const QString& nameFilter);
  96
  97     /**
  98      * Returns the current name filter. Used by konqueror to show it in the URL.
  99      */
 100     QString nameFilter() const { return m_nameFilter; }
 101
 102 protected:
 103     /**
 104      * We reimplement openUrl so no need to implement openFile.
 105      */
 106     virtual bool openFile() { return true; }
 107
 108 Q_SIGNALS:
 109     /**
 110      * Emitted when the view mode changes. Used by konqueror.
 111      */
 112     void viewModeChanged();
 113
 114
 115     /**
 116      * Emitted whenever the current URL is about to be changed.
 117      */
 118     void aboutToOpenURL();
 119
 120 private Q_SLOTS:
 121     void slotMessage(const QString& msg);
 122     void slotErrorMessage(const QString& msg);
 123     /**
 124      * Shows the information for the item \a item inside the statusbar. If the
 125      * item is null, the default statusbar information is shown.
 126      */
 127     void slotRequestItemInfo(const KFileItem& item);
 128     /**
 129      * Handles clicking on an item
 130      */
 131     void slotItemActivated(const KFileItem& item);
 132     /**
 133      * Creates a new window showing the content of \a url.
 134      */
 135     void createNewWindow(const KUrl& url);
 136     /**
 137      * Opens the context menu on the current mouse position.
 138      * @pos           Position in screen coordinates.
 139      * @item          File item context. If item is null, the context menu
 140      *                should be applied to \a url.
 141      * @url           URL which contains \a item.
 142      * @customActions Actions that should be added to the context menu,
 143      *                if the file item is null.
 144      */
 145     void slotOpenContextMenu(const QPoint& pos,
 146                              const KFileItem& item,
 147                              const KUrl& url,
 148                              const QList<QAction*>& customActions);
 149
 150     /**
 151      * Informs the host that we are opening \a url (e.g. after a redirection
 152      * coming from KDirLister).
 153      * Testcase 1: fish://localhost
 154      * Testcase 2: showing a directory that is being renamed by another window (#180156)
 155      */
 156     void slotDirectoryRedirection(const KUrl& oldUrl, const KUrl& newUrl);
 157
 158     /**
 159      * Updates the state of the 'Edit' menu actions and emits
 160      * the signal selectionChanged().
 161      */
 162     void slotSelectionChanged(const KFileItemList& selection);
 163
 164     /**
 165      * Updates the text of the paste action dependent from
 166      * the number of items which are in the clipboard.
 167      */
 168     void updatePasteAction();
 169
 170     /**
 171      * Connected to all "Go" menu actions provided by DolphinPart
 172      */
 173     void slotGoTriggered(QAction* action);
 174
 175     /**
 176      * Connected to the "editMimeType" action
 177      */
 178     void slotEditMimeType();
 179
 180     /**
 181      * Connected to the "select_items_matching" action.
 182      * Opens a dialog which permits to select all items matching a pattern like "*.jpg".
 183      */
 184     void slotSelectItemsMatchingPattern();
 185
 186     /**
 187      * Connected to the "unselect_items_matching" action.
 188      * Opens a dialog which permits to unselect all items matching a pattern like "*.jpg".
 189      */
 190     void slotUnselectItemsMatchingPattern();
 191
 192     /**
 193      * Open a terminal window, starting with the current directory.
 194      */
 195     void slotOpenTerminal();
 196
 197     /**
 198      * Open KFind with the current path.
 199      */
 200     void slotFindFile();
 201
 202     /**
 203      * Updates the 'Create New...' sub menu, just before it's shown.
 204      */
 205     void updateNewMenu();
 206
 207     /**
 208      * Updates the number of items (= number of files + number of
 209      * directories) in the statusbar. If files are selected, the number
 210      * of selected files and the sum of the filesize is shown.
 211      */
 212     void updateStatusBar();
 213
 214    /**
 215     * Notify container of folder loading progress.
 216     */
 217     void updateProgress(int percent);
 218
 219     void createDirectory();
 220
 221     /**
 222      * Called by konqueror --select
 223      */
 224     void setFilesToSelect(const KUrl::List& files);
 225     KUrl::List filesToSelect() const { return KUrl::List(); } // silence moc
 226
 227 private:
 228     void createActions();
 229     void createGoAction(const char* name, const char* iconName,
 230                         const QString& text, const QString& url,
 231                         QActionGroup* actionGroup);
 232
 233     void openSelectionDialog(const QString& title, const QString& text,
 234                              bool selectItems);
 235
 236 private:
 237     DolphinView* m_view;
 238     DolphinViewActionHandler* m_actionHandler;
 239     DolphinRemoteEncoding* m_remoteEncoding;
 240     DolphinPartBrowserExtension* m_extension;
 241     KNewFileMenu* m_newFileMenu;
 242     KAction* m_findFileAction;
 243     KAction* m_openTerminalAction;
 244     QString m_nameFilter;
 245     Q_DISABLE_COPY(DolphinPart)
 246 };
 247
 248 class DolphinPartBrowserExtension : public KParts::BrowserExtension
 249 {
 250     Q_OBJECT
 251 public:
 252     DolphinPartBrowserExtension( DolphinPart* part )
 253         : KParts::BrowserExtension( part ), m_part(part) {}
 254
 255     virtual void restoreState(QDataStream &stream);
 256     virtual void saveState(QDataStream &stream);
 257
 258 public Q_SLOTS:
 259     void cut();
 260     void copy();
 261     void paste();
 262     void pasteTo(const KUrl&);
 263     void reparseConfiguration();
 264
 265 private:
 266     DolphinPart* m_part;
 267 };
 268
 269
 270 class DolphinPartFileInfoExtension : public KParts::FileInfoExtension
 271 {
 272     Q_OBJECT
 273
 274 public:
 275     DolphinPartFileInfoExtension(DolphinPart* part);
 276
 277     virtual QueryModes supportedQueryModes() const;
 278     virtual bool hasSelection() const;
 279
 280     virtual KFileItemList queryFor(QueryMode mode) const;
 281 protected:
 282     DolphinPart* part() const;
 283 };
 284
 285 class DolphinPartListingFilterExtension : public KParts::ListingFilterExtension
 286 {
 287     Q_OBJECT
 288
 289 public:
 290     DolphinPartListingFilterExtension (DolphinPart* part);
 291     virtual FilterModes supportedFilterModes() const;
 292     virtual bool supportsMultipleFilters (FilterMode mode) const;
 293     virtual QVariant filter (FilterMode mode) const;
 294     virtual void setFilter (FilterMode mode, const QVariant& filter);
 295
 296 private:
 297     DolphinPart* m_part;
 298 };
 299
 300 class DolphinPartListingNotificationExtension : public KParts::ListingNotificationExtension
 301 {
 302     Q_OBJECT
 303
 304 public:
 305     DolphinPartListingNotificationExtension(DolphinPart* part);
 306     virtual NotificationEventTypes supportedNotificationEventTypes() const;
 307
 308 public Q_SLOTS:
 309    void slotNewItems(const KFileItemList&);
 310    void slotItemsDeleted(const KFileItemList&);
 311 };
 312
 313 #endif /* DOLPHINPART_H */