XLWorkbook.hpp

Go to the documentation of this file.

#ifndef OPENXLSX_XLWORKBOOK_HPP
#define OPENXLSX_XLWORKBOOK_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 <optional>
#include <ostream>    // std::basic_ostream
#include <string>
#include <string_view>
#include <vector>
 
// ===== OpenXLSX Includes ===== //
#include "OpenXLSX-Exports.hpp"
#include "XLXmlFile.hpp"
 
namespace OpenXLSX
{
    class XLSheet;
    class XLWorksheet;
    class XLChartsheet;
 
    enum class XLSheetType { Worksheet, Chartsheet, Dialogsheet, Macrosheet };
 
    class OPENXLSX_EXPORT XLDefinedName
    {
    public:
        XLDefinedName() = default;
        explicit XLDefinedName(const XMLNode& node);
 
        std::string name() const;
        void        setName(std::string_view name);
 
        std::string refersTo() const;
        void        setRefersTo(std::string_view formula);
 
        std::optional<uint32_t> localSheetId() const;
        void                    setLocalSheetId(uint32_t id);
 
        bool hidden() const;
        void setHidden(bool hidden);
 
        std::string comment() const;
        void        setComment(std::string_view comment);
 
        bool valid() const { return !m_node.empty(); }
 
    private:
        XMLNode m_node;
    };
 
    class OPENXLSX_EXPORT XLDefinedNames
    {
    public:
        XLDefinedNames() = default;
        explicit XLDefinedNames(const XMLNode& node);
 
        XLDefinedName append(std::string_view name, std::string_view formula, std::optional<uint32_t> localSheetId = std::nullopt);
        void          remove(std::string_view name, std::optional<uint32_t> localSheetId = std::nullopt);
        XLDefinedName get(std::string_view name, std::optional<uint32_t> localSheetId = std::nullopt) const;
        std::vector<XLDefinedName> all() const;
        bool                       exists(std::string_view name, std::optional<uint32_t> localSheetId = std::nullopt) const;
        size_t                     count() const;
 
    private:
        XMLNode m_node;
    };
 
    class OPENXLSX_EXPORT XLWorkbook : public XLXmlFile
    {
        friend class XLSheet;
        friend class XLDocument;
 
    public:    // ---------- Public Member Functions ---------- //
        XLWorkbook() = default;
 
        explicit XLWorkbook(XLXmlData* xmlData);
 
        XLWorkbook(const XLWorkbook& other) = default;
 
        XLWorkbook(XLWorkbook&& other) = default;
 
        ~XLWorkbook();
 
        XLWorkbook& operator=(const XLWorkbook& other) = default;
 
        XLWorkbook& operator=(XLWorkbook&& other) = default;
 
        XLSheet sheet(uint16_t index);
 
        XLSheet sheet(std::string_view sheetName);
 
        XLWorksheet worksheet(std::string_view sheetName);
 
        XLWorksheet worksheet(uint16_t index);
 
        XLChartsheet chartsheet(std::string_view sheetName);
 
        XLChartsheet chartsheet(uint16_t index);
 
        XLDefinedNames definedNames();
 
        void deleteSheet(std::string_view sheetName);
 
        void addWorksheet(std::string_view sheetName);
        void addChartsheet(std::string_view sheetName);
 
        void cloneSheet(std::string_view existingName, std::string_view newName);
 
        void setSheetIndex(std::string_view sheetName, unsigned int index);
 
        unsigned int indexOfSheet(std::string_view sheetName) const;
 
        XLSheetType typeOfSheet(std::string_view sheetName) const;
 
        XLSheetType typeOfSheet(unsigned int index) const;
 
        unsigned int sheetCount() const;
 
        unsigned int worksheetCount() const;
 
        unsigned int chartsheetCount() const;
 
        std::vector<std::string> sheetNames() const;
 
        std::vector<std::string> worksheetNames() const;
 
        std::vector<std::string> chartsheetNames() const;
 
        bool sheetExists(std::string_view sheetName) const;
 
        bool worksheetExists(std::string_view sheetName) const;
 
        bool chartsheetExists(std::string_view sheetName) const;
 
        void updateSheetReferences(std::string_view oldName, std::string_view newName);
 
        void deleteNamedRanges();
 
        void updateWorksheetDimensions();
 
        void setFullCalculationOnLoad();
 
        void protect(bool lockStructure, bool lockWindows, std::string_view password = "");
 
        void unprotect();
 
        bool isProtected() const;
 
        void print(std::basic_ostream<char>& ostr) const;
 
    private:    // ---------- Private Member Functions ---------- //
        uint16_t createInternalSheetID();
 
        std::string sheetID(std::string_view sheetName);
 
        std::string sheetName(std::string_view sheetID) const;
 
        std::string sheetVisibility(std::string_view sheetID) const;
 
        void prepareSheetMetadata(std::string_view sheetName, uint16_t internalID, std::string_view sheetPath = "");
 
        void setSheetName(std::string_view sheetRID, std::string_view newName);
 
        void setSheetVisibility(std::string_view sheetRID, std::string_view state);
 
        bool sheetIsActive(std::string_view sheetRID) const;
 
        bool setSheetActive(std::string_view sheetRID);
 
        bool isVisibleState(std::string_view state) const;
 
        bool isVisible(XMLNode const& sheetNode) const;
    };
}    // 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_XLWORKBOOK_HPP