plugindialog.cpp Example File

  /****************************************************************************
  **
  ** Copyright (C) 2016 The Qt Company Ltd.
  ** Contact: https://www.qt.io/licensing/
  **
  ** This file is part of the examples of the Qt Toolkit.
  **
  ** $QT_BEGIN_LICENSE:BSD$
  ** 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.
  **
  ** BSD License Usage
  ** Alternatively, you may use this file under the terms of the BSD license
  ** as follows:
  **
  ** "Redistribution and use in source and binary forms, with or without
  ** modification, are permitted provided that the following conditions are
  ** met:
  **   * Redistributions of source code must retain the above copyright
  **     notice, this list of conditions and the following disclaimer.
  **   * Redistributions in binary form must reproduce the above copyright
  **     notice, this list of conditions and the following disclaimer in
  **     the documentation and/or other materials provided with the
  **     distribution.
  **   * Neither the name of The Qt Company Ltd nor the names of its
  **     contributors may be used to endorse or promote products derived
  **     from this software without specific prior written permission.
  **
  **
  ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
  **
  ** $QT_END_LICENSE$
  **
  ****************************************************************************/

  #include "interfaces.h"
  #include "plugindialog.h"

  #include <QDir>
  #include <QGridLayout>
  #include <QHeaderView>
  #include <QLabel>
  #include <QPluginLoader>
  #include <QPushButton>
  #include <QStringList>
  #include <QTreeWidget>
  #include <QTreeWidgetItem>

  PluginDialog::PluginDialog(const QString &path, const QStringList &fileNames,
                             QWidget *parent) :
      QDialog(parent),
      label(new QLabel),
      treeWidget(new QTreeWidget),
      okButton(new QPushButton(tr("OK")))
  {
      treeWidget->setAlternatingRowColors(false);
      treeWidget->setSelectionMode(QAbstractItemView::NoSelection);
      treeWidget->setColumnCount(1);
      treeWidget->header()->hide();

      okButton->setDefault(true);

      connect(okButton, &QAbstractButton::clicked, this, &QWidget::close);

      QGridLayout *mainLayout = new QGridLayout;
      mainLayout->setColumnStretch(0, 1);
      mainLayout->setColumnStretch(2, 1);
      mainLayout->addWidget(label, 0, 0, 1, 3);
      mainLayout->addWidget(treeWidget, 1, 0, 1, 3);
      mainLayout->addWidget(okButton, 2, 1);
      setLayout(mainLayout);

      interfaceIcon.addPixmap(style()->standardPixmap(QStyle::SP_DirOpenIcon),
                              QIcon::Normal, QIcon::On);
      interfaceIcon.addPixmap(style()->standardPixmap(QStyle::SP_DirClosedIcon),
                              QIcon::Normal, QIcon::Off);
      featureIcon.addPixmap(style()->standardPixmap(QStyle::SP_FileIcon));

      setWindowTitle(tr("Plugin Information"));
      findPlugins(path, fileNames);
  }

  void PluginDialog::findPlugins(const QString &path,
                                 const QStringList &fileNames)
  {
      label->setText(tr("Plug & Paint found the following plugins\n"
                        "(looked in %1):")
                     .arg(QDir::toNativeSeparators(path)));

      const QDir dir(path);

      const auto staticInstances = QPluginLoader::staticInstances();
      for (QObject *plugin : staticInstances)
          populateTreeWidget(plugin, tr("%1 (Static Plugin)")
                                     .arg(plugin->metaObject()->className()));

      for (const QString &fileName : fileNames) {
          QPluginLoader loader(dir.absoluteFilePath(fileName));
          QObject *plugin = loader.instance();
          if (plugin)
              populateTreeWidget(plugin, fileName);
      }
  }

  void PluginDialog::populateTreeWidget(QObject *plugin, const QString &text)
  {
      auto pluginItem = new QTreeWidgetItem(treeWidget);
      pluginItem->setText(0, text);
      treeWidget->setItemExpanded(pluginItem, true);

      QFont boldFont = pluginItem->font(0);
      boldFont.setBold(true);
      pluginItem->setFont(0, boldFont);

      if (plugin) {
          auto iBrush = qobject_cast<BrushInterface *>(plugin);
          if (iBrush)
              addItems(pluginItem, "BrushInterface", iBrush->brushes());

          auto iShape = qobject_cast<ShapeInterface *>(plugin);
          if (iShape)
              addItems(pluginItem, "ShapeInterface", iShape->shapes());

          auto iFilter = qobject_cast<FilterInterface *>(plugin);
          if (iFilter)
              addItems(pluginItem, "FilterInterface", iFilter->filters());
      }
  }

  void PluginDialog::addItems(QTreeWidgetItem *pluginItem,
                              const char *interfaceName,
                              const QStringList &features)
  {
      auto interfaceItem = new QTreeWidgetItem(pluginItem);
      interfaceItem->setText(0, interfaceName);
      interfaceItem->setIcon(0, interfaceIcon);

      for (QString feature : features) {
          if (feature.endsWith("..."))
              feature.chop(3);
          auto featureItem = new QTreeWidgetItem(interfaceItem);
          featureItem->setText(0, feature);
          featureItem->setIcon(0, featureIcon);
      }
  }