pqPropertyWidget.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
#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);

  static std::vector<std::string> parseComponentLabels(
    vtkPVXMLElement* hints, unsigned int elemCount = 0);

  virtual void setReadOnly(bool readOnly);

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