1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
/*=========================================================================
Program: ParaView
Module: vtkSMDocumentation.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.
=========================================================================*/
/**
* @class vtkSMDocumentation
* @brief class providing access to the documentation
* for a vtkSMProxy.
*
* Every proxy defined in the server manager XML can have documentation
* associated with it. This class provides access to the various types
* of documentation text for every proxy.
*/
#ifndef vtkSMDocumentation_h
#define vtkSMDocumentation_h
#include "vtkPVServerManagerCoreModule.h" //needed for exports
#include "vtkSMObject.h"
class vtkPVXMLElement;
class VTKPVSERVERMANAGERCORE_EXPORT vtkSMDocumentation : public vtkSMObject
{
public:
static vtkSMDocumentation* New();
vtkTypeMacro(vtkSMDocumentation, vtkSMObject);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* Returns the text for long help, if any. NULL otherwise.
*/
const char* GetLongHelp();
/**
* Returns the text for short help, if any. NULL otherwise.
*/
const char* GetShortHelp();
/**
* Returns the description text, if any.
*/
const char* GetDescription();
//@{
/**
* Get/Set the documentation XML element.
*/
void SetDocumentationElement(vtkPVXMLElement*);
vtkGetObjectMacro(DocumentationElement, vtkPVXMLElement);
protected:
vtkSMDocumentation();
~vtkSMDocumentation();
//@}
vtkPVXMLElement* DocumentationElement;
private:
vtkSMDocumentation(const vtkSMDocumentation&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMDocumentation&) VTK_DELETE_FUNCTION;
};
#endif
|
