vtkSMDocumentation.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
2 // SPDX-License-Identifier: BSD-3-Clause
13 #ifndef vtkSMDocumentation_h
14 #define vtkSMDocumentation_h
15 
16 #include "vtkRemotingServerManagerModule.h" //needed for exports
17 #include "vtkSMObject.h"
18 
19 class vtkPVXMLElement;
20 
22 {
23 public:
24  static vtkSMDocumentation* New();
26  void PrintSelf(ostream& os, vtkIndent indent) override;
27 
31  const char* GetLongHelp();
32 
36  const char* GetShortHelp();
37 
41  const char* GetDescription();
42 
44 
47  void SetDocumentationElement(vtkPVXMLElement*);
48  vtkGetObjectMacro(DocumentationElement, vtkPVXMLElement);
49 
50 protected:
52  ~vtkSMDocumentation() override;
54 
56 
57 private:
58  vtkSMDocumentation(const vtkSMDocumentation&) = delete;
59  void operator=(const vtkSMDocumentation&) = delete;
60 
61  std::string Description;
62 };
63 
64 #endif
#define VTKREMOTINGSERVERMANAGER_EXPORT
superclass for most server manager classes
Definition: vtkSMObject.h:17
static vtkSMObject * New()
class providing access to the documentation for a vtkSMProxy.
vtkPVXMLElement * DocumentationElement
This is used by vtkPVXMLParser to represent an XML document starting at the root element.
void PrintSelf(ostream &os, vtkIndent indent) override