ParaView-5.0.1: Added the source-tree to ThirdParty-dev and patched as described in the README file

Resolves bug-report http://bugs.openfoam.org/view.php?id=2098

ParaView-5.0.1/Qt/Components/pqStringVectorPropertyWidget.cxx

@@ -0,0 +1,477 @@
+/*=========================================================================
+
+   Program: ParaView
+   Module: pqStringVectorPropertyWidget.cxx
+
+   Copyright (c) 2005-2012 Sandia Corporation, Kitware Inc.
+   All rights reserved.
+
+   ParaView is a free software; you can redistribute it and/or modify it
+   under the terms of the ParaView license version 1.2.
+
+   See License_v1.2.txt for the full ParaView license.
+   A copy of this license can be obtained by contacting
+   Kitware Inc.
+   28 Corporate Drive
+   Clifton Park, NY 12065
+   USA
+
+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 AUTHORS 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.
+
+=========================================================================*/
+
+#include "pqStringVectorPropertyWidget.h"
+
+#include "vtkPVXMLElement.h"
+#include "vtkSMArrayListDomain.h"
+#include "vtkSMArraySelectionDomain.h"
+#include "vtkSMDomain.h"
+#include "vtkSMDomainIterator.h"
+#include "vtkSMEnumerationDomain.h"
+#include "vtkSMFileListDomain.h"
+#include "vtkSMProperty.h"
+#include "vtkSMPropertyHelper.h"
+#include "vtkSMProxy.h"
+#include "vtkSMSILDomain.h"
+#include "vtkSMStringListDomain.h"
+#include "vtkSMStringVectorProperty.h"
+#include "vtkSMFieldDataDomain.h"
+
+#include "pqLineEdit.h"
+#include "pqSignalAdaptors.h"
+#include "pqApplicationCore.h"
+#include "pqArrayListDomain.h"
+#include "pqComboBoxDomain.h"
+#include "pqExodusIIVariableSelectionWidget.h"
+#include "pqFileChooserWidget.h"
+#include "pqPopOutWidget.h"
+#include "pqProxySILModel.h"
+#include "pqScalarValueListPropertyWidget.h"
+#include "pqServerManagerModel.h"
+#include "pqSILModel.h"
+#include "pqSILWidget.h"
+#include "pqTreeWidget.h"
+#include "pqTreeWidgetSelectionHelper.h"
+#include "pqTextEdit.h"
+#include "pqFieldSelectionAdaptor.h"
+#include "vtkPVConfig.h"
+#include "pqDialog.h"
+
+#include <QComboBox>
+#include <QLabel>
+#include <QTextEdit>
+#include <QTreeWidget>
+#include <QVBoxLayout>
+#include <QPushButton>
+#include <QStyle>
+
+#include <QDebug>
+
+#ifdef PARAVIEW_ENABLE_PYTHON
+#include "pqPythonSyntaxHighlighter.h"
+#endif
+
+pqStringVectorPropertyWidget::pqStringVectorPropertyWidget(vtkSMProperty *smProperty,
+                                                           vtkSMProxy *smProxy,
+                                                           QWidget *pWidget)
+  : pqPropertyWidget(smProxy, pWidget)
+{
+  this->setChangeAvailableAsChangeFinished(false);
+
+  vtkSMStringVectorProperty *svp = vtkSMStringVectorProperty::SafeDownCast(smProperty);
+  if(!svp)
+    {
+    return;
+    }
+
+  bool multiline_text = false;
+  bool python = false;
+  QString placeholderText;
+  if (svp->GetHints())
+    {
+    vtkPVXMLElement* widgetHint = svp->GetHints()->FindNestedElementByName("Widget");
+    if (widgetHint && widgetHint->GetAttribute("type") &&
+      strcmp(widgetHint->GetAttribute("type"), "multi_line") == 0)
+      {
+      multiline_text = true;
+      }
+    if (widgetHint && widgetHint->GetAttribute("syntax") &&
+      strcmp(widgetHint->GetAttribute("syntax"), "python") == 0)
+      {
+      python = true;
+      }
+    if (vtkPVXMLElement* phtElement = svp->GetHints()->FindNestedElementByName("PlaceholderText"))
+      {
+      placeholderText = phtElement->GetCharacterData();
+      placeholderText = placeholderText.trimmed();
+      }
+    }
+
+  // find the domain(s)
+  vtkSMEnumerationDomain *enumerationDomain = 0;
+  vtkSMFileListDomain *fileListDomain = 0;
+  vtkSMArrayListDomain *arrayListDomain = 0;
+  vtkSMFieldDataDomain *fieldDataDomain = 0;
+  vtkSMStringListDomain *stringListDomain = 0;
+  vtkSMSILDomain *silDomain = 0;
+  vtkSMArraySelectionDomain *arraySelectionDomain = 0;
+
+  vtkSMDomainIterator *domainIter = svp->NewDomainIterator();
+  for(domainIter->Begin(); !domainIter->IsAtEnd(); domainIter->Next())
+    {
+    vtkSMDomain *domain = domainIter->GetDomain();
+
+    if(!enumerationDomain)
+      {
+      enumerationDomain = vtkSMEnumerationDomain::SafeDownCast(domain);
+      }
+    if(!fileListDomain)
+      {
+      fileListDomain = vtkSMFileListDomain::SafeDownCast(domain);
+      }
+    if(!arrayListDomain)
+      {
+      arrayListDomain = vtkSMArrayListDomain::SafeDownCast(domain);
+      }
+    if(!silDomain)
+      {
+      silDomain = vtkSMSILDomain::SafeDownCast(domain);
+      }
+    if(!arraySelectionDomain)
+      {
+      arraySelectionDomain = vtkSMArraySelectionDomain::SafeDownCast(domain);
+      }
+    if(!stringListDomain)
+      {
+      stringListDomain = vtkSMStringListDomain::SafeDownCast(domain);
+      }
+    if(!fieldDataDomain)
+      {
+      fieldDataDomain = vtkSMFieldDataDomain::SafeDownCast(domain);
+      }
+    }
+  domainIter->Delete();
+
+  QVBoxLayout *vbox = new QVBoxLayout;
+  vbox->setMargin(0);
+  vbox->setSpacing(0);
+
+  if (fileListDomain)
+    {
+    pqFileChooserWidget *chooser = new pqFileChooserWidget(this);
+    chooser->setObjectName("FileChooser");
+
+    // decide whether to allow multiple files
+    if(smProperty->GetRepeatable())
+      {
+      // multiple file names allowed
+      chooser->setForceSingleFile(false);
+
+      this->addPropertyLink(chooser,
+                            "filenames",
+                            SIGNAL(filenamesChanged(QStringList)),
+                            smProperty);
+      this->setChangeAvailableAsChangeFinished(true);
+      }
+    else
+      {
+      // single file name
+      chooser->setForceSingleFile(true);
+      this->addPropertyLink(chooser,
+                            "singleFilename",
+                            SIGNAL(filenameChanged(QString)),
+                            smProperty);
+      this->setChangeAvailableAsChangeFinished(true);
+      }
+
+    // If there's a hint on the smproperty indicating that this smproperty expects a
+    // directory name, then, we will use the directory mode.
+    if (smProperty->IsA("vtkSMStringVectorProperty") &&
+        smProperty->GetHints() &&
+        smProperty->GetHints()->FindNestedElementByName("UseDirectoryName"))
+      {
+      chooser->setUseDirectoryMode(true);
+      }
+
+    pqServerManagerModel *smm =
+      pqApplicationCore::instance()->getServerManagerModel();
+    chooser->setServer(smm->findServer(smProxy->GetSession()));
+
+    vbox->addWidget(chooser);
+
+    PV_DEBUG_PANELS() << "pqFileChooserWidget for a StringVectorProperty with "
+                  << "a FileListDomain";
+    }
+  else if(arrayListDomain)
+    {
+    if(smProperty->GetRepeatable())
+      {
+      // repeatable array list domains get a tree widget
+      // listing each array name with a check box
+      pqExodusIIVariableSelectionWidget* selectorWidget =
+        new pqExodusIIVariableSelectionWidget(this);
+      selectorWidget->setObjectName("ArraySelectionWidget");
+      selectorWidget->setRootIsDecorated(false);
+      selectorWidget->setHeaderLabel(smProperty->GetXMLLabel());
+      selectorWidget->setMaximumRowCountBeforeScrolling(smProperty);
+
+      // hide widget label
+      this->setShowLabel(false);
+
+      vbox->addWidget(selectorWidget);
+
+      PV_DEBUG_PANELS() << "pqExodusIIVariableSelectionWidget for a "
+                    << "StringVectorProperty with a repeatable "
+                    << "ArrayListDomain (" << arrayListDomain->GetXMLName() << ")";
+
+      // unlike vtkSMArraySelectionDomain which is doesn't tend to change based
+      // on values of other properties, typically, vtkSMArrayListDomain changes
+      // on other property values e.g. when one switches from point-data to
+      // cell-data, the available arrays change. Hence we "reset" the widget
+      // every time the domain changes.
+      new pqArrayListDomain(selectorWidget,
+        smProxy->GetPropertyName(smProperty),
+        smProxy, smProperty, arrayListDomain);
+
+      PV_DEBUG_PANELS() << " Also creating pqArrayListDomain to keep the list updated.";
+
+      this->addPropertyLink(
+        selectorWidget, smProxy->GetPropertyName(smProperty),
+        SIGNAL(widgetModified()), smProperty);
+      this->setChangeAvailableAsChangeFinished(true);
+      }
+    else if(fieldDataDomain)
+      {
+      QComboBox *comboBox = new QComboBox(this);
+      comboBox->setObjectName("ComboBox");
+
+      pqFieldSelectionAdaptor *adaptor =
+        new pqFieldSelectionAdaptor(comboBox, smProperty);
+
+      this->addPropertyLink(adaptor,
+                            "selection",
+                            SIGNAL(selectionChanged()),
+                            svp);
+      this->setChangeAvailableAsChangeFinished(true);
+
+      vbox->addWidget(comboBox);
+
+      PV_DEBUG_PANELS() << "QComboBox for a StringVectorProperty with a "
+                    << "ArrayListDomain (" << arrayListDomain->GetXMLName() << ")"
+                    << "and a FieldDataDomain (" << fieldDataDomain->GetXMLName() << ")";
+      }
+    else
+      {
+      // non-repeatable array list domains get a combo box
+      // listing each array name
+      QComboBox *comboBox = new QComboBox(this);
+      comboBox->setObjectName("ComboBox");
+
+      pqSignalAdaptorComboBox *adaptor = new pqSignalAdaptorComboBox(comboBox);
+      new pqComboBoxDomain(comboBox, smProperty, "array_list");
+
+      this->addPropertyLink(adaptor,
+                            "currentText",
+                            SIGNAL(currentTextChanged(QString)),
+                            svp);
+      this->setChangeAvailableAsChangeFinished(true);
+
+      vbox->addWidget(comboBox);
+
+      PV_DEBUG_PANELS() << "QComboBox for a StringVectorProperty with a "
+                    << "ArrayListDomain (" << arrayListDomain->GetXMLName() << ")";
+      }
+    }
+  else if (silDomain)
+    {
+    pqSILWidget* tree = new pqSILWidget(silDomain->GetSubTree(), this);
+    tree->setObjectName("BlockSelectionWidget");
+
+    pqSILModel* silModel = new pqSILModel(tree);
+
+    // FIXME: This needs to be automated, we want the model to automatically
+    // fetch the SIL when the domain is updated.
+    silModel->update(silDomain->GetSIL());
+    tree->setModel(silModel);
+
+    this->addPropertyLink(tree->activeModel(), "values",
+      SIGNAL(valuesChanged()), smProperty);
+    this->setChangeAvailableAsChangeFinished(true);
+
+    // hide widget label
+    setShowLabel(false);
+
+    vbox->addWidget(tree);
+
+    PV_DEBUG_PANELS() << "pqSILWidget for a StringVectorProperty with a "
+                  << "SILDomain (" << silDomain->GetXMLName() << ")";
+    }
+  else if (arraySelectionDomain)
+    {
+    pqExodusIIVariableSelectionWidget* selectorWidget =
+      new pqExodusIIVariableSelectionWidget(this);
+    selectorWidget->setObjectName("ArraySelectionWidget");
+    selectorWidget->setRootIsDecorated(false);
+    selectorWidget->setHeaderLabel(smProperty->GetXMLLabel());
+    selectorWidget->setMaximumRowCountBeforeScrolling(smProperty);
+
+    this->addPropertyLink(
+      selectorWidget, smProxy->GetPropertyName(smProperty),
+      SIGNAL(widgetModified()), smProperty);
+    this->setChangeAvailableAsChangeFinished(true);
+
+    // hide widget label
+    setShowLabel(false);
+
+    vbox->addWidget(selectorWidget);
+
+    new pqArrayListDomain(selectorWidget,
+      smProxy->GetPropertyName(smProperty),
+      smProxy, smProperty, arraySelectionDomain);
+
+    PV_DEBUG_PANELS() << " Also creating pqArrayListDomain to keep the list updated.";
+
+
+    PV_DEBUG_PANELS() << "pqExodusIIVariableSelectionWidget for a StringVectorProperty "
+                  << "with a ArraySelectionDomain (" << arraySelectionDomain->GetXMLName() << ")";
+   }
+  else if(stringListDomain)
+    {
+    QComboBox *comboBox = new QComboBox(this);
+    comboBox->setObjectName("ComboBox");
+
+    pqSignalAdaptorComboBox *adaptor = new pqSignalAdaptorComboBox(comboBox);
+    new pqComboBoxDomain(comboBox, smProperty);
+    this->addPropertyLink(adaptor,
+                          "currentText",
+                          SIGNAL(currentTextChanged(QString)),
+                          svp);
+    this->setChangeAvailableAsChangeFinished(true);
+
+    vbox->addWidget(comboBox);
+
+    PV_DEBUG_PANELS() << "QComboBox for a StringVectorProperty with a "
+                      << "StringListDomain (" << stringListDomain->GetXMLName() << ")";
+    }
+  else if (multiline_text)
+    {
+    QWidget* w = new QWidget(this);
+    QHBoxLayout* hbox = new QHBoxLayout(this);
+    hbox->setMargin(0);
+    hbox->setSpacing(0);
+    QLabel* label = new QLabel(smProperty->GetXMLLabel(), w);
+    hbox->addWidget(label);
+    hbox->addStretch();
+
+    // add a multiline text widget
+    pqTextEdit *textEdit = new pqTextEdit(this);
+    QFont textFont("Courier");
+    textEdit->setFont(textFont);
+    textEdit->setObjectName(smProxy->GetPropertyName(smProperty));
+    textEdit->setAcceptRichText(false);
+    textEdit->setTabStopWidth(2);
+    textEdit->setLineWrapMode(QTextEdit::NoWrap);
+
+    this->setChangeAvailableAsChangeFinished(false);
+    this->addPropertyLink(textEdit, "plainText",
+                          SIGNAL(textChanged()), smProperty);
+    this->connect(textEdit, SIGNAL(textChangedAndEditingFinished()),
+                  this, SIGNAL(changeFinished()));
+
+    w->setLayout(hbox);
+    vbox->addWidget(w);
+    if (python)
+      {
+#ifdef PARAVIEW_ENABLE_PYTHON
+      PV_DEBUG_PANELS() << "Python text edit:";
+      new pqPythonSyntaxHighlighter(textEdit,textEdit);
+#else
+      PV_DEBUG_PANELS() << "Python text edit when python not enabled:";
+#endif
+      pqPopOutWidget* popOut = new pqPopOutWidget(
+        textEdit,
+        QString("%1 - %2").arg(
+          smProperty->GetParent()->GetXMLLabel(),
+          smProperty->GetXMLLabel()),
+        this);
+      QPushButton *popToDialogButton = new QPushButton(this);
+      popOut->setPopOutButton(popToDialogButton);
+      hbox->addWidget(popToDialogButton);
+      vbox->addWidget(popOut);
+      }
+    else
+      {
+      vbox->addWidget(textEdit);
+      }
+    this->setShowLabel(false);
+
+    PV_DEBUG_PANELS() << "QTextEdit for a StringVectorProperty with multi line text";
+    }
+  else if(enumerationDomain)
+    {
+    QComboBox *comboBox = new QComboBox(this);
+    comboBox->setObjectName("ComboBox");
+
+    pqSignalAdaptorComboBox *adaptor = new pqSignalAdaptorComboBox(comboBox);
+
+    this->addPropertyLink(adaptor,
+                          "currentText",
+                          SIGNAL(currentTextChanged(QString)),
+                          svp);
+    this->setChangeAvailableAsChangeFinished(true);
+
+    for(unsigned int i = 0; i < enumerationDomain->GetNumberOfEntries(); i++)
+      {
+      comboBox->addItem(enumerationDomain->GetEntryText(i));
+      }
+
+    vbox->addWidget(comboBox);
+
+    PV_DEBUG_PANELS() << "QComboBox for a StringVectorProperty with an "
+                      << "EnumerationDomain (" << enumerationDomain->GetXMLName() << ")";
+    }
+  else
+    {
+    if(smProperty->GetRepeatable())
+      {
+      pqScalarValueListPropertyWidget* widget =
+        new pqScalarValueListPropertyWidget(smProperty, smProxy, this);
+      widget->setObjectName("ScalarValueList");
+      this->addPropertyLink(widget, "scalars", SIGNAL(scalarsChanged()), smProperty);
+      this->setChangeAvailableAsChangeFinished(true);
+      vbox->addWidget(widget);
+      this->setShowLabel(true);
+      }
+    else
+      {
+      // add a single line edit.
+      QLineEdit* lineEdit = new pqLineEdit(this);
+      lineEdit->setObjectName(smProxy->GetPropertyName(smProperty));
+      this->addPropertyLink(lineEdit, "text",
+                            SIGNAL(textChanged(const QString&)), smProperty);
+      this->connect(lineEdit, SIGNAL(textChangedAndEditingFinished()),
+                    this, SIGNAL(changeFinished()));
+      this->setChangeAvailableAsChangeFinished(false);
+
+      if (!placeholderText.isEmpty())
+        {
+        lineEdit->setPlaceholderText(placeholderText);
+        }
+
+      vbox->addWidget(lineEdit);
+
+      PV_DEBUG_PANELS() << "QLineEdit for a StringVectorProperty with no domain";
+      }
+    }
+  this->setLayout(vbox);
+}