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) override
 
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) override
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

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)
 
static std::string CreatePrettyLabel (const std::string &name)
 Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Attributes

vtkPVXMLElementDocumentationElement
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
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 () override
 Get/Set the documentation XML element. More...
 

Additional Inherited Members

- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

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

Member Typedef Documentation

◆ Superclass

Definition at line 25 of file vtkSMDocumentation.h.

Constructor & Destructor Documentation

◆ vtkSMDocumentation()

vtkSMDocumentation::vtkSMDocumentation ( )
protected

Get/Set the documentation XML element.

◆ ~vtkSMDocumentation()

vtkSMDocumentation::~vtkSMDocumentation ( )
overrideprotected

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 
)
overridevirtual

Reimplemented from vtkObject.

◆ GetLongHelp()

const char* vtkSMDocumentation::GetLongHelp ( )

Returns the text for long help, if any.

nullptr otherwise.

◆ GetShortHelp()

const char* vtkSMDocumentation::GetShortHelp ( )

Returns the text for short help, if any.

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


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