?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Version 6.4.0.0.beta1, tag libreoffice-6.4.0.0.beta1
[LibreOffice.git] / extensions / source / propctrlr / formmetadata.hxx
blob9c67e3a9c513f4423bf607e77e455f5398312366
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20 #ifndef INCLUDED_EXTENSIONS_SOURCE_PROPCTRLR_FORMMETADATA_HXX
21 #define INCLUDED_EXTENSIONS_SOURCE_PROPCTRLR_FORMMETADATA_HXX
22
23 #include "propertyinfo.hxx"
24 #include "modulepcr.hxx"
25 #include "enumrepresentation.hxx"
26
27
28 namespace pcr
29 {
30
31
32 struct OPropertyInfoImpl;
33
34
35 //= OPropertyInfoService
36
37 class OPropertyInfoService final
38 :public IPropertyInfoService
39 {
40 static sal_uInt16 s_nCount;
41 static OPropertyInfoImpl* s_pPropertyInfos;
42 // TODO: a real structure which allows quick access by name as well as by id
43
44 public:
45 // IPropertyInfoService
46 virtual sal_Int32 getPropertyId(const OUString& _rName) const override;
47 virtual OUString getPropertyTranslation(sal_Int32 _nId) const override;
48 virtual OString getPropertyHelpId(sal_Int32 _nId) const override;
49 virtual sal_Int16 getPropertyPos(sal_Int32 _nId) const override;
50 virtual sal_uInt32 getPropertyUIFlags(sal_Int32 _nId) const override;
51 virtual std::vector< OUString > getPropertyEnumRepresentations(sal_Int32 _nId) const override;
52
53 bool isComposeable( const OUString& _rPropertyName ) const;
54
55 private:
56 static const OPropertyInfoImpl* getPropertyInfo();
57
58 static const OPropertyInfoImpl* getPropertyInfo(const OUString& _rName);
59 static const OPropertyInfoImpl* getPropertyInfo(sal_Int32 _nId);
60 };
61
62
63 //= DefaultEnumRepresentation
64
65 /** an implementation of the IPropertyEnumRepresentation
66
67 To be used with properties which, in formmetadata.cxx, are declared as ENUM.
68 */
69 class DefaultEnumRepresentation : public IPropertyEnumRepresentation
70 {
71 private:
72 const IPropertyInfoService& m_rMetaData;
73 css::uno::Type m_aType;
74 const sal_Int32 m_nPropertyId;
75
76 public:
77 /** constructs an instance
78
79 @param _rInfo
80 An instance implementing IPropertyInfoService. Must live at least as
81 long as the DefaultEnumRepresentation should live.
82 */
83 DefaultEnumRepresentation( const IPropertyInfoService& _rInfo, const css::uno::Type& _rType, sal_Int32 _nPropertyId );
84
85 protected:
86 virtual ~DefaultEnumRepresentation() override;
87
88 protected:
89 // IPropertyEnumRepresentation implementqation
90 virtual std::vector< OUString >
91 getDescriptions() const override;
92 virtual void getValueFromDescription( const OUString& _rDescription, css::uno::Any& _out_rValue ) const override;
93 virtual OUString getDescriptionForValue( const css::uno::Any& _rEnumValue ) const override;
94
95 private:
96 DefaultEnumRepresentation( const DefaultEnumRepresentation& ) = delete;
97 DefaultEnumRepresentation& operator=( const DefaultEnumRepresentation& ) = delete;
98 };
99
100
101 //= UI flags (for all browseable properties)
102
103
104 #define PROP_FLAG_NONE 0x00000000 // no special flag
105 #define PROP_FLAG_FORM_VISIBLE 0x00000001 // the property is visible when inspecting a form object
106 #define PROP_FLAG_DIALOG_VISIBLE 0x00000002 // the property is visible when inspecting a dialog object
107 #define PROP_FLAG_DATA_PROPERTY 0x00000004 // the property is to appear on the "Data" page
108 #define PROP_FLAG_ENUM 0x00000020 // the property is some kind of enum property, i.e. its
109 // value is chosen from a fixed list of possible values
110 #define PROP_FLAG_ENUM_ONE 0x00000060 // the property is an enum property starting with 1
111 // (note that this includes PROP_FLAG_ENUM)
112 #define PROP_FLAG_COMPOSEABLE 0x00000080 // the property is "composeable", i.e. an intersection of property
113 // sets should expose it, if all elements do
114 #define PROP_FLAG_EXPERIMENTAL 0x00000100 // the property is experimental, i.e. should not appear in the
115 // UI, unless experimental properties are enabled by a configuration
116 // option
117 #define PROP_FLAG_REPORT_INVISIBLE 0x00000200 // the property should not appear in the Report Designer UI
118
119
120 //= property ids (for all browseable properties)
121
122
123 #define PROPERTY_ID_NAME 1
124 #define PROPERTY_ID_LABEL 2
125 #define PROPERTY_ID_CONTROLLABEL 3
126 #define PROPERTY_ID_MAXTEXTLEN 4
127 #define PROPERTY_ID_EDITMASK 5
128 #define PROPERTY_ID_LITERALMASK 6
129 #define PROPERTY_ID_STRICTFORMAT 7
130 #define PROPERTY_ID_ENABLED 8
131 #define PROPERTY_ID_READONLY 9
132 #define PROPERTY_ID_PRINTABLE 10
133 #define PROPERTY_ID_CONTROLSOURCE 11
134 #define PROPERTY_ID_TABSTOP 12
135 #define PROPERTY_ID_TABINDEX 13
136 #define PROPERTY_ID_DATASOURCE 14
137 #define PROPERTY_ID_COMMAND 15
138 #define PROPERTY_ID_COMMANDTYPE 16
139 #define PROPERTY_ID_FILTER 17
140 #define PROPERTY_ID_SORT 18
141 #define PROPERTY_ID_INSERTONLY 19
142 #define PROPERTY_ID_ALLOWADDITIONS 20
143 #define PROPERTY_ID_ALLOWEDITS 21
144 #define PROPERTY_ID_ALLOWDELETIONS 22
145 #define PROPERTY_ID_GROUP_NAME 23
146 #define PROPERTY_ID_NAVIGATION 24
147 #define PROPERTY_ID_CYCLE 25
148 #define PROPERTY_ID_HIDDEN_VALUE 26
149 #define PROPERTY_ID_VALUEMIN 27
150 #define PROPERTY_ID_VALUEMAX 28
151 #define PROPERTY_ID_VALUESTEP 29
152 #define PROPERTY_ID_DEFAULT_VALUE 30
153 #define PROPERTY_ID_DECIMAL_ACCURACY 31
154 #define PROPERTY_ID_SHOWTHOUSANDSEP 32
155 #define PROPERTY_ID_REFVALUE 33
156 #define PROPERTY_ID_CURRENCYSYMBOL 34
157 #define PROPERTY_ID_CURRSYM_POSITION 35
158 #define PROPERTY_ID_DATEMIN 36
159 #define PROPERTY_ID_DATEMAX 37
160 #define PROPERTY_ID_DATEFORMAT 38
161 #define PROPERTY_ID_SELECTEDITEMS 39
162 #define PROPERTY_ID_DEFAULT_DATE 40
163 #define PROPERTY_ID_TIMEMIN 41
164 #define PROPERTY_ID_TIMEMAX 42
165 #define PROPERTY_ID_TIMEFORMAT 43
166 #define PROPERTY_ID_DEFAULT_TIME 44
167 #define PROPERTY_ID_EFFECTIVE_MIN 45
168 #define PROPERTY_ID_EFFECTIVE_MAX 46
169 #define PROPERTY_ID_EFFECTIVE_DEFAULT 47
170 #define PROPERTY_ID_FORMATKEY 48
171 #define PROPERTY_ID_CLASSID 50
172 #define PROPERTY_ID_HEIGHT 51
173 #define PROPERTY_ID_WIDTH 52
174 #define PROPERTY_ID_BOUNDCOLUMN 53
175 #define PROPERTY_ID_LISTSOURCETYPE 54
176 #define PROPERTY_ID_LISTSOURCE 55
177 #define PROPERTY_ID_LISTINDEX 56
178 #define PROPERTY_ID_STRINGITEMLIST 57
179 #define PROPERTY_ID_DEFAULT_TEXT 58
180 #define PROPERTY_ID_FONT 59
181 #define PROPERTY_ID_ALIGN 60
182 #define PROPERTY_ID_ROWHEIGHT 61
183 #define PROPERTY_ID_BACKGROUNDCOLOR 62
184 #define PROPERTY_ID_FILLCOLOR 63
185 #define PROPERTY_ID_ESCAPE_PROCESSING 64
186 #define PROPERTY_ID_LINECOLOR 65
187 #define PROPERTY_ID_BORDER 66
188 #define PROPERTY_ID_DROPDOWN 67
189 #define PROPERTY_ID_AUTOCOMPLETE 68
190 #define PROPERTY_ID_LINECOUNT 69
191 #define PROPERTY_ID_WORDBREAK 70
192 #define PROPERTY_ID_MULTILINE 71
193 #define PROPERTY_ID_MULTISELECTION 72
194 #define PROPERTY_ID_AUTOLINEBREAK 73
195 #define PROPERTY_ID_HSCROLL 74
196 #define PROPERTY_ID_VSCROLL 75
197 #define PROPERTY_ID_SPIN 76
198 #define PROPERTY_ID_BUTTONTYPE 77
199 #define PROPERTY_ID_TARGET_URL 78
200 #define PROPERTY_ID_TARGET_FRAME 79
201 #define PROPERTY_ID_SUBMIT_ACTION 80
202 #define PROPERTY_ID_SUBMIT_TARGET 81
203 #define PROPERTY_ID_SUBMIT_METHOD 82
204 #define PROPERTY_ID_SUBMIT_ENCODING 83
205 #define PROPERTY_ID_DEFAULT_STATE 84
206 #define PROPERTY_ID_DEFAULTBUTTON 85
207 #define PROPERTY_ID_IMAGE_URL 86
208 #define PROPERTY_ID_DEFAULT_SELECT_SEQ 87
209 #define PROPERTY_ID_ECHO_CHAR 88
210 #define PROPERTY_ID_EMPTY_IS_NULL 89
211 #define PROPERTY_ID_TRISTATE 90
212 #define PROPERTY_ID_MASTERFIELDS 91
213 #define PROPERTY_ID_DETAILFIELDS 92
214 #define PROPERTY_ID_RECORDMARKER 93
215 #define PROPERTY_ID_FILTERPROPOSAL 94
216 #define PROPERTY_ID_TAG 95
217 #define PROPERTY_ID_HELPTEXT 96
218 #define PROPERTY_ID_HELPURL 97
219 #define PROPERTY_ID_HASNAVIGATION 98
220 #define PROPERTY_ID_POSITIONX 99
221 #define PROPERTY_ID_POSITIONY 100
222 #define PROPERTY_ID_TITLE 101
223 #define PROPERTY_ID_STEP 102
224 #define PROPERTY_ID_PROGRESSVALUE 103
225 #define PROPERTY_ID_PROGRESSVALUE_MIN 104
226 #define PROPERTY_ID_PROGRESSVALUE_MAX 105
227 #define PROPERTY_ID_SCROLLVALUE 106
228 #define PROPERTY_ID_SCROLLVALUE_MAX 107
229 #define PROPERTY_ID_LINEINCREMENT 108
230 #define PROPERTY_ID_BLOCKINCREMENT 109
231 #define PROPERTY_ID_VISIBLESIZE 110
232 #define PROPERTY_ID_ORIENTATION 111
233 #define PROPERTY_ID_IMAGEPOSITION 112
234 #define PROPERTY_ID_DATE 113
235 #define PROPERTY_ID_STATE 114
236 #define PROPERTY_ID_TIME 115
237 #define PROPERTY_ID_VALUE 116
238 #define PROPERTY_ID_SCALEIMAGE 117
239 #define PROPERTY_ID_PUSHBUTTONTYPE 118
240 #define PROPERTY_ID_EFFECTIVE_VALUE 119
241 #define PROPERTY_ID_TEXT 120
242 #define PROPERTY_ID_BOUND_CELL 121
243 #define PROPERTY_ID_LIST_CELL_RANGE 122
244 #define PROPERTY_ID_CELL_EXCHANGE_TYPE 123
245 #define PROPERTY_ID_SCROLLVALUE_MIN 124
246 #define PROPERTY_ID_DEFAULT_SCROLLVALUE 125
247 #define PROPERTY_ID_REPEAT_DELAY 126
248 #define PROPERTY_ID_SYMBOLCOLOR 127
249 #define PROPERTY_ID_SPINVALUE 128
250 #define PROPERTY_ID_SPINVALUE_MIN 129
251 #define PROPERTY_ID_SPINVALUE_MAX 130
252 #define PROPERTY_ID_DEFAULT_SPINVALUE 131
253 #define PROPERTY_ID_SPININCREMENT 132
254 #define PROPERTY_ID_REPEAT 133
255 #define PROPERTY_ID_SHOW_SCROLLBARS 134
256 #define PROPERTY_ID_ICONSIZE 135
257 #define PROPERTY_ID_SHOW_POSITION 136
258 #define PROPERTY_ID_SHOW_NAVIGATION 137
259 #define PROPERTY_ID_SHOW_RECORDACTIONS 138
260 #define PROPERTY_ID_SHOW_FILTERSORT 139
261 #define PROPERTY_ID_TEXTTYPE 140
262 #define PROPERTY_ID_LINEEND_FORMAT 141
263 #define PROPERTY_ID_TOGGLE 142
264 #define PROPERTY_ID_FOCUSONCLICK 143
265 #define PROPERTY_ID_HIDEINACTIVESELECTION 144
266 #define PROPERTY_ID_VISUALEFFECT 145
267 #define PROPERTY_ID_BORDERCOLOR 146
268 #define PROPERTY_ID_XML_DATA_MODEL 147
269 #define PROPERTY_ID_BIND_EXPRESSION 148
270 #define PROPERTY_ID_XSD_REQUIRED 149
271 #define PROPERTY_ID_XSD_RELEVANT 150
272 #define PROPERTY_ID_XSD_READONLY 151
273 #define PROPERTY_ID_XSD_CONSTRAINT 152
274 #define PROPERTY_ID_XSD_CALCULATION 153
275 #define PROPERTY_ID_XSD_DATA_TYPE 154
276 #define PROPERTY_ID_XSD_WHITESPACES 155
277 #define PROPERTY_ID_XSD_PATTERN 156
278 #define PROPERTY_ID_XSD_LENGTH 157
279 #define PROPERTY_ID_XSD_MIN_LENGTH 158
280 #define PROPERTY_ID_XSD_MAX_LENGTH 159
281 #define PROPERTY_ID_XSD_TOTAL_DIGITS 160
282 #define PROPERTY_ID_XSD_FRACTION_DIGITS 161
283 #define PROPERTY_ID_XSD_MAX_INCLUSIVE_INT 162
284 #define PROPERTY_ID_XSD_MAX_EXCLUSIVE_INT 163
285 #define PROPERTY_ID_XSD_MIN_INCLUSIVE_INT 164
286 #define PROPERTY_ID_XSD_MIN_EXCLUSIVE_INT 165
287 #define PROPERTY_ID_XSD_MAX_INCLUSIVE_DOUBLE 166
288 #define PROPERTY_ID_XSD_MAX_EXCLUSIVE_DOUBLE 167
289 #define PROPERTY_ID_XSD_MIN_INCLUSIVE_DOUBLE 168
290 #define PROPERTY_ID_XSD_MIN_EXCLUSIVE_DOUBLE 169
291 #define PROPERTY_ID_XSD_MAX_INCLUSIVE_DATE 170
292 #define PROPERTY_ID_XSD_MAX_EXCLUSIVE_DATE 171
293 #define PROPERTY_ID_XSD_MIN_INCLUSIVE_DATE 172
294 #define PROPERTY_ID_XSD_MIN_EXCLUSIVE_DATE 173
295 #define PROPERTY_ID_XSD_MAX_INCLUSIVE_TIME 174
296 #define PROPERTY_ID_XSD_MAX_EXCLUSIVE_TIME 175
297 #define PROPERTY_ID_XSD_MIN_INCLUSIVE_TIME 176
298 #define PROPERTY_ID_XSD_MIN_EXCLUSIVE_TIME 177
299 #define PROPERTY_ID_XSD_MAX_INCLUSIVE_DATE_TIME 178
300 #define PROPERTY_ID_XSD_MAX_EXCLUSIVE_DATE_TIME 179
301 #define PROPERTY_ID_XSD_MIN_INCLUSIVE_DATE_TIME 180
302 #define PROPERTY_ID_XSD_MIN_EXCLUSIVE_DATE_TIME 181
303 #define PROPERTY_ID_UNCHECKEDREFVALUE 182
304 #define PROPERTY_ID_SUBMISSION_ID 183
305 #define PROPERTY_ID_XFORMS_BUTTONTYPE 184
306 #define PROPERTY_ID_LIST_BINDING 185
307 #define PROPERTY_ID_VERTICAL_ALIGN 186
308 #define PROPERTY_ID_BINDING_NAME 187
309 #define PROPERTY_ID_DECORATION 188
310 #define PROPERTY_ID_SELECTION_TYPE 189
311 #define PROPERTY_ID_ROOT_DISPLAYED 190
312 #define PROPERTY_ID_SHOWS_HANDLES 191
313 #define PROPERTY_ID_SHOWS_ROOT_HANDLES 192
314 #define PROPERTY_ID_EDITABLE 193
315 #define PROPERTY_ID_INVOKES_STOP_NOT_EDITING 194
316 #define PROPERTY_ID_NOLABEL 195
317 #define PROPERTY_ID_SCALE_MODE 196
318 #define PROPERTY_ID_INPUT_REQUIRED 197
319 #define PROPERTY_ID_WRITING_MODE 198
320 #define PROPERTY_ID_ENABLE_VISIBLE 199
321 #define PROPERTY_ID_WHEEL_BEHAVIOR 200
322 #define PROPERTY_ID_TEXT_ANCHOR_TYPE 201
323 #define PROPERTY_ID_SHEET_ANCHOR_TYPE 202
324 #define PROPERTY_ID_SCROLL_WIDTH 203
325 #define PROPERTY_ID_SCROLL_HEIGHT 204
326 #define PROPERTY_ID_SCROLL_TOP 205
327 #define PROPERTY_ID_SCROLL_LEFT 206
328 #define PROPERTY_ID_TYPEDITEMLIST 207
329 #define PROPERTY_ID_SELECTIONMODEL 208
330 #define PROPERTY_ID_USEGRIDLINE 209
331 #define PROPERTY_ID_GRIDLINECOLOR 210
332 #define PROPERTY_ID_SHOWCOLUMNHEADER 211
333 #define PROPERTY_ID_SHOWROWHEADER 212
334 #define PROPERTY_ID_HEADERBACKGROUNDCOLOR 213
335 #define PROPERTY_ID_HEADERTEXTCOLOR 214
336 #define PROPERTY_ID_ACTIVESELECTIONBACKGROUNDCOLOR 215
337 #define PROPERTY_ID_ACTIVESELECTIONTEXTCOLOR 216
338 #define PROPERTY_ID_INACTIVESELECTIONBACKGROUNDCOLOR 217
339 #define PROPERTY_ID_INACTIVESELECTIONTEXTCOLOR 218
340 #define PROPERTY_ID_URL 219
341 #define PROPERTY_ID_AUTOGROW 220
342
343
344 } // namespace pcr
345
346
347 #endif // INCLUDED_EXTENSIONS_SOURCE_PROPCTRLR_FORMMETADATA_HXX
348
349 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
FREE OFFICE SUITE