ThirdParty-6/ParaView-5.0.1/Qt/Components/pqProxyPropertyWidget.cxx

/*=========================================================================

   Program: ParaView
   Module: pqProxyPropertyWidget.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 "pqProxyPropertyWidget.h"

#include <QVBoxLayout>

#include "pqProxySelectionWidget.h"
#include "pqSelectionInputWidget.h"
#include "vtkPVXMLElement.h"
#include "vtkSMProperty.h"
#include "vtkSMProxyListDomain.h"

pqProxyPropertyWidget::pqProxyPropertyWidget(vtkSMProperty *smProperty,
                                             vtkSMProxy *smProxy,
                                             QWidget *parentObject)
  : pqPropertyWidget(smProxy, parentObject),
  HideWidgetsInDefaultView(false)
{
  QVBoxLayout *vbox = new QVBoxLayout;
  vbox->setMargin(0);
  vbox->setSpacing(0);

  bool selection_input = (smProperty->GetHints() &&
    smProperty->GetHints()->FindNestedElementByName("SelectionInput"));
  if (selection_input)
    {
    pqSelectionInputWidget* siw = new pqSelectionInputWidget(this);
    siw->setObjectName(smProxy->GetPropertyName(smProperty));
    vbox->addWidget(siw);
    this->SelectionInputWidget = siw;
    this->addPropertyLink(siw, "selection",
      SIGNAL(selectionChanged(pqSMProxy)), smProperty);

    // call this after the above property link is setup so that we don't
    // override the default value.
    siw->initializeDefaultValueIfNeeded();

    this->connect(siw, SIGNAL(selectionChanged(pqSMProxy)),
      this, SIGNAL(changeAvailable()));
    this->connect(siw, SIGNAL(selectionChanged(pqSMProxy)),
      this, SIGNAL(changeFinished()));

    // don't show label for the proxy selection widget
    this->setShowLabel(false);

    PV_DEBUG_PANELS() << "pqSelectionInputWidget for a ProxyProperty with a "
                  << "SelectionInput hint";
    }
  else
    {
    // find the domain
    vtkSMProxyListDomain *domain = vtkSMProxyListDomain::SafeDownCast(
      smProperty->FindDomain("vtkSMProxyListDomain"));

    if (domain)
      {
      pqProxySelectionWidget *widget = new pqProxySelectionWidget(smProxy,
        smProxy->GetPropertyName(smProperty),
        smProperty->GetXMLLabel(),
        this);
      widget->setView(this->view());
      this->addPropertyLink(widget,
        "proxy",
        SIGNAL(proxyChanged(pqSMProxy)),
        smProperty);
      this->connect(widget, SIGNAL(modified()), this, SIGNAL(changeAvailable()));
      this->connect(widget, SIGNAL(modified()), this, SIGNAL(changeFinished()));
      this->connect(this, SIGNAL(viewChanged(pqView*)), widget,
        SLOT(setView(pqView*)));

      vbox->addWidget(widget);

      // store the proxy selection widget so that we can call
      // its accept() method when our apply() is called
      this->ProxySelectionWidget = widget;

      // don't show label for the proxy selection widget
      this->setShowLabel(false);


      // If selected_proxy_panel_visibility="advanced" hint is specified, we
      // only show the widgets for the selected proxy in advanced mode.
      vtkPVXMLElement* hints = smProperty->GetHints()?
        smProperty->GetHints()->FindNestedElementByName("ProxyPropertyWidget") : NULL;
      this->HideWidgetsInDefaultView = (hints &&
        strcmp(hints->GetAttributeOrDefault("selected_proxy_panel_visibility", ""), "advanced") == 0);

      PV_DEBUG_PANELS() << "pqProxySelectionWidget for a "
                    << "ProxyListDomain (" << domain->GetXMLName() << ")";
      }
    }

  this->setLayout(vbox);
}

//-----------------------------------------------------------------------------
void pqProxyPropertyWidget::apply()
{
  if (this->SelectionInputWidget)
    {
    this->SelectionInputWidget->preAccept();
    }
  this->Superclass::apply();

  // apply properties for the proxy selection widget
  if(this->ProxySelectionWidget)
    {
    this->ProxySelectionWidget->accept();
    }

  if (this->SelectionInputWidget)
    {
    this->SelectionInputWidget->postAccept();
    }
}

//-----------------------------------------------------------------------------
void pqProxyPropertyWidget::reset()
{
  if (this->ProxySelectionWidget)
    {
    this->ProxySelectionWidget->reset();
    }
  this->Superclass::reset();
}

//-----------------------------------------------------------------------------
void pqProxyPropertyWidget::select()
{
  if (this->ProxySelectionWidget)
    {
    this->ProxySelectionWidget->select();
    }
}

//-----------------------------------------------------------------------------
void pqProxyPropertyWidget::deselect()
{
  if (this->ProxySelectionWidget)
    {
    this->ProxySelectionWidget->deselect();
    }
}

//-----------------------------------------------------------------------------
void pqProxyPropertyWidget::updateWidget(bool showing_advanced_properties)
{
  if (this->ProxySelectionWidget && this->HideWidgetsInDefaultView)
    {
    this->ProxySelectionWidget->setSelectedProxyWidgetVisibility(showing_advanced_properties);
    }
}