SdtHelper.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
#pragma once
 
#include <vector>
#include <optional>
#include <unordered_map>
 
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/text/XTextRange.hpp>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/xml/dom/XDocument.hpp>
 
#include <rtl/ustrbuf.hxx>
#include <tools/ref.hxx>
 
namespace com::sun::star
{
namespace uno
{
class XComponentContext;
}
namespace awt
{
struct Size;
class XControlModel;
}
}
 
namespace writerfilter::dmapper
{
class DomainMapper_Impl;
 
enum class SdtControlType
{
    datePicker,
    dropDown,
    plainText,
    richText,
    checkBox,
    picture,
    comboBox,
    unsupported, // Sdt block is defined, but we still do not support such type of field
    unknown
};
 
class SdtHelper final : public virtual SvRefBase
{
    DomainMapper_Impl& m_rDM_Impl;
    css::uno::Reference<css::uno::XComponentContext> m_xComponentContext;
 
    std::vector<OUString> m_aDropDownItems;
    std::vector<OUString> m_aDropDownDisplayTexts;
    SdtControlType m_aControlType;
    sal_uInt32 m_nSdtType = 0;
    OUStringBuffer m_aSdtTexts;
    OUStringBuffer m_sDate;
    OUStringBuffer m_sDateFormat;
 
    OUString m_sDataBindingPrefixMapping;
    OUString m_sDataBindingXPath;
    OUString m_sDataBindingStoreItemID;
 
    css::uno::Reference<css::text::XTextRange> m_xDateFieldStartRange;
    OUStringBuffer m_sLocale;
    std::vector<css::beans::PropertyValue> m_aGrabBag;
 
    bool m_bHasElements;
    bool m_bOutsideAParagraph;
 
    std::unordered_map<OUString, css::uno::Reference<css::xml::dom::XDocument>> m_xPropertiesXMLs;
 
    bool m_bPropertiesXMLsLoaded;
 
    bool m_bShowingPlcHdr = false;
 
    bool m_bChecked = false;
 
    OUString m_aCheckedState;
 
    OUString m_aUncheckedState;
 
    void createControlShape(css::awt::Size aSize,
                            css::uno::Reference<css::awt::XControlModel> const& xControlModel,
                            const css::uno::Sequence<css::beans::PropertyValue>& rGrabBag);
 
    void loadPropertiesXMLs();
 
    OUString m_aPlaceholderDocPart;
 
    OUString m_aColor;
 
    OUString m_aAppearance;
 
    OUString m_aAlias;
 
    OUString m_aTag;
 
    sal_Int32 m_nId = 0;
 
    sal_uInt32 m_nTabIndex = 0;
 
    OUString m_aLock;
 
public:
    explicit SdtHelper(DomainMapper_Impl& rDM_Impl,
                       css::uno::Reference<css::uno::XComponentContext> xContext);
    ~SdtHelper() override;
 
    std::vector<OUString>& getDropDownItems() { return m_aDropDownItems; }
    std::vector<OUString>& getDropDownDisplayTexts() { return m_aDropDownDisplayTexts; }
    OUStringBuffer& getSdtTexts() { return m_aSdtTexts; }
 
    OUStringBuffer& getDate() { return m_sDate; }
 
    OUStringBuffer& getDateFormat() { return m_sDateFormat; }
 
    void setDataBindingPrefixMapping(const OUString& sValue)
    {
        m_sDataBindingPrefixMapping = sValue;
    }
    const OUString& GetDataBindingPrefixMapping() const { return m_sDataBindingPrefixMapping; }
 
    void setDataBindingXPath(const OUString& sValue) { m_sDataBindingXPath = sValue; }
    const OUString& GetDataBindingXPath() const { return m_sDataBindingXPath; }
 
    void setDataBindingStoreItemID(const OUString& sValue) { m_sDataBindingStoreItemID = sValue; }
    const OUString& GetDataBindingStoreItemID() const { return m_sDataBindingStoreItemID; }
 
    void setDateFieldStartRange(const css::uno::Reference<css::text::XTextRange>& xStartRange)
    {
        m_xDateFieldStartRange = xStartRange;
    }
 
    OUStringBuffer& getLocale() { return m_sLocale; }
    bool hasElements() const { return m_bHasElements; }
 
    void setOutsideAParagraph(bool bOutsideAParagraph)
    {
        m_bOutsideAParagraph = bOutsideAParagraph;
    }
 
    bool isOutsideAParagraph() const { return m_bOutsideAParagraph; }
 
    SdtControlType getControlType() { return m_aControlType; }
    void setControlType(SdtControlType aType) { m_aControlType = aType; }
 
    void SetSdtType(sal_uInt32 nSdtType) { m_nSdtType = nSdtType; }
    sal_uInt32 GetSdtType() const { return m_nSdtType; }
 
    void createDropDownControl();
    void createDateContentControl();
 
    void createPlainTextControl();
 
    void appendToInteropGrabBag(const css::beans::PropertyValue& rValue);
    css::uno::Sequence<css::beans::PropertyValue> getInteropGrabBagAndClear();
    bool isInteropGrabBagEmpty() const;
    bool containedInInteropGrabBag(const OUString& rValueName);
    sal_Int32 getInteropGrabBagSize() const;
 
    void SetShowingPlcHdr();
    bool GetShowingPlcHdr() const;
 
    void SetChecked();
    bool GetChecked() const;
    void SetCheckedState(const OUString& rCheckedState);
    const OUString& GetCheckedState() const;
    void SetUncheckedState(const OUString& rUncheckedState);
    const OUString& GetUncheckedState() const;
 
    void clear();
 
    void SetPlaceholderDocPart(const OUString& rPlaceholderDocPart);
    const OUString& GetPlaceholderDocPart() const;
 
    void SetColor(const OUString& rColor);
    const OUString& GetColor() const;
 
    void SetAppearance(const OUString& rAppearance);
    const OUString& GetAppearance() const;
 
    void SetAlias(const OUString& rAlias);
    const OUString& GetAlias() const;
 
    void SetTag(const OUString& rTag);
    const OUString& GetTag() const;
 
    void SetId(sal_Int32 nId);
    sal_Int32 GetId() const;
 
    void SetTabIndex(sal_uInt32 nTabIndex);
    sal_uInt32 GetTabIndex() const;
 
    void SetLock(const OUString& rLock);
    const OUString& GetLock() const;
 
    std::optional<OUString> getValueFromDataBinding();
};
 
} // namespace writerfilter::dmapper
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */