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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
/**
*
* This file is part of Tulip (www.tulip-software.org)
*
* Authors: David Auber and the Tulip development Team
* from LaBRI, University of Bordeaux 1 and Inria Bordeaux - Sud Ouest
*
* Tulip is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3
* of the License, or (at your option) any later version.
*
* Tulip is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details.
*
*/
// +-------------------------------------------------------------------------+
// | Tulip Python Bindings |
// | inspired from bindings by the Booggie project development team |
// | (http://booggie.org/) |
// +-------------------------------------------------------------------------+
namespace tlp {
class StringCollection {
%TypeHeaderCode
#include <tulip/StringCollection.h>
%End
public:
%Docstring
.. deprecated:: 4.8
You should never have to use that class directly from now on.
Algorithm parameters of that type are now internally handled for commodity of use
(see :ref:`Deprecation of direct use of the tlp.StringCollection class <deprecatedStringCollection>`).
This class represents a list of selectable string entries that can be used as plugin parameter.
The list will appear as a combo box in the Plugin Parameter Dialog from the Tulip GUI.
%End
// ===========================================================================
StringCollection();
StringCollection(const std::vector<std::string> &vectorParam);
StringCollection(const std::string param);
StringCollection(const std::vector<std::string>& vectorParam, int currentParam);
StringCollection(const std::vector<std::string>& vectorParam, std::string currentString);
// ===========================================================================
std::string getCurrentString();
%Docstring
tlp.StringCollection.getCurrentString()
Returns the current selected string value.
:rtype: string
%End
// ===========================================================================
bool setCurrent(unsigned int param);
%Docstring
tlp.StringCollection.setCurrent(index)
Sets the current selected string index.
Returns :const:`True` if the provided index is valid.
:param index: a valid index in the string collection
:type index: integer
:rtype: boolean
%End
// ===========================================================================
bool setCurrent(std::string param);
%Docstring
tlp.StringCollection.setCurrent(value)
Sets the current selected string value.
Returns :const:`True` if the string value exists in the collection.
:param value: a string value from the collection
:type value: string
:rtype: boolean
%End
// ===========================================================================
int getCurrent();
%Docstring
tlp.StringCollection.getCurrent()
Returns the index of the current selected string.
:rtype: integer
%End
// ===========================================================================
void push_back(const std::string& element);
%Docstring
tlp.StringCollection.push_back(element)
Adds a string value to this string collection.
:param element: the string to add to the collection
:type element: string
%End
// ===========================================================================
bool empty();
%Docstring
tlp.StringCollection.empty()
Returns :const:`True` if the collection is empty.
:rtype: boolean
%End
// ===========================================================================
std::string at(const unsigned int index);
%Docstring
tlp.StringCollection.at(index)
Returns the string element at a certain index in the collection.
:param index: a valid index in the collection
:type index: integer
:rtype: string
%End
// ===========================================================================
unsigned int size();
%Docstring
tlp.StringCollection.size()
Returns the number of strings in the collection.
:rtype: integer
%End
// ===========================================================================
std::string operator[](const unsigned int i) const;
%MethodCode
if (a0 < sipCpp->size()) {
sipRes = new std::string((*sipCpp)[a0]);
} else {
sipIsErr = -1;
PyErr_SetNone(PyExc_IndexError);
}
%End
void __setitem__(int i, const std::string &value);
%MethodCode
(*sipCpp)[a0] = *a1;
%End
};
};
|
