text: /****************************************************************************
  **
  ** Copyright (C) 2016 The Qt Company Ltd.
  ** Contact: https://www.qt.io/licensing/
  **
  ** This file is part of the Qt Designer of the Qt Toolkit.
  **
  ** $QT_BEGIN_LICENSE:GPL-EXCEPT$
  ** Commercial License Usage
  ** Licensees holding valid commercial Qt licenses may use this file in
  ** accordance with the commercial license agreement provided with the
  ** Software or, alternatively, in accordance with the terms contained in
  ** a written agreement between you and The Qt Company. For licensing terms
  ** and conditions see https://www.qt.io/terms-conditions. For further
  ** information use the contact form at https://www.qt.io/contact-us.
  **
  ** GNU General Public License Usage
  ** Alternatively, this file may be used under the terms of the GNU
  ** General Public License version 3 as published by the Free Software
  ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
  ** included in the packaging of this file. Please review the following
  ** information to ensure the GNU General Public License requirements will
  ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
  **
  ** $QT_END_LICENSE$
  **
  ****************************************************************************/
  
  //
  //  W A R N I N G
  //  -------------
  //
  // This file is not part of the Qt API.  It exists for the convenience
  // of Qt Designer.  This header
  // file may change from version to version without notice, or even be removed.
  //
  // We mean it.
  //
  
  #ifndef PLUGINMANAGER_H
  #define PLUGINMANAGER_H
  
  #include "shared_global_p.h"
  #include "shared_enums_p.h"
  
  #include <QtCore/QSharedDataPointer>
  #include <QtCore/QMap>
  #include <QtCore/QPair>
  #include <QtCore/QObject>
  #include <QtCore/QStringList>
  
  QT_BEGIN_NAMESPACE
  
  class QDesignerFormEditorInterface;
  class QDesignerCustomWidgetInterface;
  class QDesignerPluginManagerPrivate;
  
  class QDesignerCustomWidgetSharedData;
  
  /* Information contained in the Dom XML of a custom widget. */
  class QDESIGNER_SHARED_EXPORT QDesignerCustomWidgetData {
  public:
      // StringPropertyType: validation mode and translatable flag.
      typedef QPair<qdesigner_internal::TextPropertyValidationMode, bool> StringPropertyType;
  
      explicit QDesignerCustomWidgetData(const QString &pluginPath = QString());
  
      enum ParseResult { ParseOk, ParseWarning, ParseError };
      ParseResult parseXml(const QString &xml, const QString &name, QString *errorMessage);
  
      QDesignerCustomWidgetData(const QDesignerCustomWidgetData&);
      QDesignerCustomWidgetData& operator=(const QDesignerCustomWidgetData&);
      ~QDesignerCustomWidgetData();
  
      bool isNull() const;
  
      QString pluginPath() const;
  
      // Data as parsed from the widget's domXML().
      QString xmlClassName() const;
      // Optional. The language the plugin is supposed to be used with.
      QString xmlLanguage() const;
      // Optional. method used to add pages to a container with a container extension
      QString xmlAddPageMethod() const;
      // Optional. Base class
      QString xmlExtends() const;
      // Optional. The name to be used in the widget box.
      QString xmlDisplayName() const;
      // Type of a string property
      bool xmlStringPropertyType(const QString &name, StringPropertyType *type) const;
      // Custom tool tip of property
      QString propertyToolTip(const QString &name) const;
  
  private:
      QSharedDataPointer<QDesignerCustomWidgetSharedData> m_d;
  };
  
  class QDESIGNER_SHARED_EXPORT QDesignerPluginManager: public QObject
  {
      Q_OBJECT
  public:
      typedef QList<QDesignerCustomWidgetInterface*> CustomWidgetList;
  
      explicit QDesignerPluginManager(QDesignerFormEditorInterface *core);
      virtual ~QDesignerPluginManager();
  
      QDesignerFormEditorInterface *core() const;
  
      QObject *instance(const QString &plugin) const;
  
      QStringList registeredPlugins() const;
  
      QStringList findPlugins(const QString &path);
  
      QStringList pluginPaths() const;
      void setPluginPaths(const QStringList &plugin_paths);
  
      QStringList disabledPlugins() const;
      void setDisabledPlugins(const QStringList &disabled_plugins);
  
      QStringList failedPlugins() const;
      QString failureReason(const QString &pluginName) const;
  
      QObjectList instances() const;
  
      CustomWidgetList registeredCustomWidgets() const;
      QDesignerCustomWidgetData customWidgetData(QDesignerCustomWidgetInterface *w) const;
      QDesignerCustomWidgetData customWidgetData(const QString &className) const;
  
      bool registerNewPlugins();
  
  public slots:
      bool syncSettings();
      void ensureInitialized();
  
  private:
      void updateRegisteredPlugins();
      void registerPath(const QString &path);
      void registerPlugin(const QString &plugin);
  
  private:
      static QStringList defaultPluginPaths();
  
      QDesignerPluginManagerPrivate *m_d;
  };
  
  QT_END_NAMESPACE
  
  #endif // PLUGINMANAGER_H
  