ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
vtkSMDocumentation Class Reference

class providing access to the documentation for a vtkSMProxy. More...

#include <vtkSMDocumentation.h>

Inheritance diagram for vtkSMDocumentation:
Inheritance graph
[legend]
Collaboration diagram for vtkSMDocumentation:
Collaboration graph
[legend]

Public Types

typedef vtkSMObject Superclass
 
- Public Types inherited from vtkSMObject
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...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSMDocumentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMDocumentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Attributes

vtkPVXMLElementDocumentationElement
 
void SetDocumentationElement (vtkPVXMLElement *)
 Get/Set the documentation XML element. More...
 
virtual vtkPVXMLElementGetDocumentationElement ()
 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

- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

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 33 of file vtkSMDocumentation.h.

Member Typedef Documentation

§ Superclass

Definition at line 37 of file vtkSMDocumentation.h.

Constructor & Destructor Documentation

§ vtkSMDocumentation()

vtkSMDocumentation::vtkSMDocumentation ( )
protected

Get/Set the documentation XML element.

§ ~vtkSMDocumentation()

vtkSMDocumentation::~vtkSMDocumentation ( )
protected

Get/Set the documentation XML element.

Member Function Documentation

§ New()

static vtkSMDocumentation* vtkSMDocumentation::New ( )
static

§ GetClassName()

virtual const char* vtkSMDocumentation::GetClassName ( )
virtual

Reimplemented from vtkSMObject.

§ IsTypeOf()

static int vtkSMDocumentation::IsTypeOf ( const char *  type)
static

§ IsA()

virtual int vtkSMDocumentation::IsA ( const char *  type)
virtual

Reimplemented from vtkSMObject.

§ SafeDownCast()

static vtkSMDocumentation* vtkSMDocumentation::SafeDownCast ( vtkObject *  o)
static

§ PrintSelf()

void vtkSMDocumentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

§ GetLongHelp()

const char* vtkSMDocumentation::GetLongHelp ( )

Returns the text for long help, if any.

NULL otherwise.

§ GetShortHelp()

const char* vtkSMDocumentation::GetShortHelp ( )

Returns the text for short help, if any.

NULL otherwise.

§ GetDescription()

const char* vtkSMDocumentation::GetDescription ( )

Returns the description text, if any.

§ SetDocumentationElement()

void vtkSMDocumentation::SetDocumentationElement ( vtkPVXMLElement )

Get/Set the documentation XML element.

§ GetDocumentationElement()

virtual vtkPVXMLElement* vtkSMDocumentation::GetDocumentationElement ( )
virtual

Get/Set the documentation XML element.

Member Data Documentation

§ DocumentationElement

vtkPVXMLElement* vtkSMDocumentation::DocumentationElement
protected

Definition at line 67 of file vtkSMDocumentation.h.


The documentation for this class was generated from the following file: