vtkPropertyDecorator hold the logic of pqPropertyDecorator TODO provides a mechanism to decorate pqProperty instances to add logic to the widget to add additional control logic. More...

#include <vtkPropertyDecorator.h>

Inheritance diagram for vtkPropertyDecorator:

[legend]

Collaboration diagram for vtkPropertyDecorator:

[legend]

Public Types
enum	{ VisibilityChangedEvent = vtkCommand::UserEvent + 1000, EnableStateChangedEvent = vtkCommand::UserEvent + 1001 }
	This event is fired whenever the decorator has determined that the panel may need a refresh since the state of the system has changed which would deem changes in the widget visibility or enable state. More...

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	Initialize (vtkPVXMLElement xml, vtkSMProxy proxy)
	Constructor. More...

virtual bool	CanShow (bool show_advanced) const
	Override this method to override the visibility of the widget in the panel. More...

virtual bool	Enable () const
	Override this method to override the enable state of the widget in the panel. 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 vtkPropertyDecorator *	New ()

static int	IsTypeOf (const char *type)

static vtkPropertyDecorator *	SafeDownCast (vtkObject *o)

static vtkSmartPointer< vtkPropertyDecorator >	Create (vtkPVXMLElement xml, vtkSMProxy proxy)
	Creates a new decorator, given the xml config and the proxy containing the property For unsupported/unknown, implementations should simply return nullptr without raising any errors (or messages). 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
	vtkPropertyDecorator ()

	~vtkPropertyDecorator () override

vtkPVXMLElement *	XML () const

vtkSMProxy *	Proxy () const

void	InvokeVisibilityChangedEvent ()

void	InvokeEnableStateChangedEvent ()

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

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

vtkPropertyDecorator hold the logic of pqPropertyDecorator TODO provides a mechanism to decorate pqProperty instances to add logic to the widget to add additional control logic.

Subclasses can be used to logic to control when the widget is enabled/disabled, hidden/visible, etc. based on values of other properties of UI elements.

Definition at line 29 of file vtkPropertyDecorator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPropertyDecorator::Superclass

Definition at line 34 of file vtkPropertyDecorator.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

This event is fired whenever the decorator has determined that the panel may need a refresh since the state of the system has changed which would deem changes in the widget visibility or enable state.

Enumerator
VisibilityChangedEvent
EnableStateChangedEvent

Definition at line 77 of file vtkPropertyDecorator.h.

Constructor & Destructor Documentation

◆ vtkPropertyDecorator()

vtkPropertyDecorator::vtkPropertyDecorator ( )

protected

◆ ~vtkPropertyDecorator()

vtkPropertyDecorator::~vtkPropertyDecorator ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPropertyDecorator* vtkPropertyDecorator::New ( )

static

◆ GetClassName()

virtual const char* vtkPropertyDecorator::GetClassName ( )

virtual

Reimplemented in vtkCompositePropertyDecorator, vtkGenericPropertyDecorator, vtkSessionTypeDecorator, vtkInputDataTypeDecorator, vtkBoolPropertyDecorator, vtkShowDecorator, vtkMultiComponentsDecorator, vtkEnableDecorator, and vtkOSPRayHidingDecorator.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

Reimplemented in vtkCompositePropertyDecorator, vtkGenericPropertyDecorator, vtkSessionTypeDecorator, vtkInputDataTypeDecorator, vtkBoolPropertyDecorator, vtkShowDecorator, vtkMultiComponentsDecorator, vtkEnableDecorator, and vtkOSPRayHidingDecorator.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

Reimplemented in vtkSessionTypeDecorator, and vtkShowDecorator.

◆ Initialize()

virtual void vtkPropertyDecorator::Initialize	(	vtkPVXMLElement *	xml,
		vtkSMProxy *	proxy
	)

virtual

Constructor.

Parameters

xml	The XML element from the `<Hints/>` section for the proxy/property that resulted in the creation of the decorator. Decorators can be provided configuration parameters from the XML.
proxy	The proxy that owns the property of this decorator

Reimplemented in vtkCompositePropertyDecorator, vtkGenericPropertyDecorator, vtkSessionTypeDecorator, vtkBoolPropertyDecorator, vtkInputDataTypeDecorator, vtkShowDecorator, vtkMultiComponentsDecorator, and vtkEnableDecorator.

◆ CanShow()

virtual bool vtkPropertyDecorator::CanShow ( bool show_advanced ) const

inlinevirtual

Override this method to override the visibility of the widget in the panel.

This is called after the generic tests for advanced and text filtering are passed. Since there can be multiple decorators, the first decorator that returns 'false' wins. Default implementation returns true. Thus subclasses typically override this method only to force the widget invisible given the current state.

Reimplemented in vtkCompositePropertyDecorator, vtkGenericPropertyDecorator, vtkSessionTypeDecorator, vtkInputDataTypeDecorator, vtkMultiComponentsDecorator, vtkShowDecorator, and vtkOSPRayHidingDecorator.

Definition at line 56 of file vtkPropertyDecorator.h.

◆ Enable()

virtual bool vtkPropertyDecorator::Enable ( ) const

inlinevirtual

Override this method to override the enable state of the widget in the panel.

This is called after the generic tests for advanced and text filtering are passed. Since there can be multiple decorators, the first decorator that returns 'false' wins. Default implementation returns true. Thus subclasses typically override this method only to force the widget disabled given the current state.

Reimplemented in vtkCompositePropertyDecorator, vtkGenericPropertyDecorator, vtkSessionTypeDecorator, vtkInputDataTypeDecorator, and vtkEnableDecorator.

Definition at line 70 of file vtkPropertyDecorator.h.

◆ Create()

static vtkSmartPointer<vtkPropertyDecorator> vtkPropertyDecorator::Create	(	vtkPVXMLElement *	xml,
		vtkSMProxy *	proxy
	)

static

Creates a new decorator, given the xml config and the proxy containing the property For unsupported/unknown, implementations should simply return nullptr without raising any errors (or messages).

Supported types are:

EnableWidgetDecorator : vtkEnableWidgetDecorator
ShowWidgetDecorator : vtkShowWidgetDecorator
InputDataTypeDecorator : vtkInputDataTypeDecorator
GenericDecorator: vtkGenericPropertyWidgetDecorator
OSPRayHidingDecorator: vtkOSPRayHidingDecorator
MultiComponentsDecorator: vtkMultiComponentsDecorator
CompositeDecorator: vtkCompositePropertyWidgetDecorator
SessionTypeDecorator: vtkSessionTypeDecorator

◆ XML()

vtkPVXMLElement* vtkPropertyDecorator::XML ( ) const

protected

◆ Proxy()

vtkSMProxy* vtkPropertyDecorator::Proxy ( ) const

protected

◆ InvokeVisibilityChangedEvent()

void vtkPropertyDecorator::InvokeVisibilityChangedEvent ( )

protected

◆ InvokeEnableStateChangedEvent()

void vtkPropertyDecorator::InvokeEnableStateChangedEvent ( )

protected

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ApplicationComponents/vtkPropertyDecorator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkPropertyDecorator()

◆ ~vtkPropertyDecorator()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ Initialize()

◆ CanShow()

◆ Enable()

◆ Create()

◆ XML()

◆ Proxy()

◆ InvokeVisibilityChangedEvent()

◆ InvokeEnableStateChangedEvent()