class providing access to the documentation for a vtkSMProxy. More...
#include <vtkSMDocumentation.h>
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| const char * | GetLongHelp () |
| const char * | GetShortHelp () |
| const char * | GetDescription () |
Static Public Member Functions | |
| static vtkSMDocumentation * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkSMDocumentation * | SafeDownCast (vtkObject *o) |
Protected Attributes | |
| vtkPVXMLElement * | DocumentationElement |
| void | SetDocumentationElement (vtkPVXMLElement *) |
| virtual vtkPVXMLElement * | GetDocumentationElement () |
| vtkSMDocumentation () | |
| ~vtkSMDocumentation () | |
Detailed Description
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.
Definition at line 31 of file vtkSMDocumentation.h.
Constructor & Destructor Documentation
| vtkSMDocumentation::vtkSMDocumentation | ( | ) | [protected] |
Get/Set the documentation XML element.
| vtkSMDocumentation::~vtkSMDocumentation | ( | ) | [protected] |
Get/Set the documentation XML element.
Member Function Documentation
| static vtkSMDocumentation* vtkSMDocumentation::New | ( | ) | [static] |
Reimplemented from vtkSMObject.
| virtual const char* vtkSMDocumentation::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkSMObject.
| static int vtkSMDocumentation::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkSMObject.
| virtual int vtkSMDocumentation::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkSMObject.
| static vtkSMDocumentation* vtkSMDocumentation::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkSMObject.
| void vtkSMDocumentation::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkSMObject.
| const char* vtkSMDocumentation::GetLongHelp | ( | ) |
Returns the text for long help, if any. NULL otherwise.
| const char* vtkSMDocumentation::GetShortHelp | ( | ) |
Returns the text for short help, if any. NULL otherwise.
| const char* vtkSMDocumentation::GetDescription | ( | ) |
Returns the description text, if any.
| void vtkSMDocumentation::SetDocumentationElement | ( | vtkPVXMLElement * | ) |
Get/Set the documentation XML element.
| virtual vtkPVXMLElement* vtkSMDocumentation::GetDocumentationElement | ( | ) | [virtual] |
Get/Set the documentation XML element.
Member Data Documentation
vtkPVXMLElement* vtkSMDocumentation::DocumentationElement [protected] |
Definition at line 56 of file vtkSMDocumentation.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ServerManager/vtkSMDocumentation.h
