Refactor comments and improve code formatting

sources/ui/masterpropertieswidget.cpp

@@ -1,20 +1,20 @@
 /*
-	Copyright 2006-2026 The QElectroTech Team
+ *	Copyright 2006-2026 The QElectroTech Team
-	This file is part of QElectroTech.
+ *	This file is part of QElectroTech.
-
+ *
-	QElectroTech is free software: you can redistribute it and/or modify
+ *	QElectroTech is free software: you can redistribute it and/or modify
-	it under the terms of the GNU General Public License as published by
+ *	it under the terms of the GNU General Public License as published by
-	the Free Software Foundation, either version 2 of the License, or
+ *	the Free Software Foundation, either version 2 of the License, or
-	(at your option) any later version.
+ *	(at your option) any later version.
-
+ *
-	QElectroTech is distributed in the hope that it will be useful,
+ *	QElectroTech is distributed in the hope that it will be useful,
-	but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *	but WITHOUT ANY WARRANTY; without even the implied warranty of
-	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	GNU General Public License for more details.
+ *	GNU General Public License for more details.
-
+ *
-	You should have received a copy of the GNU General Public License
+ *	You should have received a copy of the GNU General Public License
-	along with QElectroTech.  If not, see <http://www.gnu.org/licenses/>.
+ *	along with QElectroTech.  If not, see <http://www.gnu.org/licenses/>.
-*/
+ */
 #include "masterpropertieswidget.h"
 
 #include "../diagram.h"
@@ -25,64 +25,65 @@
 #include "ui_masterpropertieswidget.h"
 
 #include <QListWidgetItem>
+#include <QMessageBox>
 
 /**
-	@brief MasterPropertiesWidget::MasterPropertiesWidget
+ *	@brief MasterPropertiesWidget::MasterPropertiesWidget
-	Default constructor
+ *	Default constructor
-	@param elmt
+ *	@param elmt
-	@param parent
+ *	@param parent
-*/
+ */
 MasterPropertiesWidget::MasterPropertiesWidget(Element *elmt, QWidget *parent) :
-	AbstractElementPropertiesEditorWidget(parent),
+AbstractElementPropertiesEditorWidget(parent),
-	ui(new Ui::MasterPropertiesWidget),
+ui(new Ui::MasterPropertiesWidget),
-	m_project(nullptr)
+m_project(nullptr)
 {
 	ui->setupUi(this);
-	
+
 	ui->m_free_tree_widget->setContextMenuPolicy(Qt::CustomContextMenu);
 	ui->m_link_tree_widget->setContextMenuPolicy(Qt::CustomContextMenu);
-	
+
 	QStringList list;
 	QSettings settings;
 	if (settings.value("genericpanel/folio", false).toBool()) {
 		list << tr("Vignette")
-		     << tr("Label de folio")
+		<< tr("Label de folio")
-		     << tr("Titre de folio")
+		<< tr("Titre de folio")
-		     << tr("Position");
+		<< tr("Position");
 	}
 	else {
 		list << tr("Vignette")
-		     << tr("N° de folio")
+		<< tr("N° de folio")
-		     << tr("Titre de folio")
+		<< tr("Titre de folio")
-		     << tr("Position");
+		<< tr("Position");
 	}
 	ui->m_free_tree_widget->setHeaderLabels(list);
 	ui->m_link_tree_widget->setHeaderLabels(list);
-	
+
 	m_context_menu  = new QMenu(this);
 	m_link_action   = new QAction(tr("Lier l'élément"), this);
 	m_unlink_action = new QAction(tr("Délier l'élément"), this);
 	m_show_qtwi     = new QAction(tr("Montrer l'élément"), this);
 	m_show_element  = new QAction(tr("Montrer l'élément maître"), this);
 	m_save_header_state = new QAction(tr("Enregistrer la disposition"), this);
-	
+
 	connect(ui->m_free_tree_widget, &QTreeWidget::itemDoubleClicked,
-		this, &MasterPropertiesWidget::showElementFromTWI);
+			this, &MasterPropertiesWidget::showElementFromTWI);
 	connect(ui->m_link_tree_widget, &QTreeWidget::itemDoubleClicked,
-		this, &MasterPropertiesWidget::showElementFromTWI);
+			this, &MasterPropertiesWidget::showElementFromTWI);
-	
+
 	connect(ui->m_free_tree_widget, &QTreeWidget::customContextMenuRequested,
-		[this](QPoint point) {this->customContextMenu(point, 1);});
+			[this](QPoint point) {this->customContextMenu(point, 1);});
 	connect(ui->m_link_tree_widget, &QTreeWidget::customContextMenuRequested,
-		[this](QPoint point) {this->customContextMenu(point, 2);});
+			[this](QPoint point) {this->customContextMenu(point, 2);});
-	
+
 	connect(m_link_action,   &QAction::triggered,
-		this, &MasterPropertiesWidget::on_link_button_clicked);
+			this, &MasterPropertiesWidget::on_link_button_clicked);
 	connect(m_unlink_action, &QAction::triggered,
-		this, &MasterPropertiesWidget::on_unlink_button_clicked);
+			this, &MasterPropertiesWidget::on_unlink_button_clicked);
 	connect(m_show_qtwi,     &QAction::triggered,
-		[this]() {this->showElementFromTWI(this->m_qtwi_at_context_menu,0);});
+			[this]() {this->showElementFromTWI(this->m_qtwi_at_context_menu,0);});
-	
+
 	connect(m_show_element,  &QAction::triggered, [this]()
 	{
 		this->m_element->diagram()->showMe();
@@ -90,46 +91,46 @@ MasterPropertiesWidget::MasterPropertiesWidget(Element *elmt, QWidget *parent) :
 		if(this->m_showed_element)
 			m_showed_element->setHighlighted(false);
 	});
-	
+
 	QHeaderView *qhv = ui->m_free_tree_widget->header();
 	qhv->setContextMenuPolicy(Qt::CustomContextMenu);
 	connect(qhv, &QHeaderView::customContextMenuRequested,
-		this, &MasterPropertiesWidget::headerCustomContextMenuRequested);
+			this, &MasterPropertiesWidget::headerCustomContextMenuRequested);
 	connect(m_save_header_state, &QAction::triggered, [qhv]()
 	{
 		QByteArray qba = qhv->saveState();
 		QSettings settings;
 		settings.setValue("link-element-widget/master-state", qba);
 	});
-	
+
 	setElement(elmt);
 }
 
 /**
-	@brief MasterPropertiesWidget::~MasterPropertiesWidget
+ *	@brief MasterPropertiesWidget::~MasterPropertiesWidget
-	Destructor
+ *	Destructor
-*/
+ */
 MasterPropertiesWidget::~MasterPropertiesWidget()
 {
 	if (m_showed_element)
 		m_showed_element->setHighlighted(false);
-	
+
 	if(m_element)
 		m_element->setHighlighted(false);
-	
+
 	delete ui;
 }
 
 /**
-	@brief MasterPropertiesWidget::setElement
+ *	@brief MasterPropertiesWidget::setElement
-	Set the element to be edited
+ *	Set the element to be edited
-	@param element
+ *	@param element
-*/
+ */
 void MasterPropertiesWidget::setElement(Element *element)
 {
 	if (m_element == element)
 		return;
-	
+
 	if (m_showed_element)
 	{
 		m_showed_element->setHighlighted(false);
@@ -137,40 +138,40 @@ void MasterPropertiesWidget::setElement(Element *element)
 	}
 	if (m_element)
 		m_element->setHighlighted(false);
-	
+
 	if (m_project)
 		disconnect(m_project, SIGNAL(diagramRemoved(QETProject*,Diagram*)),
-			   this, SLOT(diagramWasdeletedFromProject()));
+				   this, SLOT(diagramWasdeletedFromProject()));
 
-	if(Q_LIKELY(element->diagram() && element->diagram()->project()))
+		if(Q_LIKELY(element->diagram() && element->diagram()->project()))
-	{
+		{
-		m_project = element->diagram()->project();
+			m_project = element->diagram()->project();
-		connect(m_project, SIGNAL(diagramRemoved(QETProject*,Diagram*)),
+			connect(m_project, SIGNAL(diagramRemoved(QETProject*,Diagram*)),
-			this, SLOT(diagramWasdeletedFromProject()));
+					this, SLOT(diagramWasdeletedFromProject()));
-	}
+		}
-	else
+		else
-		m_project = nullptr;
+			m_project = nullptr;
 
 	//Keep up to date this widget when the linked elements of m_element change
 	if (m_element)
 		disconnect(m_element.data(), &Element::linkedElementChanged,
-			   this, &MasterPropertiesWidget::updateUi);
+				   this, &MasterPropertiesWidget::updateUi);
-	
+
-	m_element = element;
+		m_element = element;
 	connect(m_element.data(), &Element::linkedElementChanged,
-		this, &MasterPropertiesWidget::updateUi);
+			this, &MasterPropertiesWidget::updateUi);
 
 	updateUi();
 }
 
 /**
-	@brief MasterPropertiesWidget::apply
+ *	@brief MasterPropertiesWidget::apply
-	If link between edited element and other change,
+ *	If link between edited element and other change,
-	apply the change with a QUndoCommand (got with method associatedUndo)
+ *	apply the change with a QUndoCommand (got with method associatedUndo)
-	pushed to the stack of element project.
+ *	pushed to the stack of element project.
-	Return true if link change, else false
+ *	Return true if link change, else false
-	@note is void no Return ???
+ *	@note is void no Return ???
-*/
+ */
 void MasterPropertiesWidget::apply()
 {
 	if (QUndoCommand *undo = associatedUndo())
@@ -178,25 +179,25 @@ void MasterPropertiesWidget::apply()
 }
 
 /**
-	@brief MasterPropertiesWidget::reset
+ *	@brief MasterPropertiesWidget::reset
-	Reset current widget, clear eveything and rebuild widget.
+ *	Reset current widget, clear eveything and rebuild widget.
-*/
+ */
 void MasterPropertiesWidget::reset()
 {
 	foreach (QTreeWidgetItem *qtwi, m_qtwi_hash.keys())
 		delete qtwi;
-	
+
 	m_qtwi_hash.clear();
 	updateUi();
 }
 
 /**
-	@brief MasterPropertiesWidget::associatedUndo
+ *	@brief MasterPropertiesWidget::associatedUndo
-	If link between the edited element and other change,
+ *	If link between the edited element and other change,
-	return a QUndoCommand with this change.
+ *	return a QUndoCommand with this change.
-	If no change return nullptr.
+ *	If no change return nullptr.
-	@return
+ *	@return
-*/
+ */
 QUndoCommand* MasterPropertiesWidget::associatedUndo() const
 {
 	QList <Element *> to_link;
@@ -205,7 +206,7 @@ QUndoCommand* MasterPropertiesWidget::associatedUndo() const
 	for (int i=0; i<ui->m_link_tree_widget->topLevelItemCount(); i++)
 		to_link << m_qtwi_hash[ui->m_link_tree_widget->topLevelItem(i)];
 
-		//The two list contain the same element, there is no change
+	//The two list contain the same element, there is no change
 	if (to_link.size() == linked_.size())
 	{
 		bool equal = true;
@@ -229,11 +230,11 @@ QUndoCommand* MasterPropertiesWidget::associatedUndo() const
 }
 
 /**
-	@brief MasterPropertiesWidget::setLiveEdit
+ *	@brief MasterPropertiesWidget::setLiveEdit
-	@param live_edit = true : live edit is enable
+ *	@param live_edit = true : live edit is enable
-	else false : live edit is disable.
+ *	else false : live edit is disable.
-	@return always true because live edit is handled by this editor widget
+ *	@return always true because live edit is handled by this editor widget
-*/
+ */
 bool MasterPropertiesWidget::setLiveEdit(bool live_edit)
 {
 	m_live_edit = live_edit;
@@ -241,9 +242,9 @@ bool MasterPropertiesWidget::setLiveEdit(bool live_edit)
 }
 
 /**
-	@brief MasterPropertiesWidget::updateUi
+ *	@brief MasterPropertiesWidget::updateUi
-	Build the interface of the widget
+ *	Build the interface of the widget
-*/
+ */
 void MasterPropertiesWidget::updateUi()
 {
 	ui->m_free_tree_widget->clear();
@@ -256,75 +257,75 @@ void MasterPropertiesWidget::updateUi()
 	ElementProvider elmt_prov(m_project);
 	QSettings settings;
 
-		//Build the list of free available element
+	//Build the list of free available element
 	QList <QTreeWidgetItem *> items_list;
 	for(const auto &elmt : elmt_prov.freeElement(ElementData::Slave))
 	{
 		QTreeWidgetItem *qtwi = new QTreeWidgetItem(ui->m_free_tree_widget);
 		qtwi->setIcon(0, elmt->pixmap());
-		
+
 		if(settings.value("genericpanel/folio", false).toBool())
 		{
 			autonum::sequentialNumbers seq;
 			QString F =autonum::AssignVariables::formulaToLabel(
-						elmt->diagram()->border_and_titleblock.folio(),
+				elmt->diagram()->border_and_titleblock.folio(),
-						seq,
+																seq,
-						elmt->diagram(),
+													   elmt->diagram(),
-						elmt);
+																elmt);
 			qtwi->setText(1, F);
 		}
 		else
 		{
 			qtwi->setText(1, QString::number(
-					      elmt->diagram()->folioIndex()
+				elmt->diagram()->folioIndex()
-					      + 1));
+				+ 1));
 		}
-		
+
 
 		qtwi->setText(2, elmt->diagram()->title());
 		qtwi->setText(4, elmt->diagram()->convertPosition(
-				      elmt->scenePos()).toString());
+			elmt->scenePos()).toString());
 		items_list.append(qtwi);
 		m_qtwi_hash.insert(qtwi, elmt);
 	}
-	
+
 	ui->m_free_tree_widget->addTopLevelItems(items_list);
 	items_list.clear();
 
-		//Build the list of already linked element
+	//Build the list of already linked element
 	const QList<Element *> link_list = m_element->linkedElements();
 	for(Element *elmt : link_list)
 	{
 		QTreeWidgetItem *qtwi = new QTreeWidgetItem(ui->m_link_tree_widget);
 		qtwi->setIcon(0, elmt->pixmap());
-		
+
 		if(settings.value("genericpanel/folio", false).toBool())
 		{
 			autonum::sequentialNumbers seq;
 			QString F =autonum::AssignVariables::formulaToLabel(
-						elmt->diagram()->border_and_titleblock.folio(),
+				elmt->diagram()->border_and_titleblock.folio(),
-						seq,
+																seq,
-						elmt->diagram(),
+													   elmt->diagram(),
-						elmt);
+																elmt);
 			qtwi->setText(1, F);
 		}
 		else
 		{
 			qtwi->setText(1, QString::number(
-					      elmt->diagram()->folioIndex()
+				elmt->diagram()->folioIndex()
-					      + 1));
+				+ 1));
 		}
 
 		qtwi->setText(2, elmt->diagram()->title());
 		qtwi->setText(3, elmt->diagram()->convertPosition(
-				      elmt->scenePos()).toString());
+			elmt->scenePos()).toString());
 		items_list.append(qtwi);
 		m_qtwi_hash.insert(qtwi, elmt);
 	}
-	
+
 	if(items_list.count())
 		ui->m_link_tree_widget->addTopLevelItems(items_list);
-	
+
 	QVariant v = settings.value("link-element-widget/master-state");
 	if(!v.isNull())
 	{
@@ -334,9 +335,9 @@ void MasterPropertiesWidget::updateUi()
 }
 
 /**
-	@brief MasterPropertiesWidget::headerCustomContextMenuRequested
+ *	@brief MasterPropertiesWidget::headerCustomContextMenuRequested
-	@param pos
+ *	@param pos
-*/
+ */
 void MasterPropertiesWidget::headerCustomContextMenuRequested(const QPoint &pos)
 {
 	m_context_menu->clear();
@@ -344,31 +345,33 @@ void MasterPropertiesWidget::headerCustomContextMenuRequested(const QPoint &pos)
 	m_context_menu->popup(ui->m_free_tree_widget->header()->mapToGlobal(pos));
 }
 
-/**
-	@brief MasterPropertiesWidget::on_link_button_clicked
-	move current item in the free_list to linked_list
-*/
 /**
  * @brief MasterPropertiesWidget::on_link_button_clicked
- * move current item in the free_list to linked_list
+ * Moves the current item from the free_list to the linked_list,
+ * provided the master's slave limit has not been reached.
  */
 void MasterPropertiesWidget::on_link_button_clicked()
 {
-	// --- NEU: Prüfen, ob das Master-Limit im UI bereits erreicht ist ---
+	// Get the maximum number of allowed slaves from the element's information
 	QVariant max_slaves_variant = m_element->kindInformations().value("max_slaves");
 
 	if (max_slaves_variant.isValid() && !max_slaves_variant.toString().isEmpty()) {
 		int max_slaves = max_slaves_variant.toInt();
+		int current_slaves = ui->m_link_tree_widget->topLevelItemCount();
 
-		// Wir zählen, wie viele Elemente schon in der "Verbunden"-Liste liegen
+		// If a limit is set and reached
-		if (max_slaves != -1 && ui->m_link_tree_widget->topLevelItemCount() >= max_slaves) {
+		if (max_slaves != -1 && current_slaves >= max_slaves) {
-			// Limit erreicht! Wir brechen die Aktion einfach ab.
+
+
+			// Show a message box with the actual window as parent to ensure it's on top
+			QMessageBox::warning(this->window(),
+								 tr("Maximum Slaves Reached"),
+								 tr("This master element cannot accept any new slaves because it is full (Limit: %1).").arg(max_slaves));
 			return;
 		}
 	}
-	// -------------------------------------------------------------------
 
-	//take the current item from free_list and push it to linked_list
+	// Move current item from free_list to linked_list
 	QTreeWidgetItem *qtwi = ui->m_free_tree_widget->currentItem();
 	if (qtwi)
 	{
@@ -381,18 +384,19 @@ void MasterPropertiesWidget::on_link_button_clicked()
 	}
 }
 
+
 /**
-	@brief MasterPropertiesWidget::on_unlink_button_clicked
+ *	@brief MasterPropertiesWidget::on_unlink_button_clicked
-	move current item in linked_list to free_list
+ *	move current item in linked_list to free_list
-*/
+ */
 void MasterPropertiesWidget::on_unlink_button_clicked()
 {
-		//take the current item from linked_list and push it to free_list
+	//take the current item from linked_list and push it to free_list
 	QTreeWidgetItem *qtwi = ui->m_link_tree_widget->currentItem();
 	if(qtwi)
 	{
 		ui->m_link_tree_widget->takeTopLevelItem(
-					ui->m_link_tree_widget->indexOfTopLevelItem(qtwi));
+			ui->m_link_tree_widget->indexOfTopLevelItem(qtwi));
 		ui->m_free_tree_widget->insertTopLevelItem(0, qtwi);
 
 		if(m_live_edit)
@@ -401,18 +405,18 @@ void MasterPropertiesWidget::on_unlink_button_clicked()
 }
 
 /**
-	@brief MasterPropertiesWidget::showElementFromTWI
+ *	@brief MasterPropertiesWidget::showElementFromTWI
-	Show the element corresponding to the given QTreeWidgetItem
+ *	Show the element corresponding to the given QTreeWidgetItem
-	@param qtwi
+ *	@param qtwi
-	@param column
+ *	@param column
-*/
+ */
 void MasterPropertiesWidget::showElementFromTWI(QTreeWidgetItem *qtwi, int column)
 {
 	Q_UNUSED(column);
 	if (m_showed_element)
 	{
 		disconnect(m_showed_element, SIGNAL(destroyed()),
-			   this, SLOT(showedElementWasDeleted()));
+				   this, SLOT(showedElementWasDeleted()));
 		m_showed_element -> setHighlighted(false);
 	}
 	if (m_element)
@@ -422,23 +426,23 @@ void MasterPropertiesWidget::showElementFromTWI(QTreeWidgetItem *qtwi, int colum
 	m_showed_element->diagram()->showMe();
 	m_showed_element->setHighlighted(true);
 	connect(m_showed_element, SIGNAL(destroyed()),
-		this, SLOT(showedElementWasDeleted()));
+			this, SLOT(showedElementWasDeleted()));
 }
 
 /**
-	@brief MasterPropertiesWidget::showedElementWasDeleted
+ *	@brief MasterPropertiesWidget::showedElementWasDeleted
-	Set to nullptr the current showed element when he was deleted
+ *	Set to nullptr the current showed element when he was deleted
-*/
+ */
 void MasterPropertiesWidget::showedElementWasDeleted()
 {
 	m_showed_element = nullptr;
 }
 
 /**
-	@brief MasterPropertiesWidget::diagramWasdeletedFromProject
+ *	@brief MasterPropertiesWidget::diagramWasdeletedFromProject
-	This slot is called when a diagram is removed from the parent project
+ *	This slot is called when a diagram is removed from the parent project
-	of edited element to update the content of this widget
+ *	of edited element to update the content of this widget
-*/
+ */
 void MasterPropertiesWidget::diagramWasdeletedFromProject()
 {
 	// We use a timer because if the removed diagram
@@ -449,11 +453,11 @@ void MasterPropertiesWidget::diagramWasdeletedFromProject()
 }
 
 /**
-	@brief MasterPropertiesWidget::customContextMenu
+ *	@brief MasterPropertiesWidget::customContextMenu
-	Display a context menu
+ *	Display a context menu
-	@param pos
+ *	@param pos
-	@param i : the tree widget where the context menu was requested.
+ *	@param i : the tree widget where the context menu was requested.
-*/
+ */
 void MasterPropertiesWidget::customContextMenu(const QPoint &pos, int i)
 {
 	// add the size of the header to display the topleft of the QMenu
@@ -462,14 +466,14 @@ void MasterPropertiesWidget::customContextMenu(const QPoint &pos, int i)
 	// section related to QAbstractScrollArea
 	QPoint point = pos;
 	point.ry()+=ui->m_free_tree_widget->header()->height();
-	
+
 	m_context_menu->clear();
-	
+
 	if (i == 1)
 	{
 		point = ui->m_free_tree_widget->mapToGlobal(point);
-		
+
-			//Context at for free tree widget
+		//Context at for free tree widget
 		if (ui->m_free_tree_widget->currentItem())
 		{
 			m_qtwi_at_context_menu = ui->m_free_tree_widget->currentItem();
@@ -480,8 +484,8 @@ void MasterPropertiesWidget::customContextMenu(const QPoint &pos, int i)
 	else
 	{
 		point = ui->m_link_tree_widget->mapToGlobal(point);
-		
+
-			//context at for link tre widget
+		//context at for link tre widget
 		if (ui->m_link_tree_widget->currentItem())
 		{
 			m_qtwi_at_context_menu = ui->m_link_tree_widget->currentItem();
@@ -489,7 +493,7 @@ void MasterPropertiesWidget::customContextMenu(const QPoint &pos, int i)
 			m_context_menu->addAction(m_show_qtwi);
 		}
 	}
-	
+
 	m_context_menu->addAction(m_show_element);
 	m_context_menu->popup(point);
 }