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
  26 #include <QItemSelectionModel>
  27
  28 class KNewFileMenu;
  29 class DolphinViewActionHandler;
  30 class QActionGroup;
  31 class KAction;
  32 class KFileItemList;
  33 class KFileItem;
  34 class DolphinPartBrowserExtension;
  35 class DolphinSortFilterProxyModel;
  36 class DolphinRemoteEncoding;
  37 class DolphinModel;
  38 class KDirLister;
  39 class DolphinView;
  40 class KAboutData;
  41
  42 class DolphinPart : public KParts::ReadOnlyPart
  43 {
  44     Q_OBJECT
  45     // Used by konqueror. Technically it means "we want undo enabled if
  46     // there are things in the undo history and the current part is a dolphin part".
  47     // Even though it's konqueror doing the undo...
  48     Q_PROPERTY( bool supportsUndo READ supportsUndo )
  49
  50     Q_PROPERTY( QString currentViewMode READ currentViewMode WRITE setCurrentViewMode )
  51
  52     // Used by konqueror when typing something like /home/dfaure/*.diff in the location bar
  53     Q_PROPERTY( QString nameFilter READ nameFilter WRITE setNameFilter )
  54
  55     // Used by konqueror to implement the --select command-line option
  56     Q_PROPERTY( KUrl::List filesToSelect READ filesToSelect WRITE setFilesToSelect )
  57
  58 public:
  59     explicit DolphinPart(QWidget* parentWidget, QObject* parent, const QVariantList& args);
  60     ~DolphinPart();
  61
  62     static KAboutData* createAboutData();
  63
  64     /**
  65      * Standard KParts::ReadOnlyPart openUrl method.
  66      * Called by Konqueror to view a directory in DolphinPart.
  67      */
  68     virtual bool openUrl(const KUrl& url);
  69
  70     /// see the supportsUndo property
  71     bool supportsUndo() const { return true; }
  72
  73     /**
  74      * Used by konqueror for setting the view mode
  75      * @param viewModeName internal name for the view mode, like "icons"
  76      * Those names come from the Actions line in dolphinpart.desktop,
  77      * and have to match the name of the KActions.
  78      */
  79     void setCurrentViewMode(const QString& viewModeName);
  80
  81     /**
  82      * Used by konqueror for displaying the current view mode.
  83      * @see setCurrentViewMode
  84      */
  85     QString currentViewMode() const;
  86
  87     /// Returns the view owned by this part; used by DolphinPartBrowserExtension
  88     DolphinView* view() { return m_view; }
  89
  90     /**
  91      * Sets a name filter, like *.diff
  92      */
  93     void setNameFilter(const QString& nameFilter);
  94
  95     /**
  96      * Returns the current name filter. Used by konqueror to show it in the URL.
  97      */
  98     QString nameFilter() const { return m_nameFilter; }
  99
 100 protected:
 101     /**
 102      * We reimplement openUrl so no need to implement openFile.
 103      */
 104     virtual bool openFile() { return true; }
 105
 106 Q_SIGNALS:
 107     /**
 108      * Emitted when the view mode changes. Used by konqueror.
 109      */
 110     void viewModeChanged();
 111
 112
 113     /**
 114      * Emitted whenever the current URL is about to be changed.
 115      */
 116     void aboutToOpenURL();
 117
 118 private Q_SLOTS:
 119     void slotCompleted(const KUrl& url);
 120     void slotCanceled(const KUrl& url);
 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 slotItemTriggered(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      * @item          File item context. If item is null, the context menu
 139      *                should be applied to \a url.
 140      * @url           URL which contains \a item.
 141      * @customActions Actions that should be added to the context menu,
 142      *                if the file item is null.
 143      */
 144     void slotOpenContextMenu(const KFileItem& item,
 145                              const KUrl& url,
 146                              const QList<QAction*>& customActions);
 147
 148     /**
 149      * Informs the host that we are opening \a url (e.g. after a redirection
 150      * coming from KDirLister).
 151      * Testcase 1: fish://localhost
 152      * Testcase 2: showing a directory that is being renamed by another window (#180156)
 153      */
 154     void slotRedirection(const KUrl& oldUrl, const KUrl& newUrl);
 155
 156     /**
 157      * Updates the state of the 'Edit' menu actions and emits
 158      * the signal selectionChanged().
 159      */
 160     void slotSelectionChanged(const KFileItemList& selection);
 161
 162     /**
 163      * Updates the text of the paste action dependent from
 164      * the number of items which are in the clipboard.
 165      */
 166     void updatePasteAction();
 167
 168     /**
 169      * Connected to all "Go" menu actions provided by DolphinPart
 170      */
 171     void slotGoTriggered(QAction* action);
 172
 173     /**
 174      * Connected to the "editMimeType" action
 175      */
 176     void slotEditMimeType();
 177
 178     /**
 179      * Connected to the "select_items_matching" action.
 180      * Opens a dialog which permits to select all items matching a pattern like "*.jpg".
 181      */
 182     void slotSelectItemsMatchingPattern();
 183
 184     /**
 185      * Connected to the "unselect_items_matching" action.
 186      * Opens a dialog which permits to unselect all items matching a pattern like "*.jpg".
 187      */
 188     void slotUnselectItemsMatchingPattern();
 189
 190     /**
 191      * Open a terminal window, starting with the current directory.
 192      */
 193     void slotOpenTerminal();
 194
 195     /**
 196      * Updates the 'Create New...' sub menu, just before it's shown.
 197      */
 198     void updateNewMenu();
 199
 200     /**
 201      * Updates the number of items (= number of files + number of
 202      * directories) in the statusbar. If files are selected, the number
 203      * of selected files and the sum of the filesize is shown.
 204      */
 205     void updateStatusBar();
 206
 207    /**
 208     * Notify container of folder loading progress.
 209     */
 210     void updateProgress(int percent);
 211
 212     void createDirectory();
 213
 214     /**
 215      * Called by konqueror --select
 216      */
 217     void setFilesToSelect(const KUrl::List& files);
 218     KUrl::List filesToSelect() const { return KUrl::List(); } // silence moc
 219
 220 private:
 221     void createActions();
 222     void createGoAction(const char* name, const char* iconName,
 223                         const QString& text, const QString& url,
 224                         QActionGroup* actionGroup);
 225
 226     void openSelectionDialog(const QString& title, const QString& text,
 227                              QItemSelectionModel::SelectionFlags command);
 228
 229     QItemSelection childrenMatchingPattern(const QModelIndex& parent, const QRegExp& patternRegExp);
 230
 231 private:
 232     DolphinView* m_view;
 233     DolphinViewActionHandler* m_actionHandler;
 234     DolphinRemoteEncoding* m_remoteEncoding;
 235     KDirLister* m_dirLister;
 236     DolphinModel* m_dolphinModel;
 237     DolphinSortFilterProxyModel* m_proxyModel;
 238     DolphinPartBrowserExtension* m_extension;
 239     KNewFileMenu* m_newFileMenu;
 240     QString m_nameFilter;
 241     Q_DISABLE_COPY(DolphinPart)
 242 };
 243
 244 class DolphinPartBrowserExtension : public KParts::BrowserExtension
 245 {
 246     Q_OBJECT
 247 public:
 248     DolphinPartBrowserExtension( DolphinPart* part )
 249         : KParts::BrowserExtension( part ), m_part(part) {}
 250
 251     virtual void restoreState(QDataStream &stream);
 252     virtual void saveState(QDataStream &stream);
 253
 254 public Q_SLOTS:
 255     void cut();
 256     void copy();
 257     void paste();
 258     void pasteTo(const KUrl&);
 259     void reparseConfiguration();
 260
 261 private:
 262     DolphinPart* m_part;
 263 };
 264
 265 #endif /* DOLPHINPART_H */