#include <vtkSMPropertyGroup.h>

Inheritance diagram for vtkSMPropertyGroup:

Collaboration diagram for vtkSMPropertyGroup:

[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

bool	IsEmpty () const
	Returns true if the property group contains zero properties. More...

void	AddProperty (const char function, vtkSMProperty property, const char *name=nullptr)
	Adds `property` to the group. More...

const char *	GetPropertyName (unsigned int index) const
	Returns the name for a property at the given index. More...

vtkSMProperty *	GetProperty (unsigned int index) const
	Returns the property at `index`. More...

vtkSMProperty *	GetProperty (const char *function) const
	Returns the property associated with a given function, if any. More...

const char *	GetFunction (vtkSMProperty *property) const
	Given property in the group, returns its function. More...

unsigned int	GetNumberOfProperties () const
	Returns the number of properties in the group. More...

virtual vtkSMDocumentation *	GetDocumentation ()
	Returns the documentation for this proxy. More...


virtual void	SetName (const char *)
	Get/Sets the name of the property group to `name`. More...

virtual char *	GetName ()
	Get/Sets the name of the property group to `name`. More...


virtual void	SetXMLLabel (const char *)
	Gets/Sets the name of the property group to `name`. More...

virtual char *	GetXMLLabel ()
	Gets/Sets the name of the property group to `name`. More...


virtual void	SetPanelWidget (const char *)
	Get/Sets the name of the panel widget to use for the property group. More...

virtual char *	GetPanelWidget ()
	Get/Sets the name of the panel widget to use for the property group. More...


virtual void	SetPanelVisibility (const char *)
	Get/Sets the panel visibility for the property group. More...

virtual char *	GetPanelVisibility ()
	Get/Sets the panel visibility for the property group. More...


virtual vtkPVXMLElement *	GetHints ()
	The server manager configuration XML may define `<Hints />` element for a property-group. More...

void	SetHints (vtkPVXMLElement *hints)
	The server manager configuration XML may define `<Hints />` element for a property-group. 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 vtkSMPropertyGroup *	New ()

static int	IsTypeOf (const char *type)

static vtkSMPropertyGroup *	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
	vtkSMPropertyGroup ()

	~vtkSMPropertyGroup () override

virtual int	ReadXMLAttributes (vtkSMProxy parent, vtkPVXMLElement element)

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
vtkPVXMLElement *	Hints

vtkSMDocumentation *	Documentation

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkSMProxy

Detailed Description

Definition at line 16 of file vtkSMPropertyGroup.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMObject vtkSMPropertyGroup::Superclass

Definition at line 20 of file vtkSMPropertyGroup.h.

Constructor & Destructor Documentation

◆ vtkSMPropertyGroup()

vtkSMPropertyGroup::vtkSMPropertyGroup ( )

protected

◆ ~vtkSMPropertyGroup()

vtkSMPropertyGroup::~vtkSMPropertyGroup ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMPropertyGroup* vtkSMPropertyGroup::New ( )

static

◆ GetClassName()

virtual const char* vtkSMPropertyGroup::GetClassName ( )

virtual

Reimplemented from vtkSMObject.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMObject.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMObject.

◆ SetName()

virtual void vtkSMPropertyGroup::SetName ( const char * )

virtual

Get/Sets the name of the property group to name.

◆ GetName()

virtual char* vtkSMPropertyGroup::GetName ( )

virtual

Get/Sets the name of the property group to name.

◆ SetXMLLabel()

virtual void vtkSMPropertyGroup::SetXMLLabel ( const char * )

virtual

Gets/Sets the name of the property group to name.

◆ GetXMLLabel()

virtual char* vtkSMPropertyGroup::GetXMLLabel ( )

virtual

Gets/Sets the name of the property group to name.

◆ SetPanelWidget()

virtual void vtkSMPropertyGroup::SetPanelWidget ( const char * )

virtual

Get/Sets the name of the panel widget to use for the property group.

◆ GetPanelWidget()

virtual char* vtkSMPropertyGroup::GetPanelWidget ( )

virtual

Get/Sets the name of the panel widget to use for the property group.

◆ SetPanelVisibility()

virtual void vtkSMPropertyGroup::SetPanelVisibility ( const char * )

virtual

Get/Sets the panel visibility for the property group.

See also: vtkSMProperty::SetPanelVisibility()

◆ GetPanelVisibility()

virtual char* vtkSMPropertyGroup::GetPanelVisibility ( )

virtual

Get/Sets the panel visibility for the property group.

See also: vtkSMProperty::SetPanelVisibility()

◆ IsEmpty()

bool vtkSMPropertyGroup::IsEmpty ( ) const

Returns true if the property group contains zero properties.

◆ AddProperty()

void vtkSMPropertyGroup::AddProperty	(	const char *	function,
		vtkSMProperty *	property,
		const char *	name = `nullptr`
	)

Adds property to the group.

name is the name of the property. If nullptr, then the property's XML name is used. function is the role assigned to this property. If nullptr, the name (either specified as argument, or the XML name for the property) will be used.

◆ GetPropertyName()

const char* vtkSMPropertyGroup::GetPropertyName ( unsigned int index ) const

Returns the name for a property at the given index.

◆ GetProperty() [1/2]

vtkSMProperty* vtkSMPropertyGroup::GetProperty ( unsigned int index ) const

Returns the property at index.

◆ GetProperty() [2/2]

vtkSMProperty* vtkSMPropertyGroup::GetProperty ( const char * function ) const

Returns the property associated with a given function, if any.

◆ GetFunction()

const char* vtkSMPropertyGroup::GetFunction ( vtkSMProperty * property ) const

Given property in the group, returns its function.

Will return nullptr if the property is not present in this group.

◆ GetNumberOfProperties()

unsigned int vtkSMPropertyGroup::GetNumberOfProperties ( ) const

Returns the number of properties in the group.

◆ GetDocumentation()

virtual vtkSMDocumentation* vtkSMPropertyGroup::GetDocumentation ( )

virtual

Returns the documentation for this proxy.

◆ GetHints()

virtual vtkPVXMLElement* vtkSMPropertyGroup::GetHints ( )

virtual

The server manager configuration XML may define <Hints /> element for a property-group.

Hints are metadata associated with the property-group. The Server Manager does not (and should not) interpret the hints. Hints provide a mechanism to add GUI pertinent information to the server manager XML. Returns the XML element for the hints associated with this property, if any, otherwise returns nullptr;

◆ SetHints()

void vtkSMPropertyGroup::SetHints ( vtkPVXMLElement * hints )

The server manager configuration XML may define <Hints /> element for a property-group.

Hints are metadata associated with the property-group. The Server Manager does not (and should not) interpret the hints. Hints provide a mechanism to add GUI pertinent information to the server manager XML. Returns the XML element for the hints associated with this property, if any, otherwise returns nullptr;

◆ ReadXMLAttributes()

virtual int vtkSMPropertyGroup::ReadXMLAttributes	(	vtkSMProxy *	parent,
		vtkPVXMLElement *	element
	)

protectedvirtual

Friends And Related Function Documentation

◆ vtkSMProxy

friend class vtkSMProxy

friend

Definition at line 119 of file vtkSMPropertyGroup.h.

Member Data Documentation

◆ Hints

vtkPVXMLElement* vtkSMPropertyGroup::Hints

protected

Definition at line 122 of file vtkSMPropertyGroup.h.

◆ Documentation

vtkSMDocumentation* vtkSMPropertyGroup::Documentation

protected

Definition at line 123 of file vtkSMPropertyGroup.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMPropertyGroup()

◆ ~vtkSMPropertyGroup()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetName()

◆ GetName()

◆ SetXMLLabel()

◆ GetXMLLabel()

◆ SetPanelWidget()

◆ GetPanelWidget()

◆ SetPanelVisibility()

◆ GetPanelVisibility()

◆ IsEmpty()

◆ AddProperty()

◆ GetPropertyName()

◆ GetProperty() [1/2]

◆ GetProperty() [2/2]

◆ GetFunction()

◆ GetNumberOfProperties()

◆ GetDocumentation()

◆ GetHints()

◆ SetHints()

◆ ReadXMLAttributes()

Friends And Related Function Documentation

◆ vtkSMProxy

Member Data Documentation

◆ Hints

◆ Documentation