XLThreadedComments.hpp

Go to the documentation of this file.

#ifndef OPENXLSX_XLTHREADEDCOMMENTS_HPP
#define OPENXLSX_XLTHREADEDCOMMENTS_HPP
 
#include <string>
#include <vector>
#include <gsl/pointers>
#include "OpenXLSX-Exports.hpp"
#include "XLXmlFile.hpp"
 
namespace OpenXLSX
{
    class XLWorksheet;
    class OPENXLSX_EXPORT XLThreadedComment
    {
    public:
        XLThreadedComment() = default;
        explicit XLThreadedComment(XMLNode node, XLWorksheet* wks = nullptr);
        ~XLThreadedComment() = default;
        XLThreadedComment(const XLThreadedComment& other) = default;
        XLThreadedComment(XLThreadedComment&& other) = default;
        XLThreadedComment& operator=(const XLThreadedComment& other) = default;
        XLThreadedComment& operator=(XLThreadedComment&& other) = default;
 
        bool valid() const;
 
        std::string ref() const;
        std::string id() const;
        std::string parentId() const;
        std::string personId() const;
        std::string text() const;
        
        bool isResolved() const;
        void setResolved(bool resolved);
 
        XLThreadedComment& addReply(const std::string& text, const std::string& author = "");
 
        void setWorksheet(XLWorksheet* wks) { m_wks = wks; }
 
    private:
        XMLNode m_node;
        XLWorksheet* m_wks{nullptr};
    };
 
    class XLWorksheet;
 
    class OPENXLSX_EXPORT XLThreadedComments : public XLXmlFile
    {
    public:
        XLThreadedComments() : XLXmlFile(nullptr) {}
        explicit XLThreadedComments(gsl::not_null<XLXmlData*> xmlData) : XLXmlFile(xmlData) {}
        ~XLThreadedComments() = default;
        XLThreadedComments(const XLThreadedComments& other) = default;
        XLThreadedComments(XLThreadedComments&& other) = default;
        XLThreadedComments& operator=(const XLThreadedComments& other) = default;
        XLThreadedComments& operator=(XLThreadedComments&& other) = default;
 
        XLThreadedComment comment(const std::string& ref) const;
 
        std::vector<XLThreadedComment> replies(const std::string& parentId) const;
 
        XLThreadedComment addComment(std::string_view ref, std::string_view personId, std::string_view text);
 
        XLThreadedComment addReply(const std::string& parentId, const std::string& personId, const std::string& text);
 
        bool deleteComment(const std::string& ref);
    };
 
    class OPENXLSX_EXPORT XLPerson
    {
    public:
        XLPerson() = default;
        explicit XLPerson(XMLNode node);
        ~XLPerson() = default;
        XLPerson(const XLPerson& other) = default;
        XLPerson(XLPerson&& other) = default;
        XLPerson& operator=(const XLPerson& other) = default;
        XLPerson& operator=(XLPerson&& other) = default;
 
        bool valid() const;
 
        std::string id() const;
        std::string displayName() const;
 
    private:
        XMLNode m_node;
    };
 
    class OPENXLSX_EXPORT XLPersons : public XLXmlFile
    {
    public:
        XLPersons() : XLXmlFile(nullptr) {}
        explicit XLPersons(gsl::not_null<XLXmlData*> xmlData) : XLXmlFile(xmlData) {}
        ~XLPersons() = default;
        XLPersons(const XLPersons& other) = default;
        XLPersons(XLPersons&& other) = default;
        XLPersons& operator=(const XLPersons& other) = default;
        XLPersons& operator=(XLPersons&& other) = default;
 
        XLPerson person(const std::string& id) const;
 
        std::string addPerson(const std::string& displayName);
    };
} // namespace OpenXLSX
 
#endif // OPENXLSX_XLTHREADEDCOMMENTS_HPP