core/OOXML/XlsxFormat/Comments/Comments.h

/*
 * Copyright (C) Ascensio System SIA, 2009-2026
 *
 * This program is a free software product. You can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License (AGPL)
 * version 3 as published by the Free Software Foundation, together with the
 * additional terms provided in the LICENSE file.
 *
 * This program is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. For
 * details, see the GNU AGPL at: https://www.gnu.org/licenses/agpl-3.0.html
 *
 * You can contact Ascensio System SIA by email at info@onlyoffice.com
 * or by postal mail at 20A-6 Ernesta Birznieka-Upisha Street, Riga,
 * LV-1050, Latvia, European Union.
 *
 * The interactive user interfaces in modified versions of the Program
 * are required to display Appropriate Legal Notices in accordance with
 * Section 5 of the GNU AGPL version 3.
 *
 * No trademark rights are granted under this License.
 *
 * All non-code elements of the Product, including illustrations,
 * icon sets, and technical writing content, are licensed under the
 * Creative Commons Attribution-ShareAlike 4.0 International License:
 * https://creativecommons.org/licenses/by-sa/4.0/legalcode
 *
 * This license applies only to such non-code elements and does not
 * modify or replace the licensing terms applicable to the Program's
 * source code, which remains licensed under the GNU Affero General
 * Public License v3.
 *
 * SPDX-License-Identifier: AGPL-3.0-only
 */
#pragma once

#include "../Worksheets/Worksheet.h"
#include "../Styles/Styles.h"

namespace OOX
{
	namespace Spreadsheet
	{
		class CSi;
		class CThreadedComment;

		class CCommentItem
		{
		public:
			nullable<unsigned int> m_nLeft;
			nullable<unsigned int> m_nTop;
			nullable<unsigned int> m_nRight;
			nullable<unsigned int> m_nBottom;
			nullable<unsigned int> m_nLeftOffset;
			nullable<unsigned int> m_nTopOffset;
			nullable<unsigned int> m_nRightOffset;
			nullable<unsigned int> m_nBottomOffset;
			nullable_double	m_dLeftMM;
			nullable_double m_dTopMM;
			nullable_double m_dWidthMM;
			nullable_double m_dHeightMM;
			nullable_string	m_sAuthor;
			nullable<unsigned int> m_nRow;
			nullable<unsigned int> m_nCol;
			nullable_bool	m_bMove;
			nullable_bool	m_bSize;
			nullable<CSi>	m_oText;
			CThreadedComment*	m_pThreadedComment;
			bool m_bThreadedCommentCopy;
			nullable_string m_sGfxdata;
			nullable_bool	m_bVisible;
			nullable_string m_sFillColorRgb;

			CCommentItem();
			bool IsValid();
		};

		class CAuthors : public WritingElement
		{
		public:
			WritingElement_AdditionMethods(CAuthors)
            WritingElement_XlsbConstructors(CAuthors)
			CAuthors();
			virtual ~CAuthors();

			virtual void ClearItems();

			virtual void fromXML(XmlUtils::CXmlNode& node);
			virtual std::wstring toXML() const;
			virtual void toXML(NSStringUtils::CStringBuilder& writer) const;
			virtual void fromXML(XmlUtils::CXmlLiteReader& oReader);

			void fromBin(XLS::BaseObjectPtr& obj);
			XLS::BaseObjectPtr toBin();

			virtual EElementType getType () const;

		private:
			void ReadAttributes(XmlUtils::CXmlLiteReader& oReader);

		public:
			std::vector<std::wstring>  m_arrItems;
		};

		class CComment : public WritingElement
		{
		public:
			WritingElement_AdditionMethods(CComment)
            WritingElement_XlsbConstructors(CComment)
			CComment();
			virtual ~CComment();

			virtual void fromXML(XmlUtils::CXmlNode& node);
			virtual std::wstring toXML() const;
			virtual void toXML(NSStringUtils::CStringBuilder& writer) const;
			virtual void fromXML(XmlUtils::CXmlLiteReader& oReader);

			void fromBin(XLS::BaseObjectPtr& obj);
			XLS::BaseObjectPtr toBin();
			XLS::BaseObjectPtr toXLS(XLS::BaseObjectPtr objectsPointer, unsigned int id, const std::wstring &author);

			virtual EElementType getType () const;

		private:
			void ReadAttributes(XmlUtils::CXmlLiteReader& oReader);
			void ReadAttributes(XLS::BaseObjectPtr& obj);

		public:
			nullable<SimpleTypes::CRelationshipId > m_oRef;
			nullable<SimpleTypes::CUnsignedDecimalNumber > m_oAuthorId;
			nullable<SimpleTypes::CGuid > m_oUid;

            nullable<CSi> m_oText;
		};

		class CCommentList : public WritingElementWithChilds<CComment>
		{
		public:
			WritingElement_AdditionMethods(CCommentList)
            WritingElement_XlsbConstructors(CCommentList)
			CCommentList();
			virtual ~CCommentList();

			virtual void fromXML(XmlUtils::CXmlNode& node);
			virtual std::wstring toXML() const;
			virtual void toXML(NSStringUtils::CStringBuilder& writer) const;
			virtual void fromXML(XmlUtils::CXmlLiteReader& oReader);

			void fromBin(XLS::BaseObjectPtr& obj);
			XLS::BaseObjectPtr toBin();

			virtual EElementType getType () const;

        private:
			void ReadAttributes(XmlUtils::CXmlLiteReader& oReader);
        };

		class CComments : public OOX::FileGlobalEnumerated, public OOX::IFileContainer
		{
		public:
			CComments(OOX::Document* pMain);
			CComments(OOX::Document* pMain, const CPath& oRootPath, const CPath& oPath);
			virtual ~CComments();

			void readBin(const CPath& oPath);
			XLS::BaseObjectPtr WriteBin() const;
			std::vector<XLS::BaseObjectPtr> toXLS(XLS::BaseObjectPtr objectsPtr) const;
			virtual void read(const CPath& oPath);
			virtual void read(const CPath& oRootPath, const CPath& oPath);
			virtual void write(const CPath& oPath, const CPath& oDirectory, CContentTypes& oContent) const;

			virtual const OOX::FileType type() const;

			virtual const CPath DefaultDirectory() const;
			virtual const CPath DefaultFileName() const;

			const CPath& GetReadPath();

		private:
			CPath m_oReadPath;

			void ReadAttributes(XmlUtils::CXmlLiteReader& oReader);

		public:
			nullable<CAuthors >		m_oAuthors;
			nullable<CCommentList > m_oCommentList;
		};

		class CLegacyDrawingWorksheet : public WritingElement
		{
		public:
			WritingElement_AdditionMethods(CLegacyDrawingWorksheet)
            WritingElement_XlsbConstructors(CLegacyDrawingWorksheet)
			CLegacyDrawingWorksheet();
			virtual ~CLegacyDrawingWorksheet();

			virtual void fromXML(XmlUtils::CXmlNode& node);
			virtual std::wstring toXML() const;
			virtual void toXML(NSStringUtils::CStringBuilder& writer) const;
			virtual void fromXML(XmlUtils::CXmlLiteReader& oReader);

			void fromBin(XLS::BaseObjectPtr& obj);
			XLS::BaseObjectPtr toBin();
            void toBin(XLS::StreamCacheWriterPtr& writer);

			virtual EElementType getType () const;

		private:
			void ReadAttributes(XmlUtils::CXmlLiteReader& oReader);
			void ReadAttributes(XLS::BaseObjectPtr& obj);

		public:
			nullable<SimpleTypes::CRelationshipId > m_oId;
		};
	} //Spreadsheet
} // namespace OOX