pqPropertiesPanel.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 pqPropertiesPanel_h
#define pqPropertiesPanel_h
 
#include "pqComponentsModule.h"
#include "vtkParaViewDeprecation.h"
 
#include <QWidget>
 
class pqDataRepresentation;
class pqOutputPort;
class pqPipelineSource;
class pqPropertyWidget;
class pqProxy;
class pqView;
class vtkSMProperty;
class vtkSMProxy;
 
class PQCOMPONENTS_EXPORT pqPropertiesPanel : public QWidget
{
  Q_OBJECT
  Q_PROPERTY(int panelMode READ panelMode WRITE setPanelMode);
  typedef QWidget Superclass;
 
public:
  pqPropertiesPanel(QWidget* parent = nullptr);
  ~pqPropertiesPanel() override;
 
  PARAVIEW_DEPRECATED_IN_5_11_0("Use `vtkPVGeneralSettings::SetAutoApply()` instead")
  static void setAutoApply(bool enabled);
 
  PARAVIEW_DEPRECATED_IN_5_11_0("Use `vtkPVGeneralSettings::GetAutoApply()` instead")
  static bool autoApply();
 
  PARAVIEW_DEPRECATED_IN_5_11_0("Use `pqApplyBehavior::setAutoApplyDelay()` instead")
  static void setAutoApplyDelay(int delay);
 
  PARAVIEW_DEPRECATED_IN_5_11_0("Use `pqApplyBehavior::autoApplyDelay()` instead")
  static int autoApplyDelay();
 
  pqView* view() const;
 
  static int suggestedMargin() { return 0; }
  static QMargins suggestedMargins() { return QMargins(0, 0, 0, 0); }
  static int suggestedHorizontalSpacing() { return 4; }
  static int suggestedVerticalSpacing() { return 4; }
 
  enum
  {
    SOURCE_PROPERTIES = 0x01,
    DISPLAY_PROPERTIES = 0x02,
    VIEW_PROPERTIES = 0x04,
    ALL_PROPERTIES = SOURCE_PROPERTIES | DISPLAY_PROPERTIES | VIEW_PROPERTIES
  };
 
  void setPanelMode(int val);
  int panelMode() const { return this->PanelMode; }
 
  bool canApply();
 
  bool canReset();
 
public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  void apply();
 
  void reset();
 
  void showHelp();
 
  void propertiesRestoreDefaults();
 
  void propertiesSaveAsDefaults();
 
  void displayRestoreDefaults();
 
  void displaySaveAsDefaults();
 
  void viewRestoreDefaults();
 
  void viewSaveAsDefaults();
 
  void setView(pqView*);
 
  void setPipelineProxy(pqProxy*);
 
  void setRepresentation(pqDataRepresentation*);
Q_SIGNALS:
  void applied();
 
  void applied(pqProxy*);
 
  void viewChanged(pqView*);
 
  void modified();
  void resetDone();
 
  void helpRequested(const QString& groupname, const QString& proxyType);
 
  void deleteRequested(pqProxy* source);
 
  void applyEnableStateChanged();
 
private Q_SLOTS:
  void deleteProxy();
 
  void proxyDeleted(pqProxy*);
 
  void updatePanel();
 
  void updateDisplayPanel();
 
  void renderActiveView();
 
  void sourcePropertyChanged(bool change_finished = true);
  void sourcePropertyChangeAvailable() { this->sourcePropertyChanged(false); }
 
  void updateButtonState();
 
  void updateButtonEnableState();
 
  void copyProperties();
  void pasteProperties();
  void copyDisplay();
  void pasteDisplay();
  void copyView();
  void pasteView();
 
protected:
  void updatePropertiesPanel(pqProxy* source);
  void updateDisplayPanel(pqDataRepresentation* repr);
  void updateViewPanel(pqView* view);
 
private:
  class pqInternals;
  friend class pqInternals;
 
  pqInternals* Internals;
  int PanelMode;
 
  Q_DISABLE_COPY(pqPropertiesPanel)
};
 
#endif