writerfilter/source/dmapper/SdtHelper.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
  10 #ifndef INCLUDED_WRITERFILTER_SOURCE_DMAPPER_SDTHELPER_HXX
  11 #define INCLUDED_WRITERFILTER_SOURCE_DMAPPER_SDTHELPER_HXX
  12
  13 #include <vector>
  14
  15 #include <com/sun/star/beans/PropertyValue.hpp>
  16 #include <com/sun/star/text/XTextRange.hpp>
  17
  18 #include <rtl/ustrbuf.hxx>
  19 #include <tools/ref.hxx>
  20
  21 namespace com
  22 {
  23 namespace sun
  24 {
  25 namespace star
  26 {
  27 namespace awt
  28 {
  29 struct Size;
  30 class XControlModel;
  31 }
  32 }
  33 }
  34 }
  35
  36 namespace writerfilter
  37 {
  38 namespace dmapper
  39 {
  40 class DomainMapper_Impl;
  41
  42 /**
  43  * Helper to create form controls from w:sdt tokens.
  44  *
  45  * w:sdt tokens can't be imported as form fields, as w:sdt supports
  46  * e.g. date picking as well.
  47  */
  48 class SdtHelper final : public virtual SvRefBase
  49 {
  50     DomainMapper_Impl& m_rDM_Impl;
  51
  52     /// Items of the drop-down control.
  53     std::vector<OUString> m_aDropDownItems;
  54     /// Indicator of a drop-down control
  55     bool m_bInsideDropDownControl;
  56     /// Pieces of the default text -- currently used only by the dropdown control.
  57     OUStringBuffer m_aSdtTexts;
  58     /// Date ISO string contained in the w:date element, used by the date control.
  59     OUStringBuffer m_sDate;
  60     /// Date format string as it comes from the ooxml document.
  61     OUStringBuffer m_sDateFormat;
  62     /// Start range of the date field
  63     css::uno::Reference<css::text::XTextRange> m_xDateFieldStartRange;
  64     /// Locale string as it comes from the ooxml document.
  65     OUStringBuffer m_sLocale;
  66     /// Grab bag to store unsupported SDTs, aiming to save them back on export.
  67     std::vector<css::beans::PropertyValue> m_aGrabBag;
  68
  69     bool m_bHasElements;
  70     /// The last stored SDT element is outside paragraphs.
  71     bool m_bOutsideAParagraph;
  72
  73     /// Create and append the drawing::XControlShape, containing the various models.
  74     void createControlShape(css::awt::Size aSize, css::uno::Reference<css::awt::XControlModel> const& xControlModel, const css::uno::Sequence<css::beans::PropertyValue>& rGrabBag);
  75 public:
  76     explicit SdtHelper(DomainMapper_Impl& rDM_Impl);
  77     ~SdtHelper() override;
  78
  79     std::vector<OUString>& getDropDownItems()
  80     {
  81         return m_aDropDownItems;
  82     }
  83     OUStringBuffer& getSdtTexts()
  84     {
  85         return m_aSdtTexts;
  86     }
  87
  88     OUStringBuffer& getDate()
  89     {
  90         return m_sDate;
  91     }
  92
  93     OUStringBuffer& getDateFormat()
  94     {
  95         return m_sDateFormat;
  96     }
  97
  98     void setDateFieldStartRange(const css::uno::Reference<css::text::XTextRange>& xStartRange)
  99     {
 100         m_xDateFieldStartRange = xStartRange;
 101     }
 102
 103     /// Decides if we have enough information to create a date control.
 104     bool validateDateFormat();
 105
 106     OUStringBuffer& getLocale()
 107     {
 108         return m_sLocale;
 109     }
 110     /// If createControlShape() was ever called.
 111     bool hasElements()
 112     {
 113         return m_bHasElements;
 114     }
 115
 116     void setOutsideAParagraph(bool bOutsideAParagraph)
 117     {
 118         m_bOutsideAParagraph = bOutsideAParagraph;
 119     }
 120
 121     bool isOutsideAParagraph()
 122     {
 123         return m_bOutsideAParagraph;
 124     }
 125
 126     bool isInsideDropDownControl() const { return m_bInsideDropDownControl; }
 127     void setInsideDropDownControl(bool bInside) { m_bInsideDropDownControl = bInside; }
 128
 129     /// Create drop-down control from w:sdt's w:dropDownList.
 130     void createDropDownControl();
 131     /// Create date control from w:sdt's w:date.
 132     void createDateContentControl();
 133
 134     void appendToInteropGrabBag(const css::beans::PropertyValue& rValue);
 135     css::uno::Sequence<css::beans::PropertyValue> getInteropGrabBagAndClear();
 136     bool isInteropGrabBagEmpty();
 137     bool containedInInteropGrabBag(const OUString& rValueName);
 138     sal_Int32 getInteropGrabBagSize();
 139 };
 140
 141 } // namespace dmapper
 142 } // namespace writerfilter
 143
 144 #endif
 145
 146 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */