xmloff/source/text/XMLIndexMarkExport.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_XMLOFF_SOURCE_TEXT_XMLINDEXMARKEXPORT_HXX
  21 #define INCLUDED_XMLOFF_SOURCE_TEXT_XMLINDEXMARKEXPORT_HXX
  22
  23 #include <rtl/ustrbuf.hxx>
  24 #include <com/sun/star/uno/Reference.h>
  25
  26 class SvXMLExport;
  27 namespace com::sun::star {
  28     namespace beans { class XPropertySet; }
  29 }
  30
  31
  32 /**
  33  * This class handles the export of index marks for table of content,
  34  * alphabetical and user index.
  35  *
  36  * Marks for bibliography indices are internally modelled as text
  37  * fields and thus handled in txtparae.cxx
  38  */
  39 class XMLIndexMarkExport
  40 {
  41     static constexpr OUStringLiteral gsLevel = u"Level";
  42     static constexpr OUStringLiteral gsUserIndexName = u"UserIndexName";
  43     static constexpr OUStringLiteral gsPrimaryKey = u"PrimaryKey";
  44     static constexpr OUStringLiteral gsSecondaryKey = u"SecondaryKey";
  45     static constexpr OUStringLiteral gsDocumentIndexMark = u"DocumentIndexMark";
  46     static constexpr OUStringLiteral gsIsStart = u"IsStart";
  47     static constexpr OUStringLiteral gsIsCollapsed = u"IsCollapsed";
  48     static constexpr OUStringLiteral gsAlternativeText = u"AlternativeText";
  49     static constexpr OUStringLiteral gsTextReading = u"TextReading";
  50     static constexpr OUStringLiteral gsPrimaryKeyReading = u"PrimaryKeyReading";
  51     static constexpr OUStringLiteral gsSecondaryKeyReading = u"SecondaryKeyReading";
  52     static constexpr OUStringLiteral gsMainEntry = u"IsMainEntry";
  53
  54     SvXMLExport& rExport;
  55
  56 public:
  57     explicit XMLIndexMarkExport(SvXMLExport& rExp);
  58
  59     ~XMLIndexMarkExport();
  60
  61     /**
  62      * export by the property set of its *text* *portion*.
  63      *
  64      * The text portion supplies us with the properties of the index
  65      * mark itself, as well as the information whether we are at the
  66      * start or end of an index mark, or whether the index mark is
  67      * collapsed.
  68      */
  69     void ExportIndexMark(
  70         const css::uno::Reference<css::beans::XPropertySet> & rPropSet,
  71         bool bAutoStyles);
  72
  73 private:
  74
  75     /// export attributes of table-of-content index marks
  76     void ExportTOCMarkAttributes(
  77         const css::uno::Reference<css::beans::XPropertySet> & rPropSet);
  78
  79     /// export attributes of user index marks
  80     void ExportUserIndexMarkAttributes(
  81         const css::uno::Reference<css::beans::XPropertySet> & rPropSet);
  82
  83     /// export attributes of alphabetical  index marks
  84     void ExportAlphabeticalIndexMarkAttributes(
  85         const css::uno::Reference<css::beans::XPropertySet> & rPropSet);
  86
  87     /// create a numerical ID for this index mark
  88     /// (represented by its properties)
  89     static void GetID(
  90         OUStringBuffer& sBuffer,
  91         const css::uno::Reference<css::beans::XPropertySet> & rPropSet);
  92
  93 };
  94
  95 #endif
  96
  97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */