vtkSMGlobalPropertiesManager Class Reference

manager for application wide properties. More...

#include <vtkSMGlobalPropertiesManager.h>

Inheritance diagram for vtkSMGlobalPropertiesManager:

Collaboration diagram for vtkSMGlobalPropertiesManager:

List of all members.

Classes
struct	ModifiedInfo
Public Types
enum	Events { GlobalPropertyLinkModified = 3000 }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
bool	InitializeProperties (const char *xmlgroup, const char *xmlname)
const char *	GetGlobalPropertyName (vtkSMProxy *proxy, const char *propname)
virtual vtkPVXMLElement *	SaveLinkState (vtkPVXMLElement *root)
virtual int	LoadLinkState (vtkPVXMLElement *element, vtkSMProxyLocator *locator)
void	SetGlobalPropertyLink (const char *globalPropertyName, vtkSMProxy *, const char *propname)
void	RemoveGlobalPropertyLink (const char *globalPropertyName, vtkSMProxy *, const char *propname)
Static Public Member Functions
static vtkSMGlobalPropertiesManager *	New ()
static int	IsTypeOf (const char *type)
static vtkSMGlobalPropertiesManager *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMGlobalPropertiesManager ()
	~vtkSMGlobalPropertiesManager ()
virtual void	SetPropertyModifiedFlag (const char *name, int flag)

---

Detailed Description

manager for application wide properties.

ParaView has notion of "global properties". These are application wide properties such as foreground color, text color etc. Changing values of these properties affects all objects that are linked to these properties. This class provides convenient API to setup/remove such links.

This is a vtkSMProxy subclass only so that the global properties can be defined in XML configuration. It should be treated more like a manager than proxy.

Definition at line 32 of file vtkSMGlobalPropertiesManager.h.

---

Member Enumeration Documentation

enum vtkSMGlobalPropertiesManager::Events

Enumerator:

GlobalPropertyLinkModified

Definition at line 77 of file vtkSMGlobalPropertiesManager.h.

---

Constructor & Destructor Documentation

vtkSMGlobalPropertiesManager::vtkSMGlobalPropertiesManager

(

)

[protected]

vtkSMGlobalPropertiesManager::~vtkSMGlobalPropertiesManager

(

)

[protected]

---

Member Function Documentation

static vtkSMGlobalPropertiesManager* vtkSMGlobalPropertiesManager::New

(

)

[static]

Reimplemented from vtkSMProxy.

virtual const char* vtkSMGlobalPropertiesManager::GetClassName

(

)

[virtual]

Reimplemented from vtkSMProxy.

static int vtkSMGlobalPropertiesManager::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkSMProxy.

virtual int vtkSMGlobalPropertiesManager::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkSMProxy.

static vtkSMGlobalPropertiesManager* vtkSMGlobalPropertiesManager::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkSMProxy.

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

Reimplemented from vtkSMProxy.

bool vtkSMGlobalPropertiesManager::InitializeProperties	(	const char *	xmlgroup,
		const char *	xmlname
	)

Initialize the manager using the xml definition.

const char* vtkSMGlobalPropertiesManager::GetGlobalPropertyName	(	vtkSMProxy *	proxy,
		const char *	propname
	)

Returns the name of the global property with which the given property is linked. NULL is returned if the property is not linked with any global properties.

void vtkSMGlobalPropertiesManager::SetGlobalPropertyLink	(	const char *	globalPropertyName,
		vtkSMProxy *	,
		const char *	propname
	)

Sets up a link between the global property and the property if none already exists. If the property is already linked with some other global property, then that link is broken, since a property can be linked to only one global property at a time.

void vtkSMGlobalPropertiesManager::RemoveGlobalPropertyLink	(	const char *	globalPropertyName,
		vtkSMProxy *	,
		const char *	propname
	)

Remove a link.

virtual vtkPVXMLElement* vtkSMGlobalPropertiesManager::SaveLinkState

(

vtkPVXMLElement *

root

)

[virtual]

Saves the links state.

virtual int vtkSMGlobalPropertiesManager::LoadLinkState	(	vtkPVXMLElement *	element,
		vtkSMProxyLocator *	locator
	)		[virtual]

Loads the state for the links.

virtual void vtkSMGlobalPropertiesManager::SetPropertyModifiedFlag	(	const char *	name,
		int	flag
	)		[protected, virtual]

Overridden to propagate the modification to the linked properties.

Reimplemented from vtkSMProxy.

---

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

• dox/ParaViewCore/ServerManager/vtkSMGlobalPropertiesManager.h