kotschak/qelectrotech-source-mirror
0
0
Fork 0
mirror of https://github.com/qelectrotech/qelectrotech-source-mirror.git synced 2026-04-01 17:00:00 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Mod doc set style de same

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

6
sources/ui/abstractelementpropertieseditorwidget.h
View File

@@ -24,9 +24,9 @@
class Element;
/**
* @brief The AbstractElementPropertiesEditorWidget class
* This class provide common method for all widget used to edit some properties of an element
*/
@brief The AbstractElementPropertiesEditorWidget class
This class provide common method for all widget used to edit some properties of an element
*/
class AbstractElementPropertiesEditorWidget : public PropertiesEditorWidget
{
Q_OBJECT

6
sources/ui/alignmenttextdialog.cpp
View File

@@ -51,9 +51,9 @@ AlignmentTextDialog::~AlignmentTextDialog()
}
/**
* @brief AlignmentTextDialog::alignment
* @return the selected alignment
*/
@brief AlignmentTextDialog::alignment
@return the selected alignment
*/
Qt::Alignment AlignmentTextDialog::alignment() const
{
if(ui->top_left->isChecked())

38
sources/ui/borderpropertieswidget.cpp
View File

@@ -20,11 +20,11 @@
#include "diagram.h"
/**
* @brief BorderPropertiesWidget::BorderPropertiesWidget
* default constructor
* @param bp properties
* @param parent paretn widget
*/
@brief BorderPropertiesWidget::BorderPropertiesWidget
default constructor
@param bp properties
@param parent paretn widget
*/
BorderPropertiesWidget::BorderPropertiesWidget(const BorderProperties &bp, QWidget *parent) :
QWidget(parent),
ui(new Ui::BorderPropertiesWidget)
@@ -34,19 +34,19 @@ BorderPropertiesWidget::BorderPropertiesWidget(const BorderProperties &bp, QWidg
}
/**
* @brief BorderPropertiesWidget::~BorderPropertiesWidget
* default destructor
*/
@brief BorderPropertiesWidget::~BorderPropertiesWidget
default destructor
*/
BorderPropertiesWidget::~BorderPropertiesWidget()
{
delete ui;
}
/**
* @brief BorderPropertiesWidget::setProperties
* Set the current properties to edit
* @param bp properties to edit
*/
@brief BorderPropertiesWidget::setProperties
Set the current properties to edit
@param bp properties to edit
*/
void BorderPropertiesWidget::setProperties(const BorderProperties &bp) {
m_properties = bp;
ui -> m_colums_count_sp ->setValue (m_properties.columns_count);
@@ -58,9 +58,9 @@ void BorderPropertiesWidget::setProperties(const BorderProperties &bp) {
}
/**
* @brief BorderPropertiesWidget::properties
* @return the edited border properties
*/
@brief BorderPropertiesWidget::properties
@return the edited border properties
*/
const BorderProperties &BorderPropertiesWidget::properties () {
m_properties.columns_count = ui -> m_colums_count_sp -> value();
m_properties.columns_width = ui -> m_columns_width_sp -> value();
@@ -72,10 +72,10 @@ const BorderProperties &BorderPropertiesWidget::properties () {
}
/**
* @brief BorderPropertiesWidget::setReadOnly
* Enable or disable this widget
* @param ro true-disable / false-enable
*/
@brief BorderPropertiesWidget::setReadOnly
Enable or disable this widget
@param ro true-disable / false-enable
*/
void BorderPropertiesWidget::setReadOnly(const bool &ro) {
ui->border_gb->setDisabled(ro);
}

6
sources/ui/borderpropertieswidget.h
View File

@@ -26,9 +26,9 @@ namespace Ui {
}
/**
* @brief The BorderPropertiesWidget class
* this widget edit the properties of a border
*/
@brief The BorderPropertiesWidget class
this widget edit the properties of a border
*/
class BorderPropertiesWidget : public QWidget
{
Q_OBJECT

20
sources/ui/compositetexteditdialog.cpp
View File

@@ -35,17 +35,17 @@ CompositeTextEditDialog::~CompositeTextEditDialog() {
}
/**
* @brief CompositeTextEditDialog::plainText
* @return The edited text
*/
@brief CompositeTextEditDialog::plainText
@return The edited text
*/
QString CompositeTextEditDialog::plainText() const {
return ui->m_plain_text_edit->toPlainText();
}
/**
* @brief CompositeTextEditDialog::setUpComboBox
* Add the available element information in the combo box
*/
@brief CompositeTextEditDialog::setUpComboBox
Add the available element information in the combo box
*/
void CompositeTextEditDialog::setUpComboBox()
{
QStringList qstrl;
@@ -78,10 +78,10 @@ void CompositeTextEditDialog::on_m_info_cb_activated(const QString &arg1)
}
/**
* @brief CompositeTextEditDialog::focusInEvent
* Reimplemented from QWidget::focusInEvent
* @param event
*/
@brief CompositeTextEditDialog::focusInEvent
Reimplemented from QWidget::focusInEvent
@param event
*/
void CompositeTextEditDialog::focusInEvent(QFocusEvent *event)
{
ui->m_plain_text_edit->setFocus();

12
sources/ui/compositetexteditdialog.h
View File

@@ -10,12 +10,12 @@ namespace Ui {
class DynamicElementTextItem;
/**
* @brief The CompositeTextEditDialog class
* CompositeTextEditDialog display a dialog use to write the complex text
* of a dynamic element text item.
* This dialog provide a QComboBox to quickly add an information of the element
* in the composite text.
*/
@brief The CompositeTextEditDialog class
CompositeTextEditDialog display a dialog use to write the complex text
of a dynamic element text item.
This dialog provide a QComboBox to quickly add an information of the element
in the composite text.
*/
class CompositeTextEditDialog : public QDialog
{
Q_OBJECT

40
sources/ui/conductorpropertiesdialog.cpp
View File

@@ -24,11 +24,11 @@
#include "QPropertyUndoCommand/qpropertyundocommand.h"
/**
* @brief ConductorPropertiesDialog::ConductorPropertiesDialog
* Constructor
* @param conductor, conductor to edit propertie
* @param parent, parent widget
*/
@brief ConductorPropertiesDialog::ConductorPropertiesDialog
Constructor
@param conductor, conductor to edit propertie
@param parent, parent widget
*/
ConductorPropertiesDialog::ConductorPropertiesDialog(Conductor *conductor, QWidget *parent) :
QDialog(parent),
ui(new Ui::ConductorPropertiesDialog)
@@ -45,19 +45,19 @@ ConductorPropertiesDialog::ConductorPropertiesDialog(Conductor *conductor, QWidg
}
/**
* @brief ConductorPropertiesDialog::~ConductorPropertiesDialog
*/
@brief ConductorPropertiesDialog::~ConductorPropertiesDialog
*/
ConductorPropertiesDialog::~ConductorPropertiesDialog()
{
delete ui;
}
/**
* @brief ConductorPropertiesDialog::PropertiesDialog
* Static method for open and apply properties.
* @param conductor, conductor to edit propertie
* @param parent, parent widget
*/
@brief ConductorPropertiesDialog::PropertiesDialog
Static method for open and apply properties.
@param conductor, conductor to edit propertie
@param parent, parent widget
*/
void ConductorPropertiesDialog::PropertiesDialog(Conductor *conductor, QWidget *parent)
{
ConductorPropertiesDialog cpd (conductor, parent);
@@ -86,19 +86,19 @@ void ConductorPropertiesDialog::PropertiesDialog(Conductor *conductor, QWidget *
}
/**
* @brief ConductorPropertiesDialog::properties
* @return the edited properties
*/
@brief ConductorPropertiesDialog::properties
@return the edited properties
*/
ConductorProperties ConductorPropertiesDialog::properties() const {
return m_cpw -> properties();
}
/**
* @brief ConductorPropertiesDialog::applyAll
* @return
* true -> must apply the propertie to all conductor at the same potential
* false -> must apply properties only for the edited conductor
*/
@brief ConductorPropertiesDialog::applyAll
@return
true -> must apply the propertie to all conductor at the same potential
false -> must apply properties only for the edited conductor
*/
bool ConductorPropertiesDialog::applyAll() const {
return ui -> m_apply_all_cb -> isChecked();
}

128
sources/ui/conductorpropertieswidget.cpp
View File

@@ -22,10 +22,10 @@
#include "qtextorientationspinboxwidget.h"
/**
* @brief ConductorPropertiesWidget::ConductorPropertiesWidget
* Constructor
* @param parent, paretn widget
*/
@brief ConductorPropertiesWidget::ConductorPropertiesWidget
Constructor
@param parent, paretn widget
*/
ConductorPropertiesWidget::ConductorPropertiesWidget(QWidget *parent) :
QWidget(parent),
ui(new Ui::ConductorPropertiesWidget)
@@ -38,11 +38,11 @@ ConductorPropertiesWidget::ConductorPropertiesWidget(QWidget *parent) :
/**
* @brief ConductorPropertiesWidget::ConductorPropertiesWidget
* Constructor with properties
* @param properties, properties to edit
* @param parent, parent widget
*/
@brief ConductorPropertiesWidget::ConductorPropertiesWidget
Constructor with properties
@param properties, properties to edit
@param parent, parent widget
*/
ConductorPropertiesWidget::ConductorPropertiesWidget(const ConductorProperties &properties, QWidget *parent) :
QWidget(parent),
ui(new Ui::ConductorPropertiesWidget)
@@ -53,19 +53,19 @@ ConductorPropertiesWidget::ConductorPropertiesWidget(const ConductorProperties &
}
/**
* @brief ConductorPropertiesWidget::~ConductorPropertiesWidget
* destructor
*/
@brief ConductorPropertiesWidget::~ConductorPropertiesWidget
destructor
*/
ConductorPropertiesWidget::~ConductorPropertiesWidget()
{
delete ui;
}
/**
* @brief ConductorPropertiesWidget::setProperties
* Set the properties
* @param properties
*/
@brief ConductorPropertiesWidget::setProperties
Set the properties
@param properties
*/
void ConductorPropertiesWidget::setProperties(const ConductorProperties &properties)
{
if (m_properties == properties)
@@ -107,9 +107,9 @@ void ConductorPropertiesWidget::setProperties(const ConductorProperties &propert
}
/**
* @brief ConductorPropertiesWidget::properties
* @return the edited properties
*/
@brief ConductorPropertiesWidget::properties
@return the edited properties
*/
ConductorProperties ConductorPropertiesWidget::properties() const
{
ConductorProperties properties_;
@@ -146,10 +146,10 @@ ConductorProperties ConductorPropertiesWidget::properties() const
}
/**
* @brief ConductorPropertiesWidget::event
* @param event
* @return
*/
@brief ConductorPropertiesWidget::event
@param event
@return
*/
bool ConductorPropertiesWidget::event(QEvent *event)
{
if (event->type() == QEvent::WindowActivate) {
@@ -160,42 +160,42 @@ bool ConductorPropertiesWidget::event(QEvent *event)
/**
* @brief ConductorPropertiesWidget::setReadOnly
* @param ro if true this widget is disabled
*/
@brief ConductorPropertiesWidget::setReadOnly
@param ro if true this widget is disabled
*/
void ConductorPropertiesWidget::setReadOnly(const bool &ro) {
this->setDisabled(ro);
}
/**
* @brief ConductorPropertiesWidget::addAutonumWidget
* @param widget
*/
@brief ConductorPropertiesWidget::addAutonumWidget
@param widget
*/
void ConductorPropertiesWidget::addAutonumWidget(QWidget *widget) {
ui->m_autonum_layout->addWidget(widget);
}
/**
* @brief ConductorPropertiesWidget::setHiddenOneTextPerFolio
* @param hide
*/
@brief ConductorPropertiesWidget::setHiddenOneTextPerFolio
@param hide
*/
void ConductorPropertiesWidget::setHiddenOneTextPerFolio(const bool &hide) {
ui -> m_one_text_per_folio_cb -> setHidden(hide);
}
/**
* @brief ConductorPropertiesWidget::setDisabledShowText
* @param disable
*/
@brief ConductorPropertiesWidget::setDisabledShowText
@param disable
*/
void ConductorPropertiesWidget::setDisabledShowText(const bool &disable) {
ui->m_show_text_cb->setDisabled(disable==true? true : false);
}
/**
* @brief ConductorPropertiesWidget::setHiddenAvailableAutonum
* Hide the label, combo box and push button of available autonum
* @param hide
*/
@brief ConductorPropertiesWidget::setHiddenAvailableAutonum
Hide the label, combo box and push button of available autonum
@param hide
*/
void ConductorPropertiesWidget::setHiddenAvailableAutonum(const bool &hide)
{
ui->m_autonum_label->setHidden(hide);
@@ -214,8 +214,8 @@ QPushButton *ConductorPropertiesWidget::editAutonumPushButton() const
}
/**
* @brief ConductorPropertiesWidget::initWidget
*/
@brief ConductorPropertiesWidget::initWidget
*/
void ConductorPropertiesWidget::initWidget() {
m_verti_select = QETApp::createTextOrientationSpinBoxWidget();
ui -> m_text_angle_gl -> addWidget(m_verti_select, 2, 0, Qt::AlignHCenter);
@@ -236,10 +236,10 @@ void ConductorPropertiesWidget::initWidget() {
}
/**
* @brief ConductorPropertiesWidget::setConductorType
* Update this widget to the new conductor type
* @param type
*/
@brief ConductorPropertiesWidget::setConductorType
Update this widget to the new conductor type
@param type
*/
void ConductorPropertiesWidget::setConductorType(ConductorProperties::ConductorType type) {
switch (type) {
case ConductorProperties::Multi:
@@ -255,11 +255,11 @@ void ConductorPropertiesWidget::setConductorType(ConductorProperties::ConductorT
}
/**
* @brief ConductorPropertiesWidget::updatePreview
* Update the preview for single lien
* @param b true: update from the value displayed by this widget
* false: update from the properties given at the constructor of this widget
*/
@brief ConductorPropertiesWidget::updatePreview
Update the preview for single lien
@param b true: update from the value displayed by this widget
false: update from the properties given at the constructor of this widget
*/
void ConductorPropertiesWidget::updatePreview(bool b) {
const QRect pixmap_rect(0, 0, 96, 96);
QPixmap pixmap(pixmap_rect.width(), pixmap_rect.height());
@@ -277,10 +277,10 @@ void ConductorPropertiesWidget::updatePreview(bool b) {
}
/**
* @brief ConductorPropertiesWidget::on_m_earth_cb_toggled
* Update the widget when toggled
* @param checked
*/
@brief ConductorPropertiesWidget::on_m_earth_cb_toggled
Update the widget when toggled
@param checked
*/
void ConductorPropertiesWidget::on_m_earth_cb_toggled(bool checked) {
if (checked && ui -> m_neutral_cb -> isChecked())
ui -> m_pen_cb -> setEnabled(true);
@@ -288,10 +288,10 @@ void ConductorPropertiesWidget::on_m_earth_cb_toggled(bool checked) {
}
/**
* @brief ConductorPropertiesWidget::on_m_neutral_cb_toggled
* Update the widget when toggled
* @param checked
*/
@brief ConductorPropertiesWidget::on_m_neutral_cb_toggled
Update the widget when toggled
@param checked
*/
void ConductorPropertiesWidget::on_m_neutral_cb_toggled(bool checked) {
if (checked && ui -> m_earth_cb -> isChecked())
ui -> m_pen_cb -> setEnabled(true);
@@ -299,12 +299,12 @@ void ConductorPropertiesWidget::on_m_neutral_cb_toggled(bool checked) {
}
/**
* @brief ConductorPropertiesWidget::on_m_update_preview_pb_clicked
* Update the preview of single line.
* m_update_preview_pb is a no used button and hidden, his role is only
* to centralize signal from various widget to edit single ligne properties,
* for update the preview
*/
@brief ConductorPropertiesWidget::on_m_update_preview_pb_clicked
Update the preview of single line.
m_update_preview_pb is a no used button and hidden, his role is only
to centralize signal from various widget to edit single ligne properties,
for update the preview
*/
void ConductorPropertiesWidget::on_m_update_preview_pb_clicked() {
updatePreview();
}

42
sources/ui/configpage/generalconfigurationpage.cpp
View File

@@ -25,9 +25,9 @@
#include <QFileDialog>
/**
* @brief GeneralConfigurationPage::GeneralConfigurationPage
* @param parent
*/
@brief GeneralConfigurationPage::GeneralConfigurationPage
@param parent
*/
GeneralConfigurationPage::GeneralConfigurationPage(QWidget *parent) :
ConfigPage(parent),
ui(new Ui::GeneralConfigurationPage)
@@ -131,9 +131,9 @@ GeneralConfigurationPage::~GeneralConfigurationPage()
}
/**
* @brief GeneralConfigurationPage::applyConf
* Write all configuration in settings file
*/
@brief GeneralConfigurationPage::applyConf
Write all configuration in settings file
*/
void GeneralConfigurationPage::applyConf()
{
QSettings settings;
@@ -231,25 +231,25 @@ void GeneralConfigurationPage::applyConf()
}
/**
* @brief GeneralConfigurationPage::title
* @return The title of this page
*/
@brief GeneralConfigurationPage::title
@return The title of this page
*/
QString GeneralConfigurationPage::title() const {
return(tr("Général", "configuration page title"));
}
/**
* @brief GeneralConfigurationPage::icon
* @return The icon of this page
*/
@brief GeneralConfigurationPage::icon
@return The icon of this page
*/
QIcon GeneralConfigurationPage::icon() const {
return(QET::Icons::Settings);
}
/**
* @brief GeneralConfigurationPage::fillLang
* fill all available lang
*/
@brief GeneralConfigurationPage::fillLang
fill all available lang
*/
void GeneralConfigurationPage::fillLang()
{
ui->m_lang_cb->addItem(QET::Icons::translation, tr("Système"), "system");
@@ -295,9 +295,9 @@ void GeneralConfigurationPage::fillLang()
}
/**
* @brief GeneralConfigurationPage::on_m_font_pb_clicked
* Apply font to config
*/
@brief GeneralConfigurationPage::on_m_font_pb_clicked
Apply font to config
*/
void GeneralConfigurationPage::on_m_font_pb_clicked()
{
bool ok;
@@ -317,9 +317,9 @@ void GeneralConfigurationPage::on_m_font_pb_clicked()
}
/**
* @brief GeneralConfigurationPage::m_dyn_text_font_pb_clicked
* Apply font to config
*/
@brief GeneralConfigurationPage::m_dyn_text_font_pb_clicked
Apply font to config
*/
void GeneralConfigurationPage::on_m_dyn_text_font_pb_clicked()
{
bool ok;

14
sources/ui/configsaveloaderwidget.h
View File

@@ -25,13 +25,13 @@ class ConfigSaveLoaderWidget;
}
/**
* @brief The ConfigSaveLoaderWidget class
* This group box provide 4 widget:
* A combo box with the available config.
* A push button to load the selected config of combo box
* A line edit to edit the text of the config to save
* A push button to save the config
*/
@brief The ConfigSaveLoaderWidget class
This group box provide 4 widget:
A combo box with the available config.
A push button to load the selected config of combo box
A line edit to edit the text of the config to save
A push button to save the config
*/
class ConfigSaveLoaderWidget : public QGroupBox
{
Q_OBJECT

48
sources/ui/diagramcontextwidget.cpp
View File

@@ -32,9 +32,9 @@ DiagramContextWidget::~DiagramContextWidget()
}
/**
* @brief DiagramContextWidget::context
* @return The diagram context object edited by this widget
*/
@brief DiagramContextWidget::context
@return The diagram context object edited by this widget
*/
DiagramContext DiagramContextWidget::context() const
{
DiagramContext context;
@@ -60,10 +60,10 @@ DiagramContext DiagramContextWidget::context() const
}
/**
* @brief DiagramContextWidget::setContext
* Load the content from @context into this widget
* @param context
*/
@brief DiagramContextWidget::setContext
Load the content from @context into this widget
@param context
*/
void DiagramContextWidget::setContext (const DiagramContext &context)
{
clear();
@@ -80,9 +80,9 @@ void DiagramContextWidget::setContext (const DiagramContext &context)
}
/**
* @brief DiagramContextWidget::nameLessRowsCount
* @return The count of name-less rows in the table
*/
@brief DiagramContextWidget::nameLessRowsCount
@return The count of name-less rows in the table
*/
int DiagramContextWidget::nameLessRowsCount() const
{
int name_less_rows_count = 0;
@@ -98,9 +98,9 @@ int DiagramContextWidget::nameLessRowsCount() const
}
/**
* @brief DiagramContextWidget::clear
* Clear any values entered within this widget
*/
@brief DiagramContextWidget::clear
Clear any values entered within this widget
*/
void DiagramContextWidget::clear()
{
ui->m_table->clearContents();
@@ -112,10 +112,10 @@ void DiagramContextWidget::clear()
}
/**
* @brief DiagramContextWidget::highlightNonAcceptableKeys
* Highlight keys that would not be accepted by a DiagramContext object.
* @return the number of highlighted keys.
*/
@brief DiagramContextWidget::highlightNonAcceptableKeys
Highlight keys that would not be accepted by a DiagramContext object.
@return the number of highlighted keys.
*/
int DiagramContextWidget::highlightNonAcceptableKeys()
{
static QRegExp re(DiagramContext::validKeyRegExp());
@@ -146,10 +146,10 @@ int DiagramContextWidget::highlightNonAcceptableKeys()
}
/**
* @brief DiagramContextWidget::refreshFormatLabel
* Sets the text describing the acceptable format for keys when adding extra
* key/value pairs.
*/
@brief DiagramContextWidget::refreshFormatLabel
Sets the text describing the acceptable format for keys when adding extra
key/value pairs.
*/
void DiagramContextWidget::refreshFormatLabel()
{
QString format_text = tr(
@@ -164,9 +164,9 @@ void DiagramContextWidget::refreshFormatLabel()
}
/**
* @brief DiagramContextWidget::checkTableRows
* Adds a row in the additional fields table if needed
*/
@brief DiagramContextWidget::checkTableRows
Adds a row in the additional fields table if needed
*/
void DiagramContextWidget::checkTableRows()
{
refreshFormatLabel();

32
sources/ui/diagrampropertiesdialog.cpp
View File

@@ -25,11 +25,11 @@
#include "changetitleblockcommand.h"
/**
* @brief DiagramPropertiesDialog::DiagramPropertiesDialog
* Deafult constructor
* @param diagram : diagram to edit properties
* @param parent : parent widget
*/
@brief DiagramPropertiesDialog::DiagramPropertiesDialog
Deafult constructor
@param diagram : diagram to edit properties
@param parent : parent widget
*/
DiagramPropertiesDialog::DiagramPropertiesDialog(Diagram *diagram, QWidget *parent) :
QDialog (parent),
m_diagram (diagram)
@@ -121,19 +121,19 @@ DiagramPropertiesDialog::DiagramPropertiesDialog(Diagram *diagram, QWidget *pare
}
/**
* @brief DiagramPropertiesDialog::diagramPropertiesDialog
* Static method to get a DiagramPropertiesDialog.
* @param diagram : diagram to edit properties
* @param parent : parent widget
*/
@brief DiagramPropertiesDialog::diagramPropertiesDialog
Static method to get a DiagramPropertiesDialog.
@param diagram : diagram to edit properties
@param parent : parent widget
*/
void DiagramPropertiesDialog::diagramPropertiesDialog(Diagram *diagram, QWidget *parent) {
DiagramPropertiesDialog dialog(diagram, parent);
}
/**
* @brief DiagramPropertiesDialog::editAutonum
* Open conductor autonum editor
*/
@brief DiagramPropertiesDialog::editAutonum
Open conductor autonum editor
*/
void DiagramPropertiesDialog::editAutonum()
{
ProjectPropertiesDialog ppd (m_diagram->project(), this);
@@ -144,9 +144,9 @@ void DiagramPropertiesDialog::editAutonum()
}
/**
* @brief DiagramPropertiesDialog::editAutonum
* Open folio autonum editor
*/
@brief DiagramPropertiesDialog::editAutonum
Open folio autonum editor
*/
void DiagramPropertiesDialog::editAutoFolioNum () {
ProjectPropertiesDialog ppd (m_diagram->project(), this);
ppd.setCurrentPage(ProjectPropertiesDialog::Autonum);

6
sources/ui/diagrampropertiesdialog.h
View File

@@ -24,9 +24,9 @@ class Diagram;
class ConductorPropertiesWidget;
/**
* @brief The DiagramPropertiesDialog class
* This dialog open a windows for edit properties of a diagram.
*/
@brief The DiagramPropertiesDialog class
This dialog open a windows for edit properties of a diagram.
*/
class DiagramPropertiesDialog : public QDialog {
Q_OBJECT

36
sources/ui/diagrampropertieseditordockwidget.cpp
View File

@@ -21,10 +21,10 @@
#include "propertieseditorfactory.h"
/**
* @brief DiagramPropertiesEditorDockWidget::DiagramPropertiesEditorDockWidget
* Constructor
* @param parent : parent widget
*/
@brief DiagramPropertiesEditorDockWidget::DiagramPropertiesEditorDockWidget
Constructor
@param parent : parent widget
*/
DiagramPropertiesEditorDockWidget::DiagramPropertiesEditorDockWidget(QWidget *parent) :
PropertiesEditorDockWidget(parent),
m_diagram(nullptr),
@@ -32,13 +32,13 @@ DiagramPropertiesEditorDockWidget::DiagramPropertiesEditorDockWidget(QWidget *pa
{}
/**
* @brief DiagramPropertiesEditorDockWidget::setDiagram
* Set the diagram to edit the selection.
* Connect the diagram signal selectionChanged() to this slot selectionChanged();
* If diagram = nullptr, we just disconnect all signal and remove editor.
* @param diagram
* @param diagram
*/
@brief DiagramPropertiesEditorDockWidget::setDiagram
Set the diagram to edit the selection.
Connect the diagram signal selectionChanged() to this slot selectionChanged();
If diagram = nullptr, we just disconnect all signal and remove editor.
@param diagram
@param diagram
*/
void DiagramPropertiesEditorDockWidget::setDiagram(Diagram *diagram)
{
if (m_diagram == diagram) return;
@@ -65,10 +65,10 @@ void DiagramPropertiesEditorDockWidget::setDiagram(Diagram *diagram)
}
/**
* @brief DiagramPropertiesEditorDockWidget::selectionChanged
* The current selection of diagram was changed.
* We fill the dock with the appropriate ElementPropertiesWidget of the current selection.
*/
@brief DiagramPropertiesEditorDockWidget::selectionChanged
The current selection of diagram was changed.
We fill the dock with the appropriate ElementPropertiesWidget of the current selection.
*/
void DiagramPropertiesEditorDockWidget::selectionChanged()
{
if (!m_diagram) {
@@ -92,9 +92,9 @@ void DiagramPropertiesEditorDockWidget::selectionChanged()
}
/**
* @brief DiagramPropertiesEditorDockWidget::diagramWasDeleted
* Remove current editor and set m_diagram to nullptr.
*/
@brief DiagramPropertiesEditorDockWidget::diagramWasDeleted
Remove current editor and set m_diagram to nullptr.
*/
void DiagramPropertiesEditorDockWidget::diagramWasDeleted()
{
m_diagram = nullptr;

16
sources/ui/diagramselection.cpp
View File

@@ -38,8 +38,8 @@ diagramselection::~diagramselection() {
}
/**
* @brief load all Diagrams of project in table
*/
@brief load all Diagrams of project in table
*/
void diagramselection::load_TableDiagram() {
// Clear all items
ui -> tableDiagram -> clear();
@@ -80,9 +80,9 @@ void diagramselection::load_TableDiagram() {
}
/**
* @brief get list of Diagrams is selected
* @return this list of Diagrams
*/
@brief get list of Diagrams is selected
@return this list of Diagrams
*/
QList<Diagram *> diagramselection::list_of_DiagramSelected() {
QList<Diagram *> listDiag;
for(int i=0; i<ui -> tableDiagram -> rowCount();i++){
@@ -94,9 +94,9 @@ QList<Diagram *> diagramselection::list_of_DiagramSelected() {
}
/**
* @brief contextMenuRequested
* @param pos
*/
@brief contextMenuRequested
@param pos
*/
void diagramselection::on_tableDiagram_customContextMenuRequested(const QPoint &pos){
QMenu menu(this);
QAction *desl = menu.addAction( tr("Désélectionner tout") );

46
sources/ui/dialogwaiting.cpp
View File

@@ -23,9 +23,9 @@
DialogWaiting *DialogWaiting::m_static_dialog = nullptr;
/**
* @brief DialogWaiting::DialogWaiting
* @param parent
*/
@brief DialogWaiting::DialogWaiting
@param parent
*/
DialogWaiting::DialogWaiting(QWidget *parent) :
QDialog(parent),
ui(new Ui::DialogWaiting)
@@ -36,58 +36,58 @@ DialogWaiting::DialogWaiting(QWidget *parent) :
}
/**
* @brief DialogWaiting::~DialogWaiting
*/
@brief DialogWaiting::~DialogWaiting
*/
DialogWaiting::~DialogWaiting() {
delete ui;
}
/**
* @brief DialogWaiting::setProgressBar
* @param val is the progressBar value
*/
@brief DialogWaiting::setProgressBar
@param val is the progressBar value
*/
void DialogWaiting::setProgressBar(int val){
ui->progressBar->setValue(val);
qApp->processEvents();
}
/**
* @brief DialogWaiting::setProgressReset, clear progressBar and reset
*/
@brief DialogWaiting::setProgressReset, clear progressBar and reset
*/
void DialogWaiting::setProgressReset(){
ui->progressBar->reset();
}
/**
* @brief DialogWaiting::setProgressBarRange
* @param min is the minimum of progressBar
* @param max is the maximun of progressBar
*/
@brief DialogWaiting::setProgressBarRange
@param min is the minimum of progressBar
@param max is the maximun of progressBar
*/
void DialogWaiting::setProgressBarRange(int min, int max){
ui->progressBar->setRange(min,max);
ui->progressBar->setFormat(QObject::tr("%p% effectué (%v sur %m)"));
}
/**
* @brief DialogWaiting::setTitle of action
* @param val is the string of action
*/
@brief DialogWaiting::setTitle of action
@param val is the string of action
*/
void DialogWaiting::setTitle(const QString& val){
ui->labelTitle->setText(val);
}
/**
* @brief DialogWaiting::setDetail of action
* @param val is the string of detail action
*/
@brief DialogWaiting::setDetail of action
@param val is the string of detail action
*/
void DialogWaiting::setDetail(const QString& val){
ui->label_detail->setText(val);
}
/**
* @brief DialogWaiting::progressBarValue
* @return The current vcalue of the progress bar
*/
@brief DialogWaiting::progressBarValue
@return The current vcalue of the progress bar
*/
int DialogWaiting::progressBarValue() const
{
return ui->progressBar->value();

34
sources/ui/dynamicelementtextitemeditor.cpp
View File

@@ -135,10 +135,10 @@ void DynamicElementTextItemEditor::apply()
}
/**
* @brief DynamicElementTextItemEditor::setCurrentText
* Expand and select the item for text @text
* @param text
*/
@brief DynamicElementTextItemEditor::setCurrentText
Expand and select the item for text @text
@param text
*/
void DynamicElementTextItemEditor::setCurrentText(DynamicElementTextItem *text)
{
QModelIndex index = m_model->indexFromText(text);
@@ -152,10 +152,10 @@ void DynamicElementTextItemEditor::setCurrentText(DynamicElementTextItem *text)
}
/**
* @brief DynamicElementTextItemEditor::setCurrentGroup
* Expand and select the item for group @group
* @param group
*/
@brief DynamicElementTextItemEditor::setCurrentGroup
Expand and select the item for group @group
@param group
*/
void DynamicElementTextItemEditor::setCurrentGroup(ElementTextItemGroup *group)
{
QModelIndex index = m_model->indexFromGroup(group);
@@ -193,9 +193,9 @@ void DynamicElementTextItemEditor::dataEdited()
}
/**
* @brief DynamicElementTextItemEditor::on_m_add_text_clicked
* Add a new dynamic text
*/
@brief DynamicElementTextItemEditor::on_m_add_text_clicked
Add a new dynamic text
*/
void DynamicElementTextItemEditor::on_m_add_text_clicked()
{
if (!m_element)
@@ -214,9 +214,9 @@ void DynamicElementTextItemEditor::on_m_add_text_clicked()
}
/**
* @brief DynamicElementTextItemEditor::on_m_remove_selection_clicked
* Remove the selected item
*/
@brief DynamicElementTextItemEditor::on_m_remove_selection_clicked
Remove the selected item
*/
void DynamicElementTextItemEditor::on_m_remove_selection_clicked()
{
DynamicElementTextItem *deti = m_model->textFromIndex(ui->m_tree_view->currentIndex());
@@ -236,9 +236,9 @@ void DynamicElementTextItemEditor::on_m_remove_selection_clicked()
}
/**
* @brief DynamicElementTextItemEditor::on_m_add_group_clicked
* Add a new group
*/
@brief DynamicElementTextItemEditor::on_m_add_group_clicked
Add a new group
*/
void DynamicElementTextItemEditor::on_m_add_group_clicked()
{
QString name = QInputDialog::getText(this, tr("Nom du groupe"), tr("Entrer le nom du nouveau groupe"));

22
sources/ui/dynamicelementtextitemeditor.h
View File

@@ -31,14 +31,16 @@ namespace Ui {
class DynamicElementTextItemEditor : public AbstractElementPropertiesEditorWidget
{
Q_OBJECT
Q_OBJECT
public:
explicit DynamicElementTextItemEditor(Element *element, QWidget *parent = nullptr);
explicit DynamicElementTextItemEditor(
Element *element,
QWidget *parent = nullptr);
~DynamicElementTextItemEditor() override;
void setElement(Element *element) override;
QString title() const override {return tr("Textes");}
QString title() const override {return tr("Textes");}
bool setLiveEdit(bool live_edit) override;
void apply() override;
void setCurrentText(DynamicElementTextItem *text);
@@ -47,18 +49,18 @@ class DynamicElementTextItemEditor : public AbstractElementPropertiesEditorWidge
private:
void dataEdited();
private slots:
void on_m_add_text_clicked();
void on_m_remove_selection_clicked();
private slots:
void on_m_add_text_clicked();
void on_m_remove_selection_clicked();
void on_m_add_group_clicked();
void on_m_tree_view_clicked(const QModelIndex &index);
void on_m_export_pb_clicked();
void on_m_import_pb_clicked();
private:
private:
Ui::DynamicElementTextItemEditor *ui;
DynamicElementTextModel *m_model = nullptr;
DynamicElementTextModel *m_model = nullptr;
};
#endif // DYNAMICELEMENTTEXTITEMEDITOR_H

240
sources/ui/dynamicelementtextmodel.cpp
View File

@@ -92,10 +92,10 @@ DynamicElementTextModel::~DynamicElementTextModel()
}
/**
* @brief DynamicElementTextModel::indexIsInGroup
* @param index
* @return True if the index represent a group or an item in a group
*/
@brief DynamicElementTextModel::indexIsInGroup
@param index
@return True if the index represent a group or an item in a group
*/
bool DynamicElementTextModel::indexIsInGroup(const QModelIndex &index) const
{
QStandardItem *item = itemFromIndex(index);
@@ -113,12 +113,12 @@ bool DynamicElementTextModel::indexIsInGroup(const QModelIndex &index) const
}
/**
* @brief DynamicElementTextModel::itemsForText
* @param deti
* @return The items for the text @deti, if the text @deti is already managed by this model
* the returned list is empty
* The returned items haven't got the same number of childs if the text is in a group or not.
*/
@brief DynamicElementTextModel::itemsForText
@param deti
@return The items for the text @deti, if the text @deti is already managed by this model
the returned list is empty
The returned items haven't got the same number of childs if the text is in a group or not.
*/
QList<QStandardItem *> DynamicElementTextModel::itemsForText(DynamicElementTextItem *deti)
{
QList <QStandardItem *> qsi_list;
@@ -328,18 +328,18 @@ QList<QStandardItem *> DynamicElementTextModel::itemsForText(DynamicElementTextI
}
/**
* @brief DynamicElementTextModel::addText
* @param deti
*/
@brief DynamicElementTextModel::addText
@param deti
*/
void DynamicElementTextModel::addText(DynamicElementTextItem *deti)
{
this->appendRow(itemsForText(deti));
}
/**
* @brief DynamicElementTextModel::removeText
* @param deti
*/
@brief DynamicElementTextModel::removeText
@param deti
*/
void DynamicElementTextModel::removeText(DynamicElementTextItem *deti)
{
if (!m_texts_list.contains(deti))
@@ -352,11 +352,11 @@ void DynamicElementTextModel::removeText(DynamicElementTextItem *deti)
}
/**
* @brief DynamicElementTextModel::textFromIndex
* @param index
* @return the text associated with @index. Returned value can be nullptr
* @Index can be a child of an index associated with a text and can be the column 0 or 1.
*/
@brief DynamicElementTextModel::textFromIndex
@param index
@return the text associated with @index. Returned value can be nullptr
@Index can be a child of an index associated with a text and can be the column 0 or 1.
*/
DynamicElementTextItem *DynamicElementTextModel::textFromIndex(const QModelIndex &index) const
{
if(!index.isValid())
@@ -369,12 +369,12 @@ DynamicElementTextItem *DynamicElementTextModel::textFromIndex(const QModelIndex
}
/**
* @brief DynamicElementTextModel::textFromItem
* @param item
* @return the text associated with @item. Return value can be nullptr
* @item can be a child of an item associated with a text and can be the column 0 or 1.
* Note can return nullptr
*/
@brief DynamicElementTextModel::textFromItem
@param item
@return the text associated with @item. Return value can be nullptr
@item can be a child of an item associated with a text and can be the column 0 or 1.
Note can return nullptr
*/
DynamicElementTextItem *DynamicElementTextModel::textFromItem(QStandardItem *item) const
{
//Get the item of the column 0
@@ -424,10 +424,10 @@ DynamicElementTextItem *DynamicElementTextModel::textFromItem(QStandardItem *ite
}
/**
* @brief DynamicElementTextModel::indexFromText
* @param text
* @return the QModelIndex for @text, or a default QModelIndex if not match
*/
@brief DynamicElementTextModel::indexFromText
@param text
@return the QModelIndex for @text, or a default QModelIndex if not match
*/
QModelIndex DynamicElementTextModel::indexFromText(DynamicElementTextItem *text) const
{
if(m_texts_list.contains(text))
@@ -437,12 +437,12 @@ QModelIndex DynamicElementTextModel::indexFromText(DynamicElementTextItem *text)
}
/**
* @brief DynamicElementTextModel::undoForEditedText
* @param deti
* @return A QUndoCommand that describe all changes made for @deti.
* Each change made for @deti is append as a child of the returned QUndoCommand.
* In other word, if the returned QUndoCommand have no child, that mean there is no change.
*/
@brief DynamicElementTextModel::undoForEditedText
@param deti
@return A QUndoCommand that describe all changes made for @deti.
Each change made for @deti is append as a child of the returned QUndoCommand.
In other word, if the returned QUndoCommand have no child, that mean there is no change.
*/
QUndoCommand *DynamicElementTextModel::undoForEditedText(DynamicElementTextItem *deti, QUndoCommand *parent_undo) const
{
@@ -562,13 +562,13 @@ QUndoCommand *DynamicElementTextModel::undoForEditedText(DynamicElementTextItem
}
/**
* @brief DynamicElementTextModel::undoForEditedGroup
* @param group
* @param parent_undo
* @return A QUndoCommand that describe all changes made for @group.
* Each change made for @group is append as a child of the returned QUndoCommand.
* In other word, if the returned QUndoCommand have no child, that mean there is no change.
*/
@brief DynamicElementTextModel::undoForEditedGroup
@param group
@param parent_undo
@return A QUndoCommand that describe all changes made for @group.
Each change made for @group is append as a child of the returned QUndoCommand.
In other word, if the returned QUndoCommand have no child, that mean there is no change.
*/
QUndoCommand *DynamicElementTextModel::undoForEditedGroup(ElementTextItemGroup *group, QUndoCommand *parent_undo) const
{
QUndoCommand *undo = nullptr;
@@ -629,10 +629,10 @@ QUndoCommand *DynamicElementTextModel::undoForEditedGroup(ElementTextItemGroup *
}
/**
* @brief DynamicElementTextModel::AddGroup
* Add a text item group to this model
* @param group
*/
@brief DynamicElementTextModel::AddGroup
Add a text item group to this model
@param group
*/
void DynamicElementTextModel::addGroup(ElementTextItemGroup *group)
{
if(m_groups_list.keys().contains(group))
@@ -759,10 +759,10 @@ void DynamicElementTextModel::addGroup(ElementTextItemGroup *group)
}
/**
* @brief DynamicElementTextModel::removeGroup
* Remove the text item group from this model
* @param group
*/
@brief DynamicElementTextModel::removeGroup
Remove the text item group from this model
@param group
*/
void DynamicElementTextModel::removeGroup(ElementTextItemGroup *group)
{
if(m_groups_list.keys().contains(group))
@@ -775,11 +775,11 @@ void DynamicElementTextModel::removeGroup(ElementTextItemGroup *group)
}
/**
* @brief DynamicElementTextModel::textAddedToGroup
* Add the text @text to the group @group
* @param deti
* @param group
*/
@brief DynamicElementTextModel::textAddedToGroup
Add the text @text to the group @group
@param deti
@param group
*/
void DynamicElementTextModel::addTextToGroup(DynamicElementTextItem *deti, ElementTextItemGroup *group)
{
QStandardItem *group_item = m_groups_list.value(group);
@@ -800,11 +800,11 @@ void DynamicElementTextModel::removeTextFromGroup(DynamicElementTextItem *deti,
}
/**
* @brief DynamicElementTextModel::groupFromIndex
* @param index
* @return the group associated with @index. Return value can be nullptr
* @Index can be a child of an index associated with a group and can be the column 0 or 1.
*/
@brief DynamicElementTextModel::groupFromIndex
@param index
@return the group associated with @index. Return value can be nullptr
@Index can be a child of an index associated with a group and can be the column 0 or 1.
*/
ElementTextItemGroup *DynamicElementTextModel::groupFromIndex(const QModelIndex &index) const
{
if(!index.isValid())
@@ -817,11 +817,11 @@ ElementTextItemGroup *DynamicElementTextModel::groupFromIndex(const QModelIndex
}
/**
* @brief DynamicElementTextModel::groupFromItem
* @param item
* @return the group associated with @item. Return value can be nullptr
* @item can be a child of an item associated with a group and can be the column 0 or 1.
*/
@brief DynamicElementTextModel::groupFromItem
@param item
@return the group associated with @item. Return value can be nullptr
@item can be a child of an item associated with a group and can be the column 0 or 1.
*/
ElementTextItemGroup *DynamicElementTextModel::groupFromItem(QStandardItem *item) const
{
//Get the item of the column 0
@@ -843,11 +843,11 @@ ElementTextItemGroup *DynamicElementTextModel::groupFromItem(QStandardItem *item
}
/**
* @brief DynamicElementTextModel::indexFromGroup
* @param group
* @return The index associated to the group @group
* or a default QModelIndex if not match
*/
@brief DynamicElementTextModel::indexFromGroup
@param group
@return The index associated to the group @group
or a default QModelIndex if not match
*/
QModelIndex DynamicElementTextModel::indexFromGroup(ElementTextItemGroup *group) const
{
if(m_groups_list.keys().contains(group))
@@ -857,11 +857,11 @@ QModelIndex DynamicElementTextModel::indexFromGroup(ElementTextItemGroup *group)
}
/**
* @brief DynamicElementTextModel::indexIsText
* @param index
* @return True if @index represente a text, both for the column 0 and 1.
* Return false if @index is a child of an index associated to a text.
*/
@brief DynamicElementTextModel::indexIsText
@param index
@return True if @index represente a text, both for the column 0 and 1.
Return false if @index is a child of an index associated to a text.
*/
bool DynamicElementTextModel::indexIsText(const QModelIndex &index) const
{
QStandardItem *item = nullptr;
@@ -884,11 +884,11 @@ bool DynamicElementTextModel::indexIsText(const QModelIndex &index) const
}
/**
* @brief DynamicElementTextModel::indexIsGroup
* @param index
* @return True if @index represente a group, both for the column 0 and 1.
* Return false if @index is a child of an index associated to a group.
*/
@brief DynamicElementTextModel::indexIsGroup
@param index
@return True if @index represente a group, both for the column 0 and 1.
Return false if @index is a child of an index associated to a group.
*/
bool DynamicElementTextModel::indexIsGroup(const QModelIndex &index) const
{
QStandardItem *item = nullptr;
@@ -957,14 +957,14 @@ bool DynamicElementTextModel::canDropMimeData(const QMimeData *data, Qt::DropAct
}
/**
* @brief DynamicElementTextModel::dropMimeData
* @param data
* @param action
* @param row
* @param column
* @param parent
* @return In any case return false, for overwrite the default behavior of model.
*/
@brief DynamicElementTextModel::dropMimeData
@param data
@param action
@param row
@param column
@param parent
@return In any case return false, for overwrite the default behavior of model.
*/
bool DynamicElementTextModel::dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
{
Q_UNUSED(action)
@@ -1081,9 +1081,9 @@ QMimeData *DynamicElementTextModel::mimeData(const QModelIndexList &indexes) con
}
/**
* @brief DynamicElementTextModel::mimeTypes
* @return
*/
@brief DynamicElementTextModel::mimeTypes
@return
*/
QStringList DynamicElementTextModel::mimeTypes() const
{
QStringList mime_list = QAbstractItemModel::mimeTypes();
@@ -1092,11 +1092,11 @@ QStringList DynamicElementTextModel::mimeTypes() const
}
/**
* @brief DynamicElementTextModel::enableSourceText
* Enable the good field, according to the current source of text, for the edited text @deti
* @param deti
* @param tf
*/
@brief DynamicElementTextModel::enableSourceText
Enable the good field, according to the current source of text, for the edited text @deti
@param deti
@param tf
*/
void DynamicElementTextModel::enableSourceText(DynamicElementTextItem *deti, DynamicElementTextItem::TextFrom tf)
{
if (!m_texts_list.contains(deti))
@@ -1124,10 +1124,10 @@ void DynamicElementTextModel::enableSourceText(DynamicElementTextItem *deti, Dyn
}
/**
* @brief DynamicElementTextModel::enableGroupRotation
* Enable/disable the item "group rotation" according the option hold to bottom
* @param group
*/
@brief DynamicElementTextModel::enableGroupRotation
Enable/disable the item "group rotation" according the option hold to bottom
@param group
*/
void DynamicElementTextModel::enableGroupRotationAndPos(ElementTextItemGroup *group)
{
if(!m_groups_list.contains(group))
@@ -1218,12 +1218,12 @@ void DynamicElementTextModel::itemDataChanged(QStandardItem *qsi)
}
/**
* @brief DynamicElementTextModel::setConnection
* Set up the connection for @deti to keep up to date the data of this model and the text.
* Is notably use with the use of QUndoCommand.
* @param deti - text to setup connection
* @param set - true = set connection - false unset connection
*/
@brief DynamicElementTextModel::setConnection
Set up the connection for @deti to keep up to date the data of this model and the text.
Is notably use with the use of QUndoCommand.
@param deti - text to setup connection
@param set - true = set connection - false unset connection
*/
void DynamicElementTextModel::setConnection(DynamicElementTextItem *deti, bool set)
{
if(set)
@@ -1258,12 +1258,12 @@ void DynamicElementTextModel::setConnection(DynamicElementTextItem *deti, bool s
}
/**
* @brief DynamicElementTextModel::setConnection
* Set up the connection for @group to keep up to date the data of this model and the group.
* Is notably use with the use of QUndoCommand.
* @param group group to setup the connection
* @param set true = set connection - false unset connection
*/
@brief DynamicElementTextModel::setConnection
Set up the connection for @group to keep up to date the data of this model and the group.
Is notably use with the use of QUndoCommand.
@param group group to setup the connection
@param set true = set connection - false unset connection
*/
void DynamicElementTextModel::setConnection(ElementTextItemGroup *group, bool set)
{
if(set)
@@ -1440,8 +1440,8 @@ void DynamicElementTextModel::updateDataFromGroup(ElementTextItemGroup *group, D
/***************************************************
* A little delegate only for add a combobox and a color dialog,
* for use with the model
A little delegate only for add a combobox and a color dialog,
for use with the model
***************************************************/
DynamicTextItemDelegate::DynamicTextItemDelegate(QObject *parent) :
@@ -1763,10 +1763,10 @@ bool DynamicTextItemDelegate::eventFilter(QObject *object, QEvent *event)
}
/**
* @brief DynamicTextItemDelegate::availableInfo
* @param deti
* @return A list of available info of element
*/
@brief DynamicTextItemDelegate::availableInfo
@param deti
@return A list of available info of element
*/
QStringList DynamicTextItemDelegate::availableInfo(DynamicElementTextItem *deti) const
{
QStringList qstrl;

10
sources/ui/dynamicelementtextmodel.h
View File

@@ -27,11 +27,11 @@ class ElementTextItemGroup;
class Element;
/**
* @brief The DynamicElementTextModel class
* A model to use with QtView.
* This model display and can edit the value of dynamic text of an element.
* Set the delegate DynamicTextItemDelegate as delegate of this model.
*/
@brief The DynamicElementTextModel class
A model to use with QtView.
This model display and can edit the value of dynamic text of an element.
Set the delegate DynamicTextItemDelegate as delegate of this model.
*/
class DynamicElementTextModel : public QStandardItemModel
{
Q_OBJECT

78
sources/ui/elementinfopartwidget.cpp
View File

@@ -24,12 +24,12 @@
typedef SearchAndReplaceWorker sarw;
/**
* @brief ElementInfoPartWidget::ElementInfoPartWidget
* Constructor
* @param key the string key what represent this info part
* @param translated_key the string key translated
* @param parent parent widget
*/
@brief ElementInfoPartWidget::ElementInfoPartWidget
Constructor
@param key the string key what represent this info part
@param translated_key the string key translated
@param parent parent widget
*/
ElementInfoPartWidget::ElementInfoPartWidget(QString key, const QString& translated_key, QWidget *parent):
QWidget(parent),
ui(new Ui::ElementInfoPartWidget),
@@ -44,19 +44,19 @@ ElementInfoPartWidget::ElementInfoPartWidget(QString key, const QString& transla
}
/**
* @brief ElementInfoPartWidget::~ElementInfoPartWidget
* destructor
*/
@brief ElementInfoPartWidget::~ElementInfoPartWidget
destructor
*/
ElementInfoPartWidget::~ElementInfoPartWidget()
{
delete ui;
}
/**
* @brief ElementInfoPartWidget::setText
* Set text to line edit
* @param txt
*/
@brief ElementInfoPartWidget::setText
Set text to line edit
@param txt
*/
void ElementInfoPartWidget::setText(const QString &txt)
{
if (m_show_erase) {
@@ -67,68 +67,68 @@ void ElementInfoPartWidget::setText(const QString &txt)
}
/**
* @brief ElementInfoPartWidget::text
* @return the text in the line edit
*/
@brief ElementInfoPartWidget::text
@return the text in the line edit
*/
QString ElementInfoPartWidget::text() const {
return (ui->line_edit->text());
}
/**
* @brief ElementInfoPartWidget::setPlaceHolderText
* @param text
*/
@brief ElementInfoPartWidget::setPlaceHolderText
@param text
*/
void ElementInfoPartWidget::setPlaceHolderText(const QString &text) {
ui->line_edit->setPlaceholderText(text);
}
/**
* @brief ElementInfoPartWidget::setFocusTolineEdit
* Set the focus to the line edit
*/
@brief ElementInfoPartWidget::setFocusTolineEdit
Set the focus to the line edit
*/
void ElementInfoPartWidget::setFocusTolineEdit() {
ui->line_edit->setFocus();
}
/**
* @brief ElementInfoPartWidget::setEnabled
* enable the line edit
* @param e
*/
@brief ElementInfoPartWidget::setEnabled
enable the line edit
@param e
*/
void ElementInfoPartWidget::setEnabled(bool e) {
ui->line_edit->setEnabled(e);
}
/**
* @brief ElementInfoPartWidget::setDisabled
* disable the line edit
* @param d
*/
@brief ElementInfoPartWidget::setDisabled
disable the line edit
@param d
*/
void ElementInfoPartWidget::setDisabled(bool d) {
ui->line_edit->setDisabled(d);
}
/**
* @brief ElementInfoPartWidget::setEraseTextVisible
* @param visible
*/
@brief ElementInfoPartWidget::setEraseTextVisible
@param visible
*/
void ElementInfoPartWidget::setEraseTextVisible(bool visible) {
ui->m_erase_text->setVisible(visible);
m_show_erase = visible;
}
/**
* @brief ElementInfoPartWidget::setEraseTextChecked
* @param check
*/
@brief ElementInfoPartWidget::setEraseTextChecked
@param check
*/
void ElementInfoPartWidget::setEraseTextChecked(bool check) {
ui->m_erase_text->setChecked(check);
}
/**
* @brief ElementInfoPartWidget::EraseTextCheckState
* @return
*/
@brief ElementInfoPartWidget::EraseTextCheckState
@return
*/
Qt::CheckState ElementInfoPartWidget::EraseTextCheckState() const {
return ui->m_erase_text->checkState();
}

120
sources/ui/elementinfowidget.cpp
View File

@@ -24,11 +24,11 @@
#include "element.h"
/**
* @brief ElementInfoWidget::ElementInfoWidget
* Constructor
* @param elmt element to edit information
* @param parent parent widget
*/
@brief ElementInfoWidget::ElementInfoWidget
Constructor
@param elmt element to edit information
@param parent parent widget
*/
ElementInfoWidget::ElementInfoWidget(Element *elmt, QWidget *parent) :
AbstractElementPropertiesEditorWidget(parent),
ui(new Ui::ElementInfoWidget),
@@ -40,9 +40,9 @@ ElementInfoWidget::ElementInfoWidget(Element *elmt, QWidget *parent) :
}
/**
* @brief ElementInfoWidget::~ElementInfoWidget
* Destructor
*/
@brief ElementInfoWidget::~ElementInfoWidget
Destructor
*/
ElementInfoWidget::~ElementInfoWidget()
{
qDeleteAll(m_eipw_list);
@@ -50,10 +50,10 @@ ElementInfoWidget::~ElementInfoWidget()
}
/**
* @brief ElementInfoWidget::setElement
* Set @element to be the edited element
* @param element
*/
@brief ElementInfoWidget::setElement
Set @element to be the edited element
@param element
*/
void ElementInfoWidget::setElement(Element *element)
{
if (m_element == element) return;
@@ -84,10 +84,10 @@ void ElementInfoWidget::setElement(Element *element)
}
/**
* @brief ElementInfoWidget::apply
* Apply the new information with a new undo command (got with method associatedUndo)
* pushed to the stack of element project.
*/
@brief ElementInfoWidget::apply
Apply the new information with a new undo command (got with method associatedUndo)
pushed to the stack of element project.
*/
void ElementInfoWidget::apply()
{
if (QUndoCommand *undo = associatedUndo())
@@ -95,12 +95,12 @@ void ElementInfoWidget::apply()
}
/**
* @brief ElementInfoWidget::associatedUndo
* If the edited info is different of the actual element info,
* return a QUndoCommand with the change.
* If no change return nullptr;
* @return
*/
@brief ElementInfoWidget::associatedUndo
If the edited info is different of the actual element info,
return a QUndoCommand with the change.
If no change return nullptr;
@return
*/
QUndoCommand* ElementInfoWidget::associatedUndo() const
{
DiagramContext new_info = currentInfo();
@@ -113,10 +113,10 @@ QUndoCommand* ElementInfoWidget::associatedUndo() const
}
/**
* @brief ElementInfoWidget::setLiveEdit
* @param live_edit true : enable the live edit mode, false disable
* @return always true;
*/
@brief ElementInfoWidget::setLiveEdit
@param live_edit true : enable the live edit mode, false disable
@return always true;
*/
bool ElementInfoWidget::setLiveEdit(bool live_edit)
{
if (m_live_edit == live_edit) return true;
@@ -131,13 +131,13 @@ bool ElementInfoWidget::setLiveEdit(bool live_edit)
}
/**
* @brief ElementInfoWidget::event
* Reimplemented from QWidget::event
* Only give focus to the first line edit at first activation.
* After send the event to QWidget.
* @param event
* @return
*/
@brief ElementInfoWidget::event
Reimplemented from QWidget::event
Only give focus to the first line edit at first activation.
After send the event to QWidget.
@param event
@return
*/
bool ElementInfoWidget::event(QEvent *event)
{
if (m_first_activation)
@@ -152,9 +152,9 @@ bool ElementInfoWidget::event(QEvent *event)
}
/**
* @brief ElementInfoWidget::enableLiveEdit
* Enable the live edit mode
*/
@brief ElementInfoWidget::enableLiveEdit
Enable the live edit mode
*/
void ElementInfoWidget::enableLiveEdit()
{
for (ElementInfoPartWidget *eipw : m_eipw_list)
@@ -162,9 +162,9 @@ void ElementInfoWidget::enableLiveEdit()
}
/**
* @brief ElementInfoWidget::disableLiveEdit
* disable the live edit mode
*/
@brief ElementInfoWidget::disableLiveEdit
disable the live edit mode
*/
void ElementInfoWidget::disableLiveEdit()
{
for (ElementInfoPartWidget *eipw : m_eipw_list)
@@ -172,9 +172,9 @@ void ElementInfoWidget::disableLiveEdit()
}
/**
* @brief ElementInfoWidget::buildInterface
* Build the widget
*/
@brief ElementInfoWidget::buildInterface
Build the widget
*/
void ElementInfoWidget::buildInterface()
{
foreach (QString str, QETApp::elementInfoKeys())
@@ -187,10 +187,10 @@ void ElementInfoWidget::buildInterface()
}
/**
* @brief ElementInfoWidget::infoPartWidgetForKey
* @param key
* @return the ElementInfoPartWidget with key @key, if not found return nullptr;
*/
@brief ElementInfoWidget::infoPartWidgetForKey
@param key
@return the ElementInfoPartWidget with key @key, if not found return nullptr;
*/
ElementInfoPartWidget *ElementInfoWidget::infoPartWidgetForKey(const QString &key) const
{
foreach (ElementInfoPartWidget *eipw, m_eipw_list)
@@ -203,10 +203,10 @@ ElementInfoPartWidget *ElementInfoWidget::infoPartWidgetForKey(const QString &ke
}
/**
* @brief ElementInfoWidget::updateUi
* fill information fetch in m_element_info to the
* corresponding line edit
*/
@brief ElementInfoWidget::updateUi
fill information fetch in m_element_info to the
corresponding line edit
*/
void ElementInfoWidget::updateUi()
{
//We disable live edit to avoid wrong undo when we fill the line edit with new text
@@ -224,9 +224,9 @@ void ElementInfoWidget::updateUi()
}
/**
* @brief ElementInfoWidget::currentInfo
* @return the info currently edited
*/
@brief ElementInfoWidget::currentInfo
@return the info currently edited
*/
DiagramContext ElementInfoWidget::currentInfo() const
{
DiagramContext info_;
@@ -249,18 +249,18 @@ DiagramContext ElementInfoWidget::currentInfo() const
}
/**
* @brief ElementInfoWidget::firstActivated
* Slot activated when this widget is show.
* Set the focus to the first line edit provided by this widget
*/
@brief ElementInfoWidget::firstActivated
Slot activated when this widget is show.
Set the focus to the first line edit provided by this widget
*/
void ElementInfoWidget::firstActivated() {
m_eipw_list.first() -> setFocusTolineEdit();
}
/**
* @brief ElementInfoWidget::elementInfoChange
* This slot is called when m_element::elementInformation change.
*/
@brief ElementInfoWidget::elementInfoChange
This slot is called when m_element::elementInformation change.
*/
void ElementInfoWidget::elementInfoChange()
{
if(currentInfo() != m_element->elementInformations())

6
sources/ui/elementinfowidget.h
View File

@@ -32,9 +32,9 @@ namespace Ui {
}
/**
* @brief The ElementInfoWidget class
* this class is a widget to edit an element informations.
*/
@brief The ElementInfoWidget class
this class is a widget to edit an element informations.
*/
class ElementInfoWidget : public AbstractElementPropertiesEditorWidget
{
Q_OBJECT

116
sources/ui/elementpropertieswidget.cpp
View File

@@ -32,11 +32,11 @@
#include <QUndoStack>
/**
* @brief ElementPropertiesWidget::ElementPropertiesWidget
* Default constructor
* @param elmt
* @param parent
*/
@brief ElementPropertiesWidget::ElementPropertiesWidget
Default constructor
@param elmt
@param parent
*/
ElementPropertiesWidget::ElementPropertiesWidget(Element *elmt, QWidget *parent) :
AbstractElementPropertiesEditorWidget (parent),
m_diagram (elmt->diagram()),
@@ -48,13 +48,13 @@ ElementPropertiesWidget::ElementPropertiesWidget(Element *elmt, QWidget *parent)
}
/**
* @brief ElementPropertiesWidget::ElementPropertiesWidget
* Same as default constructor, the edited element, is the parent element of @text.
* The only difference with default constructor, is that the current tab is the tab for dynamic texts,
* and the item in the tree that represent @text is expanded and selected.
* @param text
* @param parent
*/
@brief ElementPropertiesWidget::ElementPropertiesWidget
Same as default constructor, the edited element, is the parent element of @text.
The only difference with default constructor, is that the current tab is the tab for dynamic texts,
and the item in the tree that represent @text is expanded and selected.
@param text
@param parent
*/
ElementPropertiesWidget::ElementPropertiesWidget(DynamicElementTextItem *text, QWidget *parent) :
AbstractElementPropertiesEditorWidget (parent),
m_tab (nullptr),
@@ -69,13 +69,13 @@ ElementPropertiesWidget::ElementPropertiesWidget(DynamicElementTextItem *text, Q
}
/**
* @brief ElementPropertiesWidget::ElementPropertiesWidget
* Same as default constructor, the edited element, is the parent element of @group.
* The only difference with default constructor, is that the current tab is the tab for dynamic texts,
* and the item in the tree that represent @group is expanded and selected.
* @param group
* @param parent
*/
@brief ElementPropertiesWidget::ElementPropertiesWidget
Same as default constructor, the edited element, is the parent element of @group.
The only difference with default constructor, is that the current tab is the tab for dynamic texts,
and the item in the tree that represent @group is expanded and selected.
@param group
@param parent
*/
ElementPropertiesWidget::ElementPropertiesWidget(ElementTextItemGroup *group, QWidget *parent) :
AbstractElementPropertiesEditorWidget (parent),
m_tab (nullptr),
@@ -91,10 +91,10 @@ ElementPropertiesWidget::ElementPropertiesWidget(ElementTextItemGroup *group, QW
}
/**
* @brief ElementPropertiesWidget::setElement
* Set @element to be the edited element
* @param element
*/
@brief ElementPropertiesWidget::setElement
Set @element to be the edited element
@param element
*/
void ElementPropertiesWidget::setElement(Element *element)
{
if (m_element == element) return;
@@ -118,11 +118,11 @@ void ElementPropertiesWidget::setElement(Element *element)
}
/**
* @brief ElementPropertiesWidget::setDynamicText
* convenience function: same as call : ElementPropertiesWidget::setElement, with parameter the parent element of @text.
* Set the dynamics text tab as current tab, expand and select the item that represent @text
* @param text
*/
@brief ElementPropertiesWidget::setDynamicText
convenience function: same as call : ElementPropertiesWidget::setElement, with parameter the parent element of @text.
Set the dynamics text tab as current tab, expand and select the item that represent @text
@param text
*/
void ElementPropertiesWidget::setDynamicText(DynamicElementTextItem *text)
{
if(text->parentElement())
@@ -141,11 +141,11 @@ void ElementPropertiesWidget::setDynamicText(DynamicElementTextItem *text)
}
/**
* @brief ElementPropertiesWidget::setTextsGroup
* Conveniance function : same as call : ElementPropertiesWidget::setElement, with parameter the parent element of @group.
* Set the dynamics text tab as current tab, expand and select the item that represent @group
* @param group
*/
@brief ElementPropertiesWidget::setTextsGroup
Conveniance function : same as call : ElementPropertiesWidget::setElement, with parameter the parent element of @group.
Set the dynamics text tab as current tab, expand and select the item that represent @group
@param group
*/
void ElementPropertiesWidget::setTextsGroup(ElementTextItemGroup *group)
{
if(group->parentItem() && group->parentItem()->type() == Element::Type)
@@ -164,10 +164,10 @@ void ElementPropertiesWidget::setTextsGroup(ElementTextItemGroup *group)
}
/**
* @brief ElementPropertiesWidget::apply
* Apply the new properties by pushing an undo command
* to the parent project's undo stack of element
*/
@brief ElementPropertiesWidget::apply
Apply the new properties by pushing an undo command
to the parent project's undo stack of element
*/
void ElementPropertiesWidget::apply()
{
QList <QUndoCommand *> undo_list;
@@ -191,9 +191,9 @@ void ElementPropertiesWidget::apply()
}
/**
* @brief ElementPropertiesWidget::reset
* Reset the edited properties
*/
@brief ElementPropertiesWidget::reset
Reset the edited properties
*/
void ElementPropertiesWidget::reset() {
foreach (PropertiesEditorWidget *pew, m_list_editor) pew->reset();
}
@@ -210,9 +210,9 @@ bool ElementPropertiesWidget::setLiveEdit(bool live_edit)
}
/**
* @brief ElementPropertiesWidget::findInPanel
* If m_element is a custom element, emit findElementRequired
*/
@brief ElementPropertiesWidget::findInPanel
If m_element is a custom element, emit findElementRequired
*/
void ElementPropertiesWidget::findInPanel()
{
if (m_element && m_diagram)
@@ -223,9 +223,9 @@ void ElementPropertiesWidget::findInPanel()
}
/**
* @brief ElementPropertiesWidget::editElement
* If m_element is a custom element, emit findElementRequired and editElementRequired
*/
@brief ElementPropertiesWidget::editElement
If m_element is a custom element, emit findElementRequired and editElementRequired
*/
void ElementPropertiesWidget::editElement()
{
if (m_element && m_diagram)
@@ -237,9 +237,9 @@ void ElementPropertiesWidget::editElement()
}
/**
* @brief ElementPropertiesWidget::build
* Build the content of this widget
*/
@brief ElementPropertiesWidget::build
Build the content of this widget
*/
void ElementPropertiesWidget::buildGui()
{
m_tab = new QTabWidget(this);
@@ -249,9 +249,9 @@ void ElementPropertiesWidget::buildGui()
}
/**
* @brief ElementPropertiesWidget::updateUi
* Update the content of this widget
*/
@brief ElementPropertiesWidget::updateUi
Update the content of this widget
*/
void ElementPropertiesWidget::updateUi()
{
//We keep the current title of the tab, to return to the same tab
@@ -317,9 +317,9 @@ void ElementPropertiesWidget::updateUi()
}
/**
* @brief ElementPropertiesWidget::addGeneralWidget
* Add or update the general widget on this tab widget
*/
@brief ElementPropertiesWidget::addGeneralWidget
Add or update the general widget on this tab widget
*/
void ElementPropertiesWidget::addGeneralWidget()
{
int index = m_tab->currentIndex();
@@ -334,9 +334,9 @@ void ElementPropertiesWidget::addGeneralWidget()
}
/**
* @brief ElementPropertiesWidget::generalWidget
* @return build and return the "general" widget
*/
@brief ElementPropertiesWidget::generalWidget
@return build and return the "general" widget
*/
QWidget *ElementPropertiesWidget::generalWidget()
{
QString description_string(tr("Élement\n"));

72
sources/ui/imagepropertieswidget.cpp
View File

@@ -22,11 +22,11 @@
#include "QPropertyUndoCommand/qpropertyundocommand.h"
/**
* @brief ImagePropertiesWidget::ImagePropertiesWidget
* Constructor
* @param image : image to edit properties
* @param parent : parent widget
*/
@brief ImagePropertiesWidget::ImagePropertiesWidget
Constructor
@param image : image to edit properties
@param parent : parent widget
*/
ImagePropertiesWidget::ImagePropertiesWidget(DiagramImageItem *image, QWidget *parent) :
PropertiesEditorWidget(parent),
ui(new Ui::ImagePropertiesWidget),
@@ -38,18 +38,18 @@ ImagePropertiesWidget::ImagePropertiesWidget(DiagramImageItem *image, QWidget *p
}
/**
* @brief ImagePropertiesWidget::~ImagePropertiesWidget
* Destructor
*/
@brief ImagePropertiesWidget::~ImagePropertiesWidget
Destructor
*/
ImagePropertiesWidget::~ImagePropertiesWidget() {
delete ui;
}
/**
* @brief ImagePropertiesWidget::setImageItem
* Set the image to edit properties
* @param image : image to edit
*/
@brief ImagePropertiesWidget::setImageItem
Set the image to edit properties
@param image : image to edit
*/
void ImagePropertiesWidget::setImageItem(DiagramImageItem *image)
{
if(!image) return;
@@ -66,9 +66,9 @@ void ImagePropertiesWidget::setImageItem(DiagramImageItem *image)
}
/**
* @brief ImagePropertiesWidget::apply
* Apply the change
*/
@brief ImagePropertiesWidget::apply
Apply the change
*/
void ImagePropertiesWidget::apply()
{
if(!m_image) return;
@@ -88,9 +88,9 @@ void ImagePropertiesWidget::apply()
}
/**
* @brief ImagePropertiesWidget::reset
* Reset the change
*/
@brief ImagePropertiesWidget::reset
Reset the change
*/
void ImagePropertiesWidget::reset()
{
if(!m_image) return;
@@ -101,11 +101,11 @@ void ImagePropertiesWidget::reset()
}
/**
* @brief ImagePropertiesWidget::setLiveEdit
* @param live_edit true -> enable live edit
@brief ImagePropertiesWidget::setLiveEdit
@param live_edit true -> enable live edit
* false -> disable live edit
* @return always true
*/
@return always true
*/
bool ImagePropertiesWidget::setLiveEdit(bool live_edit)
{
if (m_live_edit == live_edit) return true;
@@ -126,10 +126,10 @@ bool ImagePropertiesWidget::setLiveEdit(bool live_edit)
}
/**
* @brief ImagePropertiesWidget::associatedUndo
* @return the change in an undo command (ItemResizerCommand).
* If there is no change return nullptr
*/
@brief ImagePropertiesWidget::associatedUndo
@return the change in an undo command (ItemResizerCommand).
If there is no change return nullptr
*/
QUndoCommand* ImagePropertiesWidget::associatedUndo() const
{
@@ -143,9 +143,9 @@ QUndoCommand* ImagePropertiesWidget::associatedUndo() const
}
/**
* @brief ImagePropertiesWidget::updateUi
* Udpdate the ui, notably when the image to edit change
*/
@brief ImagePropertiesWidget::updateUi
Udpdate the ui, notably when the image to edit change
*/
void ImagePropertiesWidget::updateUi()
{
if (!m_image) return;
@@ -154,10 +154,10 @@ void ImagePropertiesWidget::updateUi()
}
/**
* @brief ImagePropertiesWidget::on_m_scale_slider_valueChanged
* Update the size of image when move slider.
* @param value
*/
@brief ImagePropertiesWidget::on_m_scale_slider_valueChanged
Update the size of image when move slider.
@param value
*/
void ImagePropertiesWidget::on_m_scale_slider_valueChanged(int value)
{
qreal scale = value;
@@ -165,9 +165,9 @@ void ImagePropertiesWidget::on_m_scale_slider_valueChanged(int value)
}
/**
* @brief ImagePropertiesWidget::on_m_lock_pos_cb_clicked
* Set movable or not the image according to corresponding check box
*/
@brief ImagePropertiesWidget::on_m_lock_pos_cb_clicked
Set movable or not the image according to corresponding check box
*/
void ImagePropertiesWidget::on_m_lock_pos_cb_clicked() {
m_image->setMovable(!ui->m_lock_pos_cb->isChecked());
}

6
sources/ui/imagepropertieswidget.h
View File

@@ -27,9 +27,9 @@ namespace Ui {
}
/**
* @brief The ImagePropertiesWidget class
* This class provide a widget to edit the propertie of a DiagramImageItem
*/
@brief The ImagePropertiesWidget class
This class provide a widget to edit the propertie of a DiagramImageItem
*/
class ImagePropertiesWidget : public PropertiesEditorWidget
{
Q_OBJECT

20
sources/ui/importelementtextpatterndialog.cpp
View File

@@ -30,16 +30,16 @@ ImportElementTextPatternDialog::~ImportElementTextPatternDialog()
}
/**
* @brief ImportElementTextPatternDialog::getItem
* For all arguments see QInputDialog::getItem, except for erase, they store the state of the check box.
* @param parent
* @param title
* @param label
* @param items
* @param ok
* @param erase
* @return
*/
@brief ImportElementTextPatternDialog::getItem
For all arguments see QInputDialog::getItem, except for erase, they store the state of the check box.
@param parent
@param title
@param label
@param items
@param ok
@param erase
@return
*/
QString ImportElementTextPatternDialog::getItem(QWidget *parent, const QString &title, const QString &label, const QStringList &items, bool *ok, bool *erase)
{
QString text(items.value(0));

10
sources/ui/importelementtextpatterndialog.h
View File

@@ -25,11 +25,11 @@ namespace Ui {
}
/**
* @brief The ImportElementTextPatternDialog class
* A dialog use for ask user to select a element text pattern.
* This dialog is highly inspired from QInputDialog::getItem.
* In fact this the same + a check box.
*/
@brief The ImportElementTextPatternDialog class
A dialog use for ask user to select a element text pattern.
This dialog is highly inspired from QInputDialog::getItem.
In fact this the same + a check box.
*/
class ImportElementTextPatternDialog : public QDialog
{
Q_OBJECT

62
sources/ui/inditextpropertieswidget.cpp
View File

@@ -25,10 +25,10 @@
#include <QLineEdit>
/**
* @brief IndiTextPropertiesWidget::IndiTextPropertiesWidget
* @param text : the text to edit
* @param parent : the parent widget of this widget
*/
@brief IndiTextPropertiesWidget::IndiTextPropertiesWidget
@param text : the text to edit
@param parent : the parent widget of this widget
*/
IndiTextPropertiesWidget::IndiTextPropertiesWidget(IndependentTextItem *text, QWidget *parent) :
PropertiesEditorWidget(parent),
ui(new Ui::IndiTextPropertiesWidget)
@@ -40,10 +40,10 @@ IndiTextPropertiesWidget::IndiTextPropertiesWidget(IndependentTextItem *text, QW
}
/**
* @brief IndiTextPropertiesWidget::IndiTextPropertiesWidget
* @param text_list : a list of texts to edit
* @param parent : the parent widget of this widget
*/
@brief IndiTextPropertiesWidget::IndiTextPropertiesWidget
@param text_list : a list of texts to edit
@param parent : the parent widget of this widget
*/
IndiTextPropertiesWidget::IndiTextPropertiesWidget(QList<IndependentTextItem *> text_list, QWidget *parent) :
PropertiesEditorWidget (parent),
ui(new Ui::IndiTextPropertiesWidget)
@@ -53,16 +53,16 @@ IndiTextPropertiesWidget::IndiTextPropertiesWidget(QList<IndependentTextItem *>
}
/**
* @brief IndiTextPropertiesWidget::~IndiTextPropertiesWidget
*/
@brief IndiTextPropertiesWidget::~IndiTextPropertiesWidget
*/
IndiTextPropertiesWidget::~IndiTextPropertiesWidget() {
delete ui;
}
/**
* @brief IndiTextPropertiesWidget::setText
* @param text : set @text as edited text
*/
@brief IndiTextPropertiesWidget::setText
@param text : set @text as edited text
*/
void IndiTextPropertiesWidget::setText(IndependentTextItem *text)
{
if (m_text) {
@@ -109,10 +109,10 @@ void IndiTextPropertiesWidget::setText(QList<IndependentTextItem *> text_list)
}
/**
* @brief IndiTextPropertiesWidget::apply
* Apply the current edition through a QUndoCommand pushed
* to the undo stack of text's diagram.
*/
@brief IndiTextPropertiesWidget::apply
Apply the current edition through a QUndoCommand pushed
to the undo stack of text's diagram.
*/
void IndiTextPropertiesWidget::apply()
{
Diagram *d = nullptr;
@@ -138,10 +138,10 @@ void IndiTextPropertiesWidget::apply()
}
/**
* @brief IndiTextPropertiesWidget::setLiveEdit
* @param live_edit
* @return
*/
@brief IndiTextPropertiesWidget::setLiveEdit
@param live_edit
@return
*/
bool IndiTextPropertiesWidget::setLiveEdit(bool live_edit)
{
if (m_live_edit == live_edit) {
@@ -162,9 +162,9 @@ bool IndiTextPropertiesWidget::setLiveEdit(bool live_edit)
}
/**
* @brief IndiTextPropertiesWidget::associatedUndo
* @return
*/
@brief IndiTextPropertiesWidget::associatedUndo
@return
*/
QUndoCommand *IndiTextPropertiesWidget::associatedUndo() const
{
if (m_live_edit)
@@ -314,9 +314,9 @@ QUndoCommand *IndiTextPropertiesWidget::associatedUndo() const
}
/**
* @brief IndiTextPropertiesWidget::setUpEditConnection
* Disconnect the previous connection, and reconnect the connection between the editors widgets and void IndiTextPropertiesWidget::apply function
*/
@brief IndiTextPropertiesWidget::setUpEditConnection
Disconnect the previous connection, and reconnect the connection between the editors widgets and void IndiTextPropertiesWidget::apply function
*/
void IndiTextPropertiesWidget::setUpEditConnection()
{
for (QMetaObject::Connection c : m_edit_connection) {
@@ -339,8 +339,8 @@ void IndiTextPropertiesWidget::setUpEditConnection()
}
/**
* @brief IndiTextPropertiesWidget::updateUi
*/
@brief IndiTextPropertiesWidget::updateUi
*/
void IndiTextPropertiesWidget::updateUi()
{
if (!m_text && m_text_list.isEmpty()) {
@@ -417,8 +417,8 @@ void IndiTextPropertiesWidget::updateUi()
}
/**
* @brief IndiTextPropertiesWidget::on_m_advanced_editor_pb_clicked
*/
@brief IndiTextPropertiesWidget::on_m_advanced_editor_pb_clicked
*/
void IndiTextPropertiesWidget::on_m_advanced_editor_pb_clicked() {
if (m_text) {
m_text->edit();

6
sources/ui/inditextpropertieswidget.h
View File

@@ -27,9 +27,9 @@ namespace Ui {
}
/**
* @brief The IndiTextPropertiesWidget class
* This widget is used to edit the properties of one or several independent text item
*/
@brief The IndiTextPropertiesWidget class
This widget is used to edit the properties of one or several independent text item
*/
class IndiTextPropertiesWidget : public PropertiesEditorWidget
{
Q_OBJECT

142
sources/ui/linksingleelementwidget.cpp
View File

@@ -26,13 +26,13 @@
#include <QTreeWidgetItem>
/**
* @brief LinkSingleElementWidget::LinkSingleElementWidget
* Default constructor
* @param elmt
* the edited element
* @param parent
* the parent widget
*/
@brief LinkSingleElementWidget::LinkSingleElementWidget
Default constructor
@param elmt
the edited element
@param parent
the parent widget
*/
LinkSingleElementWidget::LinkSingleElementWidget(Element *elmt, QWidget *parent) :
AbstractElementPropertiesEditorWidget(parent),
ui(new Ui::LinkSingleElementWidget)
@@ -75,9 +75,9 @@ LinkSingleElementWidget::LinkSingleElementWidget(Element *elmt, QWidget *parent)
}
/**
* @brief LinkSingleElementWidget::~LinkSingleElementWidget
* Default destructor
*/
@brief LinkSingleElementWidget::~LinkSingleElementWidget
Default destructor
*/
LinkSingleElementWidget::~LinkSingleElementWidget()
{
if(m_showed_element)
@@ -93,10 +93,10 @@ LinkSingleElementWidget::~LinkSingleElementWidget()
}
/**
* @brief LinkSingleElementWidget::setElement
* Set element to be the edited element.
* @param element
*/
@brief LinkSingleElementWidget::setElement
Set element to be the edited element.
@param element
*/
void LinkSingleElementWidget::setElement(Element *element)
{
if (m_element == element)
@@ -135,10 +135,10 @@ void LinkSingleElementWidget::setElement(Element *element)
}
/**
* @brief LinkSingleElementWidget::apply
* Apply the new property of the edited element by pushing
* the associated undo command to parent project undo stack
*/
@brief LinkSingleElementWidget::apply
Apply the new property of the edited element by pushing
the associated undo command to parent project undo stack
*/
void LinkSingleElementWidget::apply()
{
QUndoCommand *undo = associatedUndo();
@@ -151,10 +151,10 @@ void LinkSingleElementWidget::apply()
}
/**
* @brief LinkSingleElementWidget::associatedUndo
* @return the undo command associated to the current edition
* if there isn't change, return nulptr
*/
@brief LinkSingleElementWidget::associatedUndo
@return the undo command associated to the current edition
if there isn't change, return nulptr
*/
QUndoCommand *LinkSingleElementWidget::associatedUndo() const
{
LinkElementCommand *undo = new LinkElementCommand(m_element);
@@ -173,9 +173,9 @@ QUndoCommand *LinkSingleElementWidget::associatedUndo() const
}
/**
* @brief LinkSingleElementWidget::title
* @return the title used for this editor
*/
@brief LinkSingleElementWidget::title
@return the title used for this editor
*/
QString LinkSingleElementWidget::title() const
{
if (m_element->linkType() & Element::AllReport)
@@ -185,9 +185,9 @@ QString LinkSingleElementWidget::title() const
}
/**
* @brief LinkSingleElementWidget::updateUi
* Update the content of this widget
*/
@brief LinkSingleElementWidget::updateUi
Update the content of this widget
*/
void LinkSingleElementWidget::updateUi()
{
m_unlink = false;
@@ -202,9 +202,9 @@ void LinkSingleElementWidget::updateUi()
}
/**
* @brief LinkSingleElementWidget::buildTree
* Build the content of the QTreeWidget
*/
@brief LinkSingleElementWidget::buildTree
Build the content of the QTreeWidget
*/
void LinkSingleElementWidget::buildTree()
{
clearTreeWidget();
@@ -324,10 +324,10 @@ void LinkSingleElementWidget::buildTree()
}
/**
* @brief LinkSingleElementWidget::setLiveEdit
* @param live_edit
* @return
*/
@brief LinkSingleElementWidget::setLiveEdit
@param live_edit
@return
*/
bool LinkSingleElementWidget::setLiveEdit(bool live_edit)
{
if (m_live_edit == live_edit)
@@ -339,11 +339,11 @@ bool LinkSingleElementWidget::setLiveEdit(bool live_edit)
}
/**
* @brief LinkSingleElementWidget::availableElements
* @return A QList with all available element
* to be linked with the edited element.
* This methode take care of the combo box "find in diagram"
*/
@brief LinkSingleElementWidget::availableElements
@return A QList with all available element
to be linked with the edited element.
This methode take care of the combo box "find in diagram"
*/
QList <Element *> LinkSingleElementWidget::availableElements()
{
QList <Element *> elmt_list;
@@ -366,9 +366,9 @@ QList <Element *> LinkSingleElementWidget::availableElements()
}
/**
* @brief LinkSingleElementWidget::setUpCompleter
* Setup the completer of search_field
*/
@brief LinkSingleElementWidget::setUpCompleter
Setup the completer of search_field
*/
void LinkSingleElementWidget::setUpCompleter()
{
ui->m_search_field->clear();
@@ -385,11 +385,11 @@ void LinkSingleElementWidget::setUpCompleter()
}
/**
* @brief LinkSingleElementWidget::clearTreeWidget
* Clear the tree widget.
* Delete all QTreeWidget (in the tree widget and in the hash).
* Clear the hash.
*/
@brief LinkSingleElementWidget::clearTreeWidget
Clear the tree widget.
Delete all QTreeWidget (in the tree widget and in the hash).
Clear the hash.
*/
void LinkSingleElementWidget::clearTreeWidget()
{
while(ui->m_tree_widget->topLevelItemCount())
@@ -439,10 +439,10 @@ void LinkSingleElementWidget::setUpHeaderLabels()
}
/**
* @brief LinkSingleElementWidget::diagramWasRemovedFromProject
* * This slot is called when a diagram is removed from the parent project of edited element
* to update the content of this widget
*/
@brief LinkSingleElementWidget::diagramWasRemovedFromProject
* This slot is called when a diagram is removed from the parent project of edited element
to update the content of this widget
*/
void LinkSingleElementWidget::diagramWasRemovedFromProject()
{
//We use a timer because if the removed diagram contain the master element linked to the edited element
@@ -456,9 +456,9 @@ void LinkSingleElementWidget::showedElementWasDeleted()
}
/**
* @brief LinkSingleElementWidget::linkTriggered
* Action linkis triggered
*/
@brief LinkSingleElementWidget::linkTriggered
Action linkis triggered
*/
void LinkSingleElementWidget::linkTriggered()
{
if(!m_qtwi_at_context_menu)
@@ -493,9 +493,9 @@ void LinkSingleElementWidget::linkTriggered()
}
/**
* @brief LinkSingleElementWidget::hideButtons
* Hide the button displayed when element is already linked
*/
@brief LinkSingleElementWidget::hideButtons
Hide the button displayed when element is already linked
*/
void LinkSingleElementWidget::hideButtons()
{
ui->m_label->hide();
@@ -506,9 +506,9 @@ void LinkSingleElementWidget::hideButtons()
}
/**
* @brief LinkSingleElementWidget::showButtons
* Show the button displayed when element is already linked
*/
@brief LinkSingleElementWidget::showButtons
Show the button displayed when element is already linked
*/
void LinkSingleElementWidget::showButtons()
{
ui->m_label->show();
@@ -539,11 +539,11 @@ void LinkSingleElementWidget::on_m_unlink_pb_clicked()
}
/**
* @brief LinkSingleElementWidget::on_m_tree_widget_itemDoubleClicked
* Highlight the element represented by @item
* @param item
* @param column
*/
@brief LinkSingleElementWidget::on_m_tree_widget_itemDoubleClicked
Highlight the element represented by @item
@param item
@param column
*/
void LinkSingleElementWidget::on_m_tree_widget_itemDoubleClicked(QTreeWidgetItem *item, int column)
{
Q_UNUSED(column);
@@ -599,11 +599,11 @@ void LinkSingleElementWidget::on_m_show_this_pb_clicked()
}
/**
* @brief LinkSingleElementWidget::on_m_search_field_textEdited
* Search all items which match with @arg1 and shows it, other items is hidden.
* If @arg1 is empty, show all items.
* @param arg1
*/
@brief LinkSingleElementWidget::on_m_search_field_textEdited
Search all items which match with @arg1 and shows it, other items is hidden.
If @arg1 is empty, show all items.
@param arg1
*/
void LinkSingleElementWidget::on_m_search_field_textEdited(const QString &arg1)
{
//Show all items if arg1 is empty, if not hide all items

16
sources/ui/linksingleelementwidget.h
View File

@@ -29,14 +29,14 @@ namespace Ui {
/**
* @brief The LinkSingleElementWidget class
* this class provide a widget to select an element to be linked
* to the element given in the constructor.
* The element given in constructor must be linked with only one other element (like report or slave element).
* This widget detect automaticaly the kind of element given in the constructor and
* search all element that can be linked with it.
* If the element is already linked, the widget ask user to unlink.
* This widget embedded the diagram command for undo/redo the action
*/
this class provide a widget to select an element to be linked
to the element given in the constructor.
The element given in constructor must be linked with only one other element (like report or slave element).
This widget detect automaticaly the kind of element given in the constructor and
search all element that can be linked with it.
If the element is already linked, the widget ask user to unlink.
This widget embedded the diagram command for undo/redo the action
*/
class LinkSingleElementWidget : public AbstractElementPropertiesEditorWidget
{
Q_OBJECT

12
sources/ui/marginseditdialog.cpp
View File

@@ -41,12 +41,12 @@ QMargins MarginsEditDialog::margins() const {
}
/**
* @brief MarginsEditDialog::getMargins
* @param margins : margins to set by default
* @param accepted : bool to know if dialog is accepted
* @param parent : parent widget.
* @return The a margins with the edited value if dialog is accepted or a default constructed QMargins() if dialog is rejected
*/
@brief MarginsEditDialog::getMargins
@param margins : margins to set by default
@param accepted : bool to know if dialog is accepted
@param parent : parent widget.
@return The a margins with the edited value if dialog is accepted or a default constructed QMargins() if dialog is rejected
*/
QMargins MarginsEditDialog::getMargins(QMargins margins, bool *accepted, QWidget *parent)
{
QScopedPointer<MarginsEditDialog> d(new MarginsEditDialog(margins, parent));

6
sources/ui/marginseditdialog.h
View File

@@ -26,9 +26,9 @@ class MarginsEditDialog;
}
/**
* @brief The MarginsEditDialog class
* A simple dialog to edit QMargins
*/
@brief The MarginsEditDialog class
A simple dialog to edit QMargins
*/
class MarginsEditDialog : public QDialog
{
Q_OBJECT

2
sources/ui/masterpropertieswidget.cpp
View File

@@ -168,7 +168,7 @@ void MasterPropertiesWidget::setElement(Element *element)
pushed to the stack of element project.
Return true if link change, else false
@note is void no Return ???
*/
*/
void MasterPropertiesWidget::apply() {
if (QUndoCommand *undo = associatedUndo())
m_element -> diagram() -> undoStack().push(undo);

6
sources/ui/masterpropertieswidget.h
View File

@@ -54,9 +54,9 @@ class MasterPropertiesWidget : public AbstractElementPropertiesEditorWidget
void reset() override;
QUndoCommand *associatedUndo () const override;
/**
* @brief title
* @return QString title
*/
@brief title
@return QString title
*/
QString title() const override {
return tr("Référence croisée (maître)");}
bool setLiveEdit(bool live_edit) override;

60
sources/ui/potentialselectordialog.cpp
View File

@@ -30,9 +30,9 @@
//### BEGIN PRIVATE CLASS ###//
/**
* @brief The NewConductorPotentialSelector class
* Use for get the conductor propertie when two potentials is linked by a conductor
*/
@brief The NewConductorPotentialSelector class
Use for get the conductor propertie when two potentials is linked by a conductor
*/
class NewConductorPotentialSelector : public AbstractPotentialSelector
{
public:
@@ -60,12 +60,12 @@ class NewConductorPotentialSelector : public AbstractPotentialSelector
bool isValid() const override {return m_is_valid;}
/**
* @brief getPotential
* Get the conductor propertie of the potential at terminal, and the number of wire in this potential.
* @param terminal
* @param properties
* @param number
*/
@brief getPotential
Get the conductor propertie of the potential at terminal, and the number of wire in this potential.
@param terminal
@param properties
@param number
*/
void getPotential(Terminal *terminal, autonum::sequentialNumbers &seq_num , int &number, QList<ConductorProperties> &properties_list, QList<Conductor*> &c_list)
{
Conductor *conductor_in_potential = nullptr;
@@ -117,9 +117,9 @@ class NewConductorPotentialSelector : public AbstractPotentialSelector
};
/**
* @brief The LinkReportPotentialSelector class
* Use for get the conductor propertie when two potentials is linked with a folio report
*/
@brief The LinkReportPotentialSelector class
Use for get the conductor propertie when two potentials is linked with a folio report
*/
class LinkReportPotentialSelector : public AbstractPotentialSelector
{
public:
@@ -215,12 +215,12 @@ ConductorProperties PotentialSelectorDialog::chosenProperties(QList<ConductorPro
}
/**
* @brief PotentialSelectorDialog::PotentialSelectorDialog
* Constructor when we link two potentiels together, with a conductor
* @param conductor : the new conductor who connect to existing potential
* @param parent_undo : undo parent to use.
* @param parent : parent widget.
*/
@brief PotentialSelectorDialog::PotentialSelectorDialog
Constructor when we link two potentiels together, with a conductor
@param conductor : the new conductor who connect to existing potential
@param parent_undo : undo parent to use.
@param parent : parent widget.
*/
PotentialSelectorDialog::PotentialSelectorDialog(Conductor *conductor, QUndoCommand *parent_undo, QWidget *parent) :
QDialog(parent),
ui(new Ui::PotentialSelectorDialog),
@@ -234,12 +234,12 @@ PotentialSelectorDialog::PotentialSelectorDialog(Conductor *conductor, QUndoComm
}
/**
* @brief PotentialSelectorDialog::PotentialSelectorDialog
* Constructor when we link two potentiels together, with a folio report.
* @param report : one of the report used to link the potentials (report must be linked to another report)
* @param parent_undo : undo parent to use
* @param parent : parent widget
*/
@brief PotentialSelectorDialog::PotentialSelectorDialog
Constructor when we link two potentiels together, with a folio report.
@param report : one of the report used to link the potentials (report must be linked to another report)
@param parent_undo : undo parent to use
@param parent : parent widget
*/
PotentialSelectorDialog::PotentialSelectorDialog(Element *report, QUndoCommand *parent_undo, QWidget *parent) :
QDialog(parent),
ui(new Ui::PotentialSelectorDialog),
@@ -259,9 +259,9 @@ PotentialSelectorDialog::~PotentialSelectorDialog()
}
/**
* @brief PotentialSelectorDialog::buildWidget
* Build the dialog
*/
@brief PotentialSelectorDialog::buildWidget
Build the dialog
*/
void PotentialSelectorDialog::buildWidget()
{
QString text1(tr("%n conducteurs composent le potentiel suivant :", "", m_potential_selector->m_conductor_number_1));
@@ -336,9 +336,9 @@ void PotentialSelectorDialog::buildWidget()
}
/**
* @brief PotentialSelectorDialog::on_buttonBox_accepted
* Action when user click on OK button
*/
@brief PotentialSelectorDialog::on_buttonBox_accepted
Action when user click on OK button
*/
void PotentialSelectorDialog::on_buttonBox_accepted()
{
if (!m_potential_selector->isValid())

26
sources/ui/potentialselectordialog.h
View File

@@ -43,20 +43,20 @@ namespace Ui {
}
/**
* @brief The PotentialSelectorDialog class
* This dialog is used when user try to connect two existing potential together.
* The dialog ask to user to make a choice between the properties of the two existing potential,
* to apply it for the new potential.
@brief The PotentialSelectorDialog class
This dialog is used when user try to connect two existing potential together.
The dialog ask to user to make a choice between the properties of the two existing potential,
to apply it for the new potential.
*
* Each constructor have a QUndoCommand @parent_undo for parameter
* If @parent_undo isn't null, when user click on OK button, the dialog will use the parent-undo
* as parent of the undo command that describe the changes.
* If @parent_undo is null, the created undo-command is push to the undo stack of the parent diagram of a conductor in potential.
* else we apply the change without a QUndoCommand.
*
* the static function chosenProperties, open a dialog who ask user to make a choice between the given
* properties
*/
Each constructor have a QUndoCommand @parent_undo for parameter
If @parent_undo isn't null, when user click on OK button, the dialog will use the parent-undo
as parent of the undo command that describe the changes.
If @parent_undo is null, the created undo-command is push to the undo stack of the parent diagram of a conductor in potential.
else we apply the change without a QUndoCommand.
the static function chosenProperties, open a dialog who ask user to make a choice between the given
properties
*/
class PotentialSelectorDialog : public QDialog
{
Q_OBJECT

34
sources/ui/projectpropertiesdialog.cpp
View File

@@ -22,11 +22,11 @@
#include "configpages.h"
/**
* @brief ProjectPropertiesDialog::ProjectPropertiesDialog
* Default constructor
* @param project : project to edit properties
* @param parent : parent widget of this dialog
*/
@brief ProjectPropertiesDialog::ProjectPropertiesDialog
Default constructor
@param project : project to edit properties
@param parent : parent widget of this dialog
*/
ProjectPropertiesDialog::ProjectPropertiesDialog(QETProject *project, QWidget *parent) {
NewDiagramPage *newDiagramPage = new NewDiagramPage(project,parent,this);
ProjectAutoNumConfigPage *projectAutoNumConfigPage = new ProjectAutoNumConfigPage (project);
@@ -43,34 +43,34 @@ ProjectPropertiesDialog::ProjectPropertiesDialog(QETProject *project, QWidget *p
}
/**
* @brief ProjectPropertiesDialog::~ProjectPropertiesDialog
*/
@brief ProjectPropertiesDialog::~ProjectPropertiesDialog
*/
ProjectPropertiesDialog::~ProjectPropertiesDialog () {
delete m_properties_dialog;
}
/**
* @brief ProjectPropertiesDialog::exec
* execute this dialog.
*/
@brief ProjectPropertiesDialog::exec
execute this dialog.
*/
void ProjectPropertiesDialog::exec() {
m_properties_dialog->setWindowModality(Qt::WindowModal);
m_properties_dialog -> exec();
}
/**
* @brief ProjectPropertiesDialog::setCurrentPage
* Change the current displayed page by p.
* @param p : page to display
*/
@brief ProjectPropertiesDialog::setCurrentPage
Change the current displayed page by p.
@param p : page to display
*/
void ProjectPropertiesDialog::setCurrentPage(ProjectPropertiesDialog::Page p) {
m_properties_dialog -> setCurrentPage(static_cast <int> (p));
}
/**
* @brief ProjectPropertiesDialog::changeToFolio
* Change the current displayed tab to folio tab.
*/
@brief ProjectPropertiesDialog::changeToFolio
Change the current displayed tab to folio tab.
*/
void ProjectPropertiesDialog::changeToFolio() {
ProjectAutoNumConfigPage *autoNumPage = static_cast <ProjectAutoNumConfigPage*>(m_properties_dialog->pages.at(2));
autoNumPage->changeToTab(3);

6
sources/ui/projectpropertiesdialog.h
View File

@@ -24,9 +24,9 @@ class QWidget;
class ConfigDialog;
/**
* @brief The ProjectPropertiesDialog class
* this class builds a dialog to edit whole properties of a project
*/
@brief The ProjectPropertiesDialog class
this class builds a dialog to edit whole properties of a project
*/
class ProjectPropertiesDialog : public QObject {
public:
enum Page {

74
sources/ui/shapegraphicsitempropertieswidget.cpp
View File

@@ -22,11 +22,11 @@
#include "QPropertyUndoCommand/qpropertyundocommand.h"
/**
* @brief ShapeGraphicsItemPropertiesWidget::ShapeGraphicsItemPropertiesWidget
* Constructor
* @param item : shape to edit
* @param parent : parent widget
*/
@brief ShapeGraphicsItemPropertiesWidget::ShapeGraphicsItemPropertiesWidget
Constructor
@param item : shape to edit
@param parent : parent widget
*/
ShapeGraphicsItemPropertiesWidget::ShapeGraphicsItemPropertiesWidget(QetShapeItem *item, QWidget *parent) :
PropertiesEditorWidget(parent),
ui(new Ui::ShapeGraphicsItemPropertiesWidget),
@@ -45,19 +45,19 @@ ShapeGraphicsItemPropertiesWidget::ShapeGraphicsItemPropertiesWidget(QList<QetSh
}
/**
* @brief ShapeGraphicsItemPropertiesWidget::~ShapeGraphicsItemPropertiesWidget
* Destructor
*/
@brief ShapeGraphicsItemPropertiesWidget::~ShapeGraphicsItemPropertiesWidget
Destructor
*/
ShapeGraphicsItemPropertiesWidget::~ShapeGraphicsItemPropertiesWidget()
{
delete ui;
}
/**
* @brief ShapeGraphicsItemPropertiesWidget::setItem
* Set @shape as the current edited item
* @param shape
*/
@brief ShapeGraphicsItemPropertiesWidget::setItem
Set @shape as the current edited item
@param shape
*/
void ShapeGraphicsItemPropertiesWidget::setItem(QetShapeItem *shape)
{
if (m_shape != shape)
@@ -88,10 +88,10 @@ void ShapeGraphicsItemPropertiesWidget::setItem(QetShapeItem *shape)
}
/**
* @brief ShapeGraphicsItemPropertiesWidget::setItems
* Set a list of shapes to be edited
* @param shapes_list
*/
@brief ShapeGraphicsItemPropertiesWidget::setItems
Set a list of shapes to be edited
@param shapes_list
*/
void ShapeGraphicsItemPropertiesWidget::setItems(QList<QetShapeItem *> shapes_list)
{
for (QMetaObject::Connection c : m_connect_list) {
@@ -119,10 +119,10 @@ void ShapeGraphicsItemPropertiesWidget::setItems(QList<QetShapeItem *> shapes_li
}
/**
* @brief ShapeGraphicsItemPropertiesWidget::apply
* Apply the current change, by pushing an undo command to the
* undo stack of the shape diagram.
*/
@brief ShapeGraphicsItemPropertiesWidget::apply
Apply the current change, by pushing an undo command to the
undo stack of the shape diagram.
*/
void ShapeGraphicsItemPropertiesWidget::apply()
{
Diagram *d = nullptr;
@@ -151,19 +151,19 @@ void ShapeGraphicsItemPropertiesWidget::apply()
}
/**
* @brief ShapeGraphicsItemPropertiesWidget::reset
* Reset the change
*/
@brief ShapeGraphicsItemPropertiesWidget::reset
Reset the change
*/
void ShapeGraphicsItemPropertiesWidget::reset() {
updateUi();
}
/**
* @brief ShapeGraphicsItemPropertiesWidget::associatedUndo
* @return an undo command that represent the change edited by this widget.
* The returned undo command is a QPropertyUndoCommand with the properties "pen".
* If there isn't change, return nullptr
*/
@brief ShapeGraphicsItemPropertiesWidget::associatedUndo
@return an undo command that represent the change edited by this widget.
The returned undo command is a QPropertyUndoCommand with the properties "pen".
If there isn't change, return nullptr
*/
QUndoCommand* ShapeGraphicsItemPropertiesWidget::associatedUndo() const
{
if (m_live_edit)
@@ -357,8 +357,8 @@ QUndoCommand* ShapeGraphicsItemPropertiesWidget::associatedUndo() const
}
/**
* @brief ShapeGraphicsItemPropertiesWidget::updateUi
*/
@brief ShapeGraphicsItemPropertiesWidget::updateUi
*/
void ShapeGraphicsItemPropertiesWidget::updateUi()
{
if (!m_shape && m_shapes_list.isEmpty()) {
@@ -455,10 +455,10 @@ void ShapeGraphicsItemPropertiesWidget::updateUi()
}
/**
* @brief ShapeGraphicsItemPropertiesWidget::setLiveEdit
* @param live_edit
* @return always true
*/
@brief ShapeGraphicsItemPropertiesWidget::setLiveEdit
@param live_edit
@return always true
*/
bool ShapeGraphicsItemPropertiesWidget::setLiveEdit(bool live_edit)
{
if (live_edit == m_live_edit) {
@@ -480,9 +480,9 @@ bool ShapeGraphicsItemPropertiesWidget::setLiveEdit(bool live_edit)
}
/**
* @brief ShapeGraphicsItemPropertiesWidget::setUpEditConnection
* Disconnect the previous connection, and reconnect the connection between the editors widgets and void ShapeGraphicsItemPropertiesWidget::apply function
*/
@brief ShapeGraphicsItemPropertiesWidget::setUpEditConnection
Disconnect the previous connection, and reconnect the connection between the editors widgets and void ShapeGraphicsItemPropertiesWidget::apply function
*/
void ShapeGraphicsItemPropertiesWidget::setUpEditConnection()
{
for (QMetaObject::Connection c : m_edit_connection) {

6
sources/ui/shapegraphicsitempropertieswidget.h
View File

@@ -27,9 +27,9 @@ namespace Ui {
class QetShapeItem;
/**
* @brief The ShapeGraphicsItemPropertiesWidget class
* Provide a widget to edit the properties of a QetShapeItem
*/
@brief The ShapeGraphicsItemPropertiesWidget class
Provide a widget to edit the properties of a QetShapeItem
*/
class ShapeGraphicsItemPropertiesWidget : public PropertiesEditorWidget
{
Q_OBJECT

134
sources/ui/titleblockpropertieswidget.cpp
View File

@@ -25,12 +25,12 @@
#include <utility>
/**
* @brief TitleBlockPropertiesWidget::TitleBlockPropertiesWidget
* default constructor
* @param titleblock properties to edit
* @param current_date if true, display the radio button "current date"
* @param parent parent widget
*/
@brief TitleBlockPropertiesWidget::TitleBlockPropertiesWidget
default constructor
@param titleblock properties to edit
@param current_date if true, display the radio button "current date"
@param parent parent widget
*/
TitleBlockPropertiesWidget::TitleBlockPropertiesWidget(const TitleBlockProperties &titleblock, bool current_date, QETProject *project, QWidget *parent) :
QWidget(parent),
ui(new Ui::TitleBlockPropertiesWidget)
@@ -41,13 +41,13 @@ TitleBlockPropertiesWidget::TitleBlockPropertiesWidget(const TitleBlockPropertie
}
/**
* @brief TitleBlockPropertiesWidget::TitleBlockPropertiesWidget
* default constructor with tempalte list
* @param tbt_collection template list
* @param titleblock properties to edit
* @param current_date if true, display the radio button "current date"
* @param parent parent widget
*/
@brief TitleBlockPropertiesWidget::TitleBlockPropertiesWidget
default constructor with tempalte list
@param tbt_collection template list
@param titleblock properties to edit
@param current_date if true, display the radio button "current date"
@param parent parent widget
*/
TitleBlockPropertiesWidget::TitleBlockPropertiesWidget(TitleBlockTemplatesCollection *tbt_collection, const TitleBlockProperties &titleblock, bool current_date, QETProject *project, QWidget *parent) :
QWidget(parent),
ui(new Ui::TitleBlockPropertiesWidget)
@@ -60,13 +60,13 @@ TitleBlockPropertiesWidget::TitleBlockPropertiesWidget(TitleBlockTemplatesCollec
}
/**
* @brief TitleBlockPropertiesWidget::TitleBlockPropertiesWidget
* Default constructor with several template collection
* @param tbt_collection template list
* @param titleblock properties to edit
* @param current_date if true, display the radio button "current date"
* @param parent parent widget
*/
@brief TitleBlockPropertiesWidget::TitleBlockPropertiesWidget
Default constructor with several template collection
@param tbt_collection template list
@param titleblock properties to edit
@param current_date if true, display the radio button "current date"
@param parent parent widget
*/
TitleBlockPropertiesWidget::TitleBlockPropertiesWidget(QList<TitleBlockTemplatesCollection *> tbt_collection, const TitleBlockProperties &titleblock, bool current_date, QETProject *project, QWidget *parent) :
QWidget(parent),
ui(new Ui::TitleBlockPropertiesWidget)
@@ -80,18 +80,18 @@ TitleBlockPropertiesWidget::TitleBlockPropertiesWidget(QList<TitleBlockTemplates
}
/**
* @brief TitleBlockPropertiesWidget::~TitleBlockPropertiesWidget
* destructor
*/
@brief TitleBlockPropertiesWidget::~TitleBlockPropertiesWidget
destructor
*/
TitleBlockPropertiesWidget::~TitleBlockPropertiesWidget()
{
delete ui;
}
/**
* @brief TitleBlockPropertiesWidget::setProperties
* @param properties
*/
@brief TitleBlockPropertiesWidget::setProperties
@param properties
*/
void TitleBlockPropertiesWidget::setProperties(const TitleBlockProperties &properties) {
ui -> m_title_le -> setText (properties.title);
ui -> m_author_le -> setText (properties.author);
@@ -146,9 +146,9 @@ void TitleBlockPropertiesWidget::setProperties(const TitleBlockProperties &prope
}
/**
* @brief TitleBlockPropertiesWidget::properties
* @return the edited properties
*/
@brief TitleBlockPropertiesWidget::properties
@return the edited properties
*/
TitleBlockProperties TitleBlockPropertiesWidget::properties() const {
TitleBlockProperties prop;
prop.title = ui -> m_title_le -> text();
@@ -187,9 +187,9 @@ TitleBlockProperties TitleBlockPropertiesWidget::properties() const {
}
/**
* @brief TitleBlockPropertiesWidget::properties
* @return return properties to enable folio autonum
*/
@brief TitleBlockPropertiesWidget::properties
@return return properties to enable folio autonum
*/
TitleBlockProperties TitleBlockPropertiesWidget::propertiesAutoNum(QString autoNum) const {
TitleBlockProperties prop;
prop.title = ui -> m_title_le -> text();
@@ -242,9 +242,9 @@ TitleBlockTemplateLocation TitleBlockPropertiesWidget::currentTitleBlockLocation
}
/**
* @brief TitleBlockPropertiesWidget::setTitleBlockTemplatesVisible
* if true, title block template combo box and menu button is visible
*/
@brief TitleBlockPropertiesWidget::setTitleBlockTemplatesVisible
if true, title block template combo box and menu button is visible
*/
void TitleBlockPropertiesWidget::setTitleBlockTemplatesVisible(const bool &visible) {
ui -> m_tbt_label -> setVisible(visible);
ui -> m_tbt_cb -> setVisible(visible);
@@ -252,17 +252,17 @@ void TitleBlockPropertiesWidget::setTitleBlockTemplatesVisible(const bool &visib
}
/**
* @brief TitleBlockPropertiesWidget::setReadOnly
* if true, this widget is disable
*/
@brief TitleBlockPropertiesWidget::setReadOnly
if true, this widget is disable
*/
void TitleBlockPropertiesWidget::setReadOnly(const bool &ro) {
ui->m_tbt_gb->setDisabled(ro);
}
/**
* @brief TitleBlockPropertiesWidget::currentTitleBlockTemplateName
* @return the current title block name
*/
@brief TitleBlockPropertiesWidget::currentTitleBlockTemplateName
@return the current title block name
*/
QString TitleBlockPropertiesWidget::currentTitleBlockTemplateName() const {
int index = ui -> m_tbt_cb -> currentIndex();
if(index != -1)
@@ -271,10 +271,10 @@ QString TitleBlockPropertiesWidget::currentTitleBlockTemplateName() const {
}
/**
* @brief TitleBlockPropertiesWidget::addCollection
* add a collection of title block available in the combo box
* @param tbt_collection
*/
@brief TitleBlockPropertiesWidget::addCollection
add a collection of title block available in the combo box
@param tbt_collection
*/
void TitleBlockPropertiesWidget::addCollection(TitleBlockTemplatesCollection *tbt_collection)
{
if (!tbt_collection || m_tbt_collection_list.contains(tbt_collection)) return;
@@ -282,10 +282,10 @@ void TitleBlockPropertiesWidget::addCollection(TitleBlockTemplatesCollection *tb
}
/**
* @brief TitleBlockPropertiesWidget::initDialog
* Init this dialog
* @param current_date true for display current date radio button
*/
@brief TitleBlockPropertiesWidget::initDialog
Init this dialog
@param current_date true for display current date radio button
*/
void TitleBlockPropertiesWidget::initDialog(const bool &current_date, QETProject *project) {
m_dcw = new DiagramContextWidget();
ui -> m_tab2_vlayout -> addWidget(m_dcw);
@@ -321,12 +321,12 @@ void TitleBlockPropertiesWidget::initDialog(const bool &current_date, QETProjec
}
/**
* @brief TitleBlockPropertiesWidget::getIndexFor
* Find the index of the combo box for the title block @tbt_name available on the collection @collection
* @param tbt_name : title block name
* @param collection : title block collection
* @return the index of the title block or -1 if no match
*/
@brief TitleBlockPropertiesWidget::getIndexFor
Find the index of the combo box for the title block @tbt_name available on the collection @collection
@param tbt_name : title block name
@param collection : title block collection
@return the index of the title block or -1 if no match
*/
int TitleBlockPropertiesWidget::getIndexFor(const QString &tbt_name, const QET::QetCollection collection) const
{
for (int i = 0; i<ui->m_tbt_cb->count(); i++) {
@@ -346,9 +346,9 @@ void TitleBlockPropertiesWidget::duplicateCurrentTitleBlockTemplate() {
}
/**
* @brief TitleBlockPropertiesWidget::updateTemplateList
* Update the title block template list available in the combo box
*/
@brief TitleBlockPropertiesWidget::updateTemplateList
Update the title block template list available in the combo box
*/
void TitleBlockPropertiesWidget::updateTemplateList()
{
ui -> m_tbt_cb ->clear();
@@ -386,9 +386,9 @@ void TitleBlockPropertiesWidget::updateTemplateList()
}
/**
* @brief TitleBlockPropertiesWidget::changeCurrentTitleBlockTemplate
* Load the additionnal field of title block "text"
*/
@brief TitleBlockPropertiesWidget::changeCurrentTitleBlockTemplate
Load the additionnal field of title block "text"
*/
void TitleBlockPropertiesWidget::changeCurrentTitleBlockTemplate(int index)
{
m_dcw -> clear();
@@ -415,17 +415,17 @@ void TitleBlockPropertiesWidget::changeCurrentTitleBlockTemplate(int index)
}
/**
* @brief TitleBlockPropertiesWidget::on_m_date_now_pb_clicked
* Set the date to current date
*/
@brief TitleBlockPropertiesWidget::on_m_date_now_pb_clicked
Set the date to current date
*/
void TitleBlockPropertiesWidget::on_m_date_now_pb_clicked() {
ui -> m_date_edit -> setDate(QDate::currentDate());
}
/**
* @brief TitleBlockPropertiesWidget::on_m_edit_autofolionum_pb_clicked
* Open Auto Folio Num dialog
*/
@brief TitleBlockPropertiesWidget::on_m_edit_autofolionum_pb_clicked
Open Auto Folio Num dialog
*/
void TitleBlockPropertiesWidget::on_m_edit_autofolionum_pb_clicked() {
emit openAutoNumFolioEditor(ui->auto_page_cb->currentText());
if (ui->auto_page_cb->currentText()!=tr("Créer un Folio Numérotation Auto"))

72
sources/ui/xrefpropertieswidget.cpp
View File

@@ -23,11 +23,11 @@
#include <QMetaEnum>
/**
* @brief XRefPropertiesWidget::XRefPropertiesWidget
* Default constructor
* @param properties: properties to use
* @param parent: parent widget
*/
@brief XRefPropertiesWidget::XRefPropertiesWidget
Default constructor
@param properties: properties to use
@param parent: parent widget
*/
XRefPropertiesWidget::XRefPropertiesWidget(QHash <QString, XRefProperties> properties, QWidget *parent) :
QWidget(parent),
ui(new Ui::XRefPropertiesWidget),
@@ -42,9 +42,9 @@ XRefPropertiesWidget::XRefPropertiesWidget(QHash <QString, XRefProperties> prope
}
/**
* @brief XRefPropertiesWidget::~XRefPropertiesWidget
* Default destructor
*/
@brief XRefPropertiesWidget::~XRefPropertiesWidget
Default destructor
*/
XRefPropertiesWidget::~XRefPropertiesWidget()
{
disconnect(ui->m_display_has_cross_rb, SIGNAL(toggled(bool)), ui->m_cross_properties_gb, SLOT(setEnabled(bool)));
@@ -54,10 +54,10 @@ XRefPropertiesWidget::~XRefPropertiesWidget()
}
/**
* @brief XRefPropertiesWidget::setProperties
* set new properties for this widget
* @param properties
*/
@brief XRefPropertiesWidget::setProperties
set new properties for this widget
@param properties
*/
void XRefPropertiesWidget::setProperties(const QHash <QString, XRefProperties> &properties) {
m_properties = properties;
updateDisplay();
@@ -65,19 +65,19 @@ void XRefPropertiesWidget::setProperties(const QHash <QString, XRefProperties> &
}
/**
* @brief XRefPropertiesWidget::properties
* @return the properties edited by this widget
*/
@brief XRefPropertiesWidget::properties
@return the properties edited by this widget
*/
QHash <QString, XRefProperties> XRefPropertiesWidget::properties(){
saveProperties(ui->m_type_cb->currentIndex());
return m_properties;
}
/**
* @brief XRefPropertiesWidget::setReadOnly
* Set all of this widget disable if true
* @param ro
*/
@brief XRefPropertiesWidget::setReadOnly
Set all of this widget disable if true
@param ro
*/
void XRefPropertiesWidget::setReadOnly(bool ro) {
ui->m_type_cb->setDisabled(ro);
ui->m_display_gb->setDisabled(ro);
@@ -89,9 +89,9 @@ void XRefPropertiesWidget::setReadOnly(bool ro) {
}
/**
* @brief XRefPropertiesWidget::buildUi
* Build some widget of this ui.
*/
@brief XRefPropertiesWidget::buildUi
Build some widget of this ui.
*/
void XRefPropertiesWidget::buildUi()
{
ui -> m_type_cb -> addItem(tr("Bobine"), "coil");
@@ -110,10 +110,10 @@ void XRefPropertiesWidget::buildUi()
}
/**
* @brief XRefPropertiesWidget::saveProperties
* Save the properties of the type define at @index of the combo box m_type_cb
* @param index
*/
@brief XRefPropertiesWidget::saveProperties
Save the properties of the type define at @index of the combo box m_type_cb
@param index
*/
void XRefPropertiesWidget::saveProperties(int index) {
QString type = ui->m_type_cb->itemData(index).toString();
XRefProperties xrp = m_properties[type];
@@ -145,9 +145,9 @@ void XRefPropertiesWidget::saveProperties(int index) {
}
/**
* @brief XRefPropertiesWidget::updateDisplay
* Update display with the curent displayed type.
*/
@brief XRefPropertiesWidget::updateDisplay
Update display with the curent displayed type.
*/
void XRefPropertiesWidget::updateDisplay() {
QString type = ui->m_type_cb->itemData(ui->m_type_cb->currentIndex()).toString();
XRefProperties xrp = m_properties[type];
@@ -191,10 +191,10 @@ void XRefPropertiesWidget::updateDisplay() {
}
/**
* @brief XRefPropertiesWidget::typeChanged
* manage the save of the current properties,
* when the combo box of type change.
*/
@brief XRefPropertiesWidget::typeChanged
manage the save of the current properties,
when the combo box of type change.
*/
void XRefPropertiesWidget::typeChanged() {
//save the properties of the previous xref type
saveProperties(m_previous_type_index);
@@ -206,9 +206,9 @@ void XRefPropertiesWidget::typeChanged() {
}
/**
* @brief XRefPropertiesWidget::enableOffsetSB
* Enable Offset SB only if Snap to Footer is selected
*/
@brief XRefPropertiesWidget::enableOffsetSB
Enable Offset SB only if Snap to Footer is selected
*/
void XRefPropertiesWidget::enableOffsetSB(int i){
if (i)
ui->m_offset_sb->setEnabled(false);

6
sources/ui/xrefpropertieswidget.h
View File

@@ -26,9 +26,9 @@ namespace Ui {
}
/**
* @brief The XRefPropertiesWidget class
* This class provide a widget to edit the XRefProperties
*/
@brief The XRefPropertiesWidget class
This class provide a widget to edit the XRefProperties
*/
class XRefPropertiesWidget : public QWidget
{
Q_OBJECT