ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
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

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetProxy (vtkSMProxy *proxy)
virtual void Begin ()
virtual int IsAtEnd ()
virtual void Next ()
virtual const char * GetKey ()
virtual const char * GetPropertyLabel ()
virtual vtkSMPropertyGetProperty ()
virtual vtkSMProxyGetProxy ()
virtual void SetTraverseSubProxies (int)
virtual int GetTraverseSubProxies ()

Static Public Member Functions

static vtkSMPropertyIteratorNew ()
static int IsTypeOf (const char *type)
static vtkSMPropertyIteratorSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSMPropertyIterator ()
 ~vtkSMPropertyIterator ()

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

static vtkSMPropertyIterator* vtkSMPropertyIterator::New ( ) [static]

Reimplemented from vtkSMObject.

Reimplemented in vtkSMNamedPropertyIterator.

virtual const char* vtkSMPropertyIterator::GetClassName ( ) [virtual]

Reimplemented from vtkSMObject.

Reimplemented in vtkSMNamedPropertyIterator.

static int vtkSMPropertyIterator::IsTypeOf ( const char *  type) [static]

Reimplemented from vtkSMObject.

Reimplemented in vtkSMNamedPropertyIterator.

virtual int vtkSMPropertyIterator::IsA ( const char *  type) [virtual]

Reimplemented from vtkSMObject.

Reimplemented in vtkSMNamedPropertyIterator.

static vtkSMPropertyIterator* vtkSMPropertyIterator::SafeDownCast ( vtkObject o) [static]

Reimplemented from vtkSMObject.

Reimplemented in vtkSMNamedPropertyIterator.

virtual void vtkSMPropertyIterator::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Reimplemented from vtkSMObject.

Reimplemented in vtkSMNamedPropertyIterator.

virtual void vtkSMPropertyIterator::SetProxy ( vtkSMProxy proxy) [virtual]

Set the proxy to be used.

virtual vtkSMProxy* vtkSMPropertyIterator::GetProxy ( ) [virtual]

Return the proxy.

virtual void vtkSMPropertyIterator::Begin ( ) [virtual]

Go to the first property.

Reimplemented in vtkSMNamedPropertyIterator.

virtual int vtkSMPropertyIterator::IsAtEnd ( ) [virtual]

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

Reimplemented in vtkSMNamedPropertyIterator.

virtual void vtkSMPropertyIterator::Next ( ) [virtual]

Move to the next property.

Reimplemented in vtkSMNamedPropertyIterator.

virtual const char* vtkSMPropertyIterator::GetKey ( ) [virtual]

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

Reimplemented in vtkSMNamedPropertyIterator.

virtual const char* vtkSMPropertyIterator::GetPropertyLabel ( ) [virtual]

Returns the XMLLabel for self properties and the exposed name for sub-proxy properties.

Reimplemented in vtkSMNamedPropertyIterator.

virtual vtkSMProperty* vtkSMPropertyIterator::GetProperty ( ) [virtual]

Returns the property at the current iterator position.

Reimplemented in vtkSMNamedPropertyIterator.

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.


Member Data Documentation

Definition at line 81 of file vtkSMPropertyIterator.h.

Definition at line 83 of file vtkSMPropertyIterator.h.


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