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 class KNewMenu;
  26 class DolphinViewActionHandler;
  27 class QActionGroup;
  28 class KAction;
  29 class KFileItemList;
  30 class KFileItem;
  31 class DolphinPartBrowserExtension;
  32 class DolphinSortFilterProxyModel;
  33 class DolphinRemoteEncoding;
  34 class DolphinModel;
  35 class KDirLister;
  36 class DolphinView;
  37 class KAboutData;
  38
  39 class DolphinPart : public KParts::ReadOnlyPart
  40 {
  41     Q_OBJECT
  42     // Used by konqueror. Technically it means "we want undo enabled if
  43     // there are things in the undo history and the current part is a dolphin part".
  44     // Even though it's konqueror doing the undo...
  45     Q_PROPERTY( bool supportsUndo READ supportsUndo )
  46
  47     Q_PROPERTY( QString currentViewMode READ currentViewMode WRITE setCurrentViewMode )
  48
  49     // Used by konqueror when typing something like /home/dfaure/*.diff in the location bar
  50     Q_PROPERTY( QString nameFilter READ nameFilter WRITE setNameFilter )
  51
  52 public:
  53     explicit DolphinPart(QWidget* parentWidget, QObject* parent, const QVariantList& args);
  54     ~DolphinPart();
  55
  56     static KAboutData* createAboutData();
  57
  58     /**
  59      * Standard KParts::ReadOnlyPart openUrl method.
  60      * Called by Konqueror to view a directory in DolphinPart.
  61      */
  62     virtual bool openUrl(const KUrl& url);
  63
  64     /// see the supportsUndo property
  65     bool supportsUndo() const { return true; }
  66
  67     /**
  68      * Used by konqueror for setting the view mode
  69      * @param viewModeName internal name for the view mode, like "icons"
  70      * Those names come from the Actions line in dolphinpart.desktop,
  71      * and have to match the name of the KActions.
  72      */
  73     void setCurrentViewMode(const QString& viewModeName);
  74
  75     /**
  76      * Used by konqueror for displaying the current view mode.
  77      * @see setCurrentViewMode
  78      */
  79     QString currentViewMode() const;
  80
  81     /// Returns the view owned by this part; used by DolphinPartBrowserExtension
  82     DolphinView* view() { return m_view; }
  83
  84     /**
  85      * Sets a name filter, like *.diff
  86      */
  87     void setNameFilter(const QString& nameFilter);
  88
  89     /**
  90      * Returns the current name filter. Used by konqueror to show it in the URL.
  91      */
  92     QString nameFilter() const { return m_nameFilter; }
  93
  94 protected:
  95     /**
  96      * We reimplement openUrl so no need to implement openFile.
  97      */
  98     virtual bool openFile() { return true; }
  99
 100 Q_SIGNALS:
 101     /**
 102      * Emitted when the view mode changes. Used by konqueror.
 103      */
 104     void viewModeChanged();
 105
 106
 107     /**
 108      * Emitted whenever the current URL is about to be changed.
 109      */
 110     void aboutToOpenURL();
 111
 112 private Q_SLOTS:
 113     void slotCompleted(const KUrl& url);
 114     void slotCanceled(const KUrl& url);
 115     void slotMessage(const QString& msg);
 116     void slotErrorMessage(const QString& msg);
 117     /**
 118      * Shows the information for the item \a item inside the statusbar. If the
 119      * item is null, the default statusbar information is shown.
 120      */
 121     void slotRequestItemInfo(const KFileItem& item);
 122     /**
 123      * Handles clicking on an item
 124      */
 125     void slotItemTriggered(const KFileItem& item);
 126     /**
 127      * Creates a new window showing the content of \a url.
 128      */
 129     void createNewWindow(const KUrl& url);
 130     /**
 131      * Opens the context menu on the current mouse position.
 132      * @item          File item context. If item is null, the context menu
 133      *                should be applied to \a url.
 134      * @url           URL which contains \a item.
 135      * @customActions Actions that should be added to the context menu,
 136      *                if the file item is null.
 137      */
 138     void slotOpenContextMenu(const KFileItem& item,
 139                              const KUrl& url,
 140                              const QList<QAction*>& customActions);
 141
 142     /**
 143      * Asks the host to open the URL \a url if the current view has
 144      * a different URL.
 145      */
 146     void slotRequestUrlChange(const KUrl& url);
 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      * Open a terminal window, starting with the current directory.
 180      */
 181     void slotOpenTerminal();
 182
 183     /**
 184      * Updates the 'Create New...' sub menu, just before it's shown.
 185      */
 186     void updateNewMenu();
 187
 188     /**
 189      * Updates the number of items (= number of files + number of
 190      * directories) in the statusbar. If files are selected, the number
 191      * of selected files and the sum of the filesize is shown.
 192      */
 193     void updateStatusBar();
 194
 195    /**
 196     * Notify container of folder loading progress.
 197     */
 198     void updateProgress(int percent);
 199
 200     void createDirectory();
 201
 202 private:
 203     void createActions();
 204     void createGoAction(const char* name, const char* iconName,
 205                         const QString& text, const QString& url,
 206                         QActionGroup* actionGroup);
 207
 208 private:
 209     DolphinView* m_view;
 210     DolphinViewActionHandler* m_actionHandler;
 211     DolphinRemoteEncoding* m_remoteEncoding;
 212     KDirLister* m_dirLister;
 213     DolphinModel* m_dolphinModel;
 214     DolphinSortFilterProxyModel* m_proxyModel;
 215     DolphinPartBrowserExtension* m_extension;
 216     KNewMenu* m_newMenu;
 217     QString m_nameFilter;
 218     Q_DISABLE_COPY(DolphinPart)
 219 };
 220
 221 class DolphinPartBrowserExtension : public KParts::BrowserExtension
 222 {
 223     Q_OBJECT
 224 public:
 225     DolphinPartBrowserExtension( DolphinPart* part )
 226         : KParts::BrowserExtension( part ), m_part(part) {}
 227
 228 public Q_SLOTS:
 229     void cut();
 230     void copy();
 231     void paste();
 232     void reparseConfiguration();
 233
 234 private:
 235     DolphinPart* m_part;
 236 };
 237
 238 #endif /* DOLPHINPART_H */