ParaView
|
class providing access to the documentation for a vtkSMProxy. More...
#include <vtkSMDocumentation.h>
Public Types | |
typedef vtkSMObject | Superclass |
![]() | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) |
const char * | GetLongHelp () |
Returns the text for long help, if any. More... | |
const char * | GetShortHelp () |
Returns the text for short help, if any. More... | |
const char * | GetDescription () |
Returns the description text, if any. More... | |
![]() | |
void | PrintSelf (ostream &os, vtkIndent indent) |
Static Public Member Functions | |
static vtkSMDocumentation * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMDocumentation * | SafeDownCast (vtkObject *o) |
![]() | |
static vtkSMObject * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMObject * | SafeDownCast (vtkObject *o) |
Protected Attributes | |
vtkPVXMLElement * | DocumentationElement |
void | SetDocumentationElement (vtkPVXMLElement *) |
Get/Set the documentation XML element. More... | |
virtual vtkPVXMLElement * | GetDocumentationElement () |
Get/Set the documentation XML element. More... | |
vtkSMDocumentation () | |
Get/Set the documentation XML element. More... | |
~vtkSMDocumentation () | |
Get/Set the documentation XML element. More... | |
Additional Inherited Members | |
![]() | |
vtkSMObject () | |
~vtkSMObject () | |
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 33 of file vtkSMDocumentation.h.
Definition at line 37 of file vtkSMDocumentation.h.
|
protected |
Get/Set the documentation XML element.
|
protected |
Get/Set the documentation XML element.
|
static |
|
virtual |
Reimplemented from vtkSMObject.
|
static |
|
virtual |
Reimplemented from vtkSMObject.
|
static |
void vtkSMDocumentation::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
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 |
Get/Set the documentation XML element.
|
protected |
Definition at line 67 of file vtkSMDocumentation.h.