1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*=========================================================================
Program: ParaView
Module: vtkSMStringListDomain.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkSMStringListDomain
* @brief list of strings
*
* vtkSMStringListDomain represents a domain consisting of a list of
* strings. It only works with vtkSMStringVectorProperty.
* Valid XML elements are:
* @verbatim
* * <String value="">
* @endverbatim
* @sa
* vtkSMDomain vtkSMStringVectorProperty
*/
#ifndef vtkSMStringListDomain_h
#define vtkSMStringListDomain_h
#include "vtkPVServerManagerCoreModule.h" //needed for exports
#include "vtkSMDomain.h"
#include <vector> // needed for vector.
class vtkStdString;
struct vtkSMStringListDomainInternals;
class VTKPVSERVERMANAGERCORE_EXPORT vtkSMStringListDomain : public vtkSMDomain
{
public:
static vtkSMStringListDomain* New();
vtkTypeMacro(vtkSMStringListDomain, vtkSMDomain);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* 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.
*/
virtual int IsInDomain(vtkSMProperty* property) VTK_OVERRIDE;
/**
* Returns true if the string is in the domain.
*/
int IsInDomain(const char* string, unsigned int& idx);
/**
* Returns a string in the domain. The pointer may become
* invalid once the domain has been modified.
*/
const char* GetString(unsigned int idx);
/**
* Returns the number of strings in the domain.
*/
unsigned int GetNumberOfStrings();
/**
* Update self checking the "unchecked" values of all required
* properties. Overwritten by sub-classes.
*/
virtual void Update(vtkSMProperty*) VTK_OVERRIDE;
/**
* Set the value of an element of a property from the animation editor.
*/
virtual void SetAnimationValue(vtkSMProperty*, int, double) VTK_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.
*/
virtual int SetDefaultValues(vtkSMProperty*, bool use_unchecked_values) VTK_OVERRIDE;
protected:
vtkSMStringListDomain();
~vtkSMStringListDomain();
//@}
/**
* Set the appropriate ivars from the xml element. Should
* be overwritten by subclass if adding ivars.
*/
virtual int ReadXMLAttributes(vtkSMProperty* prop, vtkPVXMLElement* element) VTK_OVERRIDE;
virtual void ChildSaveState(vtkPVXMLElement* domainElement) VTK_OVERRIDE;
//@{
/**
* Call to set the strings. Will fire DomainModifiedEvent if the domain values
* have indeed changed.
*/
virtual void SetStrings(const std::vector<vtkStdString>& strings);
const std::vector<vtkStdString>& GetStrings();
//@}
private:
vtkSMStringListDomain(const vtkSMStringListDomain&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMStringListDomain&) VTK_DELETE_FUNCTION;
vtkSMStringListDomainInternals* SLInternals;
};
#endif
|
