Mod doc set style de same

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

View File

@@ -25,12 +25,12 @@
ElementFactory* ElementFactory::factory_ = nullptr;
/**
* @brief ElementFactory::createElement
* @param location create element at this location
* @param qgi parent item for this elemnt
* @param state state of the creation
* @return the element or 0
*/
@brief ElementFactory::createElement
@param location create element at this location
@param qgi parent item for this elemnt
@param state state of the creation
@return the element or 0
*/
Element * ElementFactory::createElement(const ElementsLocation &location, QGraphicsItem *qgi, int *state)
{
if (Q_UNLIKELY( !(location.isElement() && location.exist()) ))

View File

@@ -25,12 +25,11 @@ class ElementsLocation;
class QGraphicsItem;
/**
* @brief The ElementFactory class
*this class is a pattern factory and also a singleton factory.
*this class create new instance of herited class element like
*simple element or report element.
*
*/
@brief The ElementFactory class
this class is a pattern factory and also a singleton factory.
this class create new instance of herited class element like
simple element or report element.
*/
class ElementFactory
{
//methods for singleton pattern

View File

@@ -32,13 +32,13 @@
ElementPictureFactory* ElementPictureFactory::m_factory = nullptr;
/**
* @brief ElementPictureFactory::getPictures
* Set the picture of the element at location.
* Note, picture can be null
* @param location
* @param picture
* @param low_picture
*/
@brief ElementPictureFactory::getPictures
Set the picture of the element at location.
Note, picture can be null
@param location
@param picture
@param low_picture
*/
void ElementPictureFactory::getPictures(const ElementsLocation &location, QPicture &picture, QPicture &low_picture)
{
if(!location.exist()) {
@@ -68,11 +68,11 @@ void ElementPictureFactory::getPictures(const ElementsLocation &location, QPictu
}
/**
* @brief ElementPictureFactory::pixmap
* @param location
* @return the pixmap of the element at @location
* Note pixmap can be null
*/
@brief ElementPictureFactory::pixmap
@param location
@return the pixmap of the element at @location
Note pixmap can be null
*/
QPixmap ElementPictureFactory::pixmap(const ElementsLocation &location)
{
QUuid uuid = location.uuid();
@@ -113,10 +113,10 @@ QPixmap ElementPictureFactory::pixmap(const ElementsLocation &location)
/**
* @brief ElementPictureFactory::getPrimitives
* @param location
* @return The primtive used to draw the element at @location
*/
@brief ElementPictureFactory::getPrimitives
@param location
@return The primtive used to draw the element at @location
*/
ElementPictureFactory::primitives ElementPictureFactory::getPrimitives(const ElementsLocation &location)
{
if(!m_primitives_H.contains(location.uuid()))
@@ -132,15 +132,15 @@ ElementPictureFactory::~ElementPictureFactory() {
}
/**
* @brief ElementPictureFactory::build
* Build the picture from location.
* @param location
* @param picture
* @param low_picture
* if @picture and/or @low_picture are not null this function draw on it and don't store it.
* if null, this function create a QPicture for normal and low zoom, draw on it and store it in m_pictures_H and m_low_pictures_H
* @return
*/
@brief ElementPictureFactory::build
Build the picture from location.
@param location
@param picture
@param low_picture
if @picture and/or @low_picture are not null this function draw on it and don't store it.
if null, this function create a QPicture for normal and low zoom, draw on it and store it in m_pictures_H and m_low_pictures_H
@return
*/
bool ElementPictureFactory::build(const ElementsLocation &location, QPicture *picture, QPicture *low_picture)
{
QDomElement dom = location.xml();
@@ -542,11 +542,11 @@ void ElementPictureFactory::parseText(const QDomElement &dom, QPainter &painter,
}
/**
* @brief ElementPictureFactory::setPainterStyle
* apply the style store in dom to painter.
* @param dom
* @param painter
*/
@brief ElementPictureFactory::setPainterStyle
apply the style store in dom to painter.
@param dom
@param painter
*/
void ElementPictureFactory::setPainterStyle(const QDomElement &dom, QPainter &painter) const
{
QPen pen = painter.pen();

View File

@@ -30,10 +30,10 @@ class QPainter;
class QGraphicsSimpleTextItem;
/**
* @brief The ElementPictureFactory class
* This class is singleton factory, use
* to create and get the picture use by elements
*/
@brief The ElementPictureFactory class
This class is singleton factory, use
to create and get the picture use by elements
*/
class ElementPictureFactory
{
public :
@@ -49,9 +49,9 @@ class ElementPictureFactory
/**
* @brief instance
* @return The instance of the factory
*/
@brief instance
@return The instance of the factory
*/
static ElementPictureFactory* instance()
{
static QMutex mutex;
@@ -67,9 +67,9 @@ class ElementPictureFactory
}
/**
* @brief dropInstance
* Drop the instance of factory
*/
@brief dropInstance
Drop the instance of factory
*/
static void dropInstance()
{
static QMutex mutex;

View File

@@ -36,12 +36,12 @@
#include "projectdbmodel.h"
/**
* @brief PropertiesEditorFactory::propertiesEditor
* @param model : the model to be edited
* @param editor : if the properties editor to be created is the same class as @editor, the this function set @item as edited item of @editor and return editor
* @param parent : parent widget of the returned editor
* @return an editor or nullptr
*/
@brief PropertiesEditorFactory::propertiesEditor
@param model : the model to be edited
@param editor : if the properties editor to be created is the same class as @editor, the this function set @item as edited item of @editor and return editor
@param parent : parent widget of the returned editor
@return an editor or nullptr
*/
PropertiesEditorWidget *PropertiesEditorFactory::propertiesEditor(QAbstractItemModel *model, PropertiesEditorWidget *editor, QWidget *parent)
{
Q_UNUSED(model)

View File

@@ -34,11 +34,11 @@ QetGraphicsTableFactory::QetGraphicsTableFactory()
}
/**
* @brief QetGraphicsTableFactory::createAndAddNomenclature
* Open a dialog for ask user the config of the table ,create a nomenclature table
* and add it to diagram @diagram;
* @param diagram
*/
@brief QetGraphicsTableFactory::createAndAddNomenclature
Open a dialog for ask user the config of the table ,create a nomenclature table
and add it to diagram @diagram;
@param diagram
*/
void QetGraphicsTableFactory::createAndAddNomenclature(Diagram *diagram)
{
QScopedPointer<AddTableDialog> d(new AddTableDialog(new ElementQueryWidget(), diagram->views().first()));
@@ -50,11 +50,11 @@ void QetGraphicsTableFactory::createAndAddNomenclature(Diagram *diagram)
}
/**
* @brief QetGraphicsTableFactory::createAndAddSummary
* Open a dialog for ask user the config of the table ,create a summary table
* and add it to diagram @diagram;
* @param diagram
*/
@brief QetGraphicsTableFactory::createAndAddSummary
Open a dialog for ask user the config of the table ,create a summary table
and add it to diagram @diagram;
@param diagram
*/
void QetGraphicsTableFactory::createAndAddSummary(Diagram *diagram)
{
QScopedPointer<AddTableDialog> d(new AddTableDialog(new SummaryQueryWidget(), diagram->views().first()));
@@ -104,14 +104,14 @@ void QetGraphicsTableFactory::create(Diagram *diagram, AddTableDialog *dialog)
}
/**
* @brief QetGraphicsTableFactory::newTable
* Create a new table .
* @param diagram : Diagram where we must add the new table.
* @param dialog : dialog conf, it's used to setup the model.
* @param previous_table : If you know that the new table will have a previous table and you already now the previous table,
* set it now they will improve time needed for creating the new table by avoiding to create a new model.
* @return the new table
*/
@brief QetGraphicsTableFactory::newTable
Create a new table .
@param diagram : Diagram where we must add the new table.
@param dialog : dialog conf, it's used to setup the model.
@param previous_table : If you know that the new table will have a previous table and you already now the previous table,
set it now they will improve time needed for creating the new table by avoiding to create a new model.
@return the new table
*/
QetGraphicsTableItem *QetGraphicsTableFactory::newTable(Diagram *diagram, AddTableDialog *dialog, QetGraphicsTableItem *previous_table)
{
auto table = new QetGraphicsTableItem();

View File

@@ -23,8 +23,8 @@ class QetGraphicsTableItem;
class AddTableDialog;
/**
* @brief The QetGraphicsTableFactory class
*/
@brief The QetGraphicsTableFactory class
*/
class QetGraphicsTableFactory
{
public:

View File

@@ -24,11 +24,11 @@
#include <QFontDialog>
/**
* @brief AddTableDialog::AddTableDialog
* @param content_widget : the widget to display in the "content" tab.
* This dialog take ownership of @content_widget.
* @param parent : parent widget.
*/
@brief AddTableDialog::AddTableDialog
@param content_widget : the widget to display in the "content" tab.
This dialog take ownership of @content_widget.
@param parent : parent widget.
*/
AddTableDialog::AddTableDialog(QWidget *content_widget, QWidget *parent) :
QDialog(parent),
ui(new Ui::AddTableDialog)
@@ -46,57 +46,57 @@ AddTableDialog::AddTableDialog(QWidget *content_widget, QWidget *parent) :
}
/**
* @brief AddTableDialog::~AddNomenclatureDialog
*/
@brief AddTableDialog::~AddNomenclatureDialog
*/
AddTableDialog::~AddTableDialog() {
delete ui;
}
/**
* @brief AddTableDialog::setQueryWidget
* Not implemented yet
* @param widget
*/
@brief AddTableDialog::setQueryWidget
Not implemented yet
@param widget
*/
void AddTableDialog::setQueryWidget(QWidget *widget) {
Q_UNUSED(widget)
}
/**
* @brief AddTableDialog::adjustTableToFolio
* @return
*/
@brief AddTableDialog::adjustTableToFolio
@return
*/
bool AddTableDialog::adjustTableToFolio() const {
return ui->m_adjust_table_size_cb->isChecked();
}
/**
* @brief AddTableDialog::addNewTableToNewDiagram
* @return
*/
@brief AddTableDialog::addNewTableToNewDiagram
@return
*/
bool AddTableDialog::addNewTableToNewDiagram() const {
return ui->m_add_table_and_folio->isChecked();
}
/**
* @brief AddTableDialog::tableName
* @return
*/
@brief AddTableDialog::tableName
@return
*/
QString AddTableDialog::tableName() const {
return ui->m_table_name_le->text();
}
/**
* @brief AddTableDialog::headerMargins
* @return
*/
@brief AddTableDialog::headerMargins
@return
*/
QMargins AddTableDialog::headerMargins() const {
return m_header_margins;
}
/**
* @brief AddTableDialog::headerAlignment
* @return
*/
@brief AddTableDialog::headerAlignment
@return
*/
Qt::Alignment AddTableDialog::headerAlignment() const
{
switch (ui->m_header_alignment_cb->currentIndex()) {
@@ -110,25 +110,25 @@ Qt::Alignment AddTableDialog::headerAlignment() const
}
/**
* @brief AddTableDialog::headerFont
* @return
*/
@brief AddTableDialog::headerFont
@return
*/
QFont AddTableDialog::headerFont() const {
return m_header_font;
}
/**
* @brief AddTableDialog::tableMargins
* @return
*/
@brief AddTableDialog::tableMargins
@return
*/
QMargins AddTableDialog::tableMargins() const {
return m_table_margins;
}
/**
* @brief AddTableDialog::tableAlignment
* @return
*/
@brief AddTableDialog::tableAlignment
@return
*/
Qt::Alignment AddTableDialog::tableAlignment() const
{
switch (ui->m_table_alignment_cb->currentIndex()) {
@@ -142,9 +142,9 @@ Qt::Alignment AddTableDialog::tableAlignment() const
}
/**
* @brief AddTableDialog::tableFont
* @return
*/
@brief AddTableDialog::tableFont
@return
*/
QFont AddTableDialog::tableFont() const {
return m_table_font;
}

View File

@@ -27,13 +27,13 @@ class AddTableDialog;
}
/**
* @brief The AddTableDialog class
* Provide a dialog used to edit the properties of table befor adding to a diagram.
* The main difference betwen this dialog and the widget used to edit the properties of table
* is that the dialog have two extra check box.
* One for adjust the size of the table to diagram
* Second for add new tables on new folios if the table can't fit into diagram
*/
@brief The AddTableDialog class
Provide a dialog used to edit the properties of table befor adding to a diagram.
The main difference betwen this dialog and the widget used to edit the properties of table
is that the dialog have two extra check box.
One for adjust the size of the table to diagram
Second for add new tables on new folios if the table can't fit into diagram
*/
class AddTableDialog : public QDialog
{
Q_OBJECT