-/***************************************************************************
- * 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-kactivities.h"
+#include "dolphinurlnavigator.h"
+#include "views/dolphinview.h"
+
#include <KFileItem>
-#include <KFileItemDelegate>
-#include <KGlobalSettings>
#include <KIO/Job>
-
#include <KUrlNavigator>
#include <QElapsedTimer>
+#include <QPushButton>
#include <QWidget>
-#include <views/dolphinview.h>
-#include <config-apps.h>
-
-#ifdef KActivities_FOUND
+#ifdef HAVE_KACTIVITIES
namespace KActivities {
class ResourceInstance;
}
class FilterBar;
class KMessageWidget;
-class KUrl;
+class QUrl;
class KUrlNavigator;
class DolphinSearchBox;
class DolphinStatusBar;
Error
};
- DolphinViewContainer(const KUrl& url, QWidget* parent);
- virtual ~DolphinViewContainer();
+ DolphinViewContainer(const QUrl& url, QWidget* parent);
+ ~DolphinViewContainer() override;
/**
* Returns the current active URL, where all actions are applied.
* The URL navigator is synchronized with this URL.
*/
- KUrl url() const;
+ QUrl url() const;
/**
* If \a active is true, the view container will marked as active. The active
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 controling the view.
+ * This method completely reverses connectUrlNavigator().
+ */
+ void disconnectUrlNavigator();
+
/**
* 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;
/**
*/
QString placesText() const;
-public slots:
+ /**
+ * Reload the view of this container. This will also hide messages in a messagewidget.
+ */
+ void reload();
+
+ /**
+ * @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;
+
+public Q_SLOTS:
/**
* Sets the current active URL, where all actions are applied. The
* URL navigator is synchronized with this URL. The signals
* are emitted.
* @see DolphinViewContainer::urlNavigator()
*/
- void setUrl(const KUrl& url);
+ void setUrl(const QUrl& url);
/**
* Popups the filter bar above the status bar if \a visible is true.
*/
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);
+
+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);
/**
* Is emitted when the write state of the folder has been changed. The application
*/
void writeStateChanged(bool isFolderWritable);
-private slots:
+private Q_SLOTS:
/**
* Updates the number of items (= number of files + number of
* directories) in the statusbar. If files are selected, the number
* Is called if the URL set by DolphinView::setUrl() represents
* a file and not a directory. Takes care to activate the file.
*/
- void slotUrlIsFileError(const KUrl& url);
+ void slotUrlIsFileError(const QUrl& url);
/**
* Handles clicking on an item. If the item is a directory, the
*/
void activate();
- /**
- * Is invoked if the signal urlAboutToBeChanged() from the DolphinView
- * is emitted. Tries to save the view-state.
- */
- void slotViewUrlAboutToBeChanged(const KUrl& url);
-
/**
* Is invoked if the signal urlAboutToBeChanged() from the URL navigator
* is emitted. Tries to save the view-state.
*/
- void slotUrlNavigatorLocationAboutToBeChanged(const KUrl& url);
+ void slotUrlNavigatorLocationAboutToBeChanged(const QUrl& url);
/**
* Restores the current view to show \a url and assures
* that the root URL of the view is respected.
*/
- void slotUrlNavigatorLocationChanged(const KUrl& url);
+ void slotUrlNavigatorLocationChanged(const QUrl& url);
/**
- * Is connected with the URL navigator and drops the URLs
- * above the destination \a destination.
+ * @see KUrlNavigator::urlSelectionRequested
*/
- void dropUrls(const KUrl& destination, QDropEvent* event);
+ void slotUrlSelectionRequested(const QUrl& url);
/**
* Is invoked when a redirection is done and changes the
* URL of the URL navigator to \a newUrl without triggering
* a reloading of the directory.
*/
- void redirect(const KUrl& oldUrl, const KUrl& newUrl);
+ void redirect(const QUrl& oldUrl, const QUrl& newUrl);
/** Requests the focus for the view \a m_view. */
void requestFocus();
- /**
- * Saves the currently used URL completion mode of
- * the URL navigator.
- */
- void saveUrlCompletionMode(KGlobalSettings::Completion completion);
-
- void slotHistoryChanged();
-
- void slotReturnPressed();
-
/**
* Gets the search URL from the searchbox and starts searching.
*/
private:
/**
- * @return True if the URL protocol is a search URL (e. g. nepomuksearch:// or filenamesearch://).
+ * @return True if the URL protocol is a search URL (e. g. baloosearch:// or filenamesearch://).
*/
- bool isSearchUrl(const KUrl& url) const;
+ bool isSearchUrl(const QUrl& url) const;
/**
* Saves the state of the current view: contents position,
*/
void saveViewState();
+ /**
+ * Restores the state of the current view iff the URL navigator contains a
+ * non-empty location state.
+ */
+ void tryRestoreViewState();
+
private:
QVBoxLayout* m_topLayout;
- KUrlNavigator* m_urlNavigator;
+
+ /**
+ * 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;
DolphinView* m_view;
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 KActivities_FOUND
+#ifdef HAVE_KACTIVITIES
private:
KActivities::ResourceInstance * m_activityResourceInstance;
#endif
projects / dolphin.git / blobdiff