GIT_SILENT Update Appstream for new release

[dolphin.git] / src / panels / panel.h

diff --git a/src/panels/panel.h b/src/panels/panel.h
index b056ca1cb08e1e19df8d87ec0e7d0f96175bb53e..5f1fabb4a7199f2df7097271df0161fd260393fd 100644 (file)
--- a/src/panels/panel.h
+++ b/src/panels/panel.h
@@ -1,53 +1,68 @@
-/***************************************************************************
- *   Copyright (C) 2006 by Cvetoslav Ludmiloff <ludmiloff@gmail.com>       *
- *   Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at>                  *
- *                                                                         *
- *   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: 2006 Cvetoslav Ludmiloff <ludmiloff@gmail.com>
+ * SPDX-FileCopyrightText: 2006-2010 Peter Penz <peter.penz19@gmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
 
 #ifndef PANEL_H
 #define PANEL_H
 
-#include <QtGui/QWidget>
-#include <kurl.h>
-#include <kfileitem.h>
+#include <QUrl>
+#include <QWidget>
 
 /**
  * @brief Base widget for all panels that can be docked on the window borders.
+ *
+ * Derived panels should provide a context menu that at least offers the
+ * actions from Panel::customContextMenuActions().
  */
 class Panel : public QWidget
 {
     Q_OBJECT
 
 public:
-    explicit Panel(QWidget* parent = 0);
-    virtual ~Panel();
+    explicit Panel(QWidget *parent = nullptr);
+    ~Panel() override;
 
     /** Returns the current set URL of the active Dolphin view. */
-    const KUrl& url() const;
+    QUrl url() const;
+
+    /**
+     * Sets custom context menu actions that are added to the panel specific
+     * context menu actions. Allows an application to apply custom actions to
+     * the panel.
+     */
+    void setCustomContextMenuActions(const QList<QAction *> &actions);
+    QList<QAction *> customContextMenuActions() const;
+
+    QSize sizeHint() const override;
 
-public slots:
+public Q_SLOTS:
     /**
      * This is invoked every time the folder being displayed in the
      * active Dolphin view changes.
      */
-    virtual void setUrl(const KUrl& url);
+    void setUrl(const QUrl &url);
+
+    /**
+     * Refreshes the view to get synchronized with the settings.
+     */
+    virtual void readSettings();
+
+protected:
+    /**
+     * Must be implemented by derived classes and is invoked when
+     * the URL has been changed (see Panel::setUrl()).
+     * @return True, if the new URL will get accepted by the derived
+     *         class. If false is returned,
+     *         the URL will be reset to the previous URL.
+     */
+    virtual bool urlChanged() = 0;
 
 private:
-    KUrl m_url;
+    QUrl m_url;
+    QList<QAction *> m_customContextMenuActions;
 };
 
 #endif // PANEL_H