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 #include "sidebarpage.h"
  27
  28 #include <config-nepomuk.h>
  29
  30 #include <kfileitemdelegate.h>
  31 #include <konq_fileundomanager.h>
  32 #include <ksortablelist.h>
  33 #include <kxmlguiwindow.h>
  34
  35 #include <QtCore/QList>
  36
  37 class DolphinApplication;
  38 class DolphinViewContainer;
  39 class KNewMenu;
  40 class KUrl;
  41 class QSplitter;
  42
  43 /**
  44  * @short Main window for Dolphin.
  45  *
  46  * Handles the menus, toolbars and Dolphin views.
  47  */
  48 class DolphinMainWindow: public KXmlGuiWindow
  49 {
  50     Q_OBJECT
  51     Q_CLASSINFO("D-Bus Interface", "org.kde.dolphin.MainWindow")
  52     Q_PROPERTY(int id READ getId SCRIPTABLE true)
  53     friend class DolphinApplication;
  54
  55 public:
  56     virtual ~DolphinMainWindow();
  57
  58     /**
  59      * Returns the currently active view.
  60      * All menu actions are applied to this view. When
  61      * having a split view setup, the nonactive view
  62      * is usually shown in darker colors.
  63      */
  64     DolphinViewContainer* activeViewContainer() const;
  65
  66     /**
  67      * Returns true, if the main window contains two instances
  68      * of a view container. The active view constainer can be
  69      * accessed by DolphinMainWindow::activeViewContainer().
  70      */
  71     bool isSplit() const;
  72
  73     /**
  74      * If the main window contains two instances of a view container
  75      * (DolphinMainWindow::isSplit() returns true), then the
  76      * two views get toggled (the right view is on the left, the left
  77      * view on the right).
  78      */
  79     void toggleViews();
  80
  81     /** Renames the item represented by \a oldUrl to \a newUrl. */
  82     void rename(const KUrl& oldUrl, const KUrl& newUrl);
  83
  84     /**
  85      * Refreshes the views of the main window by recreating them dependent from
  86      * the given Dolphin settings.
  87      */
  88     void refreshViews();
  89
  90     /**
  91      * Returns the 'Create New...' sub menu which also can be shared
  92      * with other menus (e. g. a context menu).
  93      */
  94     KNewMenu* newMenu() const;
  95
  96     /**
  97      * Returns the 'Show Menubar' action which can be shared with
  98      * other menus (e. g. a context menu).
  99      */
 100     KAction* showMenuBarAction() const;
 101
 102 public slots:
 103     /**
 104      * Handles the dropping of URLs to the given
 105      * destination. This is only called by the TreeViewSidebarPage.
 106      */
 107     void dropUrls(const KUrl::List& urls,
 108                   const KUrl& destination);
 109
 110     /**
 111      * Returns the main window ID used through DBus.
 112      */
 113     int getId() const;
 114
 115     /**
 116      * Inform all affected dolphin components (sidebars, views) of an URL
 117      * change.
 118      */
 119     void changeUrl(const KUrl& url);
 120
 121     /**
 122      * Inform all affected dolphin components that a selection change is
 123      * requested.
 124      */
 125     void changeSelection(const KFileItemList& selection);
 126
 127     /** Stores all settings and quits Dolphin. */
 128     void quit();
 129
 130 signals:
 131     /**
 132      * Is send if the active view has been changed in
 133      * the split view mode.
 134      */
 135     void activeViewChanged();
 136
 137     /**
 138      * Is sent if the selection of the currently active view has
 139      * been changed.
 140      */
 141     void selectionChanged(const KFileItemList& selection);
 142
 143     /**
 144      * Is sent if the url of the currently active view has
 145      * been changed.
 146      */
 147     void urlChanged(const KUrl& url);
 148
 149     /**
 150      * Is emitted if information of an item is requested to be shown e. g. in the sidebar.
 151      * If item is null, no item information request is pending.
 152      */
 153     void requestItemInfo(const KFileItem& item);
 154
 155 protected:
 156     /** @see QMainWindow::closeEvent() */
 157     virtual void closeEvent(QCloseEvent* event);
 158
 159     /** @see KMainWindow::saveProperties() */
 160     virtual void saveProperties(KConfigGroup& group);
 161
 162     /** @see KMainWindow::readProperties() */
 163     virtual void readProperties(const KConfigGroup& group);
 164
 165 private slots:
 166     /** Opens the dialog for creating a directory. */
 167     void createDir();
 168
 169     /** Updates the 'Create New...' sub menu. */
 170     void updateNewMenu();
 171
 172     /**
 173      * Let the user input a name for the selected item(s) and trigger
 174      * a renaming afterwards.
 175      */
 176     void rename();
 177
 178     /** Moves the selected items of the active view to the trash. */
 179     void moveToTrash();
 180
 181     /** Deletes the selected items of the active view. */
 182     void deleteItems();
 183
 184     /**
 185      * Opens the properties window for the selected items of the
 186      * active view. The properties windows shows information
 187      * like name, size and permissions.
 188      */
 189     void properties();
 190
 191     /**
 192      * Shows the error information from the places model
 193      * in the status bar.
 194      */
 195     void slotHandlePlacesError(const QString &message);
 196
 197     /**
 198      * Updates the state of the 'Undo' menu action dependent
 199      * from the parameter \a available.
 200      */
 201     void slotUndoAvailable(bool available);
 202
 203     /** Sets the text of the 'Undo' menu action to \a text. */
 204     void slotUndoTextChanged(const QString& text);
 205
 206     /** Performs the current undo operation. */
 207     void undo();
 208
 209     /**
 210      * Copies all selected items to the clipboard and marks
 211      * the items as cutted.
 212      */
 213     void cut();
 214
 215     /** Copies all selected items to the clipboard. */
 216     void copy();
 217
 218     /** Pastes the clipboard data to the active view. */
 219     void paste();
 220
 221     /**
 222      * Updates the text of the paste action dependent from
 223      * the number of items which are in the clipboard.
 224      */
 225     void updatePasteAction();
 226
 227     /** Selects all items from the active view. */
 228     void selectAll();
 229
 230     /**
 231      * Inverts the selection of all items of the active view:
 232      * Selected items get nonselected and nonselected items get
 233      * selected.
 234      */
 235     void invertSelection();
 236
 237     /** The current active view is switched to a new view mode. */
 238     void setViewMode(QAction *);
 239
 240     /** The sorting of the current view should be done by the name. */
 241     void sortByName();
 242
 243     /** The sorting of the current view should be done by the size. */
 244     void sortBySize();
 245
 246     /** The sorting of the current view should be done by the date. */
 247     void sortByDate();
 248
 249     /** The sorting of the current view should be done by the permissions. */
 250     void sortByPermissions();
 251
 252     /** The sorting of the current view should be done by the owner. */
 253     void sortByOwner();
 254
 255     /** The sorting of the current view should be done by the group. */
 256     void sortByGroup();
 257
 258     /** The sorting of the current view should be done by the type. */
 259     void sortByType();
 260
 261     /** The sorting of the current view should be done by the rating. */
 262     void sortByRating();
 263
 264     /** The sorting of the current view should be done by tags. */
 265     void sortByTags();
 266
 267     /** Switches between an ascending and descending sorting order. */
 268     void toggleSortOrder();
 269
 270     /** Switches between sorting by categories or not. */
 271     void toggleSortCategorization();
 272
 273     /** Switches between showing the size as additional information for the item or not. */
 274     void toggleSizeInfo();
 275
 276     /** Switchtes between showing the date as additional information for the item or not. */
 277     void toggleDateInfo();
 278
 279     /** Switchtes between showing the permissions as additional information for the item or not. */
 280     void togglePermissionsInfo();
 281
 282     /** Switchtes between showing the owner as additional information for the item or not. */
 283     void toggleOwnerInfo();
 284
 285     /** Switchtes between showing the group as additional information for the item or not. */
 286     void toggleGroupInfo();
 287
 288     /** Switches between showing the MIME type as additional information for the item or not. */
 289     void toggleMimeInfo();
 290
 291     /**
 292      * Switches between one and two views:
 293      * If one view is visible, it will get split into two views.
 294      * If already two views are visible, the nonactivated view gets closed.
 295      */
 296     void toggleSplitView();
 297
 298     /** Reloads the current active view. */
 299     void reloadView();
 300
 301     /** Stops the loading process for the current active view. */
 302     void stopLoading();
 303
 304     /** Switches between showing a preview of the file content and showing the icon. */
 305     void togglePreview();
 306
 307     /**
 308      * Switches between showing and hiding of hidden marked files dependent
 309      * from the current state of the 'Show Hidden Files' menu toggle action.
 310      */
 311     void toggleShowHiddenFiles();
 312
 313     /**
 314      * Toggles between showing and hiding of the filter bar dependent
 315      * from the current state of the 'Show Filter Bar' menu toggle action.
 316      */
 317     void toggleFilterBarVisibility();
 318
 319     /** Increases the size of the current set view mode. */
 320     void zoomIn();
 321
 322     /** Decreases the size of the current set view mode. */
 323     void zoomOut();
 324
 325     /**
 326      * Toggles between edit and brose mode of the navigation bar.
 327      */
 328     void toggleEditLocation();
 329
 330     /**
 331      * Switches to the edit mode of the navigation bar. If the edit mode is
 332      * already active, it is assured that the navigation bar get focused.
 333      */
 334     void editLocation();
 335
 336     /**
 337      * Opens the view properties dialog, which allows to modify the properties
 338      * of the currently active view.
 339      */
 340     void adjustViewProperties();
 341
 342     /** Goes back on step of the URL history. */
 343     void goBack();
 344
 345     /** Goes forward one step of the URL history. */
 346     void goForward();
 347
 348     /** Goes up one hierarchy of the current URL. */
 349     void goUp();
 350
 351     /** Goes to the home URL. */
 352     void goHome();
 353
 354     /** Opens KFind for the current shown directory. */
 355     void findFile();
 356
 357     /** Opens Kompare for 2 selected files. */
 358     void compareFiles();
 359
 360     /**
 361      * Hides the menu bar if it is visible, makes the menu bar
 362      * visible if it is hidden.
 363      */
 364     void toggleShowMenuBar();
 365
 366     /** Opens the settings dialog for Dolphin. */
 367     void editSettings();
 368
 369     /** Updates the state of all 'View' menu actions. */
 370     void slotViewModeChanged();
 371
 372     /** Updates the state of the 'Show preview' menu action. */
 373     void slotShowPreviewChanged();
 374
 375     /** Updates the state of the 'Show hidden files' menu action. */
 376     void slotShowHiddenFilesChanged();
 377
 378     /** Updates the state of the 'Categorized sorting' menu action. */
 379     void slotCategorizedSortingChanged();
 380
 381     /** Updates the state of the 'Sort by' actions. */
 382     void slotSortingChanged(DolphinView::Sorting sorting);
 383
 384     /** Updates the state of the 'Sort Ascending/Descending' action. */
 385     void slotSortOrderChanged(Qt::SortOrder order);
 386
 387     /** Updates the state of the 'Additional Information' actions. */
 388     void slotAdditionalInfoChanged(KFileItemDelegate::InformationList info);
 389
 390     /**
 391      * Updates the state of the 'Edit' menu actions and emits
 392      * the signal selectionChanged().
 393      */
 394     void slotSelectionChanged(const KFileItemList& selection);
 395
 396     /** Emits the signal requestItemInfo(). */
 397     void slotRequestItemInfo(const KFileItem&);
 398
 399     /**
 400      * Updates the state of the 'Back' and 'Forward' menu
 401      * actions corresponding the the current history.
 402      */
 403     void slotHistoryChanged();
 404
 405     /** Updates the state of the 'Show filter bar' menu action. */
 406     void updateFilterBarAction(bool show);
 407
 408     /** Open a new main window. */
 409     void openNewMainWindow();
 410
 411     /** Toggles the active view if two views are shown within the main window. */
 412     void toggleActiveView();
 413
 414     /** Called when the view is doing a file operation, like renaming, copying, moving etc. */
 415     void slotDoingOperation(KonqFileUndoManager::CommandType type);
 416
 417 private:
 418     DolphinMainWindow(int id);
 419     void init();
 420
 421     /**
 422      * Activates the given view, which means that
 423      * all menu actions are applied to this view. When
 424      * having a split view setup, the nonactive view
 425      * is usually shown in darker colors.
 426      */
 427     void setActiveViewContainer(DolphinViewContainer* view);
 428
 429     void setupActions();
 430     void setupDockWidgets();
 431     void updateHistory();
 432     void updateEditActions();
 433     void updateViewActions();
 434     void updateGoActions();
 435     void clearStatusBar();
 436
 437     /**
 438      * Connects the signals from the created DolphinView with
 439      * the index \a viewIndex with the corresponding slots of
 440      * the DolphinMainWindow. This method must be invoked each
 441      * time a DolphinView has been created.
 442      */
 443     void connectViewSignals(int viewIndex);
 444
 445     /**
 446      * Updates the text of the split action:
 447      * If two views are shown, the text is set to "Split",
 448      * otherwise the text is set to "Join". The icon
 449      * is updated to match with the text and the currently active view.
 450      */
 451     void updateSplitAction();
 452
 453     /**
 454      * Helper method for the slots toggleDateInfo(), toggleSizeInfo()
 455      * and toggleMimeInfo(). Applies \a info dependent from the  current
 456      * checked state of the action \a actionName to the file item delegate.
 457      */
 458     void toggleAdditionalInfo(const char* actionName,
 459                               KFileItemDelegate::Information info);
 460
 461 private:
 462     /**
 463      * DolphinMainWindow supports up to two views beside each other.
 464      */
 465     enum ViewIndex
 466     {
 467         PrimaryView = 0,   ///< View shown on the left side of the main window.
 468         SecondaryView = 1  ///< View shown on the left side of the main window.
 469     };
 470
 471     /**
 472      * Implements a custom error handling for the undo manager. This
 473      * assures that all errors are shown in the status bar of Dolphin
 474      * instead as modal error dialog with an OK button.
 475      */
 476     class UndoUiInterface : public KonqFileUndoManager::UiInterface
 477     {
 478     public:
 479         UndoUiInterface(DolphinMainWindow* mainWin);
 480         virtual ~UndoUiInterface();
 481         virtual void jobError(KIO::Job* job);
 482
 483     private:
 484         DolphinMainWindow* m_mainWin;
 485     };
 486
 487     KNewMenu* m_newMenu;
 488     KAction* m_showMenuBar;
 489     QSplitter* m_splitter;
 490     DolphinViewContainer* m_activeViewContainer;
 491     int m_id;
 492
 493     DolphinViewContainer* m_viewContainer[SecondaryView + 1];
 494
 495     /// remember pending undo operations until they are finished
 496     QList<KonqFileUndoManager::CommandType> m_undoCommandTypes;
 497 };
 498
 499 inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const
 500 {
 501     return m_activeViewContainer;
 502 }
 503
 504 inline bool DolphinMainWindow::isSplit() const
 505 {
 506     return m_viewContainer[SecondaryView] != 0;
 507 }
 508
 509 inline KNewMenu* DolphinMainWindow::newMenu() const
 510 {
 511     return m_newMenu;
 512 }
 513
 514 inline KAction* DolphinMainWindow::showMenuBarAction() const
 515 {
 516     return m_showMenuBar;
 517 }
 518
 519 inline int DolphinMainWindow::getId() const
 520 {
 521     return m_id;
 522 }
 523
 524 #endif // DOLPHIN_MAINWINDOW_H
 525