GIT_SILENT Sync po/docbooks with svn

[dolphin.git] / src / dolphinurlnavigator.h

diff --git a/src/dolphinurlnavigator.h b/src/dolphinurlnavigator.h
index a154287995a209b4e8c759d8fc1e2b0bfb9ce85a..572c29f631444d39f9e01cd7d91f312cc9732ed3 100644 (file)
--- a/src/dolphinurlnavigator.h
+++ b/src/dolphinurlnavigator.h
@@ -15,8 +15,9 @@
  *
  * 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
 {
@@ -35,7 +36,7 @@ public:
      */
     DolphinUrlNavigator(const QUrl &url, QWidget *parent = nullptr);
 
-    virtual ~DolphinUrlNavigator();
+    ~DolphinUrlNavigator() override;
 
     // TODO: Fix KUrlNavigator::sizeHint() instead.
     QSize sizeHint() const override;
@@ -55,6 +56,9 @@ public:
     /**
      * 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.
      */
     std::unique_ptr<VisualState> visualState() const;
     /**
@@ -62,7 +66,17 @@ public:
      */
     void setVisualState(const VisualState &visualState);
 
-public slots:
+    /**
+     * Clears the text in the text field
+     */
+    void clearText() const;
+
+    /**
+     * Displays placeholder text in the URL navigator
+     */
+    void setPlaceholderText(const QString &text);
+
+public Q_SLOTS:
     /**
      * Switches to "breadcrumb" mode if the editable mode is not set to be
      * preferred in the Dolphin settings.