xmloff/source/text/XMLIndexMarkExport.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: XMLIndexMarkExport.hxx,v $
  10  * $Revision: 1.5 $
  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_XMLINDEXMARKEXPORT_HXX_
  32 #define _XMLOFF_XMLINDEXMARKEXPORT_HXX_
  33
  34 #include <rtl/ustrbuf.hxx>
  35 #include <com/sun/star/uno/Reference.h>
  36 #include <com/sun/star/uno/Sequence.h>
  37
  38 class SvXMLExport;
  39 class XMLTextParagraphExport;
  40 namespace com { namespace sun { namespace star {
  41     namespace beans { class XPropertySet; }
  42  } } }
  43 namespace rtl {
  44     class OUString;
  45     class OUStringBuffer;
  46 }
  47
  48
  49 /**
  50  * This class handles the export of index marks for table of content,
  51  * alphabetical and user index.
  52  *
  53  * Marks for bibliography indices are internally modelled as text
  54  * fields and thus handled in txtparae.cxx
  55  */
  56 class XMLIndexMarkExport
  57 {
  58     ::rtl::OUString sLevel;
  59     ::rtl::OUString sUserIndexName;
  60     ::rtl::OUString sPrimaryKey;
  61     ::rtl::OUString sSecondaryKey;
  62     ::rtl::OUString sDocumentIndexMark;
  63     ::rtl::OUString sIsStart;
  64     ::rtl::OUString sIsCollapsed;
  65     ::rtl::OUString sAlternativeText;
  66     ::rtl::OUString sTextReading;
  67     ::rtl::OUString sPrimaryKeyReading;
  68     ::rtl::OUString sSecondaryKeyReading;
  69     ::rtl::OUString sMainEntry;
  70
  71
  72     SvXMLExport& rExport;
  73     XMLTextParagraphExport& rParaExport;
  74
  75 public:
  76     XMLIndexMarkExport(SvXMLExport& rExp,
  77                        XMLTextParagraphExport& rParaExp);
  78
  79     ~XMLIndexMarkExport();
  80
  81     /**
  82      * export by the property set of its *text* *portion*.
  83      *
  84      * The text portion supplies us with the properties of the index
  85      * mark itself, as well as the information whether we are at the
  86      * start or end of an index mark, or whether the index mark is
  87      * collapsed.
  88      */
  89     void ExportIndexMark(
  90         const ::com::sun::star::uno::Reference<
  91             ::com::sun::star::beans::XPropertySet> & rPropSet,
  92         sal_Bool bAutoStyles);
  93
  94 protected:
  95
  96     /// export attributes of table-of-content index marks
  97     void ExportTOCMarkAttributes(
  98         const ::com::sun::star::uno::Reference<
  99             ::com::sun::star::beans::XPropertySet> & rPropSet);
 100
 101     /// export attributes of user index marks
 102     void ExportUserIndexMarkAttributes(
 103         const ::com::sun::star::uno::Reference<
 104             ::com::sun::star::beans::XPropertySet> & rPropSet);
 105
 106     /// export attributes of alphabetical  index marks
 107     void ExportAlphabeticalIndexMarkAttributes(
 108         const ::com::sun::star::uno::Reference<
 109             ::com::sun::star::beans::XPropertySet> & rPropSet);
 110
 111     /// create a numerical ID for this index mark
 112     /// (represented by its properties)
 113     void GetID(
 114         ::rtl::OUStringBuffer& sBuffer,
 115         const ::com::sun::star::uno::Reference<
 116             ::com::sun::star::beans::XPropertySet> & rPropSet);
 117
 118 };
 119
 120 #endif