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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _XMLOFF_XMLSECTIONEXPORT_HXX_
#define _XMLOFF_XMLSECTIONEXPORT_HXX_
#include <rtl/ustring.hxx>
#include <com/sun/star/uno/Reference.h>
#include <com/sun/star/uno/Sequence.h>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <xmloff/xmltoken.hxx>
class SvXMLExport;
class XMLTextParagraphExport;
namespace com { namespace sun { namespace star {
namespace text
{
class XTextSection;
class XDocumentIndex;
class XTextContent;
}
namespace beans
{
class XPropertySet;
}
namespace container
{
class XIndexReplace;
}
} } }
enum SectionTypeEnum
{
TEXT_SECTION_TYPE_SECTION,
// indices: keep index valued together and do not change order,
// because they are used to index into array
TEXT_SECTION_TYPE_TOC,
TEXT_SECTION_TYPE_TABLE,
TEXT_SECTION_TYPE_ILLUSTRATION,
TEXT_SECTION_TYPE_OBJECT,
TEXT_SECTION_TYPE_USER,
TEXT_SECTION_TYPE_ALPHABETICAL,
TEXT_SECTION_TYPE_BIBLIOGRAPHY,
// index header sections:
TEXT_SECTION_TYPE_HEADER,
TEXT_SECTION_TYPE_UNKNOWN
};
/**
* This class handles the export of sections and indices (which are,
* internally, just sections). It is intended to be used only from
* within the XMLTextParagraphExport class.
*/
class XMLSectionExport
{
const ::rtl::OUString sCondition;
const ::rtl::OUString sCreateFromChapter;
const ::rtl::OUString sCreateFromEmbeddedObjects;
const ::rtl::OUString sCreateFromGraphicObjects;
const ::rtl::OUString sCreateFromLabels;
const ::rtl::OUString sCreateFromMarks;
const ::rtl::OUString sCreateFromOtherEmbeddedObjects;
const ::rtl::OUString sCreateFromOutline;
const ::rtl::OUString sCreateFromStarCalc;
const ::rtl::OUString sCreateFromStarChart;
const ::rtl::OUString sCreateFromStarDraw;
const ::rtl::OUString sCreateFromStarImage;
const ::rtl::OUString sCreateFromStarMath;
const ::rtl::OUString sCreateFromTables;
const ::rtl::OUString sCreateFromTextFrames;
const ::rtl::OUString sDdeCommandElement;
const ::rtl::OUString sDdeCommandFile;
const ::rtl::OUString sDdeCommandType;
const ::rtl::OUString sFileLink;
const ::rtl::OUString sIsCaseSensitive;
const ::rtl::OUString sIsProtected;
const ::rtl::OUString sIsVisible;
const ::rtl::OUString sLabelCategory;
const ::rtl::OUString sLabelDisplayType;
const ::rtl::OUString sLevel;
const ::rtl::OUString sLevelFormat;
const ::rtl::OUString sLevelParagraphStyles;
const ::rtl::OUString sLinkRegion;
const ::rtl::OUString sMainEntryCharacterStyleName;
const ::rtl::OUString sParaStyleHeading;
const ::rtl::OUString sParaStyleLevel;
const ::rtl::OUString sTitle;
const ::rtl::OUString sName;
const ::rtl::OUString sUseAlphabeticalSeparators;
const ::rtl::OUString sUseCombinedEntries;
const ::rtl::OUString sUseDash;
const ::rtl::OUString sUseKeyAsEntry;
const ::rtl::OUString sUseLevelFromSource;
const ::rtl::OUString sUsePP;
const ::rtl::OUString sUseUpperCase;
const ::rtl::OUString sIsCommaSeparated;
const ::rtl::OUString sIsAutomaticUpdate;
const ::rtl::OUString sIsRelativeTabstops;
const ::rtl::OUString sCreateFromLevelParagraphStyles;
const ::rtl::OUString sDocumentIndex;
const ::rtl::OUString sContentSection;
const ::rtl::OUString sHeaderSection;
const ::rtl::OUString sTextSection;
const ::rtl::OUString sIsGlobalDocumentSection;
const ::rtl::OUString sProtectionKey;
const ::rtl::OUString sSortAlgorithm;
const ::rtl::OUString sLocale;
const ::rtl::OUString sUserIndexName;
const ::rtl::OUString sIsCurrentlyVisible;
const ::rtl::OUString sHeadingStyleName;
const ::rtl::OUString sEmpty;
SvXMLExport& rExport;
XMLTextParagraphExport& rParaExport;
sal_Bool bHeadingDummiesExported;
public:
XMLSectionExport(SvXMLExport& rExp,
XMLTextParagraphExport& rParaExp);
/**
* export section or index start and source elements. This
* method handles the section styles, and delegates to the
* appropriate section or index method.
*/
void ExportSectionStart(
const ::com::sun::star::uno::Reference <
::com::sun::star::text::XTextSection > & rSection,
sal_Bool bAutoStyles);
/**
* export section or index end elements
*/
void ExportSectionEnd(
const ::com::sun::star::uno::Reference <
::com::sun::star::text::XTextSection > & rSection,
sal_Bool bAutoStyles);
/**
* Should the content of this section be exported?
* (E.g. linked sections in global documents are not always exported)
*/
sal_Bool IsMuteSection(
const ::com::sun::star::uno::Reference <
::com::sun::star::text::XTextSection > & rSection) const;
/**
* XTextContent-version of IsMuteSection(Reference<XTextSection>&)
* returns *true* for all non-section elements
*/
sal_Bool IsMuteSection(
const ::com::sun::star::uno::Reference <
::com::sun::star::text::XTextContent > & rSection,
/// return value if this content doesn't support the section property
sal_Bool bDefault) const;
/**
* Determine whether rContent is contained in rEnclosingSection. If the
* current section of rContent can not be determined, return bDefault.
*/
sal_Bool IsInSection(
const ::com::sun::star::uno::Reference <
::com::sun::star::text::XTextSection > & rEnclosingSection,
const ::com::sun::star::uno::Reference <
::com::sun::star::text::XTextContent > & rContent,
/// return value if this content doesn't support the section property
sal_Bool bDefault);
/**
* Export the configuration element for bibliography indices.
*
* (This is part of XMLSectionExport because all section- and
* index-related items are handled here.)
*/
static void ExportBibliographyConfiguration(SvXMLExport& rExport);
/** export a heading for every level. This is used by master documents
* to not loose the heading information if master documents are exported
* without section contents
*/
void ExportMasterDocHeadingDummies();
protected:
inline SvXMLExport& GetExport() { return rExport; }
inline XMLTextParagraphExport& GetParaExport() { return rParaExport; }
// export methods for section and index start:
/// export an index start element.
void ExportIndexStart(
const ::com::sun::star::uno::Reference <
::com::sun::star::text::XDocumentIndex > & rSection);
/// export an index header start element.
void ExportIndexHeaderStart(
const ::com::sun::star::uno::Reference <
::com::sun::star::text::XTextSection > & rSection);
/// export a proper section (and source elements)
void ExportRegularSectionStart(
const ::com::sun::star::uno::Reference <
::com::sun::star::text::XTextSection > & rSection);
/// export a table of content (and source element)
void ExportTableOfContentStart(
const ::com::sun::star::uno::Reference <
::com::sun::star::beans::XPropertySet > & rSection);
/// export a table index (and source element)
void ExportTableIndexStart(
const ::com::sun::star::uno::Reference <
::com::sun::star::beans::XPropertySet > & rSection);
/// export an object index (and source element)
void ExportObjectIndexStart(
const ::com::sun::star::uno::Reference <
::com::sun::star::beans::XPropertySet > & rSection);
/// export an illustration index (and source element)
void ExportIllustrationIndexStart(
const ::com::sun::star::uno::Reference <
::com::sun::star::beans::XPropertySet > & rSection);
/// export an alphabetical/keyword index (and source element)
void ExportAlphabeticalIndexStart(
const ::com::sun::star::uno::Reference <
::com::sun::star::beans::XPropertySet > & rSection);
/// export a user index (and source element)
void ExportUserIndexStart(
const ::com::sun::star::uno::Reference <
::com::sun::star::beans::XPropertySet > & rSection);
/// export the bibliography (and source element)
void ExportBibliographyStart(
const ::com::sun::star::uno::Reference <
::com::sun::star::beans::XPropertySet > & rIndex);
// helper methods:
/**
* If this section is an index, the index is written in the
* rIndex parameter. The return value is sal_True for all "special"
* sections.
*
* Thus we have:
* return sal_False: regular section
* return sal_True, xIndex is empty: index header section
* return sal_True, xIndex is set: index section */
sal_Bool GetIndex(
const ::com::sun::star::uno::Reference <
::com::sun::star::text::XTextSection > & rSection,
::com::sun::star::uno::Reference <
::com::sun::star::text::XDocumentIndex > & rIndex) const;
/// map service name to section type
enum SectionTypeEnum MapSectionType(const ::rtl::OUString& rSectionName);
/**
* Export the index element start (for all index types).
*
* All additional attributes (usually none) for the index element
* should have been set at GetExport() before calling this method.
*/
void ExportBaseIndexStart(
::xmloff::token::XMLTokenEnum eElement,
const ::com::sun::star::uno::Reference <
::com::sun::star::beans::XPropertySet > & rSection);
/**
* Export the index source element (common for all index types).
*
* All additional attributes for the source element should have
* been set at the GetExport() before calling this method.
*/
void ExportBaseIndexSource(
SectionTypeEnum eType, /// index type
const ::com::sun::star::uno::Reference <
::com::sun::star::beans::XPropertySet > & rSection);
/**
* Export the index body (common for all index types).
*/
void ExportBaseIndexBody(
SectionTypeEnum eType, /// index type
const ::com::sun::star::uno::Reference <
::com::sun::star::beans::XPropertySet > & rSection);
/**
* Helper method to export common attributes for table and
* illustration indices
*/
void ExportTableAndIllustrationIndexSourceAttributes(
const ::com::sun::star::uno::Reference <
::com::sun::star::beans::XPropertySet > & rSection);
/// export one template for the specific index type
sal_Bool ExportIndexTemplate(
SectionTypeEnum eType, /// index type
sal_Int32 nLevel, /// outline level (if applicable)
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySet> & rPropSet,
::com::sun::star::uno::Sequence<
::com::sun::star::uno::Sequence<
::com::sun::star::beans::PropertyValue> > & rValues);
/// export a single template element (e.g. span or tab-stop)
void ExportIndexTemplateElement(
SectionTypeEnum eType, //i90246, needed for ODF 1.0, 1.0 and 1.2 management
::com::sun::star::uno::Sequence<
::com::sun::star::beans::PropertyValue> & rValues);
/// export level paragraph styles
void ExportLevelParagraphStyles(
::com::sun::star::uno::Reference<
::com::sun::star::container::XIndexReplace> & xStyles);
/// helper to export boolean properties
void ExportBoolean(
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySet> & rPropSet,
const ::rtl::OUString& sPropertyName,
enum ::xmloff::token::XMLTokenEnum eAttributeName,
sal_Bool bDefault,
sal_Bool bInvert = sal_False);
};
#endif
|
