X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/b8572433e25a9118b38ac1271a8c435cf0930bc0..bd47eb2e6d:/src/dolphinmainwindow.h diff --git a/src/dolphinmainwindow.h b/src/dolphinmainwindow.h index c2beb202f..634c2a9e7 100644 --- a/src/dolphinmainwindow.h +++ b/src/dolphinmainwindow.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2006 by Peter Penz * + * Copyright (C) 2006 by Peter Penz * * Copyright (C) 2006 by Stefan Monov * * Copyright (C) 2006 by Cvetoslav Ludmiloff * * * @@ -19,172 +19,180 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * ***************************************************************************/ -#ifndef _DOLPHIN_MAINWINDOW_H_ -#define _DOLPHIN_MAINWINDOW_H_ +#ifndef DOLPHIN_MAINWINDOW_H +#define DOLPHIN_MAINWINDOW_H -#include -#include - -#include - -#include "dolphinview.h" -#include "undomanager.h" // for DolphinCommand::Type +#include -class KPrinter; -class KUrl; -class QLineEdit; -class KFileIconView; -class KHBox; -class Q3IconViewItem; -class QSplitter; -class KAction; -class UrlNavigator; -class DolphinApplication; +#include +#include +#include +#include +#include + +#include +#include + +typedef KIO::FileUndoManager::CommandType CommandType; + +class DolphinViewActionHandler; +class DolphinSettingsDialog; +class DolphinViewContainer; +class DolphinRemoteEncoding; +class DolphinTabWidget; +class KFileItem; +class KFileItemList; +class KJob; +class KNewFileMenu; +class QToolButton; +class QIcon; +class PlacesPanel; +class TerminalPanel; /** * @short Main window for Dolphin. * * Handles the menus, toolbars and Dolphin views. - * - * @author Peter Penz -*/ -class DolphinMainWindow: public KMainWindow + */ +class DolphinMainWindow: public KXmlGuiWindow { Q_OBJECT - friend class DolphinApplication; + Q_CLASSINFO("D-Bus Interface", "org.kde.dolphin.MainWindow") + Q_PROPERTY(int id READ getId SCRIPTABLE true) + public: + DolphinMainWindow(); virtual ~DolphinMainWindow(); - /** - * Activates the given view, which means that - * all menu actions are applied to this view. When - * having a split view setup the nonactive view + /** + * Returns the currently active view. + * All menu actions are applied to this view. When + * having a split view setup, the nonactive view * is usually shown in darker colors. */ - void setActiveView(DolphinView* view); + DolphinViewContainer* activeViewContainer() const; /** - * Returns the currently active view. See - * DolphinMainWindow::setActiveView() for more details. + * Opens each directory in \p dirs in a separate tab. If \a splitView is set, + * 2 directories are collected within one tab. + * \pre \a dirs must contain at least one url. */ - DolphinView* activeView() const { return m_activeView; } + void openDirectories(const QList &dirs, bool splitView); /** - * Handles the dropping of Urls to the given - * destination. A context menu with the options - * 'Move Here', 'Copy Here', 'Link Here' and - * 'Cancel' is offered to the user. - * @param urls List of Urls which have been - * dropped. - * @param destination Destination Url, where the - * list or Urls should be moved, - * copied or linked to. + * Opens the directories which contain the files \p files and selects all files. + * If \a splitView is set, 2 directories are collected within one tab. + * \pre \a files must contain at least one url. */ - void dropUrls(const KUrl::List& urls, - const KUrl& destination); + void openFiles(const QList& files, bool splitView); /** - * Returns the list of actions which are part of the file group - * of the 'Create New...' sub menu. Usually the list contains actions - * for creating folders, text files, HTML files etc. + * Returns the 'Create New...' sub menu which also can be shared + * with other menus (e. g. a context menu). */ - QLinkedList fileGroupActions() const { return m_fileGroupActions; } + KNewFileMenu* newFileMenu() const; + + void setTabsToHomeIfMountPathOpen(const QString& mountPath); +public slots: /** - * Refreshs the views of the main window by recreating them dependent from - * the given Dolphin settings. + * Pastes the clipboard data into the currently selected folder + * of the active view. If not exactly one folder is selected, + * no pasting is done at all. */ - void refreshViews(); + void pasteIntoFolder(); -signals: /** - * Is send if the active view has been changed in - * the split view mode. + * Returns the main window ID used through DBus. */ - void activeViewChanged(); + int getId() const; /** - * Is send if the selection of the currently active view has - * been changed. + * Implementation of the MainWindowAdaptor/QDBusAbstractAdaptor interface. + * Inform all affected dolphin components (panels, views) of an URL + * change. */ - void selectionChanged(); + void changeUrl(const QUrl& url); -protected: - /** @see QMainWindow::closeEvent */ - virtual void closeEvent(QCloseEvent* event); + /** + * The current directory of the Terminal Panel has changed, probably because + * the user entered a 'cd' command. This slot calls changeUrl(url) and makes + * sure that the panel keeps the keyboard focus. + */ + void slotTerminalDirectoryChanged(const QUrl& url); + /** Stores all settings and quits Dolphin. */ + void quit(); + +signals: /** - * This method is called when it is time for the app to save its - * properties for session management purposes. + * Is sent if the selection of the currently active view has + * been changed. */ - void saveProperties(KConfig*); + void selectionChanged(const KFileItemList& selection); /** - * This method is called when this app is restored. The KConfig - * object points to the session management config file that was saved - * with @ref saveProperties + * Is sent if the url of the currently active view has + * been changed. */ - void readProperties(KConfig*); + void urlChanged(const QUrl& url); -private slots: - /** Opens an input dialog for creating a new folder. */ - void createFolder(); + /** + * Is emitted if information of an item is requested to be shown e. g. in the panel. + * If item is null, no item information request is pending. + */ + void requestItemInfo(const KFileItem& item); - /** Creates a file with the MIME type given by the sender. */ - void createFile(); + /** + * Is emitted if the settings have been changed. + */ + void settingsChanged(); - /** Renames the selected item of the active view. */ - void rename(); +protected: + /** @see QWidget::showEvent() */ + virtual void showEvent(QShowEvent* event) Q_DECL_OVERRIDE; + + /** @see QMainWindow::closeEvent() */ + virtual void closeEvent(QCloseEvent* event) Q_DECL_OVERRIDE; - /** Moves the selected items of the active view to the trash. */ - void moveToTrash(); + /** @see KMainWindow::saveProperties() */ + virtual void saveProperties(KConfigGroup& group) Q_DECL_OVERRIDE; - /** Deletes the selected items of the active view. */ - void deleteItems(); + /** @see KMainWindow::readProperties() */ + virtual void readProperties(const KConfigGroup& group) Q_DECL_OVERRIDE; +private slots: /** - * Opens the properties window for the selected items of the - * active view. The properties windows shows informations - * like name, size and permissions. + * Refreshes the views of the main window by recreating them according to + * the given Dolphin settings. */ - void properties(); + void refreshViews(); - /** Stores all settings and quits Dolphin. */ - void quit(); + void clearStatusBar(); - /** - * Shows the error information of the job \a job - * in the status bar. - */ - void slotHandleJobError(KJob* job); + /** Updates the 'Create New...' sub menu. */ + void updateNewMenu(); - /** - * Indicates in the status bar that the delete operation - * of the job \a job has been finished. - */ - void slotDeleteFileFinished(KJob* job); + void createDirectory(); + + /** Shows the error message in the status bar of the active view. */ + void showErrorMessage(const QString& message); /** * Updates the state of the 'Undo' menu action dependent - * from the parameter \a available. + * on the parameter \a available. */ void slotUndoAvailable(bool available); /** Sets the text of the 'Undo' menu action to \a text. */ void slotUndoTextChanged(const QString& text); - /** - * Updates the state of the 'Redo' menu action dependent - * from the parameter \a available. - */ - void slotRedoAvailable(bool available); - - /** Sets the text of the 'Redo' menu action to \a text. */ - void slotRedoTextChanged(const QString& text); + /** Performs the current undo operation. */ + void undo(); /** * Copies all selected items to the clipboard and marks - * the items as cutted. + * the items as cut. */ void cut(); @@ -194,8 +202,11 @@ private slots: /** Pastes the clipboard data to the active view. */ void paste(); + /** Replaces the URL navigator by a search box to find files. */ + void find(); + /** - * Updates the text of the paste action dependent from + * Updates the text of the paste action dependent on * the number of items which are in the clipboard. */ void updatePasteAction(); @@ -210,238 +221,320 @@ private slots: */ void invertSelection(); - /** The current active view is switched to the icons mode. */ - void setIconsView(); - - /** The current active view is switched to the details mode. */ - void setDetailsView(); - - /** The sorting of the current view should be done by the name. */ - void sortByName(); - - /** The sorting of the current view should be done by the size. */ - void sortBySize(); - - /** The sorting of the current view should be done by the date. */ - void sortByDate(); - - /** Switches between an ascending and descending sorting order. */ - void toggleSortOrder(); - /** * Switches between one and two views: * If one view is visible, it will get split into two views. - * If already two views are visible, the nonactivated view gets closed. + * If already two views are visible, the active view gets closed. */ void toggleSplitView(); - /** Reloads the current active view. */ + /** Dedicated action to open the stash:/ ioslave in split view. */ + void toggleSplitStash(); + + /** Reloads the currently active view. */ void reloadView(); - /** Stops the loading process for the current active view. */ + /** Stops the loading process for the currently active view. */ void stopLoading(); - /** Switches between showing a preview of the file content and showing the icon. */ - void togglePreview(); + void enableStopAction(); + void disableStopAction(); - /** - * Switches between showing and hiding of hidden marked files dependent - * from the current state of the 'Show Hidden Files' menu toggle action. - */ - void toggleShowHiddenFiles(); - - /** - * Switches between showing and hiding of the filter bar dependent - * from the current state of the 'Show Filter Bar' menu toggle action. - */ void showFilterBar(); - /** Increases the size of the current set view mode. */ - void zoomIn(); - - /** Decreases the size of the current set view mode. */ - void zoomOut(); - /** - * Toggles between edit and brose mode of the navigation bar. + * Toggles between edit and browse mode of the navigation bar. */ void toggleEditLocation(); /** - * Switches to the edit mode of the navigation bar. If the edit mode is + * Switches to the edit mode of the navigation bar and selects + * the whole URL, so that it can be replaced by the user. If the edit mode is * already active, it is assured that the navigation bar get focused. */ - void editLocation(); + void replaceLocation(); /** - * Opens the view properties dialog, which allows to modify the properties - * of the currently active view. + * Toggles the state of the panels between a locked and unlocked layout. */ - void adjustViewProperties(); + void togglePanelLockState(); - /** Goes back on step of the Url history. */ + /** Goes back one step of the URL history. */ void goBack(); - /** Goes forward one step of the Url history. */ + /** Goes forward one step of the URL history. */ void goForward(); - /** Goes up one hierarchy of the current Url. */ + /** Goes up one hierarchy of the current URL. */ void goUp(); - /** Goes to the home Url. */ + /** Changes the location to the home URL. */ void goHome(); - /** Opens a terminal for the current shown directory. */ - void openTerminal(); + /** Open the previous URL in the URL history in a new tab. */ + void goBackInNewTab(); + + /** Open the next URL in the URL history in a new tab. */ + void goForwardInNewTab(); - /** Opens KFind for the current shown directory. */ - void findFile(); + /** Open the URL one hierarchy above the current URL in a new tab. */ + void goUpInNewTab(); + + /** * Open the home URL in a new tab. */ + void goHomeInNewTab(); /** Opens Kompare for 2 selected files. */ void compareFiles(); + /** + * Hides the menu bar if it is visible, makes the menu bar + * visible if it is hidden. + */ + void toggleShowMenuBar(); + + /** Opens a terminal window for the current location. */ + void openTerminal(); + /** Opens the settings dialog for Dolphin. */ void editSettings(); + /** Updates the state of the 'Show Full Location' action. */ + void slotEditableStateChanged(bool editable); + /** - * Adds the undo operation given by \a job - * to the UndoManager. + * Updates the state of the 'Edit' menu actions and emits + * the signal selectionChanged(). */ - void addUndoOperation(KJob* job); + void slotSelectionChanged(const KFileItemList& selection); - /** Updates the state of all 'View' menu actions. */ - void slotViewModeChanged(); + /** + * Updates the state of the 'Back' and 'Forward' menu + * actions corresponding to the current history. + */ + void updateHistory(); - /** Updates the state of the 'Show hidden files' menu action. */ - void slotShowHiddenFilesChanged(); + /** Updates the state of the 'Show filter bar' menu action. */ + void updateFilterBarAction(bool show); - /** Updates the state of the 'Sort by' actions. */ - void slotSortingChanged(DolphinView::Sorting sorting); + /** Open a new main window. */ + void openNewMainWindow(); - /** Updates the state of the 'Sort Ascending/Descending' action. */ - void slotSortOrderChanged(Qt::SortOrder order); + /** + * Opens a new view with the current URL that is part of a tab and + * activates it. + */ + void openNewActivatedTab(); - /** Updates the state of the 'Edit' menu actions. */ - void slotSelectionChanged(); + /** + * Opens a new tab in the background showing the URL \a url. + */ + void openNewTab(const QUrl& url); /** - * Updates the state of the 'Back' and 'Forward' menu - * actions corresponding the the current history. + * Opens the selected folder in a new tab. */ - void slotHistoryChanged(); + void openInNewTab(); /** - * Updates the caption of the main window and the state - * of all menu actions which depend from a changed Url. + * Opens the selected folder in a new window. */ - void slotUrlChanged(const KUrl& url); + void openInNewWindow(); - /** Updates the state of the 'Show filter bar' menu action. */ - void updateFilterBarAction(bool show); + /** + * Indicates in the statusbar that the execution of the command \a command + * has been finished. + */ + void showCommand(CommandType command); + + /** + * If the URL can be listed, open it in the current view, otherwise + * run it through KRun. + */ + void handleUrl(const QUrl& url); - /** Executes the redo operation (see UndoManager::Redo ()). */ - void redo(); + /** + * handleUrl() can trigger a stat job to see if the url can actually + * be listed. + */ + void slotHandleUrlStatFinished(KJob* job); - /** Executes the undo operation (see UndoManager::Undo()). */ - void undo(); + /** + * Is invoked when the write state of a folder has been changed and + * enables/disables the "Create New..." menu entry. + */ + void slotWriteStateChanged(bool isFolderWritable); - /** Open a new main window. */ - void openNewMainWindow(); + /** + * Opens the context menu on the current mouse position. + * @pos Position in screen coordinates. + * @item File item context. If item is null, the context menu + * should be applied to \a url. + * @url URL which contains \a item. + * @customActions Actions that should be added to the context menu, + * if the file item is null. + */ + void openContextMenu(const QPoint& pos, + const KFileItem& item, + const QUrl& url, + const QList& customActions); + + void updateControlMenu(); + void updateToolBar(); + void slotControlButtonDeleted(); /** - * Moves the items indicated by m_droppedUrls to the URL - * m_destination. + * Is called if the user clicked an item in the Places Panel. + * Reloads the view if \a url is the current URL already, and changes the + * current URL otherwise. */ - void moveDroppedItems(); + void slotPlaceActivated(const QUrl& url); /** - * Copies the items indicated by m_droppedUrls to the URL - * m_destination. + * Is called if the another view has been activated by changing the current + * tab or activating another view in split-view mode. + * + * Activates the given view, which means that all menu actions are applied + * to this view. When having a split view setup, the nonactive view is + * usually shown in darker colors. */ - void copyDroppedItems(); + void activeViewChanged(DolphinViewContainer* viewContainer); + + void closedTabsCountChanged(unsigned int count); /** - * Links the items indicated by m_droppedUrls to the URL - * m_destination. + * Is called if a new tab has been opened or a tab has been closed to + * enable/disable the tab actions. */ - void linkDroppedItems(); + void tabCountChanged(int count); -private: - DolphinMainWindow(); - void init(); - void loadSettings(); + /** + * Sets the window caption to url.fileName() if this is non-empty, + * "/" if the URL is "file:///", and url.protocol() otherwise. + */ + void setUrlAsCaption(const QUrl& url); + + /** + * This slot is called when the user requested to unmount a removable media + * from the places menu + */ + void slotStorageTearDownFromPlacesRequested(const QString& mountPath); - void setupAccel(); + /** + * This slot is called when the user requested to unmount a removable media + * _not_ from the dolphin's places menu (from the notification area for e.g.) + * This slot is basically connected to each removable device's + * Solid::StorageAccess::teardownRequested(const QString & udi) + * signal through the places panel. + */ + void slotStorageTearDownExternallyRequested(const QString& mountPath); + + /** + * Is called when the view has finished loading the directory. + */ + void slotDirectoryLoadingCompleted(); + + /** + * Is called when the user middle clicks a toolbar button. + * + * Here middle clicking Back/Forward/Up/Home will open the resulting + * folder in a new tab. + */ + void slotToolBarActionMiddleClicked(QAction *action); + +private: void setupActions(); void setupDockWidgets(); - void setupCreateNewMenuActions(); - void updateHistory(); void updateEditActions(); void updateViewActions(); void updateGoActions(); - void copyUrls(const KUrl::List& source, const KUrl& dest); - void moveUrls(const KUrl::List& source, const KUrl& dest); - void addPendingUndoJob(KIO::Job* job, - DolphinCommand::Type commandType, - const KUrl::List& source, - const KUrl& dest); - void clearStatusBar(); + + void createControlButton(); + void deleteControlButton(); + + /** + * Adds the action \p action to the menu \p menu in + * case if it has not added already to the toolbar. + * @return True if the action has been added to the menu. + */ + bool addActionToMenu(QAction* action, QMenu* menu); /** * Connects the signals from the created DolphinView with - * the index \a viewIndex with the corresponding slots of + * the DolphinViewContainer \a container with the corresponding slots of * the DolphinMainWindow. This method must be invoked each * time a DolphinView has been created. */ - void connectViewSignals(int viewIndex); + void connectViewSignals(DolphinViewContainer* container); -private: - QSplitter* m_splitter; - DolphinView* m_activeView; + /** + * Updates the text of the split action: + * If two views are shown, the text is set to "Split", + * otherwise the text is set to "Join". The icon + * is updated to match with the text and the currently active view. + */ + void updateSplitAction(); - KUrl m_dropDestination; - KUrl::List m_droppedUrls; + bool isKompareInstalled() const; /** - * DolphinMainWindowsupports only one or two views, which - * are handled internally as primary and secondary view. + * Creates an action for showing/hiding a panel, that is accessible + * in "Configure toolbars..." and "Configure shortcuts...". This is necessary + * as the action for toggling the dock visibility is done by Qt which + * is no KAction instance. */ - enum ViewIndex - { - PrimaryIdx = 0, - SecondaryIdx = 1 - }; - DolphinView* m_view[SecondaryIdx + 1]; + void createPanelAction(const QIcon &icon, + const QKeySequence& shortcut, + QAction* dockAction, + const QString& actionName); +private: /** - * Asynchronous operations like 'Move' and 'Copy' may only be added as undo - * operation after they have been finished successfully. When an asynchronous - * operation is started, it is added to a pending undo jobs list in the meantime. - * As soon as the job has been finished, the operation is added to the undo mangager. - * @see UndoManager - * @see DolphinMainWindow::addPendingUndoJob - * @see DolphinMainWindow::addUndoOperation + * Implements a custom error handling for the undo manager. This + * assures that all errors are shown in the status bar of Dolphin + * instead as modal error dialog with an OK button. */ - struct UndoInfo + class UndoUiInterface : public KIO::FileUndoManager::UiInterface { - int id; - DolphinCommand command; + public: + UndoUiInterface(); + virtual ~UndoUiInterface(); + virtual void jobError(KIO::Job* job) Q_DECL_OVERRIDE; }; - Q3ValueList m_pendingUndoJobs; - /** Contains meta information for creating files. */ - struct CreateFileEntry - { - QString name; - QString filePath; - QString templatePath; - QString icon; - QString comment; - }; + KNewFileMenu* m_newFileMenu; + DolphinTabWidget* m_tabWidget; + DolphinViewContainer* m_activeViewContainer; + int m_id; + + DolphinViewActionHandler* m_actionHandler; + DolphinRemoteEncoding* m_remoteEncoding; + QPointer m_settingsDialog; - QLinkedList m_fileGroupActions; - KSortableList m_createFileTemplates; + // Members for the toolbar menu that is shown when the menubar is hidden: + QToolButton* m_controlButton; + QTimer* m_updateToolBarTimer; + + KIO::Job* m_lastHandleUrlStatJob; + + TerminalPanel* m_terminalPanel; + PlacesPanel* m_placesPanel; + bool m_tearDownFromPlacesRequested; }; -#endif // _DOLPHIN_H_ +inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const +{ + return m_activeViewContainer; +} + +inline KNewFileMenu* DolphinMainWindow::newFileMenu() const +{ + return m_newFileMenu; +} + +inline int DolphinMainWindow::getId() const +{ + return m_id; +} + +#endif // DOLPHIN_MAINWINDOW_H