Merge branch 'release/20.12'

[dolphin.git] / src / dolphinurlnavigator.h

diff --git a/src/dolphinurlnavigator.h b/src/dolphinurlnavigator.h
index 032b81e894e95e3d937c69b8d8e6d14e13a0c88d..9bcc32b4d1463d1cfbcc37a31dd3068b92cdb312 100644 (file)
--- a/src/dolphinurlnavigator.h
+++ b/src/dolphinurlnavigator.h
@@ -1,40 +1,23 @@
 /*
- * Copyright 2020  Felix Ernst <fe.a.ernst@gmail.com>
- * 
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) version 3, or any
- * later version accepted by the membership of KDE e.V. (or its
- * successor approved by the membership of KDE e.V.), which shall
- * act as a proxy defined in Section 6 of version 3 of the license.
- * 
- * This library 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
- * Lesser General Public License for more details.
- * 
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library.  If not, see <https://www.gnu.org/licenses/>.
- */
+    This file is part of the KDE project
+    SPDX-FileCopyrightText: 2020 Felix Ernst <fe.a.ernst@gmail.com>
+
+    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
+*/
 
 #ifndef DOLPHINURLNAVIGATOR_H
 #define DOLPHINURLNAVIGATOR_H
 
-#include <KCompletion>
 #include <KUrlNavigator>
 
-#include <forward_list>
-
-class KToggleAction;
-
 /**
- * @brief Extends KUrlNavigator in a Dolphin-specific way
- * 
- * Makes sure that Dolphin preferences, settings and settings changes are
+ * @brief Extends KUrlNavigator in a Dolphin-specific way.
+ *
+ * Makes sure that Dolphin preferences and settings are
  * applied to all constructed DolphinUrlNavigators.
- * 
  * @see KUrlNavigator
+ *
+ * To apply changes to all instances of this class @see DolphinUrlNavigatorsController.
  */
 class DolphinUrlNavigator : public KUrlNavigator
 {
@@ -55,61 +38,40 @@ public:
 
     virtual ~DolphinUrlNavigator();
 
-public slots:
-    /**
-     * Refreshes all DolphinUrlNavigators to get synchronized with the
-     * Dolphin settings if they were changed.
-     */
-    static void slotReadSettings();
+    // TODO: Fix KUrlNavigator::sizeHint() instead.
+    QSize sizeHint() const override;
 
     /**
-     * Switches to "breadcrumb" mode if the editable mode is not set to be
-     * preferred in the Dolphin settings.
+     * Wraps the visual state of a DolphinUrlNavigator so it can be passed around.
+     * This notably doesn't involve the locationUrl or history.
      */
-    void slotReturnPressed();
-
+    struct VisualState {
+        bool isUrlEditable;
+        bool hasFocus;
+        QString text;
+        int cursorPosition;
+        int selectionStart;
+        int selectionLength;
+    };
     /**
-     * This method is specifically here so the locationInToolbar
-     * KToggleAction that is created in DolphinMainWindow can be passed to
-     * this class and then appear in all context menus. This last part is
-     * done by eventFilter().
-     * For any other use parts of this class need to be rewritten.
-     * @param action The locationInToolbar-action from DolphinMainWindow
+     * Retrieve the visual state of this DolphinUrlNavigator.
+     * If two DolphinUrlNavigators have the same visual state they should look identical.
+     *
+     * @return a copy of the visualState of this object. Ownership of this copy is transferred
+     *         to the caller via std::unique_ptr.
      */
-    static void addToContextMenu(QAction *action);
-
-    static void slotPlacesPanelVisibilityChanged(bool visible);
-
-protected:
-    /**
-     * Constructor-helper function
-     */
-    void init();
-
+    std::unique_ptr<VisualState> visualState() const;
     /**
-     * This filter adds the s_ActionForContextMenu action to QMenus which
-     * are spawned by the watched QObject if that QMenu contains at least
-     * two separators.
-     * @see addToContextMenu()
+     * @param visualState A struct describing the new visual state of this object.
      */
-    bool eventFilter(QObject * watched, QEvent * event) override;
+    void setVisualState(const VisualState &visualState);
 
-protected slots:
+public slots:
     /**
-     * Sets the completion mode for all DolphinUrlNavigators
-     * and saves it in settings.
+     * Switches to "breadcrumb" mode if the editable mode is not set to be
+     * preferred in the Dolphin settings.
      */
-    static void setCompletionMode(const KCompletion::CompletionMode completionMode);
-
-protected:
-    /** Contains all currently constructed DolphinUrlNavigators */
-    static std::forward_list<DolphinUrlNavigator *> s_instances;
-
-    /** Caches the (negated) places panel visibility */
-    static bool s_placesSelectorVisible;
-
-    /** An action that is added to the context menu */
-    static QAction *s_ActionForContextMenu;
+    void slotReturnPressed();
 };
 
 #endif // DOLPHINURLNAVIGATOR_H