qelectrotech-source-mirror/sources/bordertitleblock.cpp

/*
	Copyright 2006-2020 The QElectroTech Team
	This file is part of QElectroTech.

	QElectroTech is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 2 of the License, or
	(at your option) any later version.

	QElectroTech is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with QElectroTech.  If not, see <http://www.gnu.org/licenses/>.
*/
#include "bordertitleblock.h"

#include "createdxf.h"
#include "diagram.h"
#include "diagramposition.h"
#include "math.h"
#include "qetapp.h"
#include "titleblocktemplate.h"
#include "titleblocktemplaterenderer.h"

#include <QLocale>
#include <QPainter>
#include <utility>

#define MIN_COLUMN_COUNT 3
#define MIN_ROW_COUNT 3
#define MIN_COLUMN_WIDTH 5.0
#define MIN_ROW_HEIGHT 5.0

/**
	@brief BorderTitleBlock::BorderTitleBlock
	Simple constructor:
	build a border by recovering the dimensions
	in the application configuration.

	\~French Constructeur simple :
	construit une bordure en recuperant les dimensions
	dans la configuration de l'application.
	\~ @param parent :
	\~French QObject parent de ce BorderTitleBlock
*/
BorderTitleBlock::BorderTitleBlock(QObject *parent) :
	QObject(parent)
{
	// at first, the internal titleblock template renderer uses the default titleblock template
	m_titleblock_template_renderer = new TitleBlockTemplateRenderer(this);
	m_titleblock_template_renderer -> setTitleBlockTemplate(QETApp::defaultTitleBlockTemplate());

	// disable the QPicture-based cache from Qt 4.8 to avoid rendering errors and crashes
#if QT_VERSION < QT_VERSION_CHECK(4, 8, 0)	// ### Qt 6: remove
#else
	m_titleblock_template_renderer -> setUseCache(false);
#endif

	// dimensions par defaut du schema
	importBorder(BorderProperties());

	// contenu par defaut du cartouche
	importTitleBlock(TitleBlockProperties());

	display_titleblock_ = true;
	display_border_ = true;
	setFolioData(1, 1);
	updateRectangles();
}

/**
	@brief BorderTitleBlock::~BorderTitleBlock
	\~French Destructeur - ne fait rien
*/
BorderTitleBlock::~BorderTitleBlock()
{
}

/**
	@brief BorderTitleBlock::titleBlockRect
	@return the rectangle of the titleblock in scene coordinate.
*/
QRectF BorderTitleBlock::titleBlockRect() const
{
	if (m_edge == Qt::BottomEdge)
		return QRectF(diagram_rect_.bottomLeft(),
			      QSize(diagram_rect_.width(),
				    m_titleblock_template_renderer -> height()
				    ));
	else
		return QRectF(diagram_rect_.topRight(),
			      QSize(m_titleblock_template_renderer -> height(),
				    diagram_rect_.height()
				    ));
}

/**
	@brief BorderTitleBlock::titleblockInformation
	@return
*/
DiagramContext BorderTitleBlock::titleblockInformation() const
{
	return m_titleblock_template_renderer->context();
}

/**
	@brief BorderTitleBlock::titleBlockRectForQPainter
	@return The title block rect to use with the QPainter in the method draw.
	The returned rect is alway horizontal
	(like displayed at the bottom of rect) only the top left change of pos
	according to the edge where the title block need to be displayed.
	Rect according to edge:
	Bottom : top left is at the bottom left edge of the diagram rect.
	Right : top left is at the bottom right of diagram rect.
	Befor use this rect you need to rotate the QPainter by -90°
	for snap the rect at the right edge of diagram.
*/
QRectF BorderTitleBlock::titleBlockRectForQPainter() const
{
	//Rect at bottom have same position and dimension of displayed rect
	if (m_edge == Qt::BottomEdge)
		return titleBlockRect();
	else
		return QRectF (diagram_rect_.bottomRight(),
			       QSize(diagram_rect_.height(),
				     m_titleblock_template_renderer -> height()
				     ));

}

/**
	@brief BorderTitleBlock::borderAndTitleBlockRect
	@return the bounding rectangle of diagram and titleblock.
	It's like unite outsideBorderRect and titleBlockRect.
	The rect is in scene coordinate
*/
QRectF BorderTitleBlock::borderAndTitleBlockRect() const
{
	return diagram_rect_ | titleBlockRect();
}

/**
	@brief BorderTitleBlock::columnsRect
	@return The columns rect in scene coordinate.
	If column is not displayed, return a null QRectF
*/
QRectF BorderTitleBlock::columnsRect() const
{
	if (!display_columns_) return QRectF();
	return QRectF (Diagram::margin,
		       Diagram::margin,
		       (columns_count_*columns_width_) + rows_header_width_,
		       columns_header_height_);
}

/**
	@brief BorderTitleBlock::rowsRect
	@return The rows rect in scene coordinate.
	If row is not displayed, return a null QRectF
*/
QRectF BorderTitleBlock::rowsRect() const
{
	if (!display_rows_) return QRectF();
	return QRectF (Diagram::margin,
		       Diagram::margin,
		       rows_header_width_,
		       (rows_count_*rows_height_) + columns_header_height_);
}

/**
	@brief BorderTitleBlock::outsideBorderRect
	@return The rect of outside border (diagram with columns and rows)
	The rect is in scene coordinate
*/
QRectF BorderTitleBlock::outsideBorderRect() const
{
	return QRectF (Diagram::margin,
		       Diagram::margin,
		       (columns_width_*columns_count_) + rows_header_width_,
		       (rows_height_*rows_count_) + columns_header_height_);
}

/**
	@brief BorderTitleBlock::insideBorderRect
	@return The rect of the inside border, in other word, the drawing area.
	This method take care about if rows or columns are displayed or not.
	The rect is in scene coordinate
*/
QRectF BorderTitleBlock::insideBorderRect() const
{
	qreal left = Diagram::margin;
	qreal top  = Diagram::margin;
	qreal width  = columns_width_*columns_count_;
	qreal height = rows_height_*rows_count_;

	display_rows_ ? left += rows_header_width_ : width += rows_header_width_;
	display_columns_ ? top += columns_header_height_ : height += columns_header_height_;

	return QRectF (left, top, width, height);
}

/**
	@brief BorderTitleBlock::titleBlockToXml
	Exports the title block current values to XML.
	@param xml_elmt the XML element attributes will be added to
*/
void BorderTitleBlock::titleBlockToXml(QDomElement &xml_elmt) {
	exportTitleBlock().toXml(xml_elmt);
}

/**
	@brief BorderTitleBlock::titleBlockFromXml
	Reads the title block values from XML.
	@param xml_elmt the XML element values will be read from
*/
void BorderTitleBlock::titleBlockFromXml(const QDomElement &xml_elmt) {
	TitleBlockProperties tbp;
	tbp.fromXml(xml_elmt);
	importTitleBlock(tbp);
}

/**
	@brief BorderTitleBlock::borderToXml
	Exports the border current settings to XML.
	@param xml_elmt the XML element attributes will be added to
*/
void BorderTitleBlock::borderToXml(QDomElement &xml_elmt) {
	xml_elmt.setAttribute("cols",        columnsCount());
	xml_elmt.setAttribute("colsize",     QString("%1").arg(columnsWidth()));
	xml_elmt.setAttribute("displaycols", columnsAreDisplayed() ? "true" : "false");

	xml_elmt.setAttribute("rows",        rowsCount());
	xml_elmt.setAttribute("rowsize",     QString("%1").arg(rowsHeight()));
	xml_elmt.setAttribute("displayrows", rowsAreDisplayed() ? "true" : "false");

	// attribut datant de la version 0.1 - laisse pour retrocompatibilite
	xml_elmt.setAttribute("height", QString("%1").arg(diagramHeight()));
}

/**
	@brief BorderTitleBlock::borderFromXml
	Reads the border settings from XML.
	@param xml_elmt the XML element values will be read from
*/
void BorderTitleBlock::borderFromXml(const QDomElement &xml_elmt) {
	bool ok;
	// columns count
	int cols_count = xml_elmt.attribute("cols").toInt(&ok);
	if (ok) setColumnsCount(cols_count);

	// columns width
	double cols_width = xml_elmt.attribute("colsize").toDouble(&ok);
	if (ok) setColumnsWidth(cols_width);

	// backward compatibility:
	//	diagrams saved with 0.1 version have a "height" attribute
	if (xml_elmt.hasAttribute("rows") && xml_elmt.hasAttribute("rowsize")) {
		// rows counts
		int rows_count = xml_elmt.attribute("rows").toInt(&ok);
		if (ok) setRowsCount(rows_count);

		// taille des lignes
		double rows_size = xml_elmt.attribute("rowsize").toDouble(&ok);
		if (ok) setRowsHeight(rows_size);
	} else {
		// hauteur du schema
		double height = xml_elmt.attribute("height").toDouble(&ok);
		if (ok) setDiagramHeight(height);
	}

	// rows and columns display
	displayColumns(xml_elmt.attribute("displaycols") != "false");
	displayRows(xml_elmt.attribute("displayrows") != "false");

	updateRectangles();
}

/**
	@brief BorderTitleBlock::exportTitleBlock
	@return the properties of the titleblock
	\~French les proprietes du cartouches
*/
TitleBlockProperties BorderTitleBlock::exportTitleBlock()
{
	TitleBlockProperties ip;

	ip.author = author();
	ip.date = date();
	ip.title = title();
	ip.filename = fileName();
	ip.plant = plant();
	ip.locmach = locmach();
	ip.indexrev = indexrev();
	ip.version = version();
	ip.folio = folio();
	ip.template_name = titleBlockTemplateName();
	ip.display_at = m_edge;
	ip.auto_page_num = autoPageNum();
	ip.context = additional_fields_;
	ip.collection = QET::QetCollection::Embedded;

	return(ip);
}

/**
	@brief BorderTitleBlock::importTitleBlock
	@param ip the new properties of titleblock
*/
void BorderTitleBlock::importTitleBlock(const TitleBlockProperties &ip) {
	setAuthor(ip.author);
	setDate(ip.date);
	setTitle(ip.title);
	setFileName(ip.filename);
	setPlant(ip.plant);
	setLocMach(ip.locmach);
	setIndicerev(ip.indexrev);
	setVersion(QET::displayedVersion);
	setFolio(ip.folio);
	setAutoPageNum(ip.auto_page_num);
	if (m_edge != ip.display_at)
	{
		m_edge = ip.display_at;
		emit(displayChanged());
	}
	additional_fields_ = ip.context;

	emit(needFolioData()); // Note: we expect additional data to be provided
	// through setFolioData(),
	// which in turn calls updateDiagramContextForTitleBlock().
	emit(needTitleBlockTemplate(ip.template_name));
}

/**
	@brief BorderTitleBlock::exportBorder
	@return border properties
	\~French les proprietes de la bordure
*/
BorderProperties BorderTitleBlock::exportBorder()
{
	BorderProperties bp;
	bp.columns_count = columnsCount();
	bp.columns_width = columnsWidth();
	bp.columns_header_height = columnsHeaderHeight();
	bp.display_columns = columnsAreDisplayed();
	bp.rows_count = rowsCount();
	bp.rows_height = rowsHeight();
	bp.rows_header_width = rowsHeaderWidth();
	bp.display_rows = rowsAreDisplayed();
	return(bp);
}

/**
	@brief BorderTitleBlock::importBorder
	@param bp : the new properties of the border
	\~French les nouvelles proprietes de la bordure
*/
void BorderTitleBlock::importBorder(const BorderProperties &bp) {
	setColumnsHeaderHeight(bp.columns_header_height);
	setColumnsCount(bp.columns_count);
	setColumnsWidth(bp.columns_width);
	displayColumns(bp.display_columns);
	setRowsHeaderWidth(bp.rows_header_width);
	setRowsCount(bp.rows_count);
	setRowsHeight(bp.rows_height);
	displayRows(bp.display_rows);
}

/**
	@brief BorderTitleBlock::titleBlockTemplate
	@return the titleblock template used to render the titleblock
	@see TitleBlockTemplateRenderer::titleBlockTemplate()
*/
const TitleBlockTemplate *BorderTitleBlock::titleBlockTemplate()
{
	return(m_titleblock_template_renderer -> titleBlockTemplate());
}

/**
	@brief BorderTitleBlock::setTitleBlockTemplate
	@param titleblock_template:
	The new titleblock template to use to render the titleblock
	@see TitleBlockTemplateRenderer::setTitleBlockTemplate()
*/
void BorderTitleBlock::setTitleBlockTemplate(
		const TitleBlockTemplate *titleblock_template) {
	m_titleblock_template_renderer -> setTitleBlockTemplate(
				titleblock_template);
}

/**
	@brief BorderTitleBlock::titleBlockTemplateName
	@return The name of the template used to render the titleblock.
*/
QString BorderTitleBlock::titleBlockTemplateName() const
{
	QString tbt_name = m_titleblock_template_renderer -> titleBlockTemplate() -> name();
	return((tbt_name == "default") ? "" : tbt_name);
}

/**
	@brief BorderTitleBlock::titleBlockTemplateChanged
	This slot may be used to inform this class that the given title block
	template has changed.
	The title block-dedicated rendering cache will thus be flushed.
	@param template_name : Name of the title block template that has changed
*/
void BorderTitleBlock::titleBlockTemplateChanged(const QString &template_name) {
	if (titleBlockTemplateName() != template_name) return;
	m_titleblock_template_renderer -> invalidateRenderedTemplate();
}

/**
	@brief BorderTitleBlock::titleBlockTemplateRemoved
	This slot has to be used to inform this class that the given title block
	template is about to be removed and is no longer accessible. This class
	will either use the provided optional TitleBlockTemplate or the default
	title block provided by QETApp::defaultTitleBlockTemplate()
	@param removed_template_name :
	Name of the title block template that has changed
	@param new_template (Optional) title block template to use instead
*/
void BorderTitleBlock::titleBlockTemplateRemoved(
		const QString &removed_template_name,
		const TitleBlockTemplate *new_template) {
	if (titleBlockTemplateName() != removed_template_name) return;

	if (new_template) {
		setTitleBlockTemplate(new_template);
	} else {
		setTitleBlockTemplate(QETApp::defaultTitleBlockTemplate());
	}
}

/**
	@brief BorderTitleBlock::displayTitleBlock
	@param di : true to display the title block, false otherwise
	\~French true pour afficher le cartouche, false sinon
*/
void BorderTitleBlock::displayTitleBlock(bool di) {
	bool change = (di != display_titleblock_);
	display_titleblock_ = di;
	if (change) emit(displayChanged());
}

/**
	@brief BorderTitleBlock::displayColumns
	@param dc : true to display the column headers, false otherwise
	\~French true pour afficher les entetes des colonnes, false sinon
*/
void BorderTitleBlock::displayColumns(bool dc) {
	bool change = (dc != display_columns_);
	display_columns_ = dc;
	if (change) emit(displayChanged());
}

/**
	@brief BorderTitleBlock::displayRows
	@param dr : true to display line headers, false otherwise
	\~French true pour afficher les entetes des lignes, false sinon
*/
void BorderTitleBlock::displayRows(bool dr) {
	bool change = (dr != display_rows_);
	display_rows_ = dr;
	if (change) emit(displayChanged());
}

/**
	@brief BorderTitleBlock::displayBorder
	@param db : true to display the border of the diagram, false otherwise
	\~French true pour afficher la bordure du schema, false sinon
	\~ @note : if the border display is deactivated,
	the rows and columns will not be drawn.
	\~French si l'affichage de la bordure est ainsi desactivee,
	les lignes et colonnes ne seront pas dessinees.
*/
void BorderTitleBlock::displayBorder(bool db) {
	bool change = (db != display_border_);
	display_border_  = db;
	if (change) emit(displayChanged());
}

/**
	@brief BorderTitleBlock::slot_setAutoPageNum
	@param pageAutoNum :
	Set Page (Folio) Auto Num
*/
void BorderTitleBlock::slot_setAutoPageNum(QString pageAutoNum) {
	btb_auto_page_num_=std::move(pageAutoNum);
}

/**
	@brief BorderTitleBlock::updateRectangles
	This method update the diagram rect according
	to the value of rows and columns (number and size)
*/
void BorderTitleBlock::updateRectangles()
{
	QRectF previous_diagram = diagram_rect_;
	diagram_rect_ = QRectF(Diagram::margin,
			       Diagram::margin,
			       diagramWidth(),
			       diagramHeight());
	if (diagram_rect_ != previous_diagram)
		emit(borderChanged(previous_diagram, diagram_rect_));
}

/**
	@brief BorderTitleBlock::draw
	Draw the border and the titleblock.
	@param painter : QPainter to use for draw this.
*/
void BorderTitleBlock::draw(QPainter *painter)
{
	//Set the QPainter
	painter -> save();
	QPen pen(Qt::black);
	pen.setCosmetic(true);
	painter -> setPen(pen);
	painter -> setBrush(Qt::NoBrush);

	QSettings settings;

	//Draw the borer
	if (display_border_) painter -> drawRect(diagram_rect_);

	painter -> setFont(QETApp::diagramTextsFont());

	//Draw the empty case at the top left of diagram when there is header
	if (display_border_ && (display_columns_ || display_rows_))
	{
		QRectF first_rectangle(
			diagram_rect_.topLeft().x(),
			diagram_rect_.topLeft().y(),
			rows_header_width_,
			columns_header_height_
		);
		painter -> drawRect(first_rectangle);
	}

		//Draw the nums of columns
	if (display_border_ && display_columns_) {
		for (int i = 1 ; i <= columns_count_ ; ++ i) {
			QRectF numbered_rectangle = QRectF(
				diagram_rect_.topLeft().x()
					+ (rows_header_width_
					   + ((i - 1) * columns_width_)),
				diagram_rect_.topLeft().y(),
				columns_width_,
				columns_header_height_
			);
			painter -> drawRect(numbered_rectangle);
			if (settings.value("border-columns_0", true).toBool()){
			painter -> drawText(numbered_rectangle,
					    Qt::AlignVCenter
					    | Qt::AlignCenter,
					    QString("%1").arg(i - 1));
			}else{
			painter -> drawText(numbered_rectangle,
					    Qt::AlignVCenter
					    | Qt::AlignCenter,
					    QString("%1").arg(i));
			}
		}
	}

		//Draw the nums of rows
	if (display_border_ && display_rows_) {
		QString row_string("A");
		for (int i = 1 ; i <= rows_count_ ; ++ i) {
			QRectF lettered_rectangle = QRectF(
				diagram_rect_.topLeft().x(),
				diagram_rect_.topLeft().y()
					+ (
						columns_header_height_
						+ ((i - 1)* rows_height_)
						),
				rows_header_width_,
				rows_height_
			);
			painter -> drawRect(lettered_rectangle);
			painter -> drawText(lettered_rectangle,
					    Qt::AlignVCenter
					    | Qt::AlignCenter,
					    row_string);
			row_string = incrementLetters(row_string);
		}
	}

		// render the titleblock, using the TitleBlockTemplate object
	if (display_titleblock_) {
		QRectF tbt_rect = titleBlockRectForQPainter();
		if (m_edge == Qt::BottomEdge)
		{
			painter -> translate(tbt_rect.topLeft());
			m_titleblock_template_renderer -> render(
						painter,
						tbt_rect.width());
			painter -> translate(-tbt_rect.topLeft());
		}
		else
		{
			painter->translate(tbt_rect.topLeft());
			painter->rotate(-90);
			m_titleblock_template_renderer -> render(
						painter,
						tbt_rect.width());
			painter->rotate(90);
			painter -> translate(-tbt_rect.topLeft());
		}
	}

	painter -> restore();
}

/**
	@brief BorderTitleBlock::drawDxf
	@param file_path
	@param color
*/
void BorderTitleBlock::drawDxf(
		QString &file_path,
		int color)
{
	// Transform to DXF scale.
	columns_header_height_ *= Createdxf::yScale;
	rows_height_           *= Createdxf::yScale;
	rows_header_width_     *= Createdxf::xScale;
	columns_width_         *= Createdxf::xScale;

	// draw the empty box that appears as soon as there is a header
	// dessine la case vide qui apparait des qu'il y a un entete
	if (display_border_ &&
		(display_columns_ ||
		 display_rows_)
		) {
		Createdxf::drawRectangle(
			file_path,
			double(diagram_rect_.topLeft().x()) * Createdxf::xScale,
			Createdxf::sheetHeight
					- double(diagram_rect_.topLeft().y())
					* Createdxf::yScale
					- columns_header_height_,
			rows_header_width_,
			columns_header_height_,
			color
		);
	}

	QSettings settings;

	// draw the numbering of the columns
	// dessine la numerotation des colonnes
	if (display_border_ &&
		display_columns_) {
	int offset = settings.value("border-columns_0", true).toBool() ? -1 : 0;
		for (int i = 1 ; i <= columns_count_ ; ++ i) {
	    double xCoord = diagram_rect_.topLeft().x() * Createdxf::xScale +
					(rows_header_width_ + ((i - 1) *
					 columns_width_));
			double yCoord = Createdxf::sheetHeight
		    - diagram_rect_.topLeft().y()*Createdxf::yScale
					- columns_header_height_;
			double recWidth = columns_width_;
			double recHeight = columns_header_height_;
			Createdxf::drawRectangle(file_path, xCoord, yCoord,
						 recWidth, recHeight, color);

			Createdxf::drawTextAligned(file_path,
			   QString::number(i + offset),
			   xCoord+recWidth/4,
			   yCoord + recHeight*0.5,
						   recHeight*0.7,
						   0,
						   0,
						   1,
						   2,
			   xCoord+recWidth/2,
			   1,
			   color);
	}
	}

	// draw line numbering
	// dessine la numerotation des lignes
	if (display_border_ && display_rows_) {
		QString row_string("A");
		for (int i = 1 ; i <= rows_count_ ; ++ i) {
			double xCoord = diagram_rect_.topLeft().x()
					* Createdxf::xScale;
	    double yCoord = Createdxf::sheetHeight
		    - diagram_rect_.topLeft().y()
					*Createdxf::yScale
					- (
						columns_header_height_
						+ ((i - 1)
						   * rows_height_) )
					- rows_height_;
			double recWidth = rows_header_width_;
			double recHeight = rows_height_;
			Createdxf::drawRectangle(file_path, xCoord, yCoord,
						 recWidth, recHeight, color);
			Createdxf::drawTextAligned(file_path,
						   row_string,
			   xCoord+recWidth*0.1,
			   yCoord + recHeight*0.4,
						   recWidth*0.7,
						   0,
						   0,
						   1,
						   2,
						   xCoord+recWidth/2,
			   1,
			   color);
			row_string = incrementLetters(row_string);
		}
	}

	// render the titleblock, using the TitleBlockTemplate object
	if (display_titleblock_) {
		//qp -> translate(titleblock_rect_.topLeft());
		QRectF rect = titleBlockRect();
		m_titleblock_template_renderer -> renderDxf(rect,
							    rect.width(),
							    file_path,
							    color);
		//qp -> translate(-titleblock_rect_.topLeft());
	}

	// Transform back to QET scale
	columns_header_height_ /= Createdxf::yScale;
	rows_height_		   /= Createdxf::yScale;
	rows_header_width_     /= Createdxf::xScale;
	columns_width_         /= Createdxf::xScale;

}

/**
	@brief BorderTitleBlock::setColumnsCount
	Allows you to change the number of columns.
	If this number of columns is less than the minimum required,
	it is this minimum which is used.

	\~French Permet de changer le nombre de colonnes.
	Si ce nombre de colonnes est inferieur au minimum requis,
	c'est ce minimum qui est utilise.
	\~ @param nb_c : new number of columns
	\~French nouveau nombre de colonnes
	\~ @see minNbColumns()
*/
void BorderTitleBlock::setColumnsCount(int nb_c) {
	if (nb_c == columnsCount()) return;
	columns_count_ = qMax(MIN_COLUMN_COUNT , nb_c);
	updateRectangles();
}

/**
	@brief BorderTitleBlock::setColumnsWidth
	Change the width of the columns.
	If the width indicated is less than the minimum required,
	it is this minimum which is used.

	\~French Change la largeur des colonnes.
	Si la largeur indiquee est inferieure au minimum requis,
	c'est ce minimum qui est utilise.
	\~ @param new_cw : new column width
	\~French nouvelle largeur des colonnes
	\~ @see minColumnsWidth()
*/
void BorderTitleBlock::setColumnsWidth(const qreal &new_cw) {
	if (new_cw == columnsWidth()) return;
	columns_width_ = qMax(MIN_COLUMN_WIDTH , new_cw);
	updateRectangles();
}

/**
	@brief BorderTitleBlock::setColumnsHeaderHeight
	Change the height of the headers containing the column numbers.
	This must remain between 5 and 50 px.

	\~French Change la hauteur des en-tetes contenant les numeros de colonnes.
	Celle-ci doit rester comprise entre 5 et 50 px.
	\~ @param new_chh : new height of column headers
	\~French nouvelle hauteur des en-tetes de colonnes
*/
void BorderTitleBlock::setColumnsHeaderHeight(const qreal &new_chh) {
	columns_header_height_ = qBound(qreal(5.0), new_chh, qreal(50.0));
	updateRectangles();
}

/**
	@brief BorderTitleBlock::setRowsCount
	Allows you to change the number of lines.
	If this number of lines is lower than the minimum required,
	this function does nothing

	\~French Permet de changer le nombre de lignes.
	Si ce nombre de lignes est inferieur au minimum requis,
	cette fonction ne fait rien
	\~ @param nb_r : new number of lines
	\~French nouveau nombre de lignes
	\~ @see minNbRows()
*/
void BorderTitleBlock::setRowsCount(int nb_r) {
	if (nb_r == rowsCount()) return;
	rows_count_ = qMax(MIN_ROW_COUNT, nb_r);
	updateRectangles();
}

/**
	@brief BorderTitleBlock::setRowsHeight
	Change the height of the lines.
	If the indicated height is lower than the minimum required,
	it is this minimum which is used.

	\~French Change la hauteur des lignes.
	Si la hauteur indiquee est inferieure au minimum requis,
	c'est ce minimum qui est utilise.
	\~ @param new_rh : new row height
	\~French nouvelle hauteur des lignes
	\~ @see minRowsHeight()
*/
void BorderTitleBlock::setRowsHeight(const qreal &new_rh) {
	if (new_rh == rowsHeight()) return;
	rows_height_ = qMax(MIN_ROW_HEIGHT, new_rh);
	updateRectangles();
}

/**
	@brief BorderTitleBlock::setRowsHeaderWidth
	Change the width of the headers containing the line numbers.
	This must remain between 5 and 50 px.

	\~French Change la largeur des en-tetes contenant les numeros de lignes.
	Celle-ci doit rester comprise entre 5 et 50 px.
	\~ @param new_rhw : new width of line headers
	\~French nouvelle largeur des en-tetes des lignes
*/
void BorderTitleBlock::setRowsHeaderWidth(const qreal &new_rhw) {
	rows_header_width_ = qBound(qreal(5.0), new_rhw, qreal(50.0));
	updateRectangles();
}

/**
	@brief BorderTitleBlock::setDiagramHeight
	This method tries to get as close as possible to the given height
	as a parameter by modifying the number of rows in progress.

	\~French Cette methode essaye de se rapprocher le plus possible de la
	hauteur donnee en parametre en modifiant le nombre de lignes en cours.
	\~ @param height :
*/
void BorderTitleBlock::setDiagramHeight(const qreal &height) {
	//          size of rows to use = rows_height
	// taille des lignes a utiliser = rows_height
	setRowsCount(qRound(ceil(height / rows_height_)));
}

/**
	@brief BorderTitleBlock::convertPosition
	Convert a Point in cartesian coordinate (x : 12.5, 56.9)
	to a point in grid coordinate (ex : B2)
	@param pos : position to convert
	@return the converted point in grid coordinate.
*/
DiagramPosition BorderTitleBlock::convertPosition(const QPointF &pos)
{
	if(!insideBorderRect().contains(pos))
		return (DiagramPosition("", 0));

	QPointF relative_pos = pos - insideBorderRect().topLeft();
	int row_number    = int(ceil(relative_pos.x() / columnsWidth()));
	int column_number = int(ceil(relative_pos.y() / rowsHeight()));

	QString letter = "A";
	for (int i = 1 ; i < column_number ; ++ i)
		letter = incrementLetters(letter);

	return(DiagramPosition(letter, row_number));
}

/**
	@brief BorderTitleBlock::setAuthor
	@param author the new value of the "Author" field
*/
void BorderTitleBlock::setAuthor(const QString &author) {
	btb_author_ = author;
}

/**
	@brief BorderTitleBlock::setDate
	@param date the new value of the "Date" field
*/
void BorderTitleBlock::setDate(const QDate &date) {
	btb_date_ = date;
}

/**
	@brief BorderTitleBlock::setTitle
	@param title the new value of the "Title" field
*/
void BorderTitleBlock::setTitle(const QString &title)
{
	if (btb_title_ != title)
	{
		btb_title_ = title;
		emit(diagramTitleChanged(title));
	}
}

/**
	@brief BorderTitleBlock::setFolio
	@param folio the new value of the "Folio" field
*/
void BorderTitleBlock::setFolio(const QString &folio)
{
	btb_folio_ = folio;
	emit (titleBlockFolioChanged(folio));
}

/**
	@brief BorderTitleBlock::updateDiagramContextForTitleBlock
	Update the informations given to the titleblock template
	by regenerating a DiagramContext object.
	@param initial_context :
	Base diagram context that will be overridden by diagram-wide values
*/
void BorderTitleBlock::updateDiagramContextForTitleBlock(
		const DiagramContext &initial_context) {
	// Our final DiagramContext is the initial one (which is supposed to bring
	// project-wide properties), overridden by the "additional fields" one...
	DiagramContext context = initial_context;
	foreach (QString key, additional_fields_.keys()) {
		context.addValue(key, additional_fields_[key]);
	}

	// ... overridden by the historical and/or dynamically generated fields
	QLocale var;
	var.dateFormat(QLocale::ShortFormat);
	context.addValue("author",      btb_author_);
	context.addValue(
		"date",
		QLocale::system().toString(btb_date_, QLocale::ShortFormat));
	context.addValue("title",       btb_title_);
	context.addValue("filename",    btb_filename_);
	context.addValue("plant",     btb_plant_);
	context.addValue("locmach",     btb_locmach_);
	context.addValue("indexrev",    btb_indexrev_);
	context.addValue("version",     btb_version_);
	context.addValue("folio",       btb_final_folio_);
	context.addValue("folio-id",    folio_index_);
	context.addValue("folio-total", folio_total_);
	context.addValue("auto_page_num", btb_auto_page_num_);
	context.addValue("previous-folio-num", m_previous_folio_num);
	context.addValue("next-folio-num", m_next_folio_num);

	m_titleblock_template_renderer -> setContext(context);
}

/**
	@brief BorderTitleBlock::incrementLetters
	increments string with Letters A to Z
	@param string
	@return string ++Letters
	eg:
	- A-> B
	- Z -> AA
*/
QString BorderTitleBlock::incrementLetters(const QString &string) {
	if (string.isEmpty()) {
		return("A");
	} else {
		// separate previous digits from last digit
		// separe les digits precedents du dernier digit
		QString first_digits(string.left(string.count() - 1));
		QChar last_digit(string.at(string.count() - 1));
		if (last_digit != 'Z') {
			// increments the last digit
			// incremente le dernier digit
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0) // ### Qt 6: remove
			last_digit = last_digit.toLatin1() + 1;
#else
#	if TODO_LIST
#		pragma message("@TODO remove code for QT 6 or later")
#	endif
			qDebug() << "Help code for QT 6 or later";
#endif
			return(first_digits + QString(last_digit));
		} else {
			return(incrementLetters(first_digits) + "A");
		}
	}
}

/**
	@brief BorderTitleBlock::setFolioData

	\~ @param index : schema number (from 1 to total)
	\~French numero du schema (de 1 a total)

	\~ @param total : total number of diagrams in the project
	\~French nombre total de schemas dans le projet

	\~ @param autonum :

	\~ @param project_properties : Project-wide properties,
	to be merged with diagram-wide ones.
*/
void BorderTitleBlock::setFolioData(
		int index,
		int total,
		const QString& autonum,
		const DiagramContext &project_properties) {
	if (index < 1 || total < 1 || index > total) return;

	// memorize information
	// memorise les informations
	folio_index_ = index;
	folio_total_ = total;

	// regenerate the content of the folio field
	// regenere le contenu du champ folio
	btb_final_folio_ = btb_folio_;

	if (btb_final_folio_.contains("%autonum")){
		btb_final_folio_.replace("%autonum", autonum);
		btb_folio_ = btb_final_folio_;
	}
	btb_final_folio_.replace("%id",    QString::number(folio_index_));
	btb_final_folio_.replace("%total", QString::number(folio_total_));

	updateDiagramContextForTitleBlock(project_properties);
}

/**
	@brief BorderTitleBlock::setPlant
	@param plant the new value of the "plant" field
*/
void BorderTitleBlock::setPlant(const QString &plant) {
	btb_plant_ = plant;
}

/**
	@brief BorderTitleBlock::setLocMach
	@param locmach the new value of the "locmach" field
*/
void BorderTitleBlock::setLocMach(const QString &locmach) {
	btb_locmach_ = locmach;
}

/**
	@brief BorderTitleBlock::setIndicerev
	@param indexrev the new value of the "indexrev" field
*/
void BorderTitleBlock::setIndicerev(const QString &indexrev) {
	btb_indexrev_ = indexrev;
}

/**
	@brief BorderTitleBlock::setFileName
	@param filename the new value of the "filename" field
*/
void BorderTitleBlock::setFileName(const QString &filename) {
	btb_filename_ = filename;
}

/**
	@brief BorderTitleBlock::setVersion
	@param version the new value of the "version" field
*/
void BorderTitleBlock::setVersion(const QString &version) {
	btb_version_ = version;
}

/**
	@brief BorderTitleBlock::setAutoPageNum
	@param auto_page_num the new value of the "auto_page_num" field
*/
void BorderTitleBlock::setAutoPageNum(const QString &auto_page_num) {
	btb_auto_page_num_ = auto_page_num;
}

/**
	@brief BorderTitleBlock::setPreviousFolioNum
	@param previous the new value of the "previous-folio-num" field
*/
void BorderTitleBlock::setPreviousFolioNum(const QString &previous)
{
	m_previous_folio_num = previous;
	DiagramContext context = m_titleblock_template_renderer->context();
	context.addValue("previous-folio-num", m_previous_folio_num);
	m_titleblock_template_renderer->setContext(context);
}

/**
	@brief BorderTitleBlock::setNextFolioNum
	@param next the new value of the "next-folio-num" field
*/
void BorderTitleBlock::setNextFolioNum(const QString &next)
{
	m_next_folio_num = next;
	DiagramContext context = m_titleblock_template_renderer->context();
	context.addValue("next-folio-num", m_next_folio_num);
	m_titleblock_template_renderer->setContext(context);
}