Mod doc set style de same

This commit is contained in:
Simon De Backer
2020-08-16 11:19:36 +02:00
parent 90417ae509
commit d4ee161c07
274 changed files with 6823 additions and 6756 deletions

View File

@@ -53,11 +53,11 @@ DynamicTextFieldEditor::~DynamicTextFieldEditor() {
}
/**
* @brief DynamicTextFieldEditor::setPart
* Set @part as current edited part of this widget.
* @param part
* @return true if @part can be edited by this widget
*/
@brief DynamicTextFieldEditor::setPart
Set @part as current edited part of this widget.
@param part
@return true if @part can be edited by this widget
*/
bool DynamicTextFieldEditor::setPart(CustomElementPart *part) {
disconnectConnections();
@@ -104,10 +104,10 @@ bool DynamicTextFieldEditor::setParts(QList <CustomElementPart *> parts) {
}
/**
* @brief DynamicTextFieldEditor::currentPart
* @return The current edited part, note they can return nullptr if
* there is not a currently edited part.
*/
@brief DynamicTextFieldEditor::currentPart
@return The current edited part, note they can return nullptr if
there is not a currently edited part.
*/
CustomElementPart *DynamicTextFieldEditor::currentPart() const {
return m_text_field.data();
}
@@ -187,9 +187,9 @@ void DynamicTextFieldEditor::disconnectConnections() {
}
/**
* @brief DynamicTextFieldEditor::fillInfoComboBox
* Fill the combo box "element information"
*/
@brief DynamicTextFieldEditor::fillInfoComboBox
Fill the combo box "element information"
*/
void DynamicTextFieldEditor::fillInfoComboBox() {
ui -> m_elmt_info_cb -> clear();

View File

@@ -26,9 +26,9 @@ namespace Ui {
}
/**
* @brief The DynamicTextFieldEditor class
* This class provide a widget used to edit the property of a dynamic text field
*/
@brief The DynamicTextFieldEditor class
This class provide a widget used to edit the property of a dynamic text field
*/
class DynamicTextFieldEditor : public ElementItemEditor {
Q_OBJECT

View File

@@ -22,10 +22,10 @@
#include <QItemDelegate>
/**
* @brief The EditorDelegate class
* This delegate is only use for disable the edition of the first
* column of the information tree widget
*/
@brief The EditorDelegate class
This delegate is only use for disable the edition of the first
column of the information tree widget
*/
class EditorDelegate : public QItemDelegate
{
public:
@@ -44,13 +44,13 @@ class EditorDelegate : public QItemDelegate
};
/**
* @brief ElementPropertiesEditorWidget::ElementPropertiesEditorWidget
* Default constructor
* @param basic_type : QString of the drawed element
* @param kind_info : DiagramContext to store kindInfo of drawed element
* @param elmt_info : the information of element (label, manufacturer etc...]
* @param parent : parent widget
*/
@brief ElementPropertiesEditorWidget::ElementPropertiesEditorWidget
Default constructor
@param basic_type : QString of the drawed element
@param kind_info : DiagramContext to store kindInfo of drawed element
@param elmt_info : the information of element (label, manufacturer etc...]
@param parent : parent widget
*/
ElementPropertiesEditorWidget::ElementPropertiesEditorWidget(QString &basic_type, DiagramContext &kind_info, DiagramContext &elmt_info, QWidget *parent) :
QDialog(parent),
ui(new Ui::ElementPropertiesEditorWidget),
@@ -64,18 +64,18 @@ ElementPropertiesEditorWidget::ElementPropertiesEditorWidget(QString &basic_type
}
/**
* @brief ElementPropertiesEditorWidget::~ElementPropertiesEditorWidget
* Default destructor
*/
@brief ElementPropertiesEditorWidget::~ElementPropertiesEditorWidget
Default destructor
*/
ElementPropertiesEditorWidget::~ElementPropertiesEditorWidget()
{
delete ui;
}
/**
* @brief ElementPropertiesEditorWidget::upDateInterface
* Update the interface with the curent value
*/
@brief ElementPropertiesEditorWidget::upDateInterface
Update the interface with the curent value
*/
void ElementPropertiesEditorWidget::upDateInterface()
{
ui->m_base_type_cb->setCurrentIndex(ui->m_base_type_cb->findData(QVariant(m_basic_type)));
@@ -94,8 +94,8 @@ void ElementPropertiesEditorWidget::upDateInterface()
}
/**
* @brief ElementPropertiesEditorWidget::setUpInterface
*/
@brief ElementPropertiesEditorWidget::setUpInterface
*/
void ElementPropertiesEditorWidget::setUpInterface()
{
// Type combo box
@@ -147,9 +147,9 @@ void ElementPropertiesEditorWidget::updateTree()
}
/**
* @brief ElementPropertiesEditorWidget::populateTree
* Create QTreeWidgetItem of the tree widget and populate it
*/
@brief ElementPropertiesEditorWidget::populateTree
Create QTreeWidgetItem of the tree widget and populate it
*/
void ElementPropertiesEditorWidget::populateTree()
{
QStringList keys{"label", "plant", "comment", "description", "designation", "manufacturer", "manufacturer_reference", "supplier", "quantity", "unity", "machine_manufacturer_reference"};
@@ -165,9 +165,9 @@ void ElementPropertiesEditorWidget::populateTree()
}
/**
* @brief ElementPropertiesEditorWidget::on_m_buttonBox_accepted
* Action on button accepted : the new information is set
*/
@brief ElementPropertiesEditorWidget::on_m_buttonBox_accepted
Action on button accepted : the new information is set
*/
void ElementPropertiesEditorWidget::on_m_buttonBox_accepted()
{
m_basic_type = ui -> m_base_type_cb -> itemData(ui -> m_base_type_cb -> currentIndex()).toString();
@@ -194,9 +194,9 @@ void ElementPropertiesEditorWidget::on_m_buttonBox_accepted()
}
/**
* @brief ElementPropertiesEditorWidget::on_m_base_type_cb_currentIndexChanged
* @param index : Action when combo-box base type index change
*/
@brief ElementPropertiesEditorWidget::on_m_base_type_cb_currentIndexChanged
@param index : Action when combo-box base type index change
*/
void ElementPropertiesEditorWidget::on_m_base_type_cb_currentIndexChanged(int index)
{
bool slave = false , master = false;

View File

@@ -27,10 +27,10 @@ namespace Ui {
}
/**
* @brief The ElementPropertiesEditorWidget class
* This class provide a dialog for edit various property of element, like
* the type (master, slave, report etc....) and kind info.
*/
@brief The ElementPropertiesEditorWidget class
This class provide a dialog for edit various property of element, like
the type (master, slave, report etc....) and kind info.
*/
class ElementPropertiesEditorWidget : public QDialog
{
Q_OBJECT

View File

@@ -24,11 +24,11 @@
#include "QPropertyUndoCommand/qpropertyundocommand.h"
/**
* @brief PolygonEditor::PolygonEditor
* @param editor
* @param part
* @param parent
*/
@brief PolygonEditor::PolygonEditor
@param editor
@param part
@param parent
*/
PolygonEditor::PolygonEditor(QETElementEditor *editor, PartPolygon *part, QWidget *parent) :
ElementItemEditor(editor, parent),
ui(new Ui::PolygonEditor),
@@ -44,8 +44,8 @@ PolygonEditor::PolygonEditor(QETElementEditor *editor, PartPolygon *part, QWidge
}
/**
* @brief PolygonEditor::~PolygonEditor
*/
@brief PolygonEditor::~PolygonEditor
*/
PolygonEditor::~PolygonEditor() {
delete ui;
}
@@ -67,10 +67,10 @@ void PolygonEditor::disconnectChangeConnections()
}
/**
* @brief PolygonEditor::setPart
* @param new_part
* @return
*/
@brief PolygonEditor::setPart
@param new_part
@return
*/
bool PolygonEditor::setPart(CustomElementPart *new_part)
{
if (!new_part)
@@ -98,9 +98,9 @@ bool PolygonEditor::setPart(CustomElementPart *new_part)
}
/**
* @brief PolygonEditor::currentPart
* @return the curent edited part
*/
@brief PolygonEditor::currentPart
@return the curent edited part
*/
CustomElementPart *PolygonEditor::currentPart() const {
return m_part;
}
@@ -110,9 +110,9 @@ QList<CustomElementPart*> PolygonEditor::currentParts() const {
}
/**
* @brief PolygonEditor::updateForm
* Update the widget
*/
@brief PolygonEditor::updateForm
Update the widget
*/
void PolygonEditor::updateForm()
{
if (!m_part) {
@@ -135,10 +135,10 @@ void PolygonEditor::updateForm()
}
/**
* @brief PolygonEditor::pointsFromTree
* @return the point of polygon from the current value of the tree editor
* if part coordinate.
*/
@brief PolygonEditor::pointsFromTree
@return the point of polygon from the current value of the tree editor
if part coordinate.
*/
QVector<QPointF> PolygonEditor::pointsFromTree()
{
QVector<QPointF> points;
@@ -173,8 +173,8 @@ bool PolygonEditor::eventFilter(QObject *watched, QEvent *event)
}
/**
* @brief PolygonEditor::on_m_close_polygon_cb_stateChanged
*/
@brief PolygonEditor::on_m_close_polygon_cb_stateChanged
*/
void PolygonEditor::on_m_close_polygon_cb_stateChanged(int arg1)
{
Q_UNUSED(arg1);
@@ -192,9 +192,9 @@ void PolygonEditor::on_m_close_polygon_cb_stateChanged(int arg1)
}
/**
* @brief PolygonEditor::on_m_points_list_tree_itemChanged
* Update the polygon according to the current value of the tree editor
*/
@brief PolygonEditor::on_m_points_list_tree_itemChanged
Update the polygon according to the current value of the tree editor
*/
void PolygonEditor::on_m_points_list_tree_itemChanged(QTreeWidgetItem *item, int column)
{
Q_UNUSED(item);
@@ -220,9 +220,9 @@ void PolygonEditor::on_m_points_list_tree_itemChanged(QTreeWidgetItem *item, int
}
/**
* @brief PolygonEditor::on_m_points_list_tree_itemSelectionChanged
* Used to change the color of the current selected point.
*/
@brief PolygonEditor::on_m_points_list_tree_itemSelectionChanged
Used to change the color of the current selected point.
*/
void PolygonEditor::on_m_points_list_tree_itemSelectionChanged()
{
//Prevent when selection change but the widget ins't focused

View File

@@ -51,10 +51,11 @@ class PolygonEditor : public ElementItemEditor
void on_m_remove_point_action_triggered();
private:
/*!
* \brief setUpChangeConnections
* Setup the connection from the line(s) to the widget, to update it when the line(s) are changed (moved ...)
*/
/**
@brief setUpChangeConnections
Setup the connection from the line(s) to the widget,
to update it when the line(s) are changed (moved ...)
*/
void setUpChangeConnections();
void disconnectChangeConnections();

View File

@@ -24,11 +24,11 @@
#include "qeticons.h"
/**
* @brief RectangleEditor::RectangleEditor
* @param editor
* @param rect
* @param parent
*/
@brief RectangleEditor::RectangleEditor
@param editor
@param rect
@param parent
*/
RectangleEditor::RectangleEditor(QETElementEditor *editor, PartRectangle *rect, QWidget *parent) :
ElementItemEditor(editor, parent),
m_part(rect),
@@ -40,8 +40,8 @@ RectangleEditor::RectangleEditor(QETElementEditor *editor, PartRectangle *rect,
}
/**
* @brief RectangleEditor::~RectangleEditor
*/
@brief RectangleEditor::~RectangleEditor
*/
RectangleEditor::~RectangleEditor() {
delete ui;
}
@@ -64,10 +64,10 @@ void RectangleEditor::disconnectChangeConnections()
}
/**
* @brief RectangleEditor::setPart
* @param part
* @return
*/
@brief RectangleEditor::setPart
@param part
@return
*/
bool RectangleEditor::setPart(CustomElementPart *part)
{
if (!part)
@@ -109,9 +109,9 @@ bool RectangleEditor::setParts(QList <CustomElementPart *> parts)
}
/**
* @brief RectangleEditor::currentPart
* @return
*/
@brief RectangleEditor::currentPart
@return
*/
CustomElementPart *RectangleEditor::currentPart() const {
return m_part;
}
@@ -121,16 +121,16 @@ QList<CustomElementPart*> RectangleEditor::currentParts() const {
}
/**
* @brief RectangleEditor::topLeft
* @return The edited topLeft already mapped to part coordinate
*/
@brief RectangleEditor::topLeft
@return The edited topLeft already mapped to part coordinate
*/
QPointF RectangleEditor::editedTopLeft() const {
return m_part->mapFromScene(ui->m_x_sb->value(), ui->m_y_sb->value());
}
/**
* @brief RectangleEditor::updateForm
*/
@brief RectangleEditor::updateForm
*/
void RectangleEditor::updateForm()
{
if (!m_part) {
@@ -153,10 +153,10 @@ void RectangleEditor::updateForm()
}
/**
* @brief RectangleEditor::editingFinished
* Slot called when a editor widget is finish to be edited
* Update the geometry of the rectangle according to value of editing widget.
*/
@brief RectangleEditor::editingFinished
Slot called when a editor widget is finish to be edited
Update the geometry of the rectangle according to value of editing widget.
*/
void RectangleEditor::editingFinished()
{
if (m_locked) {
@@ -340,11 +340,11 @@ void RectangleEditor::yRadiusChanged()
/**
* @brief RectangleEditor::activeConnections
* Enable/disable connection between editor widget and slot editingFinished
* True == enable | false == disable
* @param active
*/
@brief RectangleEditor::activeConnections
Enable/disable connection between editor widget and slot editingFinished
True == enable | false == disable
@param active
*/
void RectangleEditor::activeConnections(bool active)
{
if (active)

View File

@@ -29,9 +29,9 @@ namespace Ui {
}
/**
* @brief The RectangleEditor class
* This class provides a widget to edit rectangles within the element editor.
*/
@brief The RectangleEditor class
This class provides a widget to edit rectangles within the element editor.
*/
class RectangleEditor : public ElementItemEditor
{
Q_OBJECT
@@ -58,9 +58,9 @@ class RectangleEditor : public ElementItemEditor
void xRadiusChanged();
void yRadiusChanged();
/*!
* \brief setUpChangeConnections
* Setup the connection from the rectangles(s) to the widget, to update it when the rectangles(s) are changed (moved ...)
*/
\brief setUpChangeConnections
Setup the connection from the rectangles(s) to the widget, to update it when the rectangles(s) are changed (moved ...)
*/
void setUpChangeConnections();
void disconnectChangeConnections();

View File

@@ -22,12 +22,12 @@
#include <cassert>
/**
* @brief TextEditor::TextEditor
* Default constructor
* @param editor : the element editor who use this editor
* @param text : the text to edit
* @param parent : the parent widget
*/
@brief TextEditor::TextEditor
Default constructor
@param editor : the element editor who use this editor
@param text : the text to edit
@param parent : the parent widget
*/
TextEditor::TextEditor(QETElementEditor *editor, PartText *text, QWidget *parent) :
ElementItemEditor(editor, parent),
ui(new Ui::TextEditor) {
@@ -40,16 +40,16 @@ TextEditor::TextEditor(QETElementEditor *editor, PartText *text, QWidget *paren
}
/**
* @brief TextEditor::~TextEditor
*/
@brief TextEditor::~TextEditor
*/
TextEditor::~TextEditor() {
delete ui;
}
/**
* @brief TextEditor::updateForm
* Update the gui
*/
@brief TextEditor::updateForm
Update the gui
*/
void TextEditor::updateForm()
{
if (m_text.isNull()) {
@@ -94,12 +94,12 @@ void TextEditor::disconnectEditConnection() {
}
/**
* @brief TextEditor::setPart
* Set the current text to edit.
* Set @part to nullptr to clear the current text.
* @param part : part to edit
* @return : return if @part is a partext or nullptr, else return false
*/
@brief TextEditor::setPart
Set the current text to edit.
Set @part to nullptr to clear the current text.
@param part : part to edit
@return : return if @part is a partext or nullptr, else return false
*/
bool TextEditor::setPart(CustomElementPart *part) {
if (!part) {
m_text = nullptr;
@@ -147,9 +147,9 @@ bool TextEditor::setParts(QList <CustomElementPart *> parts) {
}
/**
* @brief TextEditor::currentPart
* @return The current part
*/
@brief TextEditor::currentPart
@return The current part
*/
CustomElementPart *TextEditor::currentPart() const {
return m_text;
}
@@ -163,10 +163,10 @@ QList<CustomElementPart*> TextEditor::currentParts() const {
}
/**
* @brief TextEditor::setUpEditConnection
* Setup the connection between the widgets of this editor and the undo command
* use to apply the change to the edited text.
*/
@brief TextEditor::setUpEditConnection
Setup the connection between the widgets of this editor and the undo command
use to apply the change to the edited text.
*/
void TextEditor::setUpEditConnection() {
disconnectEditConnection();
@@ -234,8 +234,8 @@ void TextEditor::setUpEditConnection() {
}
/**
* @brief TextEditor::on_m_font_pb_clicked
*/
@brief TextEditor::on_m_font_pb_clicked
*/
void TextEditor::on_m_font_pb_clicked() {
bool ok;
QFont font_ = QFontDialog::getFont(&ok, m_text -> font(), this);
@@ -259,9 +259,9 @@ void TextEditor::on_m_font_pb_clicked() {
}
/**
* @brief TextEditor::on_m_color_pb_changed
* @param newColor
*/
@brief TextEditor::on_m_color_pb_changed
@param newColor
*/
void TextEditor::on_m_color_pb_changed(const QColor &newColor) {
for (int i=0; i < m_parts.length(); i++) {
PartText* partText = m_parts[i];