vtkSMStringListDomain Class Reference

list of strings More...

#include <vtkSMStringListDomain.h>

Inheritance diagram for vtkSMStringListDomain:

[legend]Collaboration diagram for vtkSMStringListDomain:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkSMStringListDomain, vtkSMDomain)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	IsInDomain (vtkSMProperty *property)
int	IsInDomain (const char *string, unsigned int &idx)
unsigned int	GetNumberOfStrings ()
const char *	GetString (unsigned int idx)
unsigned int	AddString (const char *string)
void	RemoveString (const char *string)
void	RemoveAllStrings ()
virtual void	Update (vtkSMProperty *)
virtual void	SetAnimationValue (vtkSMProperty *, int, double)
Static Public Member Functions
vtkSMStringListDomain *	New ()
Protected Member Functions
	vtkSMStringListDomain ()
	~vtkSMStringListDomain ()
virtual int	ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element)
virtual void	SaveState (const char *name, ostream *file, vtkIndent indent)
Protected Attributes
vtkSMStringListDomainInternals *	SLInternals

---

Detailed Description

list of strings

vtkSMStringListDomain represents a domain consisting of a list of strings. It only works with vtkSMStringVectorProperty. Valid XML elements are:

 * <String value="">
 

See also:

vtkSMDomain vtkSMStringVectorProperty

Definition at line 37 of file vtkSMStringListDomain.h.

---

Constructor & Destructor Documentation

vtkSMStringListDomain::vtkSMStringListDomain (   )  [protected]

vtkSMStringListDomain::~vtkSMStringListDomain (   )  [protected]

---

Member Function Documentation

vtkSMStringListDomain* vtkSMStringListDomain::New (   )  [static]

Reimplemented from vtkSMObject. Reimplemented in vtkSMArrayListDomain.

vtkSMStringListDomain::vtkTypeRevisionMacro (  vtkSMStringListDomain  , vtkSMDomain  )

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

Reimplemented from vtkSMDomain. Reimplemented in vtkSMArrayListDomain.

virtual int vtkSMStringListDomain::IsInDomain (  vtkSMProperty *  property  )  [virtual]

Returns true if the value of the property is in the domain. The propery has to be a vtkSMStringVectorProperty. If all vector values are in the domain, it returns 1. It returns 0 otherwise. Implements vtkSMDomain.

int vtkSMStringListDomain::IsInDomain (  const char *  string, unsigned int &  idx )

Returns true if the string is in the domain.

unsigned int vtkSMStringListDomain::GetNumberOfStrings (   )

Returns the number of strings in the domain.

const char* vtkSMStringListDomain::GetString (  unsigned int  idx  )

Returns a string in the domain. The pointer may become invalid once the domain has been modified.

unsigned int vtkSMStringListDomain::AddString (  const char *  string  )

Adds a new string to the domain.

void vtkSMStringListDomain::RemoveString (  const char *  string  )

Removes a string from the domain.

void vtkSMStringListDomain::RemoveAllStrings (   )

Removes all strings from the domain.

virtual void vtkSMStringListDomain::Update (  vtkSMProperty *   )  [virtual]

Update self checking the "unchecked" values of all required properties. Overwritten by sub-classes. Reimplemented from vtkSMDomain. Reimplemented in vtkSMArrayListDomain.

virtual void vtkSMStringListDomain::SetAnimationValue (  vtkSMProperty *  , int  , double  )  [virtual]

Set the value of an element of a property from the animation editor. Reimplemented from vtkSMDomain.

virtual int vtkSMStringListDomain::ReadXMLAttributes (  vtkSMProperty *  prop, vtkPVXMLElement *  element )  [protected, virtual]

Set the appropriate ivars from the xml element. Should be overwritten by subclass if adding ivars. Reimplemented from vtkSMDomain. Reimplemented in vtkSMArrayListDomain.

virtual void vtkSMStringListDomain::SaveState (  const char *  name, ostream *  file, vtkIndent  indent )  [protected, virtual]

Saves the state of the object in XML format. Should be overwritten by proxies and properties. Reimplemented from vtkSMObject.

---

Member Data Documentation

vtkSMStringListDomainInternals* vtkSMStringListDomain::SLInternals [protected]

Definition at line 85 of file vtkSMStringListDomain.h.

---

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

• Servers/ServerManager/vtkSMStringListDomain.h

---