vtkSMPropertyGroup.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ParaView
  Module:    vtkSMPropertyGroup.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/

#ifndef vtkSMPropertyGroup_h
#define vtkSMPropertyGroup_h

#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMObject.h"

class vtkPVXMLElement;
class vtkSMDocumentation;
class vtkSMProperty;
class vtkSMPropertyGroupInternals;
class vtkSMProxy;

class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMPropertyGroup : public vtkSMObject
{
public:
  static vtkSMPropertyGroup* New();
  vtkTypeMacro(vtkSMPropertyGroup, vtkSMObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetStringMacro(Name);
  vtkGetStringMacro(Name);


  vtkSetStringMacro(XMLLabel);
  vtkGetStringMacro(XMLLabel);


  vtkSetStringMacro(PanelWidget);
  vtkGetStringMacro(PanelWidget);


  vtkSetStringMacro(PanelVisibility);
  vtkGetStringMacro(PanelVisibility);

  bool IsEmpty() const;

  void AddProperty(const char* function, vtkSMProperty* property, const char* name = nullptr);

  const char* GetPropertyName(unsigned int index) const;

  vtkSMProperty* GetProperty(unsigned int index) const;

  vtkSMProperty* GetProperty(const char* function) const;

  const char* GetFunction(vtkSMProperty* property) const;

  unsigned int GetNumberOfProperties() const;

  vtkGetObjectMacro(Documentation, vtkSMDocumentation);


  vtkGetObjectMacro(Hints, vtkPVXMLElement);
  void SetHints(vtkPVXMLElement* hints);

protected:
  vtkSMPropertyGroup();
  ~vtkSMPropertyGroup() override;

  friend class vtkSMProxy;
  virtual int ReadXMLAttributes(vtkSMProxy* parent, vtkPVXMLElement* element);

  vtkPVXMLElement* Hints;
  vtkSMDocumentation* Documentation;

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

  char* Name;
  char* XMLLabel;
  char* PanelWidget;
  char* PanelVisibility;

  vtkSMPropertyGroupInternals* const Internals;
};

#endif