src/dolphinmainwindow.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at>                  *
   3  *   Copyright (C) 2006 by Stefan Monov <logixoul@gmail.com>               *
   4  *   Copyright (C) 2006 by Cvetoslav Ludmiloff <ludmiloff@gmail.com>       *
   5  *                                                                         *
   6  *   This program is free software; you can redistribute it and/or modify  *
   7  *   it under the terms of the GNU General Public License as published by  *
   8  *   the Free Software Foundation; either version 2 of the License, or     *
   9  *   (at your option) any later version.                                   *
  10  *                                                                         *
  11  *   This program is distributed in the hope that it will be useful,       *
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  14  *   GNU General Public License for more details.                          *
  15  *                                                                         *
  16  *   You should have received a copy of the GNU General Public License     *
  17  *   along with this program; if not, write to the                         *
  18  *   Free Software Foundation, Inc.,                                       *
  19  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  20  ***************************************************************************/
  21
  22 #ifndef _DOLPHIN_MAINWINDOW_H_
  23 #define _DOLPHIN_MAINWINDOW_H_
  24
  25 #include "dolphinview.h"
  26
  27 #include <kmainwindow.h>
  28 #include <ksortablelist.h>
  29 #include <konq_operations.h>
  30 #include <konq_undo.h>
  31
  32 #include <QList>
  33
  34 class KNewMenu;
  35 class KPrinter;
  36 class KUrl;
  37 class QLineEdit;
  38 class KFileIconView;
  39 class KHBox;
  40 class Q3IconViewItem;
  41 class QSplitter;
  42 class KAction;
  43 class UrlNavigator;
  44 class DolphinApplication;
  45
  46 /**
  47  * @short Main window for Dolphin.
  48  *
  49  * Handles the menus, toolbars and Dolphin views.
  50  *
  51  * @author Peter Penz <peter.penz@gmx.at>
  52 */
  53 class DolphinMainWindow: public KMainWindow
  54 {
  55     Q_OBJECT
  56     friend class DolphinApplication;
  57 public:
  58     virtual ~DolphinMainWindow();
  59
  60         /**
  61      * Activates the given view, which means that
  62      * all menu actions are applied to this view. When
  63      * having a split view setup the nonactive view
  64      * is usually shown in darker colors.
  65      */
  66     void setActiveView(DolphinView* view);
  67
  68     /**
  69      * Returns the currently active view. See
  70      * DolphinMainWindow::setActiveView() for more details.
  71      */
  72     DolphinView* activeView() const { return m_activeView; }
  73
  74     /**
  75      * Handles the dropping of Urls to the given
  76      * destination. A context menu with the options
  77      * 'Move Here', 'Copy Here', 'Link Here' and
  78      * 'Cancel' is offered to the user.
  79      * @param urls        List of Urls which have been
  80      *                    dropped.
  81      * @param destination Destination Url, where the
  82      *                    list or Urls should be moved,
  83      *                    copied or linked to.
  84      */
  85     void dropUrls(const KUrl::List& urls,
  86                   const KUrl& destination);
  87
  88     /**
  89      * Refreshs the views of the main window by recreating them dependent from
  90      * the given Dolphin settings.
  91      */
  92     void refreshViews();
  93
  94     /**
  95      * Returns the 'Create New...' sub menu which also can be shared
  96      * with other menus (e. g. a context menu).
  97      */
  98     KNewMenu* newMenu() const { return m_newMenu; }
  99
 100 signals:
 101     /**
 102      * Is send if the active view has been changed in
 103      * the split view mode.
 104      */
 105     void activeViewChanged();
 106
 107     /**
 108      * Is send if the selection of the currently active view has
 109      * been changed.
 110      */
 111     void selectionChanged();
 112
 113 protected:
 114     /** @see QMainWindow::closeEvent */
 115     virtual void closeEvent(QCloseEvent* event);
 116
 117     /**
 118      * This method is called when it is time for the app to save its
 119      * properties for session management purposes.
 120      */
 121     void saveProperties(KConfig*);
 122
 123     /**
 124      * This method is called when this app is restored.  The KConfig
 125      * object points to the session management config file that was saved
 126      * with @ref saveProperties
 127      */
 128     void readProperties(KConfig*);
 129
 130 private slots:
 131     /** Updates the 'Create New...' sub menu. */
 132     void updateNewMenu();
 133
 134     /** Renames the selected item of the active view. */
 135     void rename();
 136
 137     /** Moves the selected items of the active view to the trash. */
 138     void moveToTrash();
 139
 140     /** Deletes the selected items of the active view. */
 141     void deleteItems();
 142
 143     /**
 144      * Opens the properties window for the selected items of the
 145      * active view. The properties windows shows informations
 146      * like name, size and permissions.
 147      */
 148     void properties();
 149
 150     /** Stores all settings and quits Dolphin. */
 151     void quit();
 152
 153     /**
 154      * Shows the error information of the job \a job
 155      * in the status bar.
 156      */
 157     void slotHandleJobError(KJob* job);
 158
 159     /**
 160      * Indicates in the status bar that the delete operation
 161      * of the job \a job has been finished.
 162      */
 163     void slotDeleteFileFinished(KJob* job);
 164
 165     /**
 166      * Updates the state of the 'Undo' menu action dependent
 167      * from the parameter \a available.
 168      */
 169     void slotUndoAvailable(bool available);
 170
 171     /** Sets the text of the 'Undo' menu action to \a text. */
 172     void slotUndoTextChanged(const QString& text);
 173
 174     /**
 175      * Copies all selected items to the clipboard and marks
 176      * the items as cutted.
 177      */
 178     void cut();
 179
 180     /** Copies all selected items to the clipboard. */
 181     void copy();
 182
 183     /** Pastes the clipboard data to the active view. */
 184     void paste();
 185
 186     /**
 187      * Updates the text of the paste action dependent from
 188      * the number of items which are in the clipboard.
 189      */
 190     void updatePasteAction();
 191
 192     /** Selects all items from the active view. */
 193     void selectAll();
 194
 195     /**
 196      * Inverts the selection of all items of the active view:
 197      * Selected items get nonselected and nonselected items get
 198      * selected.
 199      */
 200     void invertSelection();
 201
 202     /** The current active view is switched to the icons mode. */
 203     void setIconsView();
 204
 205     /** The current active view is switched to the details mode. */
 206     void setDetailsView();
 207
 208     /** The sorting of the current view should be done by the name. */
 209     void sortByName();
 210
 211     /** The sorting of the current view should be done by the size. */
 212     void sortBySize();
 213
 214     /** The sorting of the current view should be done by the date. */
 215     void sortByDate();
 216
 217     /** Switches between an ascending and descending sorting order. */
 218     void toggleSortOrder();
 219
 220     /**
 221      * Switches between one and two views:
 222      * If one view is visible, it will get split into two views.
 223      * If already two views are visible, the nonactivated view gets closed.
 224      */
 225     void toggleSplitView();
 226
 227     /** Reloads the current active view. */
 228     void reloadView();
 229
 230     /** Stops the loading process for the current active view. */
 231     void stopLoading();
 232
 233     /** Switches between showing a preview of the file content and showing the icon. */
 234     void togglePreview();
 235
 236     /**
 237      * Switches between showing and hiding of hidden marked files dependent
 238      * from the current state of the 'Show Hidden Files' menu toggle action.
 239      */
 240     void toggleShowHiddenFiles();
 241
 242     /**
 243      * Switches between showing and hiding of the filter bar dependent
 244      * from the current state of the 'Show Filter Bar' menu toggle action.
 245      */
 246     void showFilterBar();
 247
 248     /** Increases the size of the current set view mode. */
 249     void zoomIn();
 250
 251     /** Decreases the size of the current set view mode. */
 252     void zoomOut();
 253
 254     /**
 255      * Toggles between edit and brose mode of the navigation bar.
 256      */
 257     void toggleEditLocation();
 258
 259     /**
 260      * Switches to the edit mode of the navigation bar. If the edit mode is
 261      * already active, it is assured that the navigation bar get focused.
 262      */
 263     void editLocation();
 264
 265     /**
 266      * Opens the view properties dialog, which allows to modify the properties
 267      * of the currently active view.
 268      */
 269     void adjustViewProperties();
 270
 271     /** Goes back on step of the Url history. */
 272     void goBack();
 273
 274     /** Goes forward one step of the Url history. */
 275     void goForward();
 276
 277     /** Goes up one hierarchy of the current Url. */
 278     void goUp();
 279
 280     /** Goes to the home Url. */
 281     void goHome();
 282
 283     /** Opens a terminal for the current shown directory. */
 284     void openTerminal();
 285
 286     /** Opens KFind for the current shown directory. */
 287     void findFile();
 288
 289     /** Opens Kompare for 2 selected files. */
 290     void compareFiles();
 291
 292     /** Opens the settings dialog for Dolphin. */
 293     void editSettings();
 294
 295     /** Updates the state of all 'View' menu actions. */
 296     void slotViewModeChanged();
 297
 298     /** Updates the state of the 'Show hidden files' menu action. */
 299     void slotShowHiddenFilesChanged();
 300
 301     /** Updates the state of the 'Sort by' actions. */
 302     void slotSortingChanged(DolphinView::Sorting sorting);
 303
 304     /** Updates the state of the 'Sort Ascending/Descending' action. */
 305     void slotSortOrderChanged(Qt::SortOrder order);
 306
 307     /** Updates the state of the 'Edit' menu actions. */
 308     void slotSelectionChanged();
 309
 310     /**
 311      * Updates the state of the 'Back' and 'Forward' menu
 312      * actions corresponding the the current history.
 313      */
 314     void slotHistoryChanged();
 315
 316     /**
 317      * Updates the caption of the main window and the state
 318      * of all menu actions which depend from a changed Url.
 319      */
 320     void slotUrlChanged(const KUrl& url);
 321
 322     /** Updates the state of the 'Show filter bar' menu action. */
 323     void updateFilterBarAction(bool show);
 324
 325     /** Open a new main window. */
 326     void openNewMainWindow();
 327
 328 private:
 329     DolphinMainWindow();
 330     void init();
 331     void loadSettings();
 332
 333     void setupAccel();
 334     void setupActions();
 335     void setupDockWidgets();
 336     void updateHistory();
 337     void updateEditActions();
 338     void updateViewActions();
 339     void updateGoActions();
 340     void copyUrls(const KUrl::List& source, const KUrl& dest);
 341     void moveUrls(const KUrl::List& source, const KUrl& dest);
 342     void linkUrls(const KUrl::List& source, const KUrl& dest);
 343     void clearStatusBar();
 344
 345     /**
 346      * Connects the signals from the created DolphinView with
 347      * the index \a viewIndex with the corresponding slots of
 348      * the DolphinMainWindow. This method must be invoked each
 349      * time a DolphinView has been created.
 350      */
 351     void connectViewSignals(int viewIndex);
 352
 353 private:
 354     KNewMenu* m_newMenu;
 355     QSplitter* m_splitter;
 356     DolphinView* m_activeView;
 357
 358     /**
 359      * DolphinMainWindowsupports only one or two views, which
 360      * are handled internally as primary and secondary view.
 361      */
 362     enum ViewIndex
 363     {
 364         PrimaryIdx = 0,
 365         SecondaryIdx = 1
 366     };
 367     DolphinView* m_view[SecondaryIdx + 1];
 368
 369     /// remember pending undo operations until they are finished
 370     QList<KonqOperations::Operation> m_undoOperations;
 371
 372     /**
 373      * Implements a custom error handling for the undo manager. This
 374      * assures that all errors are shown in the status bar of Dolphin
 375      * instead as modal error dialog with an OK button.
 376      */
 377     class UndoUiInterface : public KonqUndoManager::UiInterface {
 378     public:
 379         UndoUiInterface(DolphinMainWindow* mainWin);
 380         virtual ~UndoUiInterface();
 381         virtual void jobError(KIO::Job* job);
 382         virtual bool copiedFileWasModified(const KUrl& src,
 383                                            const KUrl& dest,
 384                                            time_t srcTime,
 385                                            time_t destTime);
 386     private:
 387         DolphinMainWindow* m_mainWin;
 388     };
 389 };
 390
 391 #endif // _DOLPHIN_H_
 392