xmloff/source/text/XMLIndexMarkExport.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef _XMLOFF_XMLINDEXMARKEXPORT_HXX_
  30 #define _XMLOFF_XMLINDEXMARKEXPORT_HXX_
  31
  32 #include <rtl/ustrbuf.hxx>
  33 #include <com/sun/star/uno/Reference.h>
  34 #include <com/sun/star/uno/Sequence.h>
  35
  36 class SvXMLExport;
  37 class XMLTextParagraphExport;
  38 namespace com { namespace sun { namespace star {
  39     namespace beans { class XPropertySet; }
  40  } } }
  41 namespace rtl {
  42     class OUString;
  43     class OUStringBuffer;
  44 }
  45
  46
  47 /**
  48  * This class handles the export of index marks for table of content,
  49  * alphabetical and user index.
  50  *
  51  * Marks for bibliography indices are internally modelled as text
  52  * fields and thus handled in txtparae.cxx
  53  */
  54 class XMLIndexMarkExport
  55 {
  56     ::rtl::OUString sLevel;
  57     ::rtl::OUString sUserIndexName;
  58     ::rtl::OUString sPrimaryKey;
  59     ::rtl::OUString sSecondaryKey;
  60     ::rtl::OUString sDocumentIndexMark;
  61     ::rtl::OUString sIsStart;
  62     ::rtl::OUString sIsCollapsed;
  63     ::rtl::OUString sAlternativeText;
  64     ::rtl::OUString sTextReading;
  65     ::rtl::OUString sPrimaryKeyReading;
  66     ::rtl::OUString sSecondaryKeyReading;
  67     ::rtl::OUString sMainEntry;
  68
  69
  70     SvXMLExport& rExport;
  71     XMLTextParagraphExport& rParaExport;
  72
  73 public:
  74     XMLIndexMarkExport(SvXMLExport& rExp,
  75                        XMLTextParagraphExport& rParaExp);
  76
  77     ~XMLIndexMarkExport();
  78
  79     /**
  80      * export by the property set of its *text* *portion*.
  81      *
  82      * The text portion supplies us with the properties of the index
  83      * mark itself, as well as the information whether we are at the
  84      * start or end of an index mark, or whether the index mark is
  85      * collapsed.
  86      */
  87     void ExportIndexMark(
  88         const ::com::sun::star::uno::Reference<
  89             ::com::sun::star::beans::XPropertySet> & rPropSet,
  90         sal_Bool bAutoStyles);
  91
  92 protected:
  93
  94     /// export attributes of table-of-content index marks
  95     void ExportTOCMarkAttributes(
  96         const ::com::sun::star::uno::Reference<
  97             ::com::sun::star::beans::XPropertySet> & rPropSet);
  98
  99     /// export attributes of user index marks
 100     void ExportUserIndexMarkAttributes(
 101         const ::com::sun::star::uno::Reference<
 102             ::com::sun::star::beans::XPropertySet> & rPropSet);
 103
 104     /// export attributes of alphabetical  index marks
 105     void ExportAlphabeticalIndexMarkAttributes(
 106         const ::com::sun::star::uno::Reference<
 107             ::com::sun::star::beans::XPropertySet> & rPropSet);
 108
 109     /// create a numerical ID for this index mark
 110     /// (represented by its properties)
 111     void GetID(
 112         ::rtl::OUStringBuffer& sBuffer,
 113         const ::com::sun::star::uno::Reference<
 114             ::com::sun::star::beans::XPropertySet> & rPropSet);
 115
 116 };
 117
 118 #endif
 119
 120 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */