/*
 * 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
 */

#ifndef NOTESHAPE_H
#define NOTESHAPE_H

#include "../HWPElements/HwpRecordTypes.h"
#include "../HWPStream.h"
#include "../Common/XMLReader.h"

namespace HWP
{
enum class ENoteNumbering
{
	CONTINUOUS,
	ON_SECTION,
	ON_PAGE,
	UNKNOWN
};

//TODO:: Verify this enum
// In the original, both EachColumn and EndOfDocument have the same values
enum class ENotePlacement
{
	EachColumn,
	MergedColumn,
	RightMostColumn,

	EndOfDocument,
	EndOfSection
};

class CNoteShape
{
	ENumberShape2 m_eNumberShape;
	HWP_BYTE m_chPlacement;
	ENoteNumbering m_eNumbering;
	bool m_bSuperscript;
	bool m_bBeneathText;
	char16_t m_chUserChar;
	char16_t m_chPrefixChar;
	char16_t m_chSuffixChar;
	short m_shNewNumber;
	int m_nNoteLineLength;
	short m_shSpacingAboveLine;
	short m_shSpacingBelowLine;
	short m_shSpacingBetweenNotes;
	ELineStyle1 m_eNoteLineType;
	HWP_BYTE m_chNoteLineWidth;
	int m_nNoteLineColor;
public:
	CNoteShape();
	CNoteShape(CXMLReader& oReader, EHanType eType);

	static CNoteShape* Parse(int nLevel, int nSize, CHWPStream& oBuffer, int nOff, int nVersion);
};
}

#endif // NOTESHAPE_H