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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
/*************************************************************************
*
* $RCSfile: flddropdown.hxx,v $
*
* $Revision: 1.3 $
*
* last change: $Author: obo $ $Date: 2004-08-12 12:02:31 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef _FLDDROPDOWN_HXX
#define _FLDDROPDOWN_HXX
#include <com/sun/star/uno/Sequence.hxx>
#include <fldbas.hxx>
#include <vector>
using namespace ::com::sun::star::uno;
using namespace rtl;
using namespace std;
/**
Field type for dropdown boxes.
*/
class SwDropDownFieldType : public SwFieldType
{
public:
/**
Constructor
*/
SwDropDownFieldType();
/**
Destructor
*/
virtual ~SwDropDownFieldType();
/**
Create a copy of this field type.
@return a copy of this type
*/
virtual SwFieldType * Copy () const;
};
/**
Dropdown field.
The dropdown field contains a list of strings. At most one of them
can be selected.
*/
class SwDropDownField : public SwField
{
/**
the possible values (aka items) of the dropdown box
*/
vector<String> aValues;
/**
the selected item
*/
String aSelectedItem;
/**
the name of the field
*/
String aName;
public:
/**
Constructor
@param pTyp field type for this field
*/
SwDropDownField(SwFieldType * pTyp);
/**
Copy constructor
@param rSrc dropdown field to copy
*/
SwDropDownField(const SwDropDownField & rSrc);
/**
Destructor
*/
virtual ~SwDropDownField();
/**
Expands the field.
The expanded value of the field is the value of the selected
item. If no item is selected, an empty string is returned.
@return the expanded value of the field
*/
virtual String Expand() const;
/**
Creates a copy of this field.
@return the copy of this field
*/
virtual SwField * Copy() const;
/**
Returns the selected value.
@see Expand
@return the selected value
*/
virtual const String & GetPar1() const;
/**
Returns the name of the field.
@return the name of the field
*/
virtual String GetPar2() const;
/**
Sets the selected value.
If rStr is an item of the field that item will be
selected. Otherwise no item will be selected, i.e. the
resulting selection will be empty.
*/
virtual void SetPar1(const String & rStr);
/**
Sets the name of the field.
@param rStr the new name of the field
*/
virtual void SetPar2(const String & rStr);
/**
Sets the items of the dropdown box.
After setting the items the selection will be empty.
@param rItems the new items
*/
void SetItems(const vector<String> & rItems);
/**
Sets the items of the dropdown box.
After setting the items the selection will be empty.
@param rItems the new items
*/
void SetItems(const Sequence<OUString> & rItems);
/**
Returns the items of the dropdown box.
@return the items of the dropdown box
*/
Sequence<OUString> GetItemSequence() const;
/**
Returns the selected item.
@return the selected item
*/
const String & GetSelectedItem() const;
/**
Returns the name of the field.
@return the name of the field
*/
const String & GetName() const;
/**
Sets the selected item.
If rItem is found in this dropdown field it is selected. If
rItem is not found the selection will be empty.
@param rItem the item to be set
@retval TRUE the selected item was successfully set
@retval TRUE failure (empty selection)
*/
BOOL SetSelectedItem(const String & rItem);
/**
Sets the name of the field.
@param rName the new name of the field
*/
void SetName(const String & rName);
/**
API: Gets a property value from the dropdown field.
@param rVal return value
@param nMId
- FIELD_PROP_PAR1 Get selected item (String)
- FIELD_PROP_STRINGS Get all items (Sequence)
*/
virtual BOOL QueryValue(Any &rVal, BYTE nMId) const;
/**
API: Sets a property value on the dropdown field.
@param rVal value to set
@param nMId
- FIELD_PROP_PAR1 Set selected item (String)
- FIELD_PROP_STRINGS Set all items (Sequence)
*/
virtual BOOL PutValue(const Any &rVal, BYTE nMId);
};
#endif
|
