Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkSMPropertyIterator Class Reference

iterates over the properties of a proxy More...

#include <vtkSMPropertyIterator.h>

Inheritance diagram for vtkSMPropertyIterator:

Inheritance graph
[legend]
Collaboration diagram for vtkSMPropertyIterator:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeRevisionMacro (vtkSMPropertyIterator, vtkSMObject)
void PrintSelf (ostream &os, vtkIndent indent)
void SetProxy (vtkSMProxy *proxy)
void Begin ()
int IsAtEnd ()
void Next ()
const char * GetKey ()
vtkSMPropertyGetProperty ()
virtual vtkSMProxyGetProxy ()
virtual void SetTraverseSubProxies (int)
virtual int GetTraverseSubProxies ()

Static Public Member Functions

vtkSMPropertyIteratorNew ()

Protected Member Functions

 vtkSMPropertyIterator ()
 ~vtkSMPropertyIterator ()
virtual void SaveState (const char *, ostream *, vtkIndent)

Protected Attributes

vtkSMProxyProxy
int TraverseSubProxies

Detailed Description

iterates over the properties of a proxy

vtkSMPropertyIterator is used to iterate over the properties of a proxy. The properties of the root proxies as well as sub-proxies are included in the iteration. For sub-proxies, only exposed properties are iterated over.

Definition at line 36 of file vtkSMPropertyIterator.h.


Constructor & Destructor Documentation

vtkSMPropertyIterator::vtkSMPropertyIterator  )  [protected]
 

vtkSMPropertyIterator::~vtkSMPropertyIterator  )  [protected]
 


Member Function Documentation

vtkSMPropertyIterator* vtkSMPropertyIterator::New  )  [static]
 

Reimplemented from vtkSMObject.

vtkSMPropertyIterator::vtkTypeRevisionMacro vtkSMPropertyIterator  ,
vtkSMObject 
 

void vtkSMPropertyIterator::PrintSelf ostream &  os,
vtkIndent  indent
 

Reimplemented from vtkSMObject.

void vtkSMPropertyIterator::SetProxy vtkSMProxy proxy  ) 
 

Set the proxy to be used.

virtual vtkSMProxy* vtkSMPropertyIterator::GetProxy  )  [virtual]
 

Return the proxy.

void vtkSMPropertyIterator::Begin  ) 
 

Go to the first property.

int vtkSMPropertyIterator::IsAtEnd  ) 
 

Returns true if iterator points past the end of the collection.

void vtkSMPropertyIterator::Next  ) 
 

Move to the next property.

const char* vtkSMPropertyIterator::GetKey  ) 
 

Returns the key (name) at the current iterator position.

vtkSMProperty* vtkSMPropertyIterator::GetProperty  ) 
 

Returns the property at the current iterator position.

virtual void vtkSMPropertyIterator::SetTraverseSubProxies int   )  [virtual]
 

If TraverseSubProxies is false, only the properties belonging to the root proxy are returned. Default is true.

virtual int vtkSMPropertyIterator::GetTraverseSubProxies  )  [virtual]
 

If TraverseSubProxies is false, only the properties belonging to the root proxy are returned. Default is true.

virtual void vtkSMPropertyIterator::SaveState const char *  ,
ostream *  ,
vtkIndent 
[inline, protected, virtual]
 

Saves the state of the object in XML format. Should be overwritten by proxies and properties.

Reimplemented from vtkSMObject.

Definition at line 81 of file vtkSMPropertyIterator.h.


Member Data Documentation

vtkSMProxy* vtkSMPropertyIterator::Proxy [protected]
 

Definition at line 77 of file vtkSMPropertyIterator.h.

int vtkSMPropertyIterator::TraverseSubProxies [protected]
 

Definition at line 79 of file vtkSMPropertyIterator.h.


The documentation for this class was generated from the following file:
Generated on Tue May 30 12:41:59 2006 for ParaView by doxygen 1.3.5