mirror of
https://github.com/qelectrotech/qelectrotech-source-mirror.git
synced 2025-12-17 20:50:34 +01:00
Mod doc set style de same
This commit is contained in:
@@ -24,20 +24,22 @@
|
||||
#include <QDir>
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::FileElementCollectionItem
|
||||
* Constructor
|
||||
@brief FileElementCollectionItem::FileElementCollectionItem
|
||||
Constructor
|
||||
*/
|
||||
FileElementCollectionItem::FileElementCollectionItem()
|
||||
{}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::setRootPath
|
||||
* Set path has root path for this file item.
|
||||
* Use this function only to set the beginning of a file collection.
|
||||
* @param path
|
||||
* @return true if path exist.
|
||||
@brief FileElementCollectionItem::setRootPath
|
||||
Set path has root path for this file item.
|
||||
Use this function only to set the beginning of a file collection.
|
||||
@param path
|
||||
@return true if path exist.
|
||||
*/
|
||||
bool FileElementCollectionItem::setRootPath(const QString& path, bool set_data, bool hide_element)
|
||||
bool FileElementCollectionItem::setRootPath(const QString& path,
|
||||
bool set_data,
|
||||
bool hide_element)
|
||||
{
|
||||
QDir dir(path);
|
||||
if (dir.exists())
|
||||
@@ -51,8 +53,8 @@ bool FileElementCollectionItem::setRootPath(const QString& path, bool set_data,
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::fileSystemPath
|
||||
* @return the file system path of this item
|
||||
@brief FileElementCollectionItem::fileSystemPath
|
||||
@return the file system path of this item
|
||||
*/
|
||||
QString FileElementCollectionItem::fileSystemPath() const
|
||||
{
|
||||
@@ -63,13 +65,13 @@ QString FileElementCollectionItem::fileSystemPath() const
|
||||
if (feci)
|
||||
return feci->fileSystemPath() + "/" + m_path;
|
||||
else
|
||||
return QString();
|
||||
return QString();//Null string
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::dirPath
|
||||
* @return the dir path of this item (if this item is a dir return the path,
|
||||
* if item is an element return the path of the parent directory)
|
||||
@brief FileElementCollectionItem::dirPath
|
||||
@return the dir path of this item (if this item is a dir return the path,
|
||||
if item is an element return the path of the parent directory)
|
||||
*/
|
||||
QString FileElementCollectionItem::dirPath() const
|
||||
{
|
||||
@@ -78,12 +80,12 @@ QString FileElementCollectionItem::dirPath() const
|
||||
else if (parent() && parent()->type() == FileElementCollectionItem::Type)
|
||||
return static_cast<FileElementCollectionItem*>(parent())->fileSystemPath();
|
||||
else
|
||||
return QString();
|
||||
return QString();//Null string
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::isDir
|
||||
* @return true if this item represent a directory
|
||||
@brief FileElementCollectionItem::isDir
|
||||
@return true if this item represent a directory
|
||||
*/
|
||||
bool FileElementCollectionItem::isDir() const
|
||||
{
|
||||
@@ -95,8 +97,8 @@ bool FileElementCollectionItem::isDir() const
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::isElement
|
||||
* @return true if this item represent an element
|
||||
@brief FileElementCollectionItem::isElement
|
||||
@return true if this item represent an element
|
||||
*/
|
||||
bool FileElementCollectionItem::isElement() const
|
||||
{
|
||||
@@ -104,8 +106,8 @@ bool FileElementCollectionItem::isElement() const
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::localName
|
||||
* @return the located name of this item
|
||||
@brief FileElementCollectionItem::localName
|
||||
@return the located name of this item
|
||||
*/
|
||||
QString FileElementCollectionItem::localName()
|
||||
{
|
||||
@@ -145,10 +147,11 @@ QString FileElementCollectionItem::localName()
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::localName
|
||||
* Surcharged method, unlike the default method, avoid to create an elementLocation and so, gain time.
|
||||
* @param location
|
||||
* @return
|
||||
@brief FileElementCollectionItem::localName
|
||||
Surcharged method, unlike the default method,
|
||||
avoid to create an elementLocation and so, gain time.
|
||||
@param location
|
||||
@return
|
||||
*/
|
||||
QString FileElementCollectionItem::localName(const ElementsLocation &location)
|
||||
{
|
||||
@@ -166,8 +169,8 @@ QString FileElementCollectionItem::localName(const ElementsLocation &location)
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::name
|
||||
* @return The collection name of this item
|
||||
@brief FileElementCollectionItem::name
|
||||
@return The collection name of this item
|
||||
*/
|
||||
QString FileElementCollectionItem::name() const
|
||||
{
|
||||
@@ -178,8 +181,8 @@ QString FileElementCollectionItem::name() const
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::collectionPath
|
||||
* @return The path of this item relative to the collection.
|
||||
@brief FileElementCollectionItem::collectionPath
|
||||
@return The path of this item relative to the collection.
|
||||
*/
|
||||
QString FileElementCollectionItem::collectionPath() const
|
||||
{
|
||||
@@ -201,8 +204,8 @@ QString FileElementCollectionItem::collectionPath() const
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::isCollectionRoot
|
||||
* @return true if this item represent the root of collection
|
||||
@brief FileElementCollectionItem::isCollectionRoot
|
||||
@return true if this item represent the root of collection
|
||||
*/
|
||||
bool FileElementCollectionItem::isCollectionRoot() const
|
||||
{
|
||||
@@ -213,8 +216,8 @@ bool FileElementCollectionItem::isCollectionRoot() const
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::isCommonCollection
|
||||
* @return True if this item represent the common collection
|
||||
@brief FileElementCollectionItem::isCommonCollection
|
||||
@return True if this item represent the common collection
|
||||
*/
|
||||
bool FileElementCollectionItem::isCommonCollection() const
|
||||
{
|
||||
@@ -222,8 +225,8 @@ bool FileElementCollectionItem::isCommonCollection() const
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::isCustomCollection
|
||||
* @return True if this item represent the custom collection
|
||||
@brief FileElementCollectionItem::isCustomCollection
|
||||
@return True if this item represent the custom collection
|
||||
*/
|
||||
bool FileElementCollectionItem::isCustomCollection() const
|
||||
{
|
||||
@@ -231,9 +234,10 @@ bool FileElementCollectionItem::isCustomCollection() const
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::addChildAtPath
|
||||
* Ask to this item item to add a child with collection name @collection_name
|
||||
* @param collection_name
|
||||
@brief FileElementCollectionItem::addChildAtPath
|
||||
Ask to this item item to add a child
|
||||
with collection name @collection_name
|
||||
@param collection_name
|
||||
*/
|
||||
void FileElementCollectionItem::addChildAtPath(const QString &collection_name)
|
||||
{
|
||||
@@ -247,8 +251,8 @@ void FileElementCollectionItem::addChildAtPath(const QString &collection_name)
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::setUpData
|
||||
* SetUp the data of this item
|
||||
@brief FileElementCollectionItem::setUpData
|
||||
SetUp the data of this item
|
||||
*/
|
||||
void FileElementCollectionItem::setUpData()
|
||||
{
|
||||
@@ -277,9 +281,10 @@ void FileElementCollectionItem::setUpData()
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::setUpIcon
|
||||
* SetUp the icon of this item.
|
||||
* Because icon use several memory, we use this method for setup icon instead setUpData.
|
||||
@brief FileElementCollectionItem::setUpIcon
|
||||
SetUp the icon of this item.
|
||||
Because icon use several memory,
|
||||
we use this method for setup icon instead setUpData.
|
||||
*/
|
||||
void FileElementCollectionItem::setUpIcon()
|
||||
{
|
||||
@@ -304,13 +309,18 @@ void FileElementCollectionItem::setUpIcon()
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::setPathName
|
||||
* Set the name of this item in the file system path.
|
||||
* This item must have a parent, because they should be a child item of another.
|
||||
* For create a new file collection see setRootPath.
|
||||
* @param path_name
|
||||
@brief FileElementCollectionItem::setPathName
|
||||
Set the name of this item in the file system path.
|
||||
This item must have a parent,
|
||||
because they should be a child item of another.
|
||||
For create a new file collection see setRootPath.
|
||||
@param path_name
|
||||
@param set_data
|
||||
@param hide_element
|
||||
*/
|
||||
void FileElementCollectionItem::setPathName(const QString& path_name, bool set_data, bool hide_element)
|
||||
void FileElementCollectionItem::setPathName(const QString& path_name,
|
||||
bool set_data,
|
||||
bool hide_element)
|
||||
{
|
||||
m_path = path_name;
|
||||
|
||||
@@ -320,9 +330,10 @@ void FileElementCollectionItem::setPathName(const QString& path_name, bool set_d
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief FileElementCollectionItem::populate
|
||||
* Create the childs of this item
|
||||
* @param set_data : if true, call setUpData for every child of this item
|
||||
@brief FileElementCollectionItem::populate
|
||||
Create the childs of this item
|
||||
@param set_data : if true, call setUpData for every child of this item
|
||||
@param hide_element
|
||||
*/
|
||||
void FileElementCollectionItem::populate(bool set_data, bool hide_element)
|
||||
{
|
||||
|
||||
@@ -21,8 +21,9 @@
|
||||
#include "elementspanel.h"
|
||||
|
||||
/**
|
||||
This class embeds an elements panel under a toolbar providing various actions
|
||||
to manage elements.
|
||||
@brief The ElementsPanelWidget class
|
||||
This class embeds an elements panel under a toolbar
|
||||
providing various actions to manage elements.
|
||||
@see ElementsPanel
|
||||
*/
|
||||
class ElementsPanelWidget : public QWidget {
|
||||
@@ -93,6 +94,7 @@ class ElementsPanelWidget : public QWidget {
|
||||
};
|
||||
|
||||
/**
|
||||
@brief ElementsPanelWidget::elementsPanel
|
||||
@return The elements panel embedded within this widget.
|
||||
*/
|
||||
inline ElementsPanel &ElementsPanelWidget::elementsPanel() const {
|
||||
|
||||
Reference in New Issue
Block a user