pqProxyWidget.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 pqProxyWidget_h
#define pqProxyWidget_h

#include "pqComponentsModule.h"
#include <QSet>
#include <QWidget>

class pqPropertyWidget;
class pqView;
class vtkSMProperty;
class vtkSMProxy;
class QPoint;

class PQCOMPONENTS_EXPORT pqProxyWidget : public QWidget
{
  Q_OBJECT
  typedef QWidget Superclass;

public:
  pqProxyWidget(vtkSMProxy* proxy, const QStringList& properties,
    std::initializer_list<QString> defaultLabels, std::initializer_list<QString> advancedLabels,
    bool showHeadersFooters = true, QWidget* parent = nullptr,
    Qt::WindowFlags flags = Qt::WindowFlags{});

  pqProxyWidget(vtkSMProxy* proxy, std::initializer_list<QString> defaultLabels,
    std::initializer_list<QString> advancedLabels, QWidget* parent = nullptr,
    Qt::WindowFlags flags = Qt::WindowFlags{});

  pqProxyWidget(vtkSMProxy* proxy, const QStringList& properties, bool showHeadersFooters = true,
    QWidget* parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags{});

  pqProxyWidget(vtkSMProxy* proxy, QWidget* parent, Qt::WindowFlags flags = Qt::WindowFlags{});

  pqProxyWidget(vtkSMProxy* proxy);

  ~pqProxyWidget() override;

  vtkSMProxy* proxy() const;

  void setApplyChangesImmediately(bool value);
  bool applyChangesImmediately() const { return this->ApplyChangesImmediately; }

  bool useDocumentationForLabels() const { return this->UseDocumentationForLabels; }

  static QWidget* newGroupLabelWidget(const QString& label, QWidget* parentWidget,
    const QList<QWidget*>& buttons = QList<QWidget*>());

  static bool useDocumentationForLabels(vtkSMProxy* proxy);

  enum DocumentationType
  {
    NONE,
    USE_DESCRIPTION,
    USE_SHORT_HELP,
    USE_LONG_HELP
  };

  static QString documentationText(
    vtkSMProperty* property, DocumentationType type = USE_DESCRIPTION);

  static QString documentationText(vtkSMProxy* property, DocumentationType type = USE_DESCRIPTION);

  static DocumentationType showProxyDocumentationInPanel(vtkSMProxy* proxy);


  const QSet<QString>& defaultVisibilityLabels() const { return this->DefaultVisibilityLabels; }
  const QSet<QString>& advancedVisibilityLabels() const { return this->AdvancedVisibilityLabels; }

  void showContextMenu(const QPoint& pt, pqPropertyWidget* propWidget);

Q_SIGNALS:
  void changeAvailable();

  void changeFinished();

  void restartRequired();

public Q_SLOTS:
  bool filterWidgets(bool show_advanced = false, const QString& filterText = QString());

  void showLinkedInteractiveWidget(int portIndex, bool show, bool changeFocus);

  virtual void apply() const;

  void reset() const;

  void setView(pqView*);

  void updatePanel();

  virtual bool restoreDefaults();

  void saveAsDefaults() const;

  static pqPropertyWidget* createWidgetForProperty(
    vtkSMProperty* property, vtkSMProxy* proxy, QWidget* parentObj);

protected:
  void showEvent(QShowEvent* event) override;
  void hideEvent(QHideEvent* event) override;

  void applyInternal() const;

protected Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  virtual void onChangeFinished();

private:
  void createWidgets(const QStringList& properties = QStringList());

  void createPropertyWidgets(const QStringList& properties = QStringList());

  void create3DWidgets();

  bool shouldPreservePropertyValues() const;

  bool resetProperty(vtkSMProperty* prop, double settingsPriority, bool warn);

  void resetPropertyToAppDefault(pqPropertyWidget* propWidget);

  void resetPropertyToUserDefault(pqPropertyWidget* propWidget);

  Q_DISABLE_COPY(pqProxyWidget);

  QSet<QString> DefaultVisibilityLabels;
  QSet<QString> AdvancedVisibilityLabels;
  bool ApplyChangesImmediately;
  bool UseDocumentationForLabels;
  bool ShowHeadersFooters = false;
  class pqInternals;
  pqInternals* Internals;
};

#endif