vtkPropertyDecorator.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 vtkPropertyDecorator_h
#define vtkPropertyDecorator_h

#include "vtkRemotingApplicationComponentsModule.h"

#include "vtkCommand.h"
#include "vtkObject.h"
#include "vtkSMProxy.h"

#include "vtkSmartPointer.h" // needed for vtkSmartPointer
#include "vtkWeakPointer.h"

#include <string>

class vtkPVXMLElement;
class vtkSMProxy;

class VTKREMOTINGAPPLICATIONCOMPONENTS_EXPORT vtkPropertyDecorator : public vtkObject
{

public:
  static vtkPropertyDecorator* New();
  vtkTypeMacro(vtkPropertyDecorator, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void virtual Initialize(vtkPVXMLElement* xml, vtkSMProxy* proxy);

  virtual bool CanShow(bool show_advanced) const
  {
    (void)show_advanced;
    return true;
  }

  virtual bool Enable() const { return true; }

  enum
  {
    VisibilityChangedEvent = vtkCommand::UserEvent + 1000,
    EnableStateChangedEvent = vtkCommand::UserEvent + 1001
  };

  static vtkSmartPointer<vtkPropertyDecorator> Create(vtkPVXMLElement* xml, vtkSMProxy* proxy);

protected:
  vtkPropertyDecorator();
  ~vtkPropertyDecorator() override;
  vtkPVXMLElement* XML() const;
  vtkSMProxy* Proxy() const;

  void InvokeVisibilityChangedEvent();
  void InvokeEnableStateChangedEvent();

private:
  vtkPropertyDecorator(const vtkPropertyDecorator&) = delete;
  void operator=(const vtkPropertyDecorator&) = delete;

  vtkWeakPointer<vtkPVXMLElement> xml_;
  vtkWeakPointer<vtkSMProxy> proxy_;
};

#endif