/*
Copyright 2006-2021 The QElectroTech Team
This file is part of QElectroTech.
QElectroTech is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
QElectroTech is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with QElectroTech. If not, see .
*/
#include "elementscollectionwidget.h"
#include "../editor/ui/qetelementeditor.h"
#include "../elementscategoryeditor.h"
#include "../newelementwizard.h"
#include "../qetapp.h"
#include "../qetdiagrameditor.h"
#include "../qeticons.h"
#include "../qetmessagebox.h"
#include "../qetproject.h"
#include "elementcollectionitem.h"
#include "elementscollectionmodel.h"
#include "elementslocation.h"
#include "elementstreeview.h"
#include "fileelementcollectionitem.h"
#include "xmlprojectelementcollectionitem.h"
#include
#include
#include
#include
#include
#include
#include
#include
#include
/**
@brief ElementsCollectionWidget::ElementsCollectionWidget
Default constructor.
@param parent : parent widget of this widget.
*/
ElementsCollectionWidget::ElementsCollectionWidget(QWidget *parent):
QWidget(parent),
m_model(nullptr)
{
//The connection in the method ElementsCollectionWidget::reload
//return a warning message at compilation :
//**********
//QObject::connect: Cannot queue arguments of type 'QVector'
//(Make sure 'QVector' is registered using qRegisterMetaType().)
//**********
//Register meta type has recommended by the message.
qRegisterMetaType>();
setUpWidget();
setUpAction();
setUpConnection();
//Timer is used to avoid launching a new search for each letter typed by user
//Timer is started or restarted at every time user type a new letter.
//When the timer emit timeout, we start the search.
m_search_timer.setInterval(500);
m_search_timer.setSingleShot(true);
}
/**
@brief ElementsCollectionWidget::expandFirstItems
Expand each first item in the tree view
*/
void ElementsCollectionWidget::expandFirstItems()
{
if (!m_model)
return;
for (int i=0; i < m_model->rowCount() ; i++)
showAndExpandItem(m_model->index(i, 0), false);
}
/**
@brief ElementsCollectionWidget::addProject
Add project to be displayed
@param project
*/
void ElementsCollectionWidget::addProject(QETProject *project)
{
if (m_model)
{
m_progress_bar->show();
m_tree_view->setDisabled(true);
QList prj; prj.append(project);
m_model->loadCollections(false,false, prj);
}
else {
m_waiting_project.append(project);
}
}
void ElementsCollectionWidget::removeProject(QETProject *project) {
if (m_model)
m_model->removeProject(project);
}
/**
@brief ElementsCollectionWidget::highlightUnusedElement
highlight the unused element
@see ElementsCollectionModel::highlightUnusedElement()
*/
void ElementsCollectionWidget::highlightUnusedElement()
{
if (m_model)
m_model->highlightUnusedElement();
}
/**
@brief ElementsCollectionWidget::setCurrentLocation
Set the current item to be the item for location
@param location
*/
void ElementsCollectionWidget::setCurrentLocation(
const ElementsLocation &location)
{
if (!location.exist())
return;
if (m_model)
m_tree_view->setCurrentIndex(
m_model->indexFromLocation(location));
}
void ElementsCollectionWidget::leaveEvent(QEvent *event)
{
if (QETDiagramEditor *qde = QETApp::diagramEditorAncestorOf(this))
qde->statusBar()->clearMessage();
QWidget::leaveEvent(event);
}
void ElementsCollectionWidget::setUpAction()
{
m_open_dir = new QAction(QET::Icons::FolderOpen,
tr("Ouvrir le dossier correspondant"), this);
m_edit_element = new QAction(QET::Icons::ElementEdit,
tr("Éditer l'élément"), this);
m_delete_element = new QAction(QET::Icons::ElementDelete,
tr("Supprimer l'élément"), this);
m_delete_dir = new QAction(QET::Icons::FolderDelete,
tr("Supprimer le dossier"), this);
m_reload = new QAction(QET::Icons::ViewRefresh,
tr("Recharger les collections"), this);
m_edit_dir = new QAction(QET::Icons::FolderEdit,
tr("Éditer le dossier"), this);
m_new_directory = new QAction(QET::Icons::FolderNew,
tr("Nouveau dossier"), this);
m_new_element = new QAction(QET::Icons::ElementNew,
tr("Nouvel élément"), this);
m_show_this_dir = new QAction(QET::Icons::FolderOnlyThis,
tr("Afficher uniquement ce dossier"),
this);
m_show_all_dir = new QAction(QET::Icons::FolderShowAll,
tr("Afficher tous les dossiers"), this);
m_dir_propertie = new QAction(QET::Icons::FolderProperties,
tr("Propriété du dossier"), this);
}
/**
@brief ElementsCollectionWidget::setUpWidget
Setup this widget
*/
void ElementsCollectionWidget::setUpWidget()
{
//Setup the main layout
m_main_vlayout = new QVBoxLayout(this);
this->setLayout(m_main_vlayout);
m_search_field = new QLineEdit(this);
m_search_field->setPlaceholderText(tr("Rechercher"));
m_search_field->setClearButtonEnabled(true);
m_main_vlayout->addWidget(m_search_field);
//Setup the tree view
m_tree_view = new ElementsTreeView(this);
m_tree_view->setHeaderHidden(true);
m_tree_view->setIconSize(QSize(50, 50));
m_tree_view->setDragDropMode(QAbstractItemView::DragDrop);
m_tree_view->setContextMenuPolicy(Qt::CustomContextMenu);
m_tree_view->setAutoExpandDelay(500);
m_tree_view->setAnimated(true);
m_tree_view->setMouseTracking(true);
m_tree_view->setVerticalScrollMode(QAbstractItemView::ScrollPerPixel);
m_main_vlayout->addWidget(m_tree_view);
//Setup the progress bar
m_progress_bar = new QProgressBar(this);
m_progress_bar->setFormat(QObject::tr("chargement %p% (%v sur %m)"));
m_main_vlayout->addWidget(m_progress_bar);
m_progress_bar->hide();
m_context_menu = new QMenu(this);
}
/**
@brief ElementsCollectionWidget::setUpConnection
Setup the connection used in this widget
*/
void ElementsCollectionWidget::setUpConnection()
{
connect(m_tree_view, &QTreeView::customContextMenuRequested,
this, &ElementsCollectionWidget::customContextMenu);
connect(m_search_field, &QLineEdit::textEdited,
[this]() {m_search_timer.start();});
connect(&m_search_timer, &QTimer::timeout,
this, &ElementsCollectionWidget::search);
connect(m_open_dir, &QAction::triggered,
this, &ElementsCollectionWidget::openDir);
connect(m_edit_element, &QAction::triggered,
this, &ElementsCollectionWidget::editElement);
connect(m_delete_element, &QAction::triggered,
this, &ElementsCollectionWidget::deleteElement);
connect(m_delete_dir, &QAction::triggered,
this, &ElementsCollectionWidget::deleteDirectory);
connect(m_reload, &QAction::triggered,
this, &ElementsCollectionWidget::reload);
connect(m_edit_dir, &QAction::triggered,
this, &ElementsCollectionWidget::editDirectory);
connect(m_new_directory, &QAction::triggered,
this, &ElementsCollectionWidget::newDirectory);
connect(m_new_element, &QAction::triggered,
this, &ElementsCollectionWidget::newElement);
connect(m_show_this_dir, &QAction::triggered,
this, &ElementsCollectionWidget::showThisDir);
connect(m_show_all_dir, &QAction::triggered,
this, &ElementsCollectionWidget::resetShowThisDir);
connect(m_dir_propertie, &QAction::triggered,
this, &ElementsCollectionWidget::dirProperties);
connect(m_tree_view, &QTreeView::doubleClicked,
[this](const QModelIndex &index)
{
this->m_index_at_context_menu = index ;
this->editElement();
});
connect(m_tree_view, &QTreeView::entered,
[this] (const QModelIndex &index) {
QETDiagramEditor *qde = QETApp::diagramEditorAncestorOf(this);
ElementCollectionItem *eci = elementCollectionItemForIndex(index);
if (qde && eci)
qde->statusBar()->showMessage(eci->localName());
});
}
/**
@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);
if (!m_index_at_context_menu.isValid()) return;
m_context_menu->clear();
ElementCollectionItem *eci = elementCollectionItemForIndex(
m_index_at_context_menu);
bool add_open_dir = false;
if (eci->isElement())
m_context_menu->addAction(m_edit_element);
if (eci->type() == FileElementCollectionItem::Type)
{
add_open_dir = true;
FileElementCollectionItem *feci =
static_cast(eci);
if (!feci->isCommonCollection())
{
if (feci->isDir())
{
m_context_menu->addAction(m_new_element);
m_context_menu->addAction(m_new_directory);
if (!feci->isCollectionRoot())
{
m_context_menu->addAction(m_edit_dir);
m_context_menu->addAction(m_delete_dir);
}
}
else
m_context_menu->addAction(m_delete_element);
}
}
if (eci->type() == XmlProjectElementCollectionItem::Type)
{
XmlProjectElementCollectionItem *xpeci =
static_cast(eci);
if (xpeci->isCollectionRoot())
add_open_dir = true;
}
m_context_menu->addSeparator();
if (eci->isDir())
{
m_context_menu->addAction(m_show_this_dir);
//there is a current filtered dir, add entry to reset it
if (m_showed_index.isValid())
m_context_menu->addAction(m_show_all_dir);
m_context_menu->addAction(m_dir_propertie);
}
if (add_open_dir)
m_context_menu->addAction(m_open_dir);
m_context_menu->addAction(m_reload);
m_context_menu->popup(mapToGlobal(m_tree_view->mapToParent(point)));
}
/**
@brief ElementsCollectionWidget::openDir
Open the directory represented by the current selected item
*/
void ElementsCollectionWidget::openDir()
{
ElementCollectionItem *eci =
elementCollectionItemForIndex(m_index_at_context_menu);
if (!eci) return;
if (eci->type() == FileElementCollectionItem::Type)
#ifdef Q_OS_LINUX
QDesktopServices::openUrl(static_cast(eci)->dirPath());
#else
QDesktopServices::openUrl(QUrl("file:///" + static_cast(eci)->dirPath()));
#endif
else if (eci->type() == XmlProjectElementCollectionItem::Type)
#ifdef Q_OS_LINUX
QDesktopServices::openUrl(static_cast(eci)->project()->currentDir());
#else
QDesktopServices::openUrl(QUrl("file:///" + static_cast(eci)->project()->currentDir()));
#endif
}
/**
@brief ElementsCollectionWidget::editElement
Edit the element represented by the current selected item
*/
void ElementsCollectionWidget::editElement()
{
ElementCollectionItem *eci = elementCollectionItemForIndex(m_index_at_context_menu);
if ( !(eci && eci->isElement()) ) return;
ElementsLocation location(eci->collectionPath());
QETApp *app = QETApp::instance();
app->openElementLocations(QList() << location);
foreach (QETElementEditor *element_editor, app->elementEditors())
connect(element_editor,
&QETElementEditor::saveToLocation,
this,
&ElementsCollectionWidget::locationWasSaved);
}
/**
@brief ElementsCollectionWidget::deleteElement
Delete the element represented by the current selected item.
*/
void ElementsCollectionWidget::deleteElement()
{
ElementCollectionItem *eci = elementCollectionItemForIndex(
m_index_at_context_menu);
if (!eci) return;
ElementsLocation loc(eci->collectionPath());
if (! (loc.isElement()
&& loc.exist()
&& loc.isFileSystem()
&& loc.collectionPath().startsWith("custom://")) ) return;
if (QET::QetMessageBox::question(
this,
tr("Supprimer l'élément ?", "message box title"),
tr("Êtes-vous sûr de vouloir supprimer cet élément ?\n",
"message box content"),
QMessageBox::Yes | QMessageBox::No) == QMessageBox::Yes)
{
QFile file(loc.fileSystemPath());
if (file.remove())
{
m_model->removeRows(m_index_at_context_menu.row(),
1,
m_index_at_context_menu.parent());
}
else
{
QET::QetMessageBox::warning(
this,
tr("Suppression de l'élément",
"message box title"),
tr("La suppression de l'élément a échoué.",
"message box content"));
}
}
}
/**
@brief ElementsCollectionWidget::deleteDirectory
Delete directory represented by the current selected item
*/
void ElementsCollectionWidget::deleteDirectory()
{
ElementCollectionItem *eci = elementCollectionItemForIndex(
m_index_at_context_menu);
if (!eci) return;
ElementsLocation loc (eci->collectionPath());
if (! (loc.isDirectory()
&& loc.exist()
&& loc.isFileSystem()
&& loc.collectionPath().startsWith("custom://")) ) return;
if (QET::QetMessageBox::question(
this,
tr("Supprimer le dossier?", "message box title"),
tr("Êtes-vous sûr de vouloir supprimer le dossier ?\n"
"Tout les éléments et les dossier contenus dans ce dossier seront supprimés.",
"message box content"),
QMessageBox::Yes | QMessageBox::No) == QMessageBox::Yes)
{
QDir dir (loc.fileSystemPath());
if (dir.removeRecursively())
{
m_model->removeRows(m_index_at_context_menu.row(),
1,
m_index_at_context_menu.parent());
}
else
{
QET::QetMessageBox::warning(
this,
tr("Suppression du dossier",
"message box title"),
tr("La suppression du dossier a échoué.",
"message box content"));
}
}
}
/**
@brief ElementsCollectionWidget::editDirectory
Edit the directory represented by the current selected item
*/
void ElementsCollectionWidget::editDirectory()
{
ElementCollectionItem *eci = elementCollectionItemForIndex(
m_index_at_context_menu);
if (eci->type() != FileElementCollectionItem::Type) return;
FileElementCollectionItem *feci =
static_cast(eci);
if(feci->isCommonCollection()) return;
ElementsLocation location(feci->collectionPath());
ElementsCategoryEditor ece(location, true, this);
if (ece.exec() == QDialog::Accepted)
eci->clearData();
}
/**
@brief ElementsCollectionWidget::newDirectory
Create a new directory
*/
void ElementsCollectionWidget::newDirectory()
{
ElementCollectionItem *eci = elementCollectionItemForIndex(
m_index_at_context_menu);
if (eci->type() != FileElementCollectionItem::Type) return;
FileElementCollectionItem *feci =
static_cast(eci);
if(feci->isCommonCollection()) return;
ElementsLocation location(feci->collectionPath());
ElementsCategoryEditor new_dir_editor(location, false, this);
if (new_dir_editor.exec() == QDialog::Accepted)
m_model->addLocation(new_dir_editor.createdLocation());
}
/**
@brief ElementsCollectionWidget::newElement
Create a new element.
*/
void ElementsCollectionWidget::newElement()
{
ElementCollectionItem *eci = elementCollectionItemForIndex(
m_index_at_context_menu);
if (eci->type() != FileElementCollectionItem::Type) {
return;
}
FileElementCollectionItem *feci =
static_cast(eci);
if(feci->isCommonCollection()) {
return;
}
NewElementWizard elmt_wizard(this);
ElementsLocation loc(feci->collectionPath());
elmt_wizard.preselectedLocation(loc);
elmt_wizard.exec();
foreach (QETElementEditor *element_editor,
QETApp::instance()->elementEditors())
connect(element_editor,
&QETElementEditor::saveToLocation,
this,
&ElementsCollectionWidget::locationWasSaved);
}
/**
@brief ElementsCollectionWidget::showThisDir
Hide all directories except the pointed dir;
*/
void ElementsCollectionWidget::showThisDir()
{
//Disable the yellow background of the previous index
if (m_showed_index.isValid())
{
ElementCollectionItem *eci =
elementCollectionItemForIndex(m_showed_index);
if (eci)
eci->setBackground(QBrush());
}
m_showed_index = m_index_at_context_menu;
if (m_showed_index.isValid())
{
hideCollection(true);
showAndExpandItem(m_showed_index, true, true);
ElementCollectionItem *eci =
elementCollectionItemForIndex(m_showed_index);
if (eci)
eci->setBackground(QBrush(QColor(255, 204, 0, 255)));
search();
}
else
resetShowThisDir();
}
/**
@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())
{
ElementCollectionItem *eci = elementCollectionItemForIndex(
m_showed_index);
if (eci)
eci->setBackground(QBrush());
}
m_showed_index = QModelIndex();
search();
}
/**
@brief ElementsCollectionWidget::dirProperties
Open an informative dialog about the curent index
*/
void ElementsCollectionWidget::dirProperties()
{
ElementCollectionItem *eci = elementCollectionItemForIndex(
m_index_at_context_menu);
if (eci && eci->isDir()) {
QString txt1 = tr("Le dossier %1 contient").arg(
eci->localName());
QString txt2 = tr("%n élément(s), répartie(s)",
"",
eci->elementsChild().size());
QString txt3 = tr("dans %n dossier(s).",
"" ,
eci->directoriesChild().size());
QString txt4 = tr("Chemin de la collection : %1").arg(
eci->collectionPath());
QString txt5;
if (eci->type() == FileElementCollectionItem::Type) {
txt5 = tr("Chemin dans le système de fichiers : %1")
.arg(static_cast(eci)->fileSystemPath());
}
QMessageBox::information(
this,
tr("Propriété du dossier %1").arg(eci->localName()),
txt1 + " " + txt2 + " " + txt3 + "\n\n" + txt4 + "\n" + txt5);
}
}
/**
@brief ElementsCollectionWidget::reload, the displayed collections.
*/
void ElementsCollectionWidget::reload()
{
qInfo()<<"Elements collection reload";
m_progress_bar->show();
// Force to repaint now,
// else progress bar will be not displayed immediately
m_progress_bar->setValue(1);
m_tree_view->setDisabled(true);
// Force to repaint now,
// else tree view will be not disabled immediately
m_tree_view->repaint();
QList project_list;
project_list.append(m_waiting_project);
m_waiting_project.clear();
if (m_model)
project_list.append(m_model->project());
if(m_new_model) {
m_new_model->deleteLater();
}
m_new_model = new ElementsCollectionModel(m_tree_view);
connect(m_new_model,
&ElementsCollectionModel::loadingProgressRangeChanged,
m_progress_bar,
&QProgressBar::setRange);
connect(m_new_model,
&ElementsCollectionModel::loadingProgressValueChanged,
m_progress_bar,
&QProgressBar::setValue);
connect(m_new_model,
&ElementsCollectionModel::loadingFinished,
this,
&ElementsCollectionWidget::loadingFinished);
m_new_model->loadCollections(true, true, project_list);
}
/**
@brief ElementsCollectionWidget::loadingFinished
Process when collection finished to be loaded
*/
void ElementsCollectionWidget::loadingFinished()
{
if (m_new_model)
{
m_new_model->highlightUnusedElement();
m_tree_view->setModel(m_new_model);
m_index_at_context_menu = QModelIndex();
m_showed_index = QModelIndex();
if (m_model) delete m_model;
m_model = m_new_model;
m_new_model = nullptr;
expandFirstItems();
}
else {
m_model->highlightUnusedElement();
}
m_progress_bar->hide();
m_tree_view->setEnabled(true);
qInfo()<<"Elements collection finished to be loaded";
}
/**
@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
//represente an existing element (in file system of project)
if (!location.exist())
return;
QModelIndex index = m_model->indexFromLocation(location);
if (index.isValid()) {
QStandardItem *item = m_model->itemFromIndex(index);
if (item) {
static_cast(item)->clearData();
static_cast(item)->setUpData();
}
}
else {
m_model->addLocation(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
*/
void ElementsCollectionWidget::search()
{
QString text = m_search_field->text();
//Reset the search
if (text.isEmpty())
{
QModelIndex current_index = m_tree_view->currentIndex();
m_tree_view->reset();
if (m_showed_index.isValid())
{
hideCollection(true);
showAndExpandItem(m_showed_index, true, true);
}
else
expandFirstItems();
//Expand the tree and scroll to the last selected index
if (current_index.isValid())
{
showAndExpandItem(current_index);
m_tree_view->setCurrentIndex(current_index);
m_tree_view->scrollTo(current_index);
}
return;
}
//start the search when text have at least 3 letters.
if (text.count() < 3) {
return;
}
hideCollection(true);
#if QT_VERSION < QT_VERSION_CHECK(5, 14, 0) // ### Qt 6: remove
const QStringList text_list = text.split("+", QString::SkipEmptyParts);
#else
#if TODO_LIST
#pragma message("@TODO remove code for QT 5.14 or later")
#endif
const QStringList text_list = text.split("+", Qt::SkipEmptyParts);
#endif
QModelIndexList match_index;
for (QString txt : text_list) {
match_index << m_model->match(m_showed_index.isValid()
? m_model->index(0,0,m_showed_index)
: m_model->index(0,0),
Qt::UserRole+1,
QVariant(txt),
-1,
Qt::MatchContains
| Qt::MatchRecursive);
}
for(QModelIndex index : match_index)
showAndExpandItem(index);
}
/**
@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 rowCount() ; i++)
hideItem(hide, m_model->index(i, 0), true);
}
/**
@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);
if (recursive)
for (int i=0 ; irowCount(index) ; i++)
hideItem(hide, m_model->index(i, 0, index), recursive);
}
/**
@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()) {
if (parent)
showAndExpandItem(index.parent(), parent);
hideItem(false, index, child);
m_tree_view->expand(index);
}
}
/**
@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;
return static_cast(
m_model->itemFromIndex(index));
}