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     /** Updates the 'Create New...' sub menu. */
 167     void updateNewMenu();
 168
 169     /**
 170      * Let the user input a name for the selected item(s) and trigger
 171      * a renaming afterwards.
 172      */
 173     void rename();
 174
 175     /** Moves the selected items of the active view to the trash. */
 176     void moveToTrash();
 177
 178     /** Deletes the selected items of the active view. */
 179     void deleteItems();
 180
 181     /**
 182      * Opens the properties window for the selected items of the
 183      * active view. The properties windows shows information
 184      * like name, size and permissions.
 185      */
 186     void properties();
 187
 188     /**
 189      * Shows the error information from the places model
 190      * in the status bar.
 191      */
 192     void slotHandlePlacesError(const QString &message);
 193
 194     /**
 195      * Updates the state of the 'Undo' menu action dependent
 196      * from the parameter \a available.
 197      */
 198     void slotUndoAvailable(bool available);
 199
 200     /** Sets the text of the 'Undo' menu action to \a text. */
 201     void slotUndoTextChanged(const QString& text);
 202
 203     /** Performs the current undo operation. */
 204     void undo();
 205
 206     /**
 207      * Copies all selected items to the clipboard and marks
 208      * the items as cutted.
 209      */
 210     void cut();
 211
 212     /** Copies all selected items to the clipboard. */
 213     void copy();
 214
 215     /** Pastes the clipboard data to the active view. */
 216     void paste();
 217
 218     /**
 219      * Updates the text of the paste action dependent from
 220      * the number of items which are in the clipboard.
 221      */
 222     void updatePasteAction();
 223
 224     /** Selects all items from the active view. */
 225     void selectAll();
 226
 227     /**
 228      * Inverts the selection of all items of the active view:
 229      * Selected items get nonselected and nonselected items get
 230      * selected.
 231      */
 232     void invertSelection();
 233
 234     /** The current active view is switched to a new view mode. */
 235     void setViewMode(QAction *);
 236
 237     /** The sorting of the current view should be done by the name. */
 238     void sortByName();
 239
 240     /** The sorting of the current view should be done by the size. */
 241     void sortBySize();
 242
 243     /** The sorting of the current view should be done by the date. */
 244     void sortByDate();
 245
 246     /** The sorting of the current view should be done by the permissions. */
 247     void sortByPermissions();
 248
 249     /** The sorting of the current view should be done by the owner. */
 250     void sortByOwner();
 251
 252     /** The sorting of the current view should be done by the group. */
 253     void sortByGroup();
 254
 255     /** The sorting of the current view should be done by the type. */
 256     void sortByType();
 257
 258     /** The sorting of the current view should be done by the rating. */
 259     void sortByRating();
 260
 261     /** The sorting of the current view should be done by tags. */
 262     void sortByTags();
 263
 264     /** Switches between an ascending and descending sorting order. */
 265     void toggleSortOrder();
 266
 267     /** Switches between sorting by categories or not. */
 268     void toggleSortCategorization();
 269
 270     /** Switches between showing the size as additional information for the item or not. */
 271     void toggleSizeInfo();
 272
 273     /** Switchtes between showing the date as additional information for the item or not. */
 274     void toggleDateInfo();
 275
 276     /** Switchtes between showing the permissions as additional information for the item or not. */
 277     void togglePermissionsInfo();
 278
 279     /** Switchtes between showing the owner as additional information for the item or not. */
 280     void toggleOwnerInfo();
 281
 282     /** Switchtes between showing the group as additional information for the item or not. */
 283     void toggleGroupInfo();
 284
 285     /** Switches between showing the MIME type as additional information for the item or not. */
 286     void toggleMimeInfo();
 287
 288     /**
 289      * Switches between one and two views:
 290      * If one view is visible, it will get split into two views.
 291      * If already two views are visible, the nonactivated view gets closed.
 292      */
 293     void toggleSplitView();
 294
 295     /** Reloads the current active view. */
 296     void reloadView();
 297
 298     /** Stops the loading process for the current active view. */
 299     void stopLoading();
 300
 301     /** Switches between showing a preview of the file content and showing the icon. */
 302     void togglePreview();
 303
 304     /**
 305      * Switches between showing and hiding of hidden marked files dependent
 306      * from the current state of the 'Show Hidden Files' menu toggle action.
 307      */
 308     void toggleShowHiddenFiles();
 309
 310     /**
 311      * Toggles between showing and hiding of the filter bar dependent
 312      * from the current state of the 'Show Filter Bar' menu toggle action.
 313      */
 314     void toggleFilterBarVisibility();
 315
 316     /** Increases the size of the current set view mode. */
 317     void zoomIn();
 318
 319     /** Decreases the size of the current set view mode. */
 320     void zoomOut();
 321
 322     /**
 323      * Toggles between edit and brose mode of the navigation bar.
 324      */
 325     void toggleEditLocation();
 326
 327     /**
 328      * Switches to the edit mode of the navigation bar. If the edit mode is
 329      * already active, it is assured that the navigation bar get focused.
 330      */
 331     void editLocation();
 332
 333     /**
 334      * Opens the view properties dialog, which allows to modify the properties
 335      * of the currently active view.
 336      */
 337     void adjustViewProperties();
 338
 339     /** Goes back on step of the URL history. */
 340     void goBack();
 341
 342     /** Goes forward one step of the URL history. */
 343     void goForward();
 344
 345     /** Goes up one hierarchy of the current URL. */
 346     void goUp();
 347
 348     /** Goes to the home URL. */
 349     void goHome();
 350
 351     /** Opens KFind for the current shown directory. */
 352     void findFile();
 353
 354     /** Opens Kompare for 2 selected files. */
 355     void compareFiles();
 356
 357     /**
 358      * Hides the menu bar if it is visible, makes the menu bar
 359      * visible if it is hidden.
 360      */
 361     void toggleShowMenuBar();
 362
 363     /** Opens the settings dialog for Dolphin. */
 364     void editSettings();
 365
 366     /** Updates the state of all 'View' menu actions. */
 367     void slotViewModeChanged();
 368
 369     /** Updates the state of the 'Show preview' menu action. */
 370     void slotShowPreviewChanged();
 371
 372     /** Updates the state of the 'Show hidden files' menu action. */
 373     void slotShowHiddenFilesChanged();
 374
 375     /** Updates the state of the 'Categorized sorting' menu action. */
 376     void slotCategorizedSortingChanged();
 377
 378     /** Updates the state of the 'Sort by' actions. */
 379     void slotSortingChanged(DolphinView::Sorting sorting);
 380
 381     /** Updates the state of the 'Sort Ascending/Descending' action. */
 382     void slotSortOrderChanged(Qt::SortOrder order);
 383
 384     /** Updates the state of the 'Additional Information' actions. */
 385     void slotAdditionalInfoChanged(KFileItemDelegate::InformationList info);
 386
 387     /**
 388      * Updates the state of the 'Edit' menu actions and emits
 389      * the signal selectionChanged().
 390      */
 391     void slotSelectionChanged(const KFileItemList& selection);
 392
 393     /** Emits the signal requestItemInfo(). */
 394     void slotRequestItemInfo(const KFileItem&);
 395
 396     /**
 397      * Updates the state of the 'Back' and 'Forward' menu
 398      * actions corresponding the the current history.
 399      */
 400     void slotHistoryChanged();
 401
 402     /** Updates the state of the 'Show filter bar' menu action. */
 403     void updateFilterBarAction(bool show);
 404
 405     /** Open a new main window. */
 406     void openNewMainWindow();
 407
 408     /** Toggles the active view if two views are shown within the main window. */
 409     void toggleActiveView();
 410
 411     /** Called when the view is doing a file operation, like renaming, copying, moving etc. */
 412     void slotDoingOperation(KonqFileUndoManager::CommandType type);
 413
 414 private:
 415     DolphinMainWindow(int id);
 416     void init();
 417
 418     /**
 419      * Activates the given view, which means that
 420      * all menu actions are applied to this view. When
 421      * having a split view setup, the nonactive view
 422      * is usually shown in darker colors.
 423      */
 424     void setActiveViewContainer(DolphinViewContainer* view);
 425
 426     void setupActions();
 427     void setupDockWidgets();
 428     void updateHistory();
 429     void updateEditActions();
 430     void updateViewActions();
 431     void updateGoActions();
 432     void clearStatusBar();
 433
 434     /**
 435      * Connects the signals from the created DolphinView with
 436      * the index \a viewIndex with the corresponding slots of
 437      * the DolphinMainWindow. This method must be invoked each
 438      * time a DolphinView has been created.
 439      */
 440     void connectViewSignals(int viewIndex);
 441
 442     /**
 443      * Updates the text of the split action:
 444      * If two views are shown, the text is set to "Split",
 445      * otherwise the text is set to "Join". The icon
 446      * is updated to match with the text and the currently active view.
 447      */
 448     void updateSplitAction();
 449
 450     /**
 451      * Helper method for the slots toggleDateInfo(), toggleSizeInfo()
 452      * and toggleMimeInfo(). Applies \a info dependent from the  current
 453      * checked state of the action \a actionName to the file item delegate.
 454      */
 455     void toggleAdditionalInfo(const char* actionName,
 456                               KFileItemDelegate::Information info);
 457
 458 private:
 459     /**
 460      * DolphinMainWindow supports up to two views beside each other.
 461      */
 462     enum ViewIndex
 463     {
 464         PrimaryView = 0,   ///< View shown on the left side of the main window.
 465         SecondaryView = 1  ///< View shown on the left side of the main window.
 466     };
 467
 468     /**
 469      * Implements a custom error handling for the undo manager. This
 470      * assures that all errors are shown in the status bar of Dolphin
 471      * instead as modal error dialog with an OK button.
 472      */
 473     class UndoUiInterface : public KonqFileUndoManager::UiInterface
 474     {
 475     public:
 476         UndoUiInterface(DolphinMainWindow* mainWin);
 477         virtual ~UndoUiInterface();
 478         virtual void jobError(KIO::Job* job);
 479
 480     private:
 481         DolphinMainWindow* m_mainWin;
 482     };
 483
 484     KNewMenu* m_newMenu;
 485     KAction* m_showMenuBar;
 486     QSplitter* m_splitter;
 487     DolphinViewContainer* m_activeViewContainer;
 488     int m_id;
 489
 490     DolphinViewContainer* m_viewContainer[SecondaryView + 1];
 491
 492     /// remember pending undo operations until they are finished
 493     QList<KonqFileUndoManager::CommandType> m_undoCommandTypes;
 494 };
 495
 496 inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const
 497 {
 498     return m_activeViewContainer;
 499 }
 500
 501 inline bool DolphinMainWindow::isSplit() const
 502 {
 503     return m_viewContainer[SecondaryView] != 0;
 504 }
 505
 506 inline KNewMenu* DolphinMainWindow::newMenu() const
 507 {
 508     return m_newMenu;
 509 }
 510
 511 inline KAction* DolphinMainWindow::showMenuBarAction() const
 512 {
 513     return m_showMenuBar;
 514 }
 515
 516 inline int DolphinMainWindow::getId() const
 517 {
 518     return m_id;
 519 }
 520
 521 #endif // DOLPHIN_MAINWINDOW_H
 522