kotschak/qelectrotech-source-mirror
0
0
Fork 0
mirror of https://github.com/qelectrotech/qelectrotech-source-mirror.git synced 2026-01-06 22:00:52 +01: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

64
sources/ElementsCollection/elementcollectionhandler.cpp
View File

@@ -298,9 +298,9 @@ ElementsLocation ECHSToXml::copy()
/******************************************************/
/**
* @brief ElementCollectionHandler::ElementCollectionHandler
* @param widget
*/
@brief ElementCollectionHandler::ElementCollectionHandler
@param widget
*/
ElementCollectionHandler::ElementCollectionHandler() {}
ElementCollectionHandler::~ElementCollectionHandler()
@@ -309,14 +309,14 @@ ElementCollectionHandler::~ElementCollectionHandler()
}
/**
* @brief ElementCollectionHandler::copy
* Copy the content of collection represented by source to the collection represented by destination.
* Destination must be a directory, else the copy do nothing and return a null ElementLocation
* if destination have an item with the same name of source, a dialog ask to user what to do.
* @param source
* @param destination
* @return
*/
@brief ElementCollectionHandler::copy
Copy the content of collection represented by source to the collection represented by destination.
Destination must be a directory, else the copy do nothing and return a null ElementLocation
if destination have an item with the same name of source, a dialog ask to user what to do.
@param source
@param destination
@return
*/
ElementsLocation ElementCollectionHandler::copy(ElementsLocation &source, ElementsLocation &destination)
{
if (!source.exist() || !destination.exist() || destination.isElement()) return ElementsLocation();
@@ -332,14 +332,14 @@ ElementsLocation ElementCollectionHandler::copy(ElementsLocation &source, Elemen
}
/**
* @brief ElementCollectionHandler::createDir
* Create a directorie with name @name as child of @parent.
* Parent must be a directory
* @param parent : parent of the dir to create
* @param name : name of directorie to create
* @param name_list : translations of the directorie name
* @return : ElementsLocation that represent the new directorie, location can be null if an error was occurred
*/
@brief ElementCollectionHandler::createDir
Create a directorie with name @name as child of @parent.
Parent must be a directory
@param parent : parent of the dir to create
@param name : name of directorie to create
@param name_list : translations of the directorie name
@return : ElementsLocation that represent the new directorie, location can be null if an error was occurred
*/
ElementsLocation ElementCollectionHandler::createDir(ElementsLocation &parent, const QString &name, const NamesList &name_list)
{
//Parent must be a directorie and writable
@@ -393,13 +393,13 @@ ElementsLocation ElementCollectionHandler::createDir(ElementsLocation &parent, c
}
/**
* @brief ElementCollectionHandler::importFromProject
* Import the element represented by @location to the embedded collection of @project at the same path.
* @location must represente an element owned by a project embedded collection
* @param project : project where copy the element
* @param location : location to copy
* @return true if import with success
*/
@brief ElementCollectionHandler::importFromProject
Import the element represented by @location to the embedded collection of @project at the same path.
@location must represente an element owned by a project embedded collection
@param project : project where copy the element
@param location : location to copy
@return true if import with success
*/
bool ElementCollectionHandler::importFromProject(QETProject *project, ElementsLocation &location)
{
if (!(location.isElement() && location.exist() && location.isProject())) return false;
@@ -436,12 +436,12 @@ bool ElementCollectionHandler::importFromProject(QETProject *project, ElementsLo
}
/**
* @brief ElementCollectionHandler::setNames
* Set the names stored in @name_list as the names of the item represented by location
* @param location : location to change the names
* @param name_list : NamesList to use
* @return return true if success
*/
@brief ElementCollectionHandler::setNames
Set the names stored in @name_list as the names of the item represented by location
@param location : location to change the names
@param name_list : NamesList to use
@return return true if success
*/
bool ElementCollectionHandler::setNames(ElementsLocation &location, const NamesList &name_list)
{
if ( !(location.exist() && location.isWritable()) ) {

34
sources/ElementsCollection/elementcollectionhandler.h
View File

@@ -24,9 +24,9 @@
class QWidget;
/**
* @brief The ECHStrategy class
* Abstract class for manage copy of directory or element from a collection to another
*/
@brief The ECHStrategy class
Abstract class for manage copy of directory or element from a collection to another
*/
class ECHStrategy
{
public:
@@ -38,9 +38,9 @@ class ECHStrategy
};
/**
* @brief The ECHSFileToFile class
* Manage the copy of directory or element from a file system collection to another file system collection
*/
@brief The ECHSFileToFile class
Manage the copy of directory or element from a file system collection to another file system collection
*/
class ECHSFileToFile : public ECHStrategy
{
public:
@@ -53,9 +53,9 @@ class ECHSFileToFile : public ECHStrategy
};
/**
* @brief The ECHSXmlToFile class
* Manage the copy of a directory or element from an xml collection to a file.
*/
@brief The ECHSXmlToFile class
Manage the copy of a directory or element from an xml collection to a file.
*/
class ECHSXmlToFile : public ECHStrategy
{
public:
@@ -68,10 +68,10 @@ class ECHSXmlToFile : public ECHStrategy
};
/**
* @brief The ECHSToXml class
* Manage the copy of a directory or element from a collection (no matter if the source is a file system collection or an xml collection)
* to an xml collection
*/
@brief The ECHSToXml class
Manage the copy of a directory or element from a collection (no matter if the source is a file system collection or an xml collection)
to an xml collection
*/
class ECHSToXml : public ECHStrategy
{
public:
@@ -80,10 +80,10 @@ class ECHSToXml : public ECHStrategy
};
/**
* @brief The ElementCollectionHandler class
* Provide several method to copy element or directory from a collection
* to another collection.
*/
@brief The ElementCollectionHandler class
Provide several method to copy element or directory from a collection
to another collection.
*/
class ElementCollectionHandler
{
public:

94
sources/ElementsCollection/elementcollectionitem.cpp
View File

@@ -19,16 +19,16 @@
#include "elementcollectionitem.h"
/**
* @brief ElementCollectionItem::ElementCollectionItem
* Constructor
*/
@brief ElementCollectionItem::ElementCollectionItem
Constructor
*/
ElementCollectionItem::ElementCollectionItem()
{}
/**
* @brief ElementCollectionItem::clearData
* Reset the data
*/
@brief ElementCollectionItem::clearData
Reset the data
*/
void ElementCollectionItem::clearData()
{
setText(QString());
@@ -38,13 +38,13 @@ void ElementCollectionItem::clearData()
}
/**
* @brief ElementCollectionItem::lastItemForPath
* Return the last existing item in this ElementCollectionItem hierarchy according to the given path.
* Next_item is the first non existing item in this hierarchy according to the given path.
* @param path : The path to find last item. The path must be in form : path/otherPath/.../.../myElement.elmt.
* @param no_found_path : The first item that not exist in this hierarchy
* @return : The last item that exist in this hierarchy, or nullptr can't find (an error was occurred, or path already exist)
*/
@brief ElementCollectionItem::lastItemForPath
Return the last existing item in this ElementCollectionItem hierarchy according to the given path.
Next_item is the first non existing item in this hierarchy according to the given path.
@param path : The path to find last item. The path must be in form : path/otherPath/.../.../myElement.elmt.
@param no_found_path : The first item that not exist in this hierarchy
@return : The last item that exist in this hierarchy, or nullptr can't find (an error was occurred, or path already exist)
*/
ElementCollectionItem *ElementCollectionItem::lastItemForPath(const QString &path, QString &no_found_path)
{
QStringList str_list = path.split("/");
@@ -67,11 +67,11 @@ ElementCollectionItem *ElementCollectionItem::lastItemForPath(const QString &pat
}
/**
* @brief ElementCollectionItem::childWithCollectionName
* Return the child with the collection name @name, else return nullptr
* @param name
* @return
*/
@brief ElementCollectionItem::childWithCollectionName
Return the child with the collection name @name, else return nullptr
@param name
@return
*/
ElementCollectionItem *ElementCollectionItem::childWithCollectionName(const QString& name) const
{
rowCount();
@@ -85,10 +85,10 @@ ElementCollectionItem *ElementCollectionItem::childWithCollectionName(const QStr
}
/**
* @brief ElementCollectionItem::directChilds
* Return the direct child of this item
* @return
*/
@brief ElementCollectionItem::directChilds
Return the direct child of this item
@return
*/
QList<QStandardItem *> ElementCollectionItem::directChilds() const
{
QList <QStandardItem *> item_list;
@@ -100,12 +100,12 @@ QList<QStandardItem *> ElementCollectionItem::directChilds() const
}
/**
* @brief ElementCollectionItem::rowForInsertItem
* Return the row for insert a new child item to this item with name @collection_name.
* If row can't be found (collection_name is null, or already exist) return -1;
* @param collection_name
* @return
*/
@brief ElementCollectionItem::rowForInsertItem
Return the row for insert a new child item to this item with name @collection_name.
If row can't be found (collection_name is null, or already exist) return -1;
@param collection_name
@return
*/
int ElementCollectionItem::rowForInsertItem(const QString &name)
{
if (name.isEmpty())
@@ -137,10 +137,10 @@ int ElementCollectionItem::rowForInsertItem(const QString &name)
}
/**
* @brief ElementCollectionItem::itemAtPath
* @param path
* @return the item at path or nullptr if doesn't exist
*/
@brief ElementCollectionItem::itemAtPath
@param path
@return the item at path or nullptr if doesn't exist
*/
ElementCollectionItem *ElementCollectionItem::itemAtPath(const QString &path)
{
QStringList str_list = path.split("/");
@@ -160,9 +160,9 @@ ElementCollectionItem *ElementCollectionItem::itemAtPath(const QString &path)
}
/**
* @brief ElementCollectionItem::elementsDirectChild
* @return The direct element child of this item
*/
@brief ElementCollectionItem::elementsDirectChild
@return The direct element child of this item
*/
QList<ElementCollectionItem *> ElementCollectionItem::elementsDirectChild() const
{
QList <ElementCollectionItem *> element_child;
@@ -177,9 +177,9 @@ QList<ElementCollectionItem *> ElementCollectionItem::elementsDirectChild() cons
}
/**
* @brief ElementCollectionItem::directoriesDirectChild
* @return the direct directory child of this item
*/
@brief ElementCollectionItem::directoriesDirectChild
@return the direct directory child of this item
*/
QList<ElementCollectionItem *> ElementCollectionItem::directoriesDirectChild() const
{
QList <ElementCollectionItem *> dir_child;
@@ -194,9 +194,9 @@ QList<ElementCollectionItem *> ElementCollectionItem::directoriesDirectChild() c
}
/**
* @brief ElementCollectionItem::elementsChild
* @return Every elements child (direct and indirect) of this item
*/
@brief ElementCollectionItem::elementsChild
@return Every elements child (direct and indirect) of this item
*/
QList<ElementCollectionItem *> ElementCollectionItem::elementsChild() const
{
QList <ElementCollectionItem *> list = elementsDirectChild();
@@ -208,9 +208,9 @@ QList<ElementCollectionItem *> ElementCollectionItem::elementsChild() const
}
/**
* @brief ElementCollectionItem::directoriesChild
* @return Every directories child (direct and indirect) of this item
*/
@brief ElementCollectionItem::directoriesChild
@return Every directories child (direct and indirect) of this item
*/
QList<ElementCollectionItem *> ElementCollectionItem::directoriesChild() const
{
QList<ElementCollectionItem *> list = directoriesDirectChild();
@@ -224,9 +224,9 @@ QList<ElementCollectionItem *> ElementCollectionItem::directoriesChild() const
}
/**
* @brief ElementCollectionItem::items
* @return every childs of this item (direct and indirect childs)
*/
@brief ElementCollectionItem::items
@return every childs of this item (direct and indirect childs)
*/
QList<ElementCollectionItem *> ElementCollectionItem::items() const
{
QList <ElementCollectionItem *> list;

10
sources/ElementsCollection/elementcollectionitem.h
View File

@@ -21,11 +21,11 @@
#include <QStandardItem>
/**
* @brief The ElementCollectionItem class
* This class represent a item (a directory or an element) in a element collection.
* This class must be herited for specialisation.
* This item is used by ElementsCollectionModel for manage the elements collection
*/
@brief The ElementCollectionItem class
This class represent a item (a directory or an element) in a element collection.
This class must be herited for specialisation.
This item is used by ElementsCollectionModel for manage the elements collection
*/
class ElementCollectionItem : public QStandardItem
{
public:

18
sources/ElementsCollection/elementscollectionmodel.cpp
View File

@@ -99,15 +99,15 @@ QStringList ElementsCollectionModel::mimeTypes() const
}
/**
* @brief ElementsCollectionModel::canDropMimeData
* Reimplemented from QStandardItemModel
* @param data
* @param action
* @param row
* @param column
* @param parent
* @return
*/
@brief ElementsCollectionModel::canDropMimeData
Reimplemented from QStandardItemModel
@param data
@param action
@param row
@param column
@param parent
@return
*/
bool ElementsCollectionModel::canDropMimeData(const QMimeData *data,
Qt::DropAction action,
int row,

192
sources/ElementsCollection/elementscollectionwidget.cpp
View File

@@ -38,10 +38,10 @@
#include <QTimer>
/**
* @brief ElementsCollectionWidget::ElementsCollectionWidget
* Default constructor.
* @param parent : parent widget of this widget.
*/
@brief ElementsCollectionWidget::ElementsCollectionWidget
Default constructor.
@param parent : parent widget of this widget.
*/
ElementsCollectionWidget::ElementsCollectionWidget(QWidget *parent):
QWidget(parent),
m_model(nullptr)
@@ -66,9 +66,9 @@ ElementsCollectionWidget::ElementsCollectionWidget(QWidget *parent):
}
/**
* @brief ElementsCollectionWidget::expandFirstItems
* Expand each first item in the tree view
*/
@brief ElementsCollectionWidget::expandFirstItems
Expand each first item in the tree view
*/
void ElementsCollectionWidget::expandFirstItems()
{
if (!m_model)
@@ -79,10 +79,10 @@ void ElementsCollectionWidget::expandFirstItems()
}
/**
* @brief ElementsCollectionWidget::addProject
* Add @project to be displayed
* @param project
*/
@brief ElementsCollectionWidget::addProject
Add @project to be displayed
@param project
*/
void ElementsCollectionWidget::addProject(QETProject *project)
{
if (m_model)
@@ -103,10 +103,10 @@ void ElementsCollectionWidget::removeProject(QETProject *project) {
}
/**
* @brief ElementsCollectionWidget::highlightUnusedElement
* highlight the unused element
* @See ElementsCollectionModel::highlightUnusedElement()
*/
@brief ElementsCollectionWidget::highlightUnusedElement
highlight the unused element
@See ElementsCollectionModel::highlightUnusedElement()
*/
void ElementsCollectionWidget::highlightUnusedElement()
{
if (m_model)
@@ -114,10 +114,10 @@ void ElementsCollectionWidget::highlightUnusedElement()
}
/**
* @brief ElementsCollectionWidget::setCurrentLocation
* Set the current item to be the item for @location
* @param location
*/
@brief ElementsCollectionWidget::setCurrentLocation
Set the current item to be the item for @location
@param location
*/
void ElementsCollectionWidget::setCurrentLocation(const ElementsLocation &location)
{
if (!location.exist())
@@ -151,9 +151,9 @@ void ElementsCollectionWidget::setUpAction()
}
/**
* @brief ElementsCollectionWidget::setUpWidget
* Setup this widget
*/
@brief ElementsCollectionWidget::setUpWidget
Setup this widget
*/
void ElementsCollectionWidget::setUpWidget()
{
//Setup the main layout
@@ -188,9 +188,9 @@ void ElementsCollectionWidget::setUpWidget()
}
/**
* @brief ElementsCollectionWidget::setUpConnection
* Setup the connection used in this widget
*/
@brief ElementsCollectionWidget::setUpConnection
Setup the connection used in this widget
*/
void ElementsCollectionWidget::setUpConnection()
{
connect(m_tree_view, &QTreeView::customContextMenuRequested, this, &ElementsCollectionWidget::customContextMenu);
@@ -221,10 +221,10 @@ void ElementsCollectionWidget::setUpConnection()
}
/**
* @brief ElementsCollectionWidget::customContextMenu
* Display the context menu of this widget at @point
* @param point
*/
@brief ElementsCollectionWidget::customContextMenu
Display the context menu of this widget at @point
@param point
*/
void ElementsCollectionWidget::customContextMenu(const QPoint &point)
{
m_index_at_context_menu = m_tree_view->indexAt(point);
@@ -283,9 +283,9 @@ void ElementsCollectionWidget::customContextMenu(const QPoint &point)
}
/**
* @brief ElementsCollectionWidget::openDir
* Open the directory represented by the current selected item
*/
@brief ElementsCollectionWidget::openDir
Open the directory represented by the current selected item
*/
void ElementsCollectionWidget::openDir()
{
ElementCollectionItem *eci = elementCollectionItemForIndex(m_index_at_context_menu);
@@ -309,9 +309,9 @@ void ElementsCollectionWidget::openDir()
}
/**
* @brief ElementsCollectionWidget::editElement
* Edit the element represented by the current selected item
*/
@brief ElementsCollectionWidget::editElement
Edit the element represented by the current selected item
*/
void ElementsCollectionWidget::editElement()
{
ElementCollectionItem *eci = elementCollectionItemForIndex(m_index_at_context_menu);
@@ -328,9 +328,9 @@ void ElementsCollectionWidget::editElement()
}
/**
* @brief ElementsCollectionWidget::deleteElement
* Delete the element represented by the current selected item.
*/
@brief ElementsCollectionWidget::deleteElement
Delete the element represented by the current selected item.
*/
void ElementsCollectionWidget::deleteElement()
{
ElementCollectionItem *eci = elementCollectionItemForIndex(m_index_at_context_menu);
@@ -360,9 +360,9 @@ void ElementsCollectionWidget::deleteElement()
}
/**
* @brief ElementsCollectionWidget::deleteDirectory
* Delete directory represented by the current selected item
*/
@brief ElementsCollectionWidget::deleteDirectory
Delete directory represented by the current selected item
*/
void ElementsCollectionWidget::deleteDirectory()
{
ElementCollectionItem *eci = elementCollectionItemForIndex(m_index_at_context_menu);
@@ -394,9 +394,9 @@ void ElementsCollectionWidget::deleteDirectory()
}
/**
* @brief ElementsCollectionWidget::editDirectory
* Edit the directory represented by the current selected item
*/
@brief ElementsCollectionWidget::editDirectory
Edit the directory represented by the current selected item
*/
void ElementsCollectionWidget::editDirectory()
{
ElementCollectionItem *eci = elementCollectionItemForIndex(m_index_at_context_menu);
@@ -414,9 +414,9 @@ void ElementsCollectionWidget::editDirectory()
}
/**
* @brief ElementsCollectionWidget::newDirectory
* Create a new directory
*/
@brief ElementsCollectionWidget::newDirectory
Create a new directory
*/
void ElementsCollectionWidget::newDirectory()
{
ElementCollectionItem *eci = elementCollectionItemForIndex(m_index_at_context_menu);
@@ -433,9 +433,9 @@ void ElementsCollectionWidget::newDirectory()
}
/**
* @brief ElementsCollectionWidget::newElement
* Create a new element.
*/
@brief ElementsCollectionWidget::newElement
Create a new element.
*/
void ElementsCollectionWidget::newElement()
{
ElementCollectionItem *eci = elementCollectionItemForIndex(m_index_at_context_menu);
@@ -459,9 +459,9 @@ void ElementsCollectionWidget::newElement()
}
/**
* @brief ElementsCollectionWidget::showThisDir
* Hide all directories except the pointed dir;
*/
@brief ElementsCollectionWidget::showThisDir
Hide all directories except the pointed dir;
*/
void ElementsCollectionWidget::showThisDir()
{
//Disable the yellow background of the previous index
@@ -487,10 +487,10 @@ void ElementsCollectionWidget::showThisDir()
}
/**
* @brief ElementsCollectionWidget::resetShowThisDir
* reset show this dir, all collection are show.
* If search field isn't empty, apply the search after show all collection
*/
@brief ElementsCollectionWidget::resetShowThisDir
reset show this dir, all collection are show.
If search field isn't empty, apply the search after show all collection
*/
void ElementsCollectionWidget::resetShowThisDir()
{
if (m_showed_index.isValid())
@@ -505,9 +505,9 @@ void ElementsCollectionWidget::resetShowThisDir()
}
/**
* @brief ElementsCollectionWidget::dirProperties
* Open an informative dialog about the curent index
*/
@brief ElementsCollectionWidget::dirProperties
Open an informative dialog about the curent index
*/
void ElementsCollectionWidget::dirProperties()
{
ElementCollectionItem *eci = elementCollectionItemForIndex(m_index_at_context_menu);
@@ -527,8 +527,8 @@ void ElementsCollectionWidget::dirProperties()
}
/**
* @brief ElementsCollectionWidget::reload, the displayed collections.
*/
@brief ElementsCollectionWidget::reload, the displayed collections.
*/
void ElementsCollectionWidget::reload()
{
m_progress_bar->show();
@@ -554,9 +554,9 @@ void ElementsCollectionWidget::reload()
}
/**
* @brief ElementsCollectionWidget::loadingFinished
* Process when collection finished to be loaded
*/
@brief ElementsCollectionWidget::loadingFinished
Process when collection finished to be loaded
*/
void ElementsCollectionWidget::loadingFinished()
{
if (m_new_model)
@@ -579,11 +579,11 @@ void ElementsCollectionWidget::loadingFinished()
}
/**
* @brief ElementsCollectionWidget::locationWasSaved
* This method is connected with the signal savedToLocation of Element editor (see ElementsCollectionWidget::editElement())
* Update or add the item represented by location to m_model
* @param location
*/
@brief ElementsCollectionWidget::locationWasSaved
This method is connected with the signal savedToLocation of Element editor (see ElementsCollectionWidget::editElement())
Update or add the item represented by location to m_model
@param location
*/
void ElementsCollectionWidget::locationWasSaved(const ElementsLocation& location)
{
//Because this method update an item in the model, location must
@@ -606,10 +606,10 @@ void ElementsCollectionWidget::locationWasSaved(const ElementsLocation& location
}
/**
* @brief ElementsCollectionWidget::search
* Search every item (directory or element) that match the text of m_search_field
* and display it, other item who does not match @text is hidden
*/
@brief ElementsCollectionWidget::search
Search every item (directory or element) that match the text of m_search_field
and display it, other item who does not match @text is hidden
*/
void ElementsCollectionWidget::search()
{
QString text = m_search_field->text();
@@ -655,10 +655,10 @@ void ElementsCollectionWidget::search()
}
/**
* @brief ElementsCollectionWidget::hideCollection
* Hide all collection displayed in this tree
* @param hide- true = hide , false = visible
*/
@brief ElementsCollectionWidget::hideCollection
Hide all collection displayed in this tree
@param hide- true = hide , false = visible
*/
void ElementsCollectionWidget::hideCollection(bool hide)
{
for (int i=0 ; i <m_model->rowCount() ; i++)
@@ -666,12 +666,12 @@ void ElementsCollectionWidget::hideCollection(bool hide)
}
/**
* @brief ElementsCollectionWidget::hideItem
* Hide the item @index. If @recursive is true, hide all subchilds of @index
* @param hide- true = hide , false = visible
* @param index- index to hide
* @param recursive- true = apply to child , false = only for @index
*/
@brief ElementsCollectionWidget::hideItem
Hide the item @index. If @recursive is true, hide all subchilds of @index
@param hide- true = hide , false = visible
@param index- index to hide
@param recursive- true = apply to child , false = only for @index
*/
void ElementsCollectionWidget::hideItem(bool hide, const QModelIndex &index, bool recursive)
{
m_tree_view->setRowHidden(index.row(), index.parent(), hide);
@@ -682,14 +682,14 @@ void ElementsCollectionWidget::hideItem(bool hide, const QModelIndex &index, boo
}
/**
* @brief ElementsCollectionWidget::showAndExpandItem
* Show the item @index and expand it.
* If parent is true, ensure parents of @index is show and expanded
* If child is true, ensure all childs of @index is show and expended
* @param index- index to show
* @param parent- Apply to parent
* @param child- Apply to all childs
*/
@brief ElementsCollectionWidget::showAndExpandItem
Show the item @index and expand it.
If parent is true, ensure parents of @index is show and expanded
If child is true, ensure all childs of @index is show and expended
@param index- index to show
@param parent- Apply to parent
@param child- Apply to all childs
*/
void ElementsCollectionWidget::showAndExpandItem(const QModelIndex &index, bool parent, bool child)
{
if (index.isValid()) {
@@ -702,10 +702,10 @@ void ElementsCollectionWidget::showAndExpandItem(const QModelIndex &index, bool
}
/**
* @brief ElementsCollectionWidget::elementCollectionItemForIndex
* @param index
* @return The internal pointer of index casted to ElementCollectionItem;
*/
@brief ElementsCollectionWidget::elementCollectionItemForIndex
@param index
@return The internal pointer of index casted to ElementCollectionItem;
*/
ElementCollectionItem *ElementsCollectionWidget::elementCollectionItemForIndex(const QModelIndex &index) {
if (!index.isValid())
return nullptr;

10
sources/ElementsCollection/elementscollectionwidget.h
View File

@@ -34,11 +34,11 @@ class QETProject;
class ElementsTreeView;
/**
* @brief The ElementsCollectionWidget class
* This widget embedd a tree view that display the element collection (common, custom, embedded)
* and all action needed to use this widget.
* This is the element collection widget used in the diagram editor.
*/
@brief The ElementsCollectionWidget class
This widget embedd a tree view that display the element collection (common, custom, embedded)
and all action needed to use this widget.
This is the element collection widget used in the diagram editor.
*/
class ElementsCollectionWidget : public QWidget
{
Q_OBJECT

2
sources/ElementsCollection/elementslocation.cpp
View File

@@ -125,7 +125,7 @@ bool ElementsLocation::operator!=(const ElementsLocation &other) const {
this method don't return the extension name.
For exemple if this location represent an element they return myElement.
@see fileName()
*/
*/
QString ElementsLocation::baseName() const {
QRegExp regexp("^.*([^/]+)\\.elmt$");
if (regexp.exactMatch(m_collection_path)) {

22
sources/ElementsCollection/elementstreeview.cpp
View File

@@ -29,18 +29,18 @@ static int MAX_DND_PIXMAP_WIDTH = 500;
static int MAX_DND_PIXMAP_HEIGHT = 375;
/**
* @brief ElementsTreeView::ElementsTreeView
* @param parent
*/
@brief ElementsTreeView::ElementsTreeView
@param parent
*/
ElementsTreeView::ElementsTreeView(QWidget *parent) :
QTreeView(parent)
{}
/**
* @brief ElementsTreeView::startDrag
* Reimplemented from QTreeView
* @param supportedActions
*/
@brief ElementsTreeView::startDrag
Reimplemented from QTreeView
@param supportedActions
*/
void ElementsTreeView::startDrag(Qt::DropActions supportedActions)
{
QModelIndex index = currentIndex();
@@ -63,10 +63,10 @@ void ElementsTreeView::startDrag(Qt::DropActions supportedActions)
}
/**
* @brief ElementsTreeView::startElementDrag
* Build a QDrag according to the content of @location
* @param location : location to use for create the content of the QDrag
*/
@brief ElementsTreeView::startElementDrag
Build a QDrag according to the content of @location
@param location : location to use for create the content of the QDrag
*/
void ElementsTreeView::startElementDrag(const ElementsLocation &location)
{
if (!location.exist())

10
sources/ElementsCollection/elementstreeview.h
View File

@@ -23,11 +23,11 @@
class ElementsLocation;
/**
* @brief The ElementsTreeView class
* This class just reimplement startDrag from QTreeView, for set a custom pixmap.
* This class must be used when the tree view have an ElementsCollectionModel as model.
* The pixmap used is the pixmap of the dragged element or a directory pixmap.
*/
@brief The ElementsTreeView class
This class just reimplement startDrag from QTreeView, for set a custom pixmap.
This class must be used when the tree view have an ElementsCollectionModel as model.
The pixmap used is the pixmap of the dragged element or a directory pixmap.
*/
class ElementsTreeView : public QTreeView
{
public:

8
sources/ElementsCollection/fileelementcollectionitem.h
View File

@@ -22,10 +22,10 @@
#include "elementslocation.h"
/**
* @brief The FileElementCollectionItem class
* This class specialise ElementCollectionItem for manage a collection in
* a file system. They represente a directory or an element.
*/
@brief The FileElementCollectionItem class
This class specialise ElementCollectionItem for manage a collection in
a file system. They represente a directory or an element.
*/
class FileElementCollectionItem : public ElementCollectionItem
{
public:

306
sources/ElementsCollection/xmlelementcollection.cpp
View File

@@ -22,16 +22,16 @@
#include "qetproject.h"
/**
* @brief XmlElementCollection::XmlElementCollection
* Build an empty collection.
* The collection start by :
@brief XmlElementCollection::XmlElementCollection
Build an empty collection.
The collection start by :
* <collection>
* <category name="import>
* </category>
* </collection>
* All elements and category are stored as child of <category name="import>
* @param project : the project of this collection
*/
All elements and category are stored as child of <category name="import>
@param project : the project of this collection
*/
XmlElementCollection::XmlElementCollection(QETProject *project) :
QObject(project),
m_project(project)
@@ -71,11 +71,11 @@ XmlElementCollection::XmlElementCollection(QETProject *project) :
}
/**
* @brief XmlElementCollection::XmlElementCollection
* Constructor with an collection. The tagName of @dom_element must be "collection"
* @param dom_element -the collection in a dom_element (the dom element in cloned)
* @param project : the project of this collection
*/
@brief XmlElementCollection::XmlElementCollection
Constructor with an collection. The tagName of @dom_element must be "collection"
@param dom_element -the collection in a dom_element (the dom element in cloned)
@param project : the project of this collection
*/
XmlElementCollection::XmlElementCollection(const QDomElement &dom_element, QETProject *project) :
QObject(project),
m_project(project)
@@ -87,29 +87,29 @@ XmlElementCollection::XmlElementCollection(const QDomElement &dom_element, QETPr
}
/**
* @brief XmlElementCollection::root
* The root is the first DOM-Element the xml collection, the tag name
* of the dom element is : collection
* @return The root QDomElement of the collection
*/
@brief XmlElementCollection::root
The root is the first DOM-Element the xml collection, the tag name
of the dom element is : collection
@return The root QDomElement of the collection
*/
QDomElement XmlElementCollection::root() const {
return m_dom_document.documentElement();
}
/**
* @brief XmlElementCollection::importCategory
* @return The QDomElement import (the begining of a xml collection) or
* a null QDomElement if doesn't exist.
*/
@brief XmlElementCollection::importCategory
@return The QDomElement import (the begining of a xml collection) or
a null QDomElement if doesn't exist.
*/
QDomElement XmlElementCollection::importCategory() const {
return root().firstChildElement("category");
}
/**
* @brief XmlElementCollection::childs
* @param parent_element
* @return All childs element in the @parent_element tree
*/
@brief XmlElementCollection::childs
@param parent_element
@return All childs element in the @parent_element tree
*/
QDomNodeList XmlElementCollection::childs(const QDomElement &parent_element) const
{
if (parent_element.ownerDocument() != m_dom_document) return QDomNodeList();
@@ -117,14 +117,14 @@ QDomNodeList XmlElementCollection::childs(const QDomElement &parent_element) con
}
/**
* @brief XmlElementCollection::child
* If parent_element have child element with an attribute name = @child_name, return it, else return a null QDomElement.
* Only search for element with tag-name "category" and "element" (if child_name end with ".elmt")
* @param parent_element : the parent DomElement where we search for child.
* @parent_element must be a child node of this XmlElementCollection.
* @param child_name : name of child to search.
* @return The child QDomElement or a null QDomElement if not found
*/
@brief XmlElementCollection::child
If parent_element have child element with an attribute name = @child_name, return it, else return a null QDomElement.
Only search for element with tag-name "category" and "element" (if child_name end with ".elmt")
@param parent_element : the parent DomElement where we search for child.
@parent_element must be a child node of this XmlElementCollection.
@param child_name : name of child to search.
@return The child QDomElement or a null QDomElement if not found
*/
QDomElement XmlElementCollection::child(const QDomElement &parent_element, const QString &child_name) const
{
if (parent_element.ownerDocument() != m_dom_document) return QDomElement();
@@ -149,10 +149,10 @@ QDomElement XmlElementCollection::child(const QDomElement &parent_element, const
}
/**
* @brief XmlElementCollection::child
* @param path
* @return the DomElement at path if exist, else return a null QDomElement
*/
@brief XmlElementCollection::child
@param path
@return the DomElement at path if exist, else return a null QDomElement
*/
QDomElement XmlElementCollection::child(const QString &path) const
{
QStringList path_list = path.split("/");
@@ -173,10 +173,10 @@ QDomElement XmlElementCollection::child(const QString &path) const
}
/**
* @brief XmlElementCollection::directories
* @param parent_element
* @return A list of directory stored in @parent_element
*/
@brief XmlElementCollection::directories
@param parent_element
@return A list of directory stored in @parent_element
*/
QList<QDomElement> XmlElementCollection::directories(const QDomElement &parent_element) const
{
QList <QDomElement> directory_list;
@@ -194,10 +194,10 @@ QList<QDomElement> XmlElementCollection::directories(const QDomElement &parent_e
}
/**
* @brief XmlElementCollection::directoriesNames
* @param parent_element
* @return a list of names for every child directories of @parent_element
*/
@brief XmlElementCollection::directoriesNames
@param parent_element
@return a list of names for every child directories of @parent_element
*/
QStringList XmlElementCollection::directoriesNames(const QDomElement &parent_element) const
{
QList <QDomElement> childs = directories(parent_element);
@@ -214,10 +214,10 @@ QStringList XmlElementCollection::directoriesNames(const QDomElement &parent_ele
}
/**
* @brief XmlElementCollection::elements
* @param parent_element
* @return A list of element stored in @parent_element
*/
@brief XmlElementCollection::elements
@param parent_element
@return A list of element stored in @parent_element
*/
QList<QDomElement> XmlElementCollection::elements(const QDomElement &parent_element) const
{
QList <QDomElement> element_list;
@@ -235,10 +235,10 @@ QList<QDomElement> XmlElementCollection::elements(const QDomElement &parent_elem
}
/**
* @brief XmlElementCollection::elementsNames
* @param parent_element
* @return A list of names fr every childs element of @parent_element
*/
@brief XmlElementCollection::elementsNames
@param parent_element
@return A list of names fr every childs element of @parent_element
*/
QStringList XmlElementCollection::elementsNames(const QDomElement &parent_element) const
{
QList <QDomElement> childs = elements(parent_element);
@@ -255,11 +255,11 @@ QStringList XmlElementCollection::elementsNames(const QDomElement &parent_elemen
}
/**
* @brief XmlElementCollection::element
* @param path : path of the element in this collection
* @return the QDomElement that represent the element at path @path
* or a null QDomElement if not found or doesn't represent an element
*/
@brief XmlElementCollection::element
@param path : path of the element in this collection
@return the QDomElement that represent the element at path @path
or a null QDomElement if not found or doesn't represent an element
*/
QDomElement XmlElementCollection::element(const QString &path) const
{
if (!path.endsWith(".elmt")) return QDomElement();
@@ -273,11 +273,11 @@ QDomElement XmlElementCollection::element(const QString &path) const
}
/**
* @brief XmlElementCollection::directory
* @param path : path of the directory in this collection
* @return the QDomElement that represent the directory at path @path
* or a null QDomElement if not found.
*/
@brief XmlElementCollection::directory
@param path : path of the directory in this collection
@return the QDomElement that represent the directory at path @path
or a null QDomElement if not found.
*/
QDomElement XmlElementCollection::directory(const QString &path) const
{
QDomElement directory = child(path);
@@ -289,15 +289,15 @@ QDomElement XmlElementCollection::directory(const QString &path) const
}
/**
* @brief XmlElementCollection::addElement
* Add the element at location to this collection.
* The element is copied in this collection in "import" dir with the same path, in other word
* if the path is dir1/dir2/dir3/myElement.elmt, myElement is copied to this collection at the path : import/dir1/dir2/dir3/myElement.elmt
* If the path doesn't exist, he was created.
* If the element already exist, do nothing.
* @param location, location of the element
* @return the collection path of the added item or a null QString if element can't be added.
*/
@brief XmlElementCollection::addElement
Add the element at location to this collection.
The element is copied in this collection in "import" dir with the same path, in other word
if the path is dir1/dir2/dir3/myElement.elmt, myElement is copied to this collection at the path : import/dir1/dir2/dir3/myElement.elmt
If the path doesn't exist, he was created.
If the element already exist, do nothing.
@param location, location of the element
@return the collection path of the added item or a null QString if element can't be added.
*/
QString XmlElementCollection::addElement(ElementsLocation &location)
{
//location must be an element and exist
@@ -423,15 +423,15 @@ QString XmlElementCollection::addElement(ElementsLocation &location)
}
/**
* @brief XmlElementCollection::addElementDefinition
* Add the élément defintion @xml_definition in the directory at path @dir_path with the name @elmt_name.
* @param dir_path : the path of the directory where we must add the element.
* The path must be an existing directory of this collection.
* @param elmt_name : The name used to store the element (the name must end with .elmt, if not, .elmt will be append to @elmt_name)
* @param xml_definition : The xml definition of the element.
* The tag name of @xml_definition must be "definition".
* @return True if the element is added with success.
*/
@brief XmlElementCollection::addElementDefinition
Add the élément defintion @xml_definition in the directory at path @dir_path with the name @elmt_name.
@param dir_path : the path of the directory where we must add the element.
The path must be an existing directory of this collection.
@param elmt_name : The name used to store the element (the name must end with .elmt, if not, .elmt will be append to @elmt_name)
@param xml_definition : The xml definition of the element.
The tag name of @xml_definition must be "definition".
@return True if the element is added with success.
*/
bool XmlElementCollection::addElementDefinition(const QString &dir_path, const QString &elmt_name, const QDomElement &xml_definition)
{
QDomElement dom_dir = directory(dir_path);
@@ -461,12 +461,12 @@ bool XmlElementCollection::addElementDefinition(const QString &dir_path, const Q
}
/**
* @brief XmlElementCollection::removeElement
* Remove the element at path @path.
* @param path
* @return True if element is removed and emit the signal elementRemoved.
* else false.
*/
@brief XmlElementCollection::removeElement
Remove the element at path @path.
@param path
@return True if element is removed and emit the signal elementRemoved.
else false.
*/
bool XmlElementCollection::removeElement(const QString& path)
{
QDomElement elmt = element(path);
@@ -481,16 +481,16 @@ bool XmlElementCollection::removeElement(const QString& path)
}
/**
* @brief XmlElementCollection::copy
* Copy the content represented by source (an element or a directory) to destination.
* Destination must be a directory of this collection.
* If the destination already have an item at the same path of source, he will be replaced by source.
* @param source : content to copy
* @param destination : destination of the copy, must be a directory of this collection
* @param rename : rename the copy with @rename else use the name of source
* @param deep_copy : if true copy all childs of source (only if source is directory)
* @return the ElementLocation that represent the copy, if copy failed return a null ElementLocation
*/
@brief XmlElementCollection::copy
Copy the content represented by source (an element or a directory) to destination.
Destination must be a directory of this collection.
If the destination already have an item at the same path of source, he will be replaced by source.
@param source : content to copy
@param destination : destination of the copy, must be a directory of this collection
@param rename : rename the copy with @rename else use the name of source
@param deep_copy : if true copy all childs of source (only if source is directory)
@return the ElementLocation that represent the copy, if copy failed return a null ElementLocation
*/
ElementsLocation XmlElementCollection::copy(ElementsLocation &source, ElementsLocation &destination, const QString& rename, bool deep_copy)
{
if (!(source.exist() && destination.isDirectory() && destination.isProject() && destination.projectCollection() == this))
@@ -503,11 +503,11 @@ ElementsLocation XmlElementCollection::copy(ElementsLocation &source, ElementsLo
}
/**
* @brief XmlElementCollection::exist
* Return true if the path @path exist in this collection
* @param path
* @return
*/
@brief XmlElementCollection::exist
Return true if the path @path exist in this collection
@param path
@return
*/
bool XmlElementCollection::exist(const QString &path) const
{
if (child(path).isNull())
@@ -517,14 +517,14 @@ bool XmlElementCollection::exist(const QString &path) const
}
/**
* @brief XmlElementCollection::createDir
* Create a child directorie at path @path with the name @name.
* Emit directorieAdded if success.
* @param path : path of parent diectorie
* @param name : name of the directori to create.
* @param name_list : translation of the directorie name.
* @return true if creation success, if directorie already exist return true.
*/
@brief XmlElementCollection::createDir
Create a child directorie at path @path with the name @name.
Emit directorieAdded if success.
@param path : path of parent diectorie
@param name : name of the directori to create.
@param name_list : translation of the directorie name.
@return true if creation success, if directorie already exist return true.
*/
bool XmlElementCollection::createDir(const QString& path, const QString& name, const NamesList &name_list)
{
QString new_dir_path = path + "/" + name;
@@ -551,12 +551,12 @@ bool XmlElementCollection::createDir(const QString& path, const QString& name, c
}
/**
* @brief XmlElementCollection::removeDir
* Remove the directory at path @path.
* @param path
* @return true if successfuly removed and emit directoryRemoved(QString),
* else false.
*/
@brief XmlElementCollection::removeDir
Remove the directory at path @path.
@param path
@return true if successfuly removed and emit directoryRemoved(QString),
else false.
*/
bool XmlElementCollection::removeDir(const QString& path)
{
QDomElement dir = directory(path);
@@ -569,14 +569,14 @@ bool XmlElementCollection::removeDir(const QString& path)
}
/**
* @brief XmlElementCollection::elementsLocation
* Return all locations stored in dom_element (element and directory).
* If dom_element is null, return all location owned by this collection
* dom_element must be a child of this collection.
* @param dom_element : dom_element where we must to search location.
* @param childs = if true return all childs location of dom_element, if false, only return the direct childs location of dom_element.
* @return
*/
@brief XmlElementCollection::elementsLocation
Return all locations stored in dom_element (element and directory).
If dom_element is null, return all location owned by this collection
dom_element must be a child of this collection.
@param dom_element : dom_element where we must to search location.
@param childs = if true return all childs location of dom_element, if false, only return the direct childs location of dom_element.
@return
*/
QList<ElementsLocation> XmlElementCollection::elementsLocation(QDomElement dom_element, bool childs) const
{
QList <ElementsLocation> location_list;
@@ -612,13 +612,13 @@ QList<ElementsLocation> XmlElementCollection::elementsLocation(QDomElement dom_e
}
/**
* @brief XmlElementCollection::domToLocation
* Return the element location who represent the xml element : dom_element
* dom_element must be owned by this collection
* @param dom_element : the dom_element of this collection that represent an element.
* The tag name of dom_element must be "element"
* @return the element location, location can be null if fail.
*/
@brief XmlElementCollection::domToLocation
Return the element location who represent the xml element : dom_element
dom_element must be owned by this collection
@param dom_element : the dom_element of this collection that represent an element.
The tag name of dom_element must be "element"
@return the element location, location can be null if fail.
*/
ElementsLocation XmlElementCollection::domToLocation(QDomElement dom_element) const
{
if (dom_element.ownerDocument() == m_dom_document) {
@@ -638,9 +638,9 @@ ElementsLocation XmlElementCollection::domToLocation(QDomElement dom_element) co
}
/**
* @brief XmlElementCollection::cleanUnusedElement
* Remove elements in this collection which is not used in the owner project
*/
@brief XmlElementCollection::cleanUnusedElement
Remove elements in this collection which is not used in the owner project
*/
void XmlElementCollection::cleanUnusedElement()
{
foreach (ElementsLocation loc, m_project->unusedElements())
@@ -648,9 +648,9 @@ void XmlElementCollection::cleanUnusedElement()
}
/**
* @brief XmlElementCollection::cleanUnusedDirectory
* Remove the empty directories of this collection
*/
@brief XmlElementCollection::cleanUnusedDirectory
Remove the empty directories of this collection
*/
void XmlElementCollection::cleanUnusedDirectory()
{
QDomNodeList lst = importCategory().elementsByTagName("category");
@@ -666,15 +666,15 @@ void XmlElementCollection::cleanUnusedDirectory()
}
/**
* @brief XmlElementCollection::copyDirectory
* Copy the directory represented by source to destination.
* if destination have a directory with the same name as source, then this directory is removed
* @param source : directory to copy
* @param destination : destination of the copy
* @param rename : rename the copy with @rename else use the name of source
* @param deep_copy :if true copy all childs of source
* @return the ElementLocation that represent the copy, if copy failed return a null ElementLocation
*/
@brief XmlElementCollection::copyDirectory
Copy the directory represented by source to destination.
if destination have a directory with the same name as source, then this directory is removed
@param source : directory to copy
@param destination : destination of the copy
@param rename : rename the copy with @rename else use the name of source
@param deep_copy :if true copy all childs of source
@return the ElementLocation that represent the copy, if copy failed return a null ElementLocation
*/
ElementsLocation XmlElementCollection::copyDirectory(ElementsLocation &source, ElementsLocation &destination, const QString& rename, bool deep_copy)
{
QString new_dir_name = rename.isEmpty() ? source.fileName() : rename;
@@ -754,14 +754,14 @@ ElementsLocation XmlElementCollection::copyDirectory(ElementsLocation &source, E
}
/**
* @brief XmlElementCollection::copyElement
* Copy the element represented by source to destination (must be a directory)
* If element already exist in destination he will be replaced by the new.
* @param source : element to copy
* @param destination : destination of the copy
* @param rename : rename the copy with @rename else use the name of source
* @return The ElementsLocation of the copy
*/
@brief XmlElementCollection::copyElement
Copy the element represented by source to destination (must be a directory)
If element already exist in destination he will be replaced by the new.
@param source : element to copy
@param destination : destination of the copy
@param rename : rename the copy with @rename else use the name of source
@return The ElementsLocation of the copy
*/
ElementsLocation XmlElementCollection::copyElement(ElementsLocation &source, ElementsLocation &destination, const QString& rename)
{
QString new_elmt_name = rename.isEmpty() ? source.fileName() : rename;

46
sources/ElementsCollection/xmlelementcollection.h
View File

@@ -27,9 +27,9 @@ class QFile;
class QETProject;
/**
* @brief The XmlElementCollection class
* This class represent a collection of elements stored to xml
*/
@brief The XmlElementCollection class
This class represent a collection of elements stored to xml
*/
class XmlElementCollection : public QObject
{
Q_OBJECT
@@ -68,34 +68,34 @@ class XmlElementCollection : public QObject
signals:
/**
* @brief elementAdded
* This signal is emited when a element is added to this collection
* @param collection_path, the path of element in this collection
*/
@brief elementAdded
This signal is emited when a element is added to this collection
@param collection_path, the path of element in this collection
*/
void elementAdded(QString collection_path);
/**
* @brief elementChanged
* This signal is emited when the defintion of the element at path was changed
* @param collection_path, the path of this element in this collection
*/
@brief elementChanged
This signal is emited when the defintion of the element at path was changed
@param collection_path, the path of this element in this collection
*/
void elementChanged (QString collection_path);
/**
* @brief elementRemoved
* This signal is emited when an element is removed to this collection
* @param collection_path, the path of the removed element in this collection
*/
@brief elementRemoved
This signal is emited when an element is removed to this collection
@param collection_path, the path of the removed element in this collection
*/
void elementRemoved(QString collection_path);
/**
* @brief directorieAdded
* This signal is emited when a directorie is added to this collection
* @param collection_path, the path of the new directorie
*/
@brief directorieAdded
This signal is emited when a directorie is added to this collection
@param collection_path, the path of the new directorie
*/
void directorieAdded(QString collection_path);
/**
* @brief directoryRemoved
* This signal is emited when a directory is removed to this collection
* @param collection_path, the path of the removed directory
*/
@brief directoryRemoved
This signal is emited when a directory is removed to this collection
@param collection_path, the path of the removed directory
*/
void directoryRemoved(QString collection_path);
private:

112
sources/ElementsCollection/xmlprojectelementcollectionitem.cpp
View File

@@ -21,16 +21,16 @@
#include "xmlprojectelementcollectionitem.h"
/**
* @brief XmlProjectElementCollectionItem::XmlProjectElementCollectionItem
* Constructor
*/
@brief XmlProjectElementCollectionItem::XmlProjectElementCollectionItem
Constructor
*/
XmlProjectElementCollectionItem::XmlProjectElementCollectionItem()
{}
/**
* @brief XmlProjectElementCollectionItem::isDir
* @return true if this item represent a directory
*/
@brief XmlProjectElementCollectionItem::isDir
@return true if this item represent a directory
*/
bool XmlProjectElementCollectionItem::isDir() const
{
if (m_dom_element.tagName() == "category") return true;
@@ -38,9 +38,9 @@ bool XmlProjectElementCollectionItem::isDir() const
}
/**
* @brief XmlProjectElementCollectionItem::isElement
* @return true if this item represent an element
*/
@brief XmlProjectElementCollectionItem::isElement
@return true if this item represent an element
*/
bool XmlProjectElementCollectionItem::isElement() const
{
if (m_dom_element.tagName() == "element") return true;
@@ -48,9 +48,9 @@ bool XmlProjectElementCollectionItem::isElement() const
}
/**
* @brief XmlProjectElementCollectionItem::localName
* @return the located name of this item
*/
@brief XmlProjectElementCollectionItem::localName
@return the located name of this item
*/
QString XmlProjectElementCollectionItem::localName()
{
if (!text().isNull())
@@ -71,18 +71,18 @@ QString XmlProjectElementCollectionItem::localName()
}
/**
* @brief XmlProjectElementCollectionItem::name
* @return The collection name of this item
*/
@brief XmlProjectElementCollectionItem::name
@return The collection name of this item
*/
QString XmlProjectElementCollectionItem::name() const
{
return m_dom_element.attribute("name");
}
/**
* @brief XmlProjectElementCollectionItem::collectionPath
* @return The path of this item relative to the collection.
*/
@brief XmlProjectElementCollectionItem::collectionPath
@return The path of this item relative to the collection.
*/
QString XmlProjectElementCollectionItem::collectionPath() const
{
ElementsLocation loc (embeddedPath(), m_project);
@@ -93,10 +93,10 @@ QString XmlProjectElementCollectionItem::collectionPath() const
}
/**
* @brief XmlProjectElementCollectionItem::embeddedPath
* @return The embedde path of this item
* The path is in form : embed://dir/subdir/myElement.elmt
*/
@brief XmlProjectElementCollectionItem::embeddedPath
@return The embedde path of this item
The path is in form : embed://dir/subdir/myElement.elmt
*/
QString XmlProjectElementCollectionItem::embeddedPath() const
{
if (isCollectionRoot())
@@ -114,9 +114,9 @@ QString XmlProjectElementCollectionItem::embeddedPath() const
}
/**
* @brief XmlProjectElementCollectionItem::isCollectionRoot
* @return true if this item represent the root of collection
*/
@brief XmlProjectElementCollectionItem::isCollectionRoot
@return true if this item represent the root of collection
*/
bool XmlProjectElementCollectionItem::isCollectionRoot() const
{
if (!parent())
@@ -128,11 +128,11 @@ bool XmlProjectElementCollectionItem::isCollectionRoot() const
}
/**
* @brief XmlProjectElementCollectionItem::addChildAtPath
* Ask to this item item to add a new child with collection name @collection_name
* (the child must exist in the xml element collection)
* @param collection_name : name of the child item to add.
*/
@brief XmlProjectElementCollectionItem::addChildAtPath
Ask to this item item to add a new child with collection name @collection_name
(the child must exist in the xml element collection)
@param collection_name : name of the child item to add.
*/
void XmlProjectElementCollectionItem::addChildAtPath(const QString &collection_name)
{
if (collection_name.isEmpty())
@@ -155,21 +155,21 @@ void XmlProjectElementCollectionItem::addChildAtPath(const QString &collection_n
}
/**
* @brief XmlProjectElementCollectionItem::project
* @return the paretn project of the managed collection
*/
@brief XmlProjectElementCollectionItem::project
@return the paretn project of the managed collection
*/
QETProject *XmlProjectElementCollectionItem::project() const
{
return m_project;
}
/**
* @brief XmlProjectElementCollectionItem::setProject
* Set the project for this item.
* Use this method for set this item the root of the collection
* @param project : project to manage the collection
* @param set_data : if true, call setUpData for every child of this item
*/
@brief XmlProjectElementCollectionItem::setProject
Set the project for this item.
Use this method for set this item the root of the collection
@param project : project to manage the collection
@param set_data : if true, call setUpData for every child of this item
*/
void XmlProjectElementCollectionItem::setProject(QETProject *project, bool set_data, bool hide_element)
{
if (m_project)
@@ -181,9 +181,9 @@ void XmlProjectElementCollectionItem::setProject(QETProject *project, bool set_d
}
/**
* @brief XmlProjectElementCollectionItem::setUpData
* SetUp the data of this item
*/
@brief XmlProjectElementCollectionItem::setUpData
SetUp the data of this item
*/
void XmlProjectElementCollectionItem::setUpData()
{
//Setup the displayed name
@@ -212,10 +212,10 @@ void XmlProjectElementCollectionItem::setUpData()
}
/**
* @brief XmlProjectElementCollectionItem::setUpIcon
* SetUp the icon of this item.
* Because icon use several memory, we use this method for setup icon instead setUpData.
*/
@brief XmlProjectElementCollectionItem::setUpIcon
SetUp the icon of this item.
Because icon use several memory, we use this method for setup icon instead setUpData.
*/
void XmlProjectElementCollectionItem::setUpIcon()
{
if (!icon().isNull())
@@ -232,10 +232,10 @@ void XmlProjectElementCollectionItem::setUpIcon()
}
/**
* @brief XmlProjectElementCollectionItem::populate
* Create the childs of this item
* @param set_data : if true, call setUpData for every child of this item
*/
@brief XmlProjectElementCollectionItem::populate
Create the childs of this item
@param set_data : if true, call setUpData for every child of this item
*/
void XmlProjectElementCollectionItem::populate(bool set_data, bool hide_element)
{
QList <QDomElement> dom_category = m_project->embeddedElementCollection()->directories(m_dom_element);
@@ -267,12 +267,12 @@ void XmlProjectElementCollectionItem::populate(bool set_data, bool hide_element)
}
/**
* @brief XmlProjectElementCollectionItem::setXmlElement
* Set the managed content of this item
* @param element : the dom element (directory or element), to be managed by this item
* @param project : the parent project of managed collection
* @param set_data : if true, call setUpData for every child of this item
*/
@brief XmlProjectElementCollectionItem::setXmlElement
Set the managed content of this item
@param element : the dom element (directory or element), to be managed by this item
@param project : the parent project of managed collection
@param set_data : if true, call setUpData for every child of this item
*/
void XmlProjectElementCollectionItem::setXmlElement(const QDomElement& element, QETProject *project, bool set_data, bool hide_element)
{
m_dom_element = element;

6
sources/ElementsCollection/xmlprojectelementcollectionitem.h
View File

@@ -24,9 +24,9 @@
class QETProject;
/**
* @brief The XmlProjectElementCollectionItem class
* This class specialise ElementCollectionItem for manage an xml collection embedded in a project.
*/
@brief The XmlProjectElementCollectionItem class
This class specialise ElementCollectionItem for manage an xml collection embedded in a project.
*/
class XmlProjectElementCollectionItem : public ElementCollectionItem
{
public: