iterates over the properties of a proxy More...

#include <vtkSMPropertyIterator.h>

Inheritance diagram for vtkSMPropertyIterator:

[legend]

Collaboration diagram for vtkSMPropertyIterator:

[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

virtual void	SetProxy (vtkSMProxy *proxy)
	Set the proxy to be used. More...

virtual void	Begin ()
	Go to the first property. More...

virtual int	IsAtEnd ()
	Returns true if iterator points past the end of the collection. More...

virtual void	Next ()
	Move to the next property. More...

virtual const char *	GetKey ()
	Returns the key (name) at the current iterator position. More...

virtual const char *	GetPropertyLabel ()
	Returns the XMLLabel for self properties and the exposed name for sub-proxy properties. More...

virtual vtkSMProperty *	GetProperty ()
	Returns the property at the current iterator position. More...


virtual vtkSMProxy *	GetProxy ()
	Return the proxy. More...


virtual void	SetTraverseSubProxies (int)
	If TraverseSubProxies is false, only the properties belonging to the root proxy are returned. More...

virtual int	GetTraverseSubProxies ()
	If TraverseSubProxies is false, only the properties belonging to the root proxy are returned. More...

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)

vtkCommand *	GetCommand (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)

vtkCommand *	GetCommand (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 vtkSMPropertyIterator *	New ()

static int	IsTypeOf (const char *type)

static vtkSMPropertyIterator *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMObject
static vtkSMObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (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 vtkObject *	New ()

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 vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkSMPropertyIterator ()

	~vtkSMPropertyIterator () override

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

Protected Attributes
vtkSMProxy *	Proxy

int	TraverseSubProxies

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 24 of file vtkSMPropertyIterator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMObject vtkSMPropertyIterator::Superclass

Definition at line 28 of file vtkSMPropertyIterator.h.

Constructor & Destructor Documentation

◆ vtkSMPropertyIterator()

vtkSMPropertyIterator::vtkSMPropertyIterator ( )

protected

◆ ~vtkSMPropertyIterator()

vtkSMPropertyIterator::~vtkSMPropertyIterator ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMPropertyIterator* vtkSMPropertyIterator::New ( )

static

◆ GetClassName()

virtual const char* vtkSMPropertyIterator::GetClassName ( )

virtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMNamedPropertyIterator.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMNamedPropertyIterator.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMObject.

◆ SetProxy()

virtual void vtkSMPropertyIterator::SetProxy ( vtkSMProxy * proxy )

virtual

Set the proxy to be used.

◆ GetProxy()

virtual vtkSMProxy* vtkSMPropertyIterator::GetProxy ( )

virtual

Return the proxy.

◆ Begin()

virtual void vtkSMPropertyIterator::Begin ( )

virtual

Go to the first property.

Reimplemented in vtkSMNamedPropertyIterator.

◆ IsAtEnd()

virtual int vtkSMPropertyIterator::IsAtEnd ( )

virtual

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

Reimplemented in vtkSMNamedPropertyIterator.

◆ Next()

virtual void vtkSMPropertyIterator::Next ( )

virtual

Move to the next property.

Reimplemented in vtkSMNamedPropertyIterator.

◆ GetKey()

virtual const char* vtkSMPropertyIterator::GetKey ( )

virtual

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

Reimplemented in vtkSMNamedPropertyIterator.

◆ GetPropertyLabel()

virtual const char* vtkSMPropertyIterator::GetPropertyLabel ( )

virtual

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

Reimplemented in vtkSMNamedPropertyIterator.

◆ GetProperty()

virtual vtkSMProperty* vtkSMPropertyIterator::GetProperty ( )

virtual

Returns the property at the current iterator position.

Reimplemented in vtkSMNamedPropertyIterator.

◆ SetTraverseSubProxies()

virtual void vtkSMPropertyIterator::SetTraverseSubProxies ( int )

virtual

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

Default is true.

◆ GetTraverseSubProxies()

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

◆ Proxy

vtkSMProxy* vtkSMPropertyIterator::Proxy

protected

Definition at line 87 of file vtkSMPropertyIterator.h.

◆ TraverseSubProxies

int vtkSMPropertyIterator::TraverseSubProxies

protected

Definition at line 89 of file vtkSMPropertyIterator.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMPropertyIterator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMPropertyIterator()

◆ ~vtkSMPropertyIterator()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetProxy()

◆ GetProxy()

◆ Begin()

◆ IsAtEnd()

◆ Next()

◆ GetKey()

◆ GetPropertyLabel()

◆ GetProperty()

◆ SetTraverseSubProxies()

◆ GetTraverseSubProxies()

Member Data Documentation

◆ Proxy

◆ TraverseSubProxies