list of strings More...
#include <vtkSMStringListDomain.h>
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| 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) |
| virtual int | RemoveString (const char *string) |
| virtual void | RemoveAllStrings () |
| virtual void | Update (vtkSMProperty *) |
| virtual void | SetAnimationValue (vtkSMProperty *, int, double) |
Static Public Member Functions | |
| static vtkSMStringListDomain * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkSMStringListDomain * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| virtual int | ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element) |
| virtual void | ChildSaveState (vtkPVXMLElement *domainElement) |
| virtual int | LoadState (vtkPVXMLElement *domainElement, vtkSMProxyLocator *loader) |
Protected Attributes | |
| vtkSMStringListDomainInternals * | SLInternals |
| virtual int | SetDefaultValues (vtkSMProperty *) |
| vtkSMStringListDomain () | |
| ~vtkSMStringListDomain () | |
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] |
A vtkSMProperty is often defined with a default value in the XML itself. However, many times, the default value must be determined at run time. To facilitate this, domains can override this method to compute and set the default value for the property. Note that unlike the compile-time default values, the application must explicitly call this method to initialize the property. Returns 1 if the domain updated the property.
| vtkSMStringListDomain::~vtkSMStringListDomain | ( | ) | [protected] |
A vtkSMProperty is often defined with a default value in the XML itself. However, many times, the default value must be determined at run time. To facilitate this, domains can override this method to compute and set the default value for the property. Note that unlike the compile-time default values, the application must explicitly call this method to initialize the property. Returns 1 if the domain updated the property.
Member Function Documentation
| static vtkSMStringListDomain* vtkSMStringListDomain::New | ( | ) | [static] |
Reimplemented from vtkSMSessionObject.
Reimplemented in vtkSMArrayListDomain, and vtkSMFileListDomain.
| virtual const char* vtkSMStringListDomain::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkSMDomain.
Reimplemented in vtkSMArrayListDomain, and vtkSMFileListDomain.
| static int vtkSMStringListDomain::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkSMDomain.
Reimplemented in vtkSMArrayListDomain, and vtkSMFileListDomain.
| virtual int vtkSMStringListDomain::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkSMDomain.
Reimplemented in vtkSMArrayListDomain, and vtkSMFileListDomain.
| static vtkSMStringListDomain* vtkSMStringListDomain::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkSMDomain.
Reimplemented in vtkSMArrayListDomain, and vtkSMFileListDomain.
| void vtkSMStringListDomain::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkSMDomain.
Reimplemented in vtkSMArrayListDomain, and vtkSMFileListDomain.
| 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.
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.
Reimplemented in vtkSMArrayListDomain.
| virtual int vtkSMStringListDomain::RemoveString | ( | const char * | string | ) | [virtual] |
Removes a string from the domain. Returns the index of the removed string. Will return -1, if the string was not found.
Reimplemented in vtkSMArrayListDomain.
| virtual void vtkSMStringListDomain::RemoveAllStrings | ( | ) | [virtual] |
Removes all strings from the domain.
Reimplemented in vtkSMArrayListDomain.
| 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::SetDefaultValues | ( | vtkSMProperty * | ) | [virtual] |
A vtkSMProperty is often defined with a default value in the XML itself. However, many times, the default value must be determined at run time. To facilitate this, domains can override this method to compute and set the default value for the property. Note that unlike the compile-time default values, the application must explicitly call this method to initialize the property. Returns 1 if the domain updated the property.
Reimplemented from vtkSMDomain.
Reimplemented in vtkSMArrayListDomain, and vtkSMFileListDomain.
| 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::ChildSaveState | ( | vtkPVXMLElement * | domainElement | ) | [protected, virtual] |
Reimplemented from vtkSMDomain.
| virtual int vtkSMStringListDomain::LoadState | ( | vtkPVXMLElement * | domainElement, |
| vtkSMProxyLocator * | loader | ||
| ) | [protected, virtual] |
Member Data Documentation
vtkSMStringListDomainInternals* vtkSMStringListDomain::SLInternals [protected] |
Definition at line 100 of file vtkSMStringListDomain.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ServerManager/vtkSMStringListDomain.h
