pqPropertyWidget.h

Go to the documentation of this file.

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

   Program: ParaView
   Module: pqPropertyWidget.h

   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.

=========================================================================*/
#ifndef pqPropertyWidget_h
#define pqPropertyWidget_h

#include "pqComponentsModule.h"

#include "pqPropertyLinks.h"
#include <QFrame>
#include <QPointer>
#include <QScopedPointer>

class pqPropertyWidgetDecorator;
class pqTimer;
class pqView;
class vtkPVXMLElement;
class vtkSMDomain;
class vtkSMProperty;
class vtkSMProxy;
class PQCOMPONENTS_EXPORT pqPropertyWidget : public QFrame
{
  Q_OBJECT
  typedef QWidget Superclass;

public:
  pqPropertyWidget(vtkSMProxy* proxy, QWidget* parent = nullptr);
  ~pqPropertyWidget() override;

  virtual void apply();
  virtual void reset();


  virtual void select() { this->Selected = true; }
  virtual void selectPort(int portIndex) { Q_UNUSED(portIndex); }
  virtual void deselect() { this->Selected = false; }
  bool isSelected() const { return this->Selected; }

  // This method is called on pqPropertyWidget instances that pqProxyWidget
  // deems that should be shown in current configuration. Subclasses can
  // override this method to change the appearance of the widget based on
  // whether advanced properties are currently being shown by the pqProxyWidget
  // or not.
  virtual void updateWidget(bool showing_advanced_properties)
  {
    Q_UNUSED(showing_advanced_properties);
  }

  pqView* view() const;
  vtkSMProxy* proxy() const;
  vtkSMProperty* property() const;
  using Superclass::property; // Don't hide superclass method

  virtual char* panelVisibility() const;
  virtual void setPanelVisibility(const char* vis);

  virtual bool isSingleRowItem() const;

  bool showLabel() const;

  template <class T>
  static QString getXMLName(T* object)
  {
    return QString(object->GetXMLName());
  }

  const QList<QPointer<pqPropertyWidgetDecorator>>& decorators() const { return this->Decorators; }

  using Superclass::setProperty;

  static QString getTooltip(vtkSMProperty* property);

  static int hintsWidgetHeightNumberOfRows(vtkPVXMLElement* hints, int defaultValue = 10);

Q_SIGNALS:
  void viewChanged(pqView* view);

  void changeAvailable();

  void changeFinished();

  void restartRequired();

public Q_SLOTS:
  virtual void setView(pqView*);

protected:
  void addPropertyLink(QObject* qobject, const char* qproperty, const char* qsignal,
    vtkSMProperty* smproperty, int smindex = -1);
  void addPropertyLink(QObject* qobject, const char* qproperty, const char* qsignal,
    vtkSMProxy* smproxy, vtkSMProperty* smproperty, int smindex = -1);
  void removePropertyLink(QObject* qobject, const char* qproperty, const char* qsignal,
    vtkSMProperty* smproperty, int smindex = -1);
  void removePropertyLink(QObject* qobject, const char* qproperty, const char* qsignal,
    vtkSMProxy* smproxy, vtkSMProperty* smproperty, int smindex = -1);
  void setShowLabel(bool show);

  void setChangeAvailableAsChangeFinished(bool status)
  {
    this->ChangeAvailableAsChangeFinished = status;
  }

  void addDecorator(pqPropertyWidgetDecorator*);

  void removeDecorator(pqPropertyWidgetDecorator*);

  pqPropertyLinks& links() { return this->Links; }

public:
  void setProperty(vtkSMProperty* property);

private:
  friend class pqCompositePropertyWidgetDecorator;
  friend class pqPropertyWidgetDecorator;
  friend class pqProxyWidget;

private Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  void onChangeAvailable();

private: // NOLINT(readability-redundant-access-specifiers)
  vtkSMProxy* Proxy;
  vtkSMProperty* Property;
  QPointer<pqView> View;
  QList<QPointer<pqPropertyWidgetDecorator>> Decorators;

  pqPropertyLinks Links;
  bool ShowLabel;
  bool ChangeAvailableAsChangeFinished;
  bool Selected;

  const QScopedPointer<pqTimer> Timer;

  void modified();
  void editingFinished();
};

#endif // pqPropertyWidget_h