Component to show status messages and details, encapsulated so it can be used elsewhere

* originally part of log component
* now independent component

Motivated by Ref T231, Ref T232
This commit is contained in:
Klaus Basan
2018-01-20 17:10:53 +01:00
parent ecf84eebf0
commit 9bbef8cc28
3 changed files with 316 additions and 0 deletions

View File

@@ -0,0 +1,111 @@
/* Copyright (C) 2018
* swift project Community / Contributors
*
* This file is part of swift Project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*/
#include "statusmessagesdetail.h"
#include "ui_statusmessagesdetail.h"
using namespace BlackMisc;
using namespace BlackGui::Menus;
using namespace BlackGui::Views;
namespace BlackGui
{
namespace Components
{
CStatusMessagesDetail::CStatusMessagesDetail(QWidget *parent) :
QFrame(parent),
ui(new Ui::CStatusMessagesDetail)
{
ui->setupUi(this);
connect(ui->tvp_StatusMessages, &CStatusMessageView::objectSelected, ui->form_StatusMessage, &CStatusMessageForm::setVariant);
connect(ui->tvp_StatusMessages, &CStatusMessageView::modelDataChangedDigest, this, &CStatusMessagesDetail::modelDataChangedDigest);
ui->tvp_StatusMessages->setAutoResizeFrequency(3);
ui->tvp_StatusMessages->setCustomMenu(new CMessageMenu(this));
ui->tvp_StatusMessages->menuAddItems(CStatusMessageView::MenuSave);
this->showFilterBar(); // default
}
CStatusMessagesDetail::~CStatusMessagesDetail()
{ }
void CStatusMessagesDetail::appendStatusMessageToList(const CStatusMessage &message, bool resize)
{
if (message.isEmpty()) { return; }
ui->tvp_StatusMessages->insert(message, resize);
this->removeOldest();
}
void CStatusMessagesDetail::appendStatusMessagesToList(const CStatusMessageList &messages, bool resize)
{
if (messages.isEmpty()) { return; }
ui->tvp_StatusMessages->insert(messages, resize);
this->removeOldest();
}
void CStatusMessagesDetail::showDetails(bool details)
{
ui->form_StatusMessage->setVisible(details);
}
void CStatusMessagesDetail::showFilterDialog()
{
ui->tvp_StatusMessages->addFilterDialog();
ui->filter_LogMessages->hide();
}
void CStatusMessagesDetail::showFilterBar()
{
ui->tvp_StatusMessages->setFilterWidget(ui->filter_LogMessages);
ui->filter_LogMessages->show();
}
void CStatusMessagesDetail::clear()
{
ui->tvp_StatusMessages->clear();
ui->form_StatusMessage->clear();
}
int CStatusMessagesDetail::rowCount() const
{
return ui->tvp_StatusMessages->rowCount();
}
void CStatusMessagesDetail::filterUseRadioButtonDescriptiveIcons(bool oneCharacterText)
{
ui->filter_LogMessages->useRadioButtonDescriptiveIcons(oneCharacterText);
}
void CStatusMessagesDetail::removeOldest()
{
// do not remove every time, but when a threshold is reached
if (m_maxLogMessages < 1) { return; }
if (m_maxLogMessages < 100 && ui->tvp_StatusMessages->rowCount() > (m_maxLogMessages + 10))
{
ui->tvp_StatusMessages->keepLatest(m_maxLogMessages);
}
else if (ui->tvp_StatusMessages->rowCount() > (m_maxLogMessages * 1.1))
{
ui->tvp_StatusMessages->keepLatest(m_maxLogMessages);
}
}
void CStatusMessagesDetail::CMessageMenu::customMenu(CMenuActions &menuActions)
{
CStatusMessagesDetail *messagesDetail = qobject_cast<CStatusMessagesDetail *>(this->parent());
Q_ASSERT_X(messagesDetail, Q_FUNC_INFO, "Missing parent");
bool v = messagesDetail->ui->form_StatusMessage->isVisible();
const QString formString(v ? "Hide log details" : "Show log details");
this->m_action = menuActions.addAction(this->m_action, BlackMisc::CIcons::databaseTable16(), formString,
CMenuAction::pathLog(), { messagesDetail->ui->form_StatusMessage, &CStatusMessageForm::toggleVisibility});
this->m_action->setCheckable(true);
this->m_action->setChecked(v);
}
} // ns
} // ns

View File

@@ -0,0 +1,96 @@
/* Copyright (C) 2018
* swift project Community / Contributors
*
* This file is part of swift Project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*/
//! \file
#ifndef BLACKGUI_COMPONENTS_STATUSMESSAGESDETAIL_H
#define BLACKGUI_COMPONENTS_STATUSMESSAGESDETAIL_H
#include "blackgui/menus/menudelegate.h"
#include "blackgui/blackguiexport.h"
#include "blackmisc/statusmessagelist.h"
#include "blackmisc/variant.h"
#include <QFrame>
#include <QObject>
#include <QScopedPointer>
namespace Ui { class CStatusMessagesDetail; }
namespace BlackGui
{
namespace Components
{
//! Status messages plus detail
class BLACKGUI_EXPORT CStatusMessagesDetail : public QFrame
{
Q_OBJECT
public:
//! Constructor
explicit CStatusMessagesDetail(QWidget *parent = nullptr);
//! Destructor
virtual ~CStatusMessagesDetail();
//! Add message
void appendStatusMessageToList(const BlackMisc::CStatusMessage &message, bool resize = true);
//! Add messages
void appendStatusMessagesToList(const BlackMisc::CStatusMessageList &messages, bool resize = true);
//! Show log details
void showDetails(bool details);
//! Show filter dialog and disable bar
void showFilterDialog();
//! Show a filter bar
void showFilterBar();
//! Clear
void clear();
//! Number of status messages in view
int rowCount() const;
//! Set max.log messages
void setMaxLogMessages(int desiredNumber) { m_maxLogMessages = desiredNumber; }
//! \copydoc BlackGui::Filters::CStatusMessageFilterBar::useRadioButtonDescriptiveIcons
void filterUseRadioButtonDescriptiveIcons(bool oneCharacterText);
signals:
//! \copydoc BlackGui::Views::CStatusMessageView::modelDataChangedDigest
void modelDataChangedDigest(int count, bool withFilter);
private:
QScopedPointer<Ui::CStatusMessagesDetail> ui;
int m_maxLogMessages = -1;
//! Remove oldest messages
void removeOldest();
//! Custom menu for the log component
class CMessageMenu : public Menus::IMenuDelegate
{
public:
//! Constructor
CMessageMenu(CStatusMessagesDetail *parent) : IMenuDelegate(parent) {}
//! \copydoc IMenuDelegate::customMenu
virtual void customMenu(Menus::CMenuActions &menuActions) override;
private:
QAction *m_action = nullptr;
};
};
} // ns
} // ns
#endif // guard

View File

@@ -0,0 +1,109 @@
<?xml version="1.0" encoding="UTF-8"?>
<ui version="4.0">
<class>CStatusMessagesDetail</class>
<widget class="QFrame" name="CStatusMessagesDetail">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>640</width>
<height>480</height>
</rect>
</property>
<property name="windowTitle">
<string>Status messages plus details</string>
</property>
<layout class="QVBoxLayout" name="vl_StatusMessages">
<property name="leftMargin">
<number>0</number>
</property>
<property name="topMargin">
<number>0</number>
</property>
<property name="rightMargin">
<number>0</number>
</property>
<property name="bottomMargin">
<number>0</number>
</property>
<item>
<widget class="BlackGui::Filters::CStatusMessageFilterBar" name="filter_LogMessages">
<property name="minimumSize">
<size>
<width>0</width>
<height>30</height>
</size>
</property>
</widget>
</item>
<item>
<widget class="BlackGui::Views::CStatusMessageView" name="tvp_StatusMessages">
<property name="whatsThis">
<string>Status message log view</string>
</property>
<property name="verticalScrollBarPolicy">
<enum>Qt::ScrollBarAlwaysOn</enum>
</property>
<property name="selectionMode">
<enum>QAbstractItemView::SingleSelection</enum>
</property>
<property name="selectionBehavior">
<enum>QAbstractItemView::SelectRows</enum>
</property>
<attribute name="verticalHeaderVisible">
<bool>false</bool>
</attribute>
</widget>
</item>
<item>
<widget class="BlackGui::Components::CStatusMessageForm" name="form_StatusMessage">
<property name="sizePolicy">
<sizepolicy hsizetype="Preferred" vsizetype="Fixed">
<horstretch>0</horstretch>
<verstretch>0</verstretch>
</sizepolicy>
</property>
<property name="minimumSize">
<size>
<width>0</width>
<height>100</height>
</size>
</property>
<property name="maximumSize">
<size>
<width>16777215</width>
<height>100</height>
</size>
</property>
<property name="frameShape">
<enum>QFrame::StyledPanel</enum>
</property>
<property name="frameShadow">
<enum>QFrame::Raised</enum>
</property>
</widget>
</item>
</layout>
</widget>
<customwidgets>
<customwidget>
<class>BlackGui::Views::CStatusMessageView</class>
<extends>QTableView</extends>
<header>blackgui/views/statusmessageview.h</header>
</customwidget>
<customwidget>
<class>BlackGui::Components::CStatusMessageForm</class>
<extends>QFrame</extends>
<header>blackgui/components/statusmessageform.h</header>
<container>1</container>
</customwidget>
<customwidget>
<class>BlackGui::Filters::CStatusMessageFilterBar</class>
<extends>QFrame</extends>
<header>blackgui/filters/statusmessagefilterbar.h</header>
<container>1</container>
</customwidget>
</customwidgets>
<resources/>
<connections/>
</ui>