pqPropertyLinksConnection.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 pqPropertyLinksConnection_h
#define pqPropertyLinksConnection_h

#include <QObject>
#include <QPointer>

#include "pqCoreModule.h"
#include "vtkEventQtSlotConnect.h"
#include "vtkNew.h"
#include "vtkSMProperty.h"
#include "vtkSMProxy.h"
#include "vtkWeakPointer.h"

class pqPropertyLinks;

class PQCORE_EXPORT pqPropertyLinksConnection : public QObject
{
  Q_OBJECT
  typedef QObject Superclass;

public:
  pqPropertyLinksConnection(QObject* qobject, const char* qproperty, const char* qsignal,
    vtkSMProxy* smproxy, vtkSMProperty* smproperty, int smindex, bool use_unchecked_modified_event,
    QObject* parentObject = nullptr);

  ~pqPropertyLinksConnection() override;

  void setUseUncheckedProperties(bool useUnchecked);

  bool operator==(const pqPropertyLinksConnection& other) const;

  QObject* objectQt() const { return this->ObjectQt; }
  const QString& propertyQt() const { return this->PropertyQt; }

  vtkSMProxy* proxy() const { return this->ProxySM; }
  vtkSMProxy* proxySM() const { return this->ProxySM; }
  vtkSMProperty* propertySM() const { return this->PropertySM; }
  int indexSM() const { return this->IndexSM; }

  void setTraceChanges(bool trace) { this->TraceChanges = trace; }
  bool traceChanges() const { return this->TraceChanges; }

public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  void copyValuesFromServerManagerToQt(bool use_unchecked);

  void copyValuesFromQtToServerManager(bool use_unchecked);

protected:
  virtual void setQtValue(const QVariant& value);
  virtual void setServerManagerValue(bool use_unchecked, const QVariant& value);
  virtual QVariant currentQtValue() const;
  virtual QVariant currentServerManagerValue(bool use_unchecked) const;

Q_SIGNALS:
  void qtpropertyModified();

  void smpropertyModified();

private:
  Q_DISABLE_COPY(pqPropertyLinksConnection)
  vtkNew<vtkEventQtSlotConnect> VTKConnector;

  QPointer<QObject> ObjectQt;
  QString PropertyQt;
  QString SignalQt;

  vtkWeakPointer<vtkSMProxy> ProxySM;
  vtkWeakPointer<vtkSMProperty> PropertySM;
  int IndexSM;
  bool TraceChanges;
};

#endif