vtkSMDocumentation.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMDocumentation_h
#define vtkSMDocumentation_h
 
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMObject.h"
 
class vtkPVXMLElement;
 
class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMDocumentation : public vtkSMObject
{
public:
  static vtkSMDocumentation* New();
  vtkTypeMacro(vtkSMDocumentation, vtkSMObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  const char* GetLongHelp();
 
  const char* GetShortHelp();
 
  const char* GetDescription();
 
 
  void SetDocumentationElement(vtkPVXMLElement*);
  vtkGetObjectMacro(DocumentationElement, vtkPVXMLElement);
 
protected:
  vtkSMDocumentation();
  ~vtkSMDocumentation() override;
 
  vtkPVXMLElement* DocumentationElement;
 
private:
  vtkSMDocumentation(const vtkSMDocumentation&) = delete;
  void operator=(const vtkSMDocumentation&) = delete;
 
  std::string Description;
};
 
#endif