xmloff/source/text/XMLIndexTOCContext.hxx

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