File indexing completed on 2024-10-06 05:01:28

 /*
     SPDX-FileCopyrightText: 2008 Will Stephenson <wstephenson@kde.org>
     SPDX-FileCopyrightText: 2013 Lukáš Tinkl <ltinkl@redhat.com>
 
     SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
 */
 
 #ifndef PLASMA_NM_VPN_UI_PLUGIN_H
 #define PLASMA_NM_VPN_UI_PLUGIN_H
 
 #include "plasmanm_editor_export.h"
 
 #include <QMessageBox>
 #include <QObject>
 #include <QVariant>
 
 #include <NetworkManagerQt/ConnectionSettings>
 #include <NetworkManagerQt/GenericTypes>
 #include <NetworkManagerQt/VpnSetting>
 
 #include <KPluginFactory>
 
 #include "settingwidget.h"
 
 #include "nm-connection.h"
 
 /**
  * Plugin for UI elements for VPN configuration
  */
 class PLASMANM_EDITOR_EXPORT VpnUiPlugin : public QObject
 {
     Q_OBJECT
 public:
     enum ErrorType { NoError, NotImplemented, Error };
 
     explicit VpnUiPlugin(QObject *parent = nullptr, const QVariantList & = QVariantList());
     ~VpnUiPlugin() override;
 
     virtual SettingWidget *widget(const NetworkManager::VpnSetting::Ptr &setting, QWidget *parent) = 0;
     virtual SettingWidget *askUser(const NetworkManager::VpnSetting::Ptr &setting, const QStringList &hints, QWidget *parent) = 0;
 
     /**
      * Suggested file name to save the exported connection configuration.
      * Try not to use space, parenthesis, or any other Unix unfriendly file name character.
      */
     virtual QString suggestedFileName(const NetworkManager::ConnectionSettings::Ptr &connection) const = 0;
     /**
      * File extension to be used in QFileDialog when selecting the file to import.
      * The format is: *.<extension> [*.<extension> ...]. For instance: '*.pcf'
      */
     virtual QStringList supportedFileExtensions() const;
 
     struct ImportResult {
     private:
         NMConnection *m_connection;
         ErrorType m_error = NoError;
         QString m_errorMessage;
 
     public:
         operator bool() const;
 
         QString errorMessage() const;
 
         NMConnection *connection() const;
 
         static ImportResult fail(const QString &errorMessage);
 
         static ImportResult pass(NMConnection *connection);
 
         static ImportResult notImplemented();
     };
 
     virtual ImportResult importConnectionSettings(const QString &fileName);
 
     struct ExportResult {
     private:
         ErrorType m_error = NoError;
         QString m_errorMessage;
 
     public:
         operator bool() const;
 
         QString errorMessage() const;
 
         static ExportResult pass();
 
         static ExportResult fail(const QString &errorMessage);
 
         static ExportResult notImplemented();
     };
 
     virtual ExportResult exportConnectionSettings(const NetworkManager::ConnectionSettings::Ptr &connection, const QString &fileName);
 
     virtual QMessageBox::StandardButtons suggestedAuthDialogButtons() const;
 
     static KPluginFactory::Result<VpnUiPlugin> loadPluginForType(QObject *parent, const QString &serviceType);
 };
 
 #endif // PLASMA_NM_VPN_UI_PLUGIN_H