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     /** Performs the current undo operation. */
 175     void undo();
 176
 177     /**
 178      * Copies all selected items to the clipboard and marks
 179      * the items as cutted.
 180      */
 181     void cut();
 182
 183     /** Copies all selected items to the clipboard. */
 184     void copy();
 185
 186     /** Pastes the clipboard data to the active view. */
 187     void paste();
 188
 189     /**
 190      * Updates the text of the paste action dependent from
 191      * the number of items which are in the clipboard.
 192      */
 193     void updatePasteAction();
 194
 195     /** Selects all items from the active view. */
 196     void selectAll();
 197
 198     /**
 199      * Inverts the selection of all items of the active view:
 200      * Selected items get nonselected and nonselected items get
 201      * selected.
 202      */
 203     void invertSelection();
 204
 205     /** The current active view is switched to the icons mode. */
 206     void setIconsView();
 207
 208     /** The current active view is switched to the details mode. */
 209     void setDetailsView();
 210
 211     /** The sorting of the current view should be done by the name. */
 212     void sortByName();
 213
 214     /** The sorting of the current view should be done by the size. */
 215     void sortBySize();
 216
 217     /** The sorting of the current view should be done by the date. */
 218     void sortByDate();
 219
 220     /** Switches between an ascending and descending sorting order. */
 221     void toggleSortOrder();
 222
 223     /**
 224      * Switches between one and two views:
 225      * If one view is visible, it will get split into two views.
 226      * If already two views are visible, the nonactivated view gets closed.
 227      */
 228     void toggleSplitView();
 229
 230     /** Reloads the current active view. */
 231     void reloadView();
 232
 233     /** Stops the loading process for the current active view. */
 234     void stopLoading();
 235
 236     /** Switches between showing a preview of the file content and showing the icon. */
 237     void togglePreview();
 238
 239     /**
 240      * Switches between showing and hiding of hidden marked files dependent
 241      * from the current state of the 'Show Hidden Files' menu toggle action.
 242      */
 243     void toggleShowHiddenFiles();
 244
 245     /**
 246      * Switches between showing and hiding of the filter bar dependent
 247      * from the current state of the 'Show Filter Bar' menu toggle action.
 248      */
 249     void showFilterBar();
 250
 251     /** Increases the size of the current set view mode. */
 252     void zoomIn();
 253
 254     /** Decreases the size of the current set view mode. */
 255     void zoomOut();
 256
 257     /**
 258      * Toggles between edit and brose mode of the navigation bar.
 259      */
 260     void toggleEditLocation();
 261
 262     /**
 263      * Switches to the edit mode of the navigation bar. If the edit mode is
 264      * already active, it is assured that the navigation bar get focused.
 265      */
 266     void editLocation();
 267
 268     /**
 269      * Opens the view properties dialog, which allows to modify the properties
 270      * of the currently active view.
 271      */
 272     void adjustViewProperties();
 273
 274     /** Goes back on step of the Url history. */
 275     void goBack();
 276
 277     /** Goes forward one step of the Url history. */
 278     void goForward();
 279
 280     /** Goes up one hierarchy of the current Url. */
 281     void goUp();
 282
 283     /** Goes to the home Url. */
 284     void goHome();
 285
 286     /** Opens a terminal for the current shown directory. */
 287     void openTerminal();
 288
 289     /** Opens KFind for the current shown directory. */
 290     void findFile();
 291
 292     /** Opens Kompare for 2 selected files. */
 293     void compareFiles();
 294
 295     /** Opens the settings dialog for Dolphin. */
 296     void editSettings();
 297
 298     /** Updates the state of all 'View' menu actions. */
 299     void slotViewModeChanged();
 300
 301     /** Updates the state of the 'Show hidden files' menu action. */
 302     void slotShowHiddenFilesChanged();
 303
 304     /** Updates the state of the 'Sort by' actions. */
 305     void slotSortingChanged(DolphinView::Sorting sorting);
 306
 307     /** Updates the state of the 'Sort Ascending/Descending' action. */
 308     void slotSortOrderChanged(Qt::SortOrder order);
 309
 310     /** Updates the state of the 'Edit' menu actions. */
 311     void slotSelectionChanged();
 312
 313     /**
 314      * Updates the state of the 'Back' and 'Forward' menu
 315      * actions corresponding the the current history.
 316      */
 317     void slotHistoryChanged();
 318
 319     /**
 320      * Updates the caption of the main window and the state
 321      * of all menu actions which depend from a changed Url.
 322      */
 323     void slotUrlChanged(const KUrl& url);
 324
 325     /** Updates the state of the 'Show filter bar' menu action. */
 326     void updateFilterBarAction(bool show);
 327
 328     /** Open a new main window. */
 329     void openNewMainWindow();
 330
 331 private:
 332     DolphinMainWindow();
 333     void init();
 334     void loadSettings();
 335
 336     void setupAccel();
 337     void setupActions();
 338     void setupDockWidgets();
 339     void updateHistory();
 340     void updateEditActions();
 341     void updateViewActions();
 342     void updateGoActions();
 343     void copyUrls(const KUrl::List& source, const KUrl& dest);
 344     void moveUrls(const KUrl::List& source, const KUrl& dest);
 345     void linkUrls(const KUrl::List& source, const KUrl& dest);
 346     void clearStatusBar();
 347
 348     /**
 349      * Connects the signals from the created DolphinView with
 350      * the index \a viewIndex with the corresponding slots of
 351      * the DolphinMainWindow. This method must be invoked each
 352      * time a DolphinView has been created.
 353      */
 354     void connectViewSignals(int viewIndex);
 355
 356 private:
 357     /**
 358      * DolphinMainWindowsupports only one or two views, which
 359      * are handled internally as primary and secondary view.
 360      */
 361     enum ViewIndex
 362     {
 363         PrimaryIdx = 0,
 364         SecondaryIdx = 1
 365     };
 366
 367     /**
 368      * Implements a custom error handling for the undo manager. This
 369      * assures that all errors are shown in the status bar of Dolphin
 370      * instead as modal error dialog with an OK button.
 371      */
 372     class UndoUiInterface : public KonqUndoManager::UiInterface
 373     {
 374     public:
 375         UndoUiInterface(DolphinMainWindow* mainWin);
 376         virtual ~UndoUiInterface();
 377         virtual void jobError(KIO::Job* job);
 378
 379     private:
 380         DolphinMainWindow* m_mainWin;
 381     };
 382
 383     KNewMenu* m_newMenu;
 384     QSplitter* m_splitter;
 385     DolphinView* m_activeView;
 386
 387     DolphinView* m_view[SecondaryIdx + 1];
 388
 389     /// remember pending undo operations until they are finished
 390     QList<KonqOperations::Operation> m_undoOperations;
 391 };
 392
 393 #endif // _DOLPHIN_H_
 394