OpenXLSX 1.9.1
Loading...
Searching...
No Matches
OpenXLSX::XLThreadedComment Class Reference

A proxy class encapsulating a single modern threaded comment. More...

#include <XLThreadedComments.hpp>

Public Member Functions

 XLThreadedComment ()=default
 
 XLThreadedComment (XMLNode node, XLWorksheet *wks=nullptr)
 
 ~XLThreadedComment ()=default
 
 XLThreadedComment (const XLThreadedComment &other)=default
 
 XLThreadedComment (XLThreadedComment &&other)=default
 
XLThreadedCommentoperator= (const XLThreadedComment &other)=default
 
XLThreadedCommentoperator= (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)
 
XLThreadedCommentaddReply (const std::string &text, const std::string &author="")
 Add a reply to this thread (only works if initialized with Worksheet context).
 
void setWorksheet (XLWorksheet *wks)
 

Detailed Description

A proxy class encapsulating a single modern threaded comment.

Constructor & Destructor Documentation

◆ XLThreadedComment() [1/4]

OpenXLSX::XLThreadedComment::XLThreadedComment ( )
default

◆ XLThreadedComment() [2/4]

XLThreadedComment::XLThreadedComment ( XMLNode  node,
XLWorksheet wks = nullptr 
)
explicit

◆ ~XLThreadedComment()

OpenXLSX::XLThreadedComment::~XLThreadedComment ( )
default

◆ XLThreadedComment() [3/4]

OpenXLSX::XLThreadedComment::XLThreadedComment ( const XLThreadedComment other)
default

◆ XLThreadedComment() [4/4]

OpenXLSX::XLThreadedComment::XLThreadedComment ( XLThreadedComment &&  other)
default

Member Function Documentation

◆ addReply()

XLThreadedComment & XLThreadedComment::addReply ( const std::string &  text,
const std::string &  author = "" 
)

Add a reply to this thread (only works if initialized with Worksheet context).

◆ id()

std::string XLThreadedComment::id ( ) const

◆ isResolved()

bool XLThreadedComment::isResolved ( ) const

◆ operator=() [1/2]

XLThreadedComment & OpenXLSX::XLThreadedComment::operator= ( const XLThreadedComment other)
default

◆ operator=() [2/2]

XLThreadedComment & OpenXLSX::XLThreadedComment::operator= ( XLThreadedComment &&  other)
default

◆ parentId()

std::string XLThreadedComment::parentId ( ) const

◆ personId()

std::string XLThreadedComment::personId ( ) const

◆ ref()

std::string XLThreadedComment::ref ( ) const

◆ setResolved()

void XLThreadedComment::setResolved ( bool  resolved)

◆ setWorksheet()

void OpenXLSX::XLThreadedComment::setWorksheet ( XLWorksheet wks)
inline

◆ text()

std::string XLThreadedComment::text ( ) const

◆ valid()

bool XLThreadedComment::valid ( ) const

The documentation for this class was generated from the following files: