Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSMStringListDomain Class Reference

list of strings More...

#include <vtkSMStringListDomain.h>

Inheritance diagram for vtkSMStringListDomain:
Inheritance graph
[legend]
Collaboration diagram for vtkSMStringListDomain:
Collaboration graph
[legend]

Public Types

typedef vtkSMDomain Superclass
 
- Public Types inherited from vtkSMDomain
enum  IsInDomainReturnCodes { NOT_APPLICABLE = -1, NOT_IN_DOMAIN = 0, IN_DOMAIN = 1 }
 Return values for IsInDomain calls. More...
 
typedef vtkSMSessionObject Superclass
 
- Public Types inherited from vtkSMSessionObject
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
 
int IsInDomain (vtkSMProperty *property) override
 Returns true if the value of the property is in the domain. More...
 
int IsInDomain (const char *string, unsigned int &idx)
 Returns true if the string is in the domain. More...
 
const char * GetString (unsigned int idx)
 Returns a string in the domain. More...
 
unsigned int GetNumberOfStrings ()
 Returns the number of strings in the domain. More...
 
void Update (vtkSMProperty *) override
 Update self checking the "unchecked" values of all required properties. More...
 
void SetAnimationValue (vtkSMProperty *, int, double) override
 Set the value of an element of a property from the animation editor. More...
 
virtual char * GetNoneString ()
 Return the string that is used as "none_string" in XML configuration. More...
 
virtual void SetNoneString (const char *)
 Return the string that is used as "none_string" in XML configuration. More...
 
- Public Member Functions inherited from vtkSMDomain
virtual int IsInDomain (vtkSMProperty *vtkNotUsed(property))
 Is the (unchecked) value of the property in the domain? Overwritten by sub-classes. More...
 
virtual void SetAnimationValue (vtkSMProperty *, int vtkNotUsed(index), double vtkNotUsed(value))
 Set the value of an element of a property from the animation editor. More...
 
virtual int SetDefaultValues (vtkSMProperty *, bool vtkNotUsed(use_unchecked_values))
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 
vtkSMPropertyGetProperty ()
 Provides access to the vtkSMProperty on which this domain is hooked up. More...
 
virtual unsigned int GetNumberOfInputConnections (const char *function)
 Helper method to get the number of input connections hence the number of available vtkPVDataInformation from input proxy connected to the required property with the given function. More...
 
vtkSMPropertyGetRequiredProperty (const char *function)
 Returns a given required property of the given function. More...
 
virtual char * GetXMLName ()
 Assigned by the XML parser. More...
 
virtual bool GetIsOptional ()
 When the IsOptional flag is set, IsInDomain() always returns true. More...
 
virtual vtkPVDataInformationGetInputDataInformation (const char *function, unsigned int index=0)
 Helper methods to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More...
 
virtual vtkPVDataInformationGetInputSubsetDataInformation (unsigned int compositeIndex, const char *function, unsigned int index=0)
 Helper methods to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More...
 
- Public Member Functions inherited from vtkSMSessionObject
virtual vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual void SetSession (vtkSMSession *)
 Get/Set the session on wihch this object exists. More...
 
virtual vtkSMSessionGetSession ()
 Get/Set the session on wihch this object exists. 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)
 
vtkCommandGetCommand (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)
 
vtkCommandGetCommand (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 vtkSMStringListDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMStringListDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMDomain
static vtkSMDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element) override
 Set the appropriate ivars from the xml element. More...
 
void ChildSaveState (vtkPVXMLElement *domainElement) override
 Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes. More...
 
virtual void SetStrings (const std::vector< std::string > &strings)
 Call to set the strings. More...
 
const std::vector< std::string > & GetStrings ()
 Call to set the strings. More...
 
- Protected Member Functions inherited from vtkSMDomain
 vtkSMDomain ()
 
 ~vtkSMDomain () override
 
virtual int LoadState (vtkPVXMLElement *vtkNotUsed(domainElement), vtkSMProxyLocator *vtkNotUsed(loader))
 Load the state of the domain from the XML. More...
 
void RemoveRequiredProperty (vtkSMProperty *prop)
 Remove the given property from the required properties list. More...
 
void AddRequiredProperty (vtkSMProperty *prop, const char *function)
 Add a new required property to this domain. More...
 
void DomainModified ()
 Invokes DomainModifiedEvent. More...
 
void InvokeModified ()
 
unsigned int GetNumberOfRequiredProperties ()
 Gets the number of required properties added. More...
 
void SetProperty (vtkSMProperty *)
 Set the domain's property. More...
 
void SaveState (vtkPVXMLElement *parent, const char *uid)
 Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes. More...
 
virtual void SetIsOptional (bool)
 When the IsOptional flag is set, IsInDomain() always returns true. More...
 
virtual void SetXMLName (const char *)
 Assigned by the XML parser. More...
 
- Protected Member Functions inherited from vtkSMSessionObject
 vtkSMSessionObject ()
 
 ~vtkSMSessionObject () override
 
- 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

char * NoneString
 Default string always present in this string list. More...
 
- Protected Attributes inherited from vtkSMDomain
char * XMLName
 
bool IsOptional
 
vtkSMDomainInternals * Internals
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 Identifies the session id to which this object is related. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
int SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) override
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 
 vtkSMStringListDomain ()
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 
 ~vtkSMStringListDomain () override
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 

Detailed Description

list of strings

vtkSMStringListDomain represents a domain consisting of a list of strings. It only works with vtkSMStringVectorProperty.

Supported attributes:

Valid XML elements are:

* * <String value="">
* 
See also
vtkSMDomain vtkSMStringVectorProperty

Definition at line 44 of file vtkSMStringListDomain.h.

Member Typedef Documentation

◆ Superclass

Definition at line 48 of file vtkSMStringListDomain.h.

Constructor & Destructor Documentation

◆ vtkSMStringListDomain()

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::~vtkSMStringListDomain ( )
overrideprotected

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

◆ New()

static vtkSMStringListDomain* vtkSMStringListDomain::New ( )
static

◆ GetClassName()

virtual const char* vtkSMStringListDomain::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ IsInDomain() [1/2]

int vtkSMStringListDomain::IsInDomain ( vtkSMProperty property)
override

Returns true if the value of the property is in the domain.

The property has to be a vtkSMStringVectorProperty. If all vector values are in the domain, it returns 1. It returns 0 otherwise.

◆ IsInDomain() [2/2]

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

Returns true if the string is in the domain.

◆ GetString()

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

Returns a string in the domain.

The pointer may become invalid once the domain has been modified.

◆ GetNumberOfStrings()

unsigned int vtkSMStringListDomain::GetNumberOfStrings ( )

Returns the number of strings in the domain.

◆ Update()

void vtkSMStringListDomain::Update ( vtkSMProperty )
overridevirtual

Update self checking the "unchecked" values of all required properties.

Overwritten by sub-classes.

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMChartSeriesSelectionDomain, vtkSMChartSeriesListDomain, vtkSMRepresentedArrayListDomain, vtkSMMaterialDomain, and vtkSMRendererDomain.

◆ SetAnimationValue()

void vtkSMStringListDomain::SetAnimationValue ( vtkSMProperty ,
int  ,
double   
)
override

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

◆ GetNoneString()

virtual char* vtkSMStringListDomain::GetNoneString ( )
virtual

Return the string that is used as "none_string" in XML configuration.

◆ SetNoneString()

virtual void vtkSMStringListDomain::SetNoneString ( const char *  )
virtual

Return the string that is used as "none_string" in XML configuration.

◆ SetDefaultValues()

int vtkSMStringListDomain::SetDefaultValues ( vtkSMProperty ,
bool  use_unchecked_values 
)
override

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.

◆ ReadXMLAttributes()

int vtkSMStringListDomain::ReadXMLAttributes ( vtkSMProperty prop,
vtkPVXMLElement element 
)
overrideprotectedvirtual

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMChartSeriesSelectionDomain, vtkSMChartSeriesListDomain, vtkSMRepresentedArrayListDomain, vtkSMMaterialDomain, and vtkSMRendererDomain.

◆ ChildSaveState()

void vtkSMStringListDomain::ChildSaveState ( vtkPVXMLElement domainElement)
overrideprotectedvirtual

Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes.

The newly created element will also be added to the parent element as a child node. Subclasses can override ChildSaveState() method to fill it up with subclass specific values.

Reimplemented from vtkSMDomain.

◆ SetStrings()

virtual void vtkSMStringListDomain::SetStrings ( const std::vector< std::string > &  strings)
protectedvirtual

Call to set the strings.

Will fire DomainModifiedEvent if the domain values have indeed changed.

◆ GetStrings()

const std::vector<std::string>& vtkSMStringListDomain::GetStrings ( )
protected

Call to set the strings.

Will fire DomainModifiedEvent if the domain values have indeed changed.

Member Data Documentation

◆ NoneString

char* vtkSMStringListDomain::NoneString
protected

Default string always present in this string list.

When selected, it is equivalent with not selecting any string.

Definition at line 124 of file vtkSMStringListDomain.h.


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