XLXmlFile.hpp

Go to the documentation of this file.

#ifndef OPENXLSX_XLXMLFILE_HPP
#define OPENXLSX_XLXMLFILE_HPP
 
#ifdef _MSC_VER    // conditionally enable MSVC specific pragmas to avoid other compilers warning about unknown pragmas
#    pragma warning(push)
#    pragma warning(disable : 4251)
#    pragma warning(disable : 4275)
#endif    // _MSC_VER
 
// ===== External Includes ===== //
#include <gsl/gsl>
 
// ===== OpenXLSX Includes ===== //
#include "OpenXLSX-Exports.hpp"
#include "XLXmlParser.hpp"
#include "XLXmlSavingDeclaration.hpp"
 
namespace OpenXLSX
{
    class XLXmlData;
    class XLDocument;
 
    class OPENXLSX_EXPORT XLUnsupportedElement
    {
    public:
        XLUnsupportedElement() {}
        bool        empty() const { return true; }
        std::string summary() const { return "XLUnsupportedElement"; }
    };
 
    class OPENXLSX_EXPORT XLXmlFile
    {
    public:    // ===== PUBLIC MEMBER FUNCTIONS
        XLXmlFile() = default;
 
        std::string xmlData(XLXmlSavingDeclaration savingDeclaration = XLXmlSavingDeclaration{}) const;
 
        explicit XLXmlFile(XLXmlData* xmlData);
 
        XLXmlFile(const XLXmlFile& other) = default;
 
        XLXmlFile(XLXmlFile&& other) noexcept = default;
 
        ~XLXmlFile() = default;
 
        bool valid() const { return m_xmlData != nullptr; }
 
        XLXmlFile& operator=(const XLXmlFile& other) = default;
 
        XLXmlFile& operator=(XLXmlFile&& other) noexcept = default;
 
        XLDocument& parentDoc();
 
        const XLDocument& parentDoc() const;
 
        XMLDocument& xmlDocument();
 
        const XMLDocument& xmlDocument() const;
 
        std::string getXmlPath() const;
 
    protected:    // ===== PROTECTED MEMBER FUNCTIONS
        void setXmlData(std::string_view xmlData);
 
        std::string relationshipID() const;
 
    protected:                         // ===== PROTECTED MEMBER VARIABLES
        XLXmlData* m_xmlData{nullptr}; 
    };
}    // namespace OpenXLSX
 
#ifdef _MSC_VER    // conditionally enable MSVC specific pragmas to avoid other compilers warning about unknown pragmas
#    pragma warning(pop)
#endif    // _MSC_VER
 
#endif    // OPENXLSX_XLXMLFILE_HPP