-/***************************************************************************
- * Copyright (C) 2007 by Peter Penz <peter.penz19@gmail.com> *
- * *
- * This program is free software; you can redistribute it and/or modify *
- * it under the terms of the GNU General Public License as published by *
- * the Free Software Foundation; either version 2 of the License, or *
- * (at your option) any later version. *
- * *
- * This program is distributed in the hope that it will be useful, *
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
- * GNU General Public License for more details. *
- * *
- * You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the *
- * Free Software Foundation, Inc., *
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2007 Peter Penz <peter.penz19@gmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
#ifndef DOLPHINVIEWCONTAINER_H
#define DOLPHINVIEWCONTAINER_H
+#include "config-dolphin.h"
+#include "dolphinurlnavigator.h"
+#include "selectionmode/bottombar.h"
+#include "views/dolphinview.h"
+
#include <KFileItem>
-#include <KCompletion>
#include <KIO/Job>
-
#include <KUrlNavigator>
#include <QElapsedTimer>
+#include <QPushButton>
#include <QWidget>
-#include <views/dolphinview.h>
-#include <config-dolphin.h>
-
-#ifdef KF5Activities_FOUND
+#if HAVE_KACTIVITIES
namespace KActivities {
class ResourceInstance;
}
class FilterBar;
class KMessageWidget;
+class QAction;
+class QGridLayout;
class QUrl;
-class KUrlNavigator;
class DolphinSearchBox;
class DolphinStatusBar;
+namespace SelectionMode {
+ class TopBar;
+}
/**
* @short Represents a view for the directory content
};
DolphinViewContainer(const QUrl& url, QWidget* parent);
- virtual ~DolphinViewContainer();
+ ~DolphinViewContainer() override;
/**
* Returns the current active URL, where all actions are applied.
void setAutoGrabFocus(bool grab);
bool autoGrabFocus() const;
+ QString currentSearchText() const;
+
const DolphinStatusBar* statusBar() const;
DolphinStatusBar* statusBar();
- const KUrlNavigator* urlNavigator() const;
- KUrlNavigator* urlNavigator();
+ /**
+ * @return An UrlNavigator that is controlling this view
+ * or nullptr if there is none.
+ * @see connectUrlNavigator()
+ * @see disconnectUrlNavigator()
+ *
+ * Use urlNavigatorInternalWithHistory() if you want to access the history.
+ * @see urlNavigatorInternalWithHistory()
+ */
+ const DolphinUrlNavigator *urlNavigator() const;
+ /**
+ * @return An UrlNavigator that is controlling this view
+ * or nullptr if there is none.
+ * @see connectUrlNavigator()
+ * @see disconnectUrlNavigator()
+ *
+ * Use urlNavigatorInternalWithHistory() if you want to access the history.
+ * @see urlNavigatorInternalWithHistory()
+ */
+ DolphinUrlNavigator *urlNavigator();
+
+ /**
+ * @return An UrlNavigator that contains this view's history.
+ * Use urlNavigator() instead when not accessing the history.
+ */
+ const DolphinUrlNavigator *urlNavigatorInternalWithHistory() const;
+ /**
+ * @return An UrlNavigator that contains this view's history.
+ * Use urlNavigator() instead when not accessing the history.
+ */
+ DolphinUrlNavigator *urlNavigatorInternalWithHistory();
const DolphinView* view() const;
DolphinView* view();
+ /**
+ * @param urlNavigator The UrlNavigator that is supposed to control
+ * this view.
+ */
+ void connectUrlNavigator(DolphinUrlNavigator *urlNavigator);
+
+ /**
+ * Disconnects the navigator that is currently controlling the view.
+ * This method completely reverses connectUrlNavigator().
+ */
+ void disconnectUrlNavigator();
+
+ /**
+ * Sets a selection mode that is useful for quick and easy selecting or deselecting of files.
+ * This method is the central authority about enabling or disabling selection mode:
+ * All other classes that want to enable or disable selection mode should trigger a call of this method.
+ *
+ * This method sets the selection mode for the view of this viewContainer and sets the visibility of the
+ * selection mode top and bottom bar which also belong to this viewContainer.
+ *
+ * @param enabled Whether to enable or disable selection mode.
+ * @param actionCollection The collection of actions from which the actions on the bottom bar are retrieved.
+ * @param bottomBarContents The contents the bar is supposed to show after this call.
+ */
+ void setSelectionModeEnabled(bool enabled, KActionCollection *actionCollection = nullptr, SelectionMode::BottomBar::Contents bottomBarContents = SelectionMode::BottomBar::Contents::GeneralContents);
+ /** @see setSelectionModeEnabled() */
+ bool isSelectionModeEnabled() const;
+
/**
* Shows the message \msg with the given type non-modal above
* the view-content.
/** Returns true, if the filter bar is visible. */
bool isFilterBarVisible() const;
- /**
- * Enables the search mode, if \p enabled is true. In the search mode the URL navigator
- * will be hidden and replaced by a line editor that allows to enter a search term.
- */
- void setSearchModeEnabled(bool enabled);
+
+ /** Returns true if the search mode is enabled. */
bool isSearchModeEnabled() const;
/**
*/
void reload();
-public slots:
+ /**
+ * @return Returns a Caption suitable for display in the window title.
+ * It is calculated depending on GeneralSettings::showFullPathInTitlebar().
+ * If it's false, it calls caption().
+ */
+ QString captionWindowTitle() const;
+
+ /**
+ * @return Returns a Caption suitable for display to the user. It is
+ * calculated depending on settings, if a search is active and other
+ * factors.
+ */
+ QString caption() const;
+
+ /**
+ * Disable/enable the behavior of "select child when moving to parent folder"
+ * offered by KUrlNavigator.
+ *
+ * See KUrlNavigator::urlSelectionRequested
+ */
+ void disableUrlNavigatorSelectionRequests();
+ void enableUrlNavigatorSelectionRequests();
+
+public Q_SLOTS:
/**
* Sets the current active URL, where all actions are applied. The
* URL navigator is synchronized with this URL. The signals
*/
void setFilterBarVisible(bool visible);
-signals:
+ /**
+ * Enables the search mode, if \p enabled is true. In the search mode the URL navigator
+ * will be hidden and replaced by a line editor that allows to enter a search term.
+ */
+ void setSearchModeEnabled(bool enabled);
+
+ /** Used to notify the m_selectionModeBottomBar that there is no other ViewContainer in the tab. */
+ void slotSplitTabDisabled();
+
+Q_SIGNALS:
/**
* Is emitted whenever the filter bar has changed its visibility state.
*/
void showFilterBarChanged(bool shown);
+ /**
+ * Is emitted whenever the search mode has changed its state.
+ */
+ void searchModeEnabledChanged(bool enabled);
+
+ void selectionModeChanged(bool enabled);
/**
* Is emitted when the write state of the folder has been changed. The application
*/
void writeStateChanged(bool isFolderWritable);
-private slots:
+ /**
+ * Is emitted when the Caption has been changed.
+ * @see DolphinViewContainer::caption()
+ */
+ void captionChanged();
+
+ /**
+ * Is emitted if a new tab should be opened in the background for the URL \a url.
+ */
+ void tabRequested(const QUrl &url);
+
+ /**
+ * Is emitted if a new tab should be opened for the URL \a url and set as active.
+ */
+ void activeTabRequested(const QUrl &url);
+
+private Q_SLOTS:
/**
* Updates the number of items (= number of files + number of
* directories) in the statusbar. If files are selected, the number
* directory is opened in the view. If the item is a file, the file
* gets started by the corresponding application.
*/
- void slotItemActivated(const KFileItem& item);
+ void slotItemActivated(const KFileItem &item);
/**
* Handles activation of multiple files. The files get started by
/** Requests the focus for the view \a m_view. */
void requestFocus();
- /**
- * Saves the currently used URL completion mode of
- * the URL navigator.
- */
- void saveUrlCompletionMode(KCompletion::CompletionMode completion);
-
- void slotReturnPressed();
-
/**
* Gets the search URL from the searchbox and starts searching.
*/
*/
void showErrorMessage(const QString& msg);
+ /**
+ * Is invoked when a KFilePlacesModel has been changed
+ * @see DolphinPlacesModelSingleton::instance().placesModel()
+ */
+ void slotPlacesModelChanged();
+
+ void slotHiddenFilesShownChanged(bool showHiddenFiles);
+ void slotSortHiddenLastChanged(bool hiddenLast);
+ void slotCurrentDirectoryRemoved();
+
+ void slotOpenUrlFinished(KJob* job);
+
private:
/**
* @return True if the URL protocol is a search URL (e. g. baloosearch:// or filenamesearch://).
*/
void tryRestoreViewState();
+ /**
+ * @return Path of nearest existing ancestor directory.
+ */
+ QString getNearestExistingAncestorOfPath(const QString& path) const;
+
private:
- QVBoxLayout* m_topLayout;
- KUrlNavigator* m_urlNavigator;
+ QGridLayout *m_topLayout;
+
+ /**
+ * The internal UrlNavigator which is never visible to the user.
+ * m_urlNavigator is used even when another UrlNavigator is controlling
+ * the view to keep track of this object's history.
+ */
+ std::unique_ptr<DolphinUrlNavigator> m_urlNavigator;
+
+ /**
+ * The UrlNavigator that is currently connected to the view.
+ * This is a nullptr if no UrlNavigator is connected.
+ * Otherwise it's one of the UrlNavigators visible in the toolbar.
+ */
+ QPointer<DolphinUrlNavigator> m_urlNavigatorConnected;
+
DolphinSearchBox* m_searchBox;
+ bool m_searchModeEnabled;
+
KMessageWidget* m_messageWidget;
+ /// A bar shown at the top of the view to signify that selection mode is currently active.
+ SelectionMode::TopBar *m_selectionModeTopBar;
+
DolphinView* m_view;
FilterBar* m_filterBar;
+ /// A bar shown at the bottom of the view whose contents depend on what the user is currently doing.
+ SelectionMode::BottomBar *m_selectionModeBottomBar;
+
DolphinStatusBar* m_statusBar;
QTimer* m_statusBarTimer; // Triggers a delayed update
QElapsedTimer m_statusBarTimestamp; // Time in ms since last update
bool m_autoGrabFocus;
+ /**
+ * The visual state to be applied to the next UrlNavigator that gets
+ * connected to this ViewContainer.
+ */
+ std::unique_ptr<DolphinUrlNavigator::VisualState> m_urlNavigatorVisualState;
-#ifdef KF5Activities_FOUND
+#if HAVE_KACTIVITIES
private:
KActivities::ResourceInstance * m_activityResourceInstance;
#endif
projects / dolphin.git / blobdiff