XLProperties.hpp

Go to the documentation of this file.

#ifndef OPENXLSX_XLPROPERTIES_HPP
#define OPENXLSX_XLPROPERTIES_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 <string>
#include <string_view>
#include <vector>
 
// ===== OpenXLSX Includes ===== //
#include "OpenXLSX-Exports.hpp"
#include "XLDateTime.hpp"
#include "XLXmlFile.hpp"
 
namespace OpenXLSX
{
    class OPENXLSX_EXPORT XLProperties : public XLXmlFile
    {
    private:
        void createFromTemplate();
 
    public:
        XLProperties() = default;
 
        explicit XLProperties(XLXmlData* xmlData);
 
        XLProperties(const XLProperties& other) = default;
 
        XLProperties(XLProperties&& other) noexcept = default;
 
        ~XLProperties();
 
        XLProperties& operator=(const XLProperties& other) = default;
 
        XLProperties& operator=(XLProperties&& other) noexcept = default;
 
        void setProperty(std::string_view name, std::string_view value);
 
        void setProperty(std::string_view name, int value);
 
        void setProperty(std::string_view name, double value);
 
        std::string property(std::string_view name) const;
 
        void deleteProperty(std::string_view name);
 
        // Standard Core Properties
        std::string title() const;
        void        setTitle(std::string_view title);
 
        std::string subject() const;
        void        setSubject(std::string_view subject);
 
        std::string creator() const;
        void        setCreator(std::string_view creator);
 
        std::string keywords() const;
        void        setKeywords(std::string_view keywords);
 
        std::string description() const;
        void        setDescription(std::string_view description);
 
        std::string lastModifiedBy() const;
        void        setLastModifiedBy(std::string_view author);
 
        std::string revision() const;
        void        setRevision(std::string_view revision);
 
        std::string lastPrinted() const;
        void        setLastPrinted(std::string_view date);
 
        XLDateTime created() const;
        void       setCreated(const XLDateTime& date);
 
        XLDateTime modified() const;
        void       setModified(const XLDateTime& date);
 
        std::string category() const;
        void        setCategory(std::string_view category);
 
        std::string contentStatus() const;
        void        setContentStatus(std::string_view status);
    };
 
    class OPENXLSX_EXPORT XLAppProperties : public XLXmlFile
    {
    private:
        void createFromTemplate(XMLDocument const& workbookXml);
 
    public:
        XLAppProperties() = default;
 
        explicit XLAppProperties(XLXmlData* xmlData, XMLDocument const& workbookXml);
 
        explicit XLAppProperties(XLXmlData* xmlData);
 
        XLAppProperties(const XLAppProperties& other) = default;
 
        XLAppProperties(XLAppProperties&& other) noexcept = default;
 
        ~XLAppProperties();
 
        XLAppProperties& operator=(const XLAppProperties& other) = default;
 
        XLAppProperties& operator=(XLAppProperties&& other) noexcept = default;
 
        void incrementSheetCount(int16_t increment);
 
        void alignWorksheets(const std::vector<std::string>& workbookSheetNames);
 
        void addSheetName(std::string_view title);
 
        void deleteSheetName(std::string_view title);
 
        void setSheetName(std::string_view oldTitle, std::string_view newTitle);
 
        void addHeadingPair(std::string_view name, int value);
 
        void deleteHeadingPair(std::string_view name);
 
        void setHeadingPair(std::string_view name, int newValue);
 
        void setProperty(std::string_view name, std::string_view value);
 
        std::string property(std::string_view name) const;
 
        void deleteProperty(std::string_view name);
 
        void appendSheetName(std::string_view sheetName);
 
        void prependSheetName(std::string_view sheetName);
 
        void insertSheetName(std::string_view sheetName, unsigned int index);
    };
 
    class OPENXLSX_EXPORT XLCustomProperties : public XLXmlFile
    {
    private:
        void createFromTemplate();
 
    public:
        XLCustomProperties() = default;
 
        explicit XLCustomProperties(XLXmlData* xmlData);
 
        XLCustomProperties(const XLCustomProperties& other) = default;
 
        XLCustomProperties(XLCustomProperties&& other) noexcept = default;
 
        ~XLCustomProperties();
 
        XLCustomProperties& operator=(const XLCustomProperties& other) = default;
 
        XLCustomProperties& operator=(XLCustomProperties&& other) noexcept = default;
 
        void setProperty(std::string_view name, std::string_view value);
 
        void setProperty(std::string_view name, const char* value);
 
        void setProperty(std::string_view name, int value);
 
        void setProperty(std::string_view name, double value);
 
        void setProperty(std::string_view name, bool value);
 
        void setProperty(std::string_view name, const XLDateTime& value);
 
        std::string property(std::string_view name) const;
 
        void deleteProperty(std::string_view name);
    };
 
}    // 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_XLPROPERTIES_HPP