xref: /trunk/main/xmloff/source/text/XMLIndexTOCContext.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef _XMLOFF_XMLINDEXTOCCONTEXT_HXX_
29 #define _XMLOFF_XMLINDEXTOCCONTEXT_HXX_
30 
31 #include <xmloff/xmlictxt.hxx>
32 #include <com/sun/star/uno/Reference.h>
33 
34 
35 namespace com { namespace sun { namespace star {
36     namespace xml { namespace sax { class XAttributeList; } }
37     namespace beans { class XPropertySet; }
38 } } }
39 namespace rtl { class OUString; }
40 
41 
42 enum IndexTypeEnum
43 {
44     TEXT_INDEX_TOC,
45     TEXT_INDEX_ALPHABETICAL,
46     TEXT_INDEX_TABLE,
47     TEXT_INDEX_OBJECT,
48     TEXT_INDEX_BIBLIOGRAPHY,
49     TEXT_INDEX_USER,
50     TEXT_INDEX_ILLUSTRATION,
51 
52     TEXT_INDEX_UNKNOWN
53 };
54 
55 
56 /**
57  * Import all indices.
58  *
59  * Originally, this class would import only the TOC (table of
60  * content), but now it's role has been expanded to handle all
61  * indices, and hence is named inappropriately. Depending on the
62  * element name it decides which index source element context to create.
63  */
64 class XMLIndexTOCContext : public SvXMLImportContext
65 {
66     const ::rtl::OUString sTitle;
67     const ::rtl::OUString sIsProtected;
68     const ::rtl::OUString sName;
69 
70     /** XPropertySet of the index */
71     ::com::sun::star::uno::Reference<
72         ::com::sun::star::beans::XPropertySet> xTOCPropertySet;
73 
74     enum IndexTypeEnum eIndexType;
75 
76     sal_Bool bValid;
77 
78     SvXMLImportContextRef xBodyContextRef;
79 
80 public:
81 
82     TYPEINFO();
83 
84     XMLIndexTOCContext(
85         SvXMLImport& rImport,
86         sal_uInt16 nPrfx,
87         const ::rtl::OUString& rLocalName );
88 
89     ~XMLIndexTOCContext();
90 
91 protected:
92 
93     virtual void StartElement(
94         const ::com::sun::star::uno::Reference<
95             ::com::sun::star::xml::sax::XAttributeList> & xAttrList);
96 
97     virtual void EndElement();
98 
99     virtual SvXMLImportContext *CreateChildContext(
100         sal_uInt16 nPrefix,
101         const ::rtl::OUString& rLocalName,
102         const ::com::sun::star::uno::Reference<
103             ::com::sun::star::xml::sax::XAttributeList> & xAttrList );
104 };
105 
106 #endif
107