Differential D7545 Diff 19413 kmymoney/models/securitiesmodel.cpp

Changeset View

Standalone View

View Options

kmymoney/models/securitiesmodel.cpp

  • This file was added.
1​/***************************************************************************
2​ securitiesmodel.cpp
3​ -------------------
4​ copyright : (C) 2017 by Łukasz Wojniłowicz <lukasz.wojnilowicz@gmail.com>
5​ ***************************************************************************/
6​
7​/***************************************************************************
8​ * *
9​ * This program is free software; you can redistribute it and/or modify *
10​ * it under the terms of the GNU General Public License as published by *
11​ * the Free Software Foundation; either version 2 of the License, or *
12​ * (at your option) any later version. *
13​ * *
14​ ***************************************************************************/
15​
16​#include "securitiesmodel.h"
17​
18​// ----------------------------------------------------------------------------
19​// QT Includes
20​
21​#include <QMenu>
22​
23​// ----------------------------------------------------------------------------
24​// KDE Includes
25​
26​#include <KLocalizedString>
27​
28​// ----------------------------------------------------------------------------
29​// Project Includes
30​
31​class SecuritiesModel::Private
32​{
33​public:
34​ Private() : m_file(MyMoneyFile::instance())
35​ {
36​ QVector<Column> columns {
37​ Column::Security, Column::Symbol, Column::Type,
38​ Column::Market, Column::Currency, Column::Fraction
39​ };
40​ foreach (auto const column, columns)
41​ m_columns.append(column);
42​ }
43​
44​ ~Private() {}
45​
46​ void loadSecurity(QStandardItem *node, const MyMoneySecurity &sec)
47​ {
48​ auto itSec = new QStandardItem(sec.name());
49​ node->appendRow(itSec);
50​ itSec->setEditable(false);
51​ setSecurityData(node, itSec->row(), sec, m_columns);
52​ }
53​
54​ void setSecurityData(QStandardItem *node, const int row, const MyMoneySecurity &security, const QList<Column> &columns)
55​ {
56​ QStandardItem *cell;
57​
58​ auto getCell = [&, row](const auto column) {
59​ cell = node->child(row, column); // try to get QStandardItem
60​ if (!cell) { // it may be uninitialized
61​ cell = new QStandardItem; // so create one
62​ node->setChild(row, column, cell); // and add it under the node
63​ cell->setEditable(false); // and don't forget that it's non-editable
64​ }
65​ };
66​
67​ auto colNum = m_columns.indexOf(Column::Security);
68​ if (colNum == -1)
69​ return;
70​
71​ // Security
72​ getCell(colNum);
73​ if (columns.contains(Column::Security)) {
74​ cell->setData(security.name(), Qt::DisplayRole);
75​ cell->setData(security.id(), Qt::UserRole);
76​ }
77​
78​ // Symbol
79​ if (columns.contains(Column::Symbol)) {
80​ colNum = m_columns.indexOf(Column::Symbol);
81​ if (colNum != -1) {
82​ getCell(colNum);
83​ cell->setData(security.tradingSymbol(), Qt::DisplayRole);
84​ }
85​ }
86​
87​ // Type
88​ if (columns.contains(Column::Type)) {
89​ colNum = m_columns.indexOf(Column::Type);
90​ if (colNum != -1) {
91​ getCell(colNum);
92​ cell->setData(security.securityTypeToString(security.securityType()), Qt::DisplayRole);
93​ }
94​ }
95​
96​ // Market
97​ if (columns.contains(Column::Market)) {
98​ colNum = m_columns.indexOf(Column::Market);
99​ if (colNum != -1) {
100​ getCell(colNum);
101​ QString market;
102​ if (security.isCurrency())
103​ market = QLatin1String("ISO 4217");
104​ else
105​ market = security.tradingMarket();
106​ cell->setData(market, Qt::DisplayRole);
107​ }
108​ }
109​
110​ // Currency
111​ if (columns.contains(Column::Currency)) {
112​ colNum = m_columns.indexOf(Column::Currency);
113​ if (colNum != -1) {
114​ getCell(colNum);
115​ MyMoneySecurity tradingCurrency;
116​ if (!security.isCurrency())
117​ tradingCurrency = m_file->security(security.tradingCurrency());
118​ cell->setData(tradingCurrency.tradingSymbol(), Qt::DisplayRole);
119​ }
120​ }
121​
122​ // Fraction
123​ if (columns.contains(Column::Fraction)) {
124​ colNum = m_columns.indexOf(Column::Fraction);
125​ if (colNum != -1) {
126​ getCell(colNum);
127​ cell->setData(QString::number(security.smallestAccountFraction()), Qt::DisplayRole);
128​ }
129​ }
130​ }
131​
132​ QStandardItem *itemFromSecurityId(QStandardItemModel *model, const QString &securityId)
133​ {
134​ const auto itemList = model->match(model->index(0, 0), Qt::UserRole, QVariant(securityId), 1, Qt::MatchFlags(Qt::MatchExactly | Qt::MatchCaseSensitive | Qt::MatchRecursive));
135​ if (!itemList.isEmpty())
136​ return model->itemFromIndex(itemList.first());
137​ return nullptr;
138​ }
139​
140​ MyMoneyFile *m_file;
141​ QList<SecuritiesModel::Column> m_columns;
142​ QStandardItem *m_ndCurrencies;
143​ QStandardItem *m_ndSecurities;
144​};
tbaumgartUnsubmitted
Done

Couldn't you make m_columns a QVector? That would make initialization a lot easier.

tbaumgart: Couldn't you make m_columns a QVector? That would make initialization a lot easier.
wojnilowiczAuthorUnsubmitted
Not Done

No, because m_columns isn't supposed to be fixed length. If length of QVector grows and there is no space immediate after it, then whole QVector needs to be moved to another continuous space.

wojnilowicz: No, because m_columns isn't supposed to be fixed length. If length of QVector grows and there…
145​
146​SecuritiesModel::SecuritiesModel(QObject *parent)
147​ : QStandardItemModel(parent), d(new Private)
148​{
149​ init();
150​}
151​
152​SecuritiesModel::~SecuritiesModel()
153​{
154​ delete d;
155​}
156​
157​void SecuritiesModel::init()
158​{
159​ QStringList headerLabels;
160​ foreach (const auto column, d->m_columns)
161​ headerLabels.append(getHeaderName(column));
162​ setHorizontalHeaderLabels(headerLabels);
163​}
164​
165​void SecuritiesModel::load()
166​{
167​ this->blockSignals(true);
168​
169​ auto rootItem = invisibleRootItem();
170​ auto secList = d->m_file->securityList(); // get all available securities
tbaumgartUnsubmitted
Done

Is the this pointer really needed here?

tbaumgart: Is the **this** pointer really needed here?
wojnilowiczAuthorUnsubmitted
Not Done

It's not.

wojnilowicz: It's not.
171​ d->m_ndSecurities = new QStandardItem(QStringLiteral("Securities"));
172​ d->m_ndSecurities->setEditable(false);
173​ rootItem->appendRow(d->m_ndSecurities);
174​
175​ foreach (const auto sec, secList)
176​ d->loadSecurity(d->m_ndSecurities, sec);
177​
178​ secList = d->m_file->currencyList(); // get all available currencies
179​ d->m_ndCurrencies = new QStandardItem(QStringLiteral("Currencies"));
180​ d->m_ndCurrencies->setEditable(false);
181​ rootItem->appendRow(d->m_ndCurrencies);
182​ foreach (const auto sec, secList)
183​ d->loadSecurity(d->m_ndCurrencies, sec);
184​
185​ this->blockSignals(false);
186​}
187​
188​/**
189​ * Notify the model that an object has been added. An action is performed only if the object is a security.
190​ *
191​ */
192​void SecuritiesModel::slotObjectAdded(MyMoneyFile::notificationObjectT objType, const MyMoneyObject * const obj)
193​{
194​ // check whether change is about security
195​ if (objType != MyMoneyFile::notifySecurity)
196​ return;
197​
198​ // check that we're about to add security
199​ auto sec = dynamic_cast<const MyMoneySecurity * const>(obj);
200​ if (!sec)
201​ return;
202​
203​ auto itSec = d->itemFromSecurityId(this, sec->id());
204​
205​ QStandardItem *node;
206​ if (sec->isCurrency())
207​ node = d->m_ndCurrencies;
208​ else
209​ node = d->m_ndSecurities;
210​
211​ // if security doesn't exist in model then add it
212​ if (!itSec) {
213​ itSec = new QStandardItem(sec->name());
214​ node->appendRow(itSec);
215​ itSec->setEditable(false);
216​ }
217​
218​ d->setSecurityData(node, itSec->row(), *sec, d->m_columns);
219​}
220​
221​/**
222​ * Notify the model that an object has been modified. An action is performed only if the object is a security.
223​ *
224​ */
225​void SecuritiesModel::slotObjectModified(MyMoneyFile::notificationObjectT objType, const MyMoneyObject * const obj)
226​{
227​ if (objType != MyMoneyFile::notifySecurity)
228​ return;
229​
230​ // check that we're about to modify security
231​ auto sec = dynamic_cast<const MyMoneySecurity * const>(obj);
232​ if (!sec)
233​ return;
234​
235​ auto itSec = d->itemFromSecurityId(this, sec->id());
236​
237​ QStandardItem *node;
238​ if (sec->isCurrency())
239​ node = d->m_ndCurrencies;
240​ else
241​ node = d->m_ndSecurities;
242​ d->setSecurityData(node, itSec->row(), *sec, d->m_columns);
243​}
244​
245​/**
246​ * Notify the model that an object has been removed. An action is performed only if the object is an account.
247​ *
248​ */
249​void SecuritiesModel::slotObjectRemoved(MyMoneyFile::notificationObjectT objType, const QString& id)
250​{
251​ if (objType != MyMoneyFile::notifySecurity)
252​ return;
253​
254​ const auto indexList = match(index(0, 0), Qt::UserRole, id, -1, Qt::MatchFlags(Qt::MatchExactly | Qt::MatchRecursive));
255​ foreach (const auto index, indexList)
256​ removeRow(index.row(), index.parent());
257​}
258​
259​auto SecuritiesModel::getColumns()
260​{
261​ return &d->m_columns;
262​}
263​
264​QString SecuritiesModel::getHeaderName(const Column column)
265​{
266​ switch(column) {
267​ case Security:
268​ return i18n("Security");
269​ case Symbol:
270​ return i18n("Symbol");
271​ case Type:
272​ return i18n("Type");
273​ case Market:
274​ return i18n("Market");
275​ case Currency:
276​ return i18n("Currency");
277​ case Fraction:
278​ return i18n("Fraction");
279​ default:
280​ return QString();
281​ }
282​}
283​
284​class SecuritiesFilterProxyModel::Private
285​{
286​public:
287​ Private() :
288​ m_mdlColumns(nullptr),
289​ m_file(MyMoneyFile::instance())
290​ {}
291​
292​ ~Private() {}
293​
294​ QList<SecuritiesModel::Column> *m_mdlColumns;
295​ QList<SecuritiesModel::Column> m_visColumns;
296​
297​ MyMoneyFile *m_file;
298​};
299​
300​SecuritiesFilterProxyModel::SecuritiesFilterProxyModel(QObject *parent, SecuritiesModel *model, const QList<SecuritiesModel::Column> &columns)
301​ : KRecursiveFilterProxyModel(parent), d(new Private)
302​{
303​ setDynamicSortFilter(true);
304​ setFilterKeyColumn(-1);
305​ setSortLocaleAware(true);
306​ setFilterCaseSensitivity(Qt::CaseInsensitive);
307​ setSourceModel(model);
308​ d->m_mdlColumns = model->getColumns();
309​ d->m_visColumns.append(columns);
310​}
311​
312​SecuritiesFilterProxyModel::~SecuritiesFilterProxyModel()
313​{
314​ delete d;
315​}
316​
317​bool SecuritiesFilterProxyModel::filterAcceptsColumn(int source_column, const QModelIndex &source_parent) const
318​{
319​ Q_UNUSED(source_parent)
320​ if (d->m_visColumns.isEmpty() || d->m_visColumns.contains(d->m_mdlColumns->at(source_column)))
321​ return true;
322​ return false;
323​}
324​
325​QList<SecuritiesModel::Column> &SecuritiesFilterProxyModel::getVisibleColumns()
326​{
327​ return d->m_visColumns;
328​}
329​
330​void SecuritiesFilterProxyModel::slotColumnsMenu(const QPoint)
331​{
332​ // construct all hideable columns list
333​ const QList<SecuritiesModel::Column> idColumns {
334​ SecuritiesModel::Symbol, SecuritiesModel::Type,
335​ SecuritiesModel::Market, SecuritiesModel::Currency,
336​ SecuritiesModel::Fraction
337​ };
338​
339​ // create menu
340​ QMenu menu(i18n("Displayed columns"));
341​ QList<QAction *> actions;
342​ foreach (const auto idColumn, idColumns) {
343​ auto a = new QAction(nullptr);
344​ a->setObjectName(QString::number(idColumn));
345​ a->setText(SecuritiesModel::getHeaderName(idColumn));
346​ a->setCheckable(true);
347​ a->setChecked(d->m_visColumns.contains(idColumn));
348​ actions.append(a);
349​ }
350​ menu.addActions(actions);
351​
352​ // execute menu and get result
353​ const auto retAction = menu.exec(QCursor::pos());
354​ if (retAction) {
355​ const auto idColumn = static_cast<SecuritiesModel::Column>(retAction->objectName().toInt());
356​ const auto isChecked = retAction->isChecked();
357​ const auto contains = d->m_visColumns.contains(idColumn);
358​ if (isChecked && !contains) { // column has just been enabled
359​ d->m_visColumns.append(idColumn); // change filtering variable
360​ emit columnToggled(idColumn, true); // emit signal for method to add column to model
361​ invalidate(); // refresh model to reflect recent changes
362​ } else if (!isChecked && contains) { // column has just been disabled
363​ d->m_visColumns.removeOne(idColumn);
364​ emit columnToggled(idColumn, false);
365​ invalidate();
366​ }
367​ }
368​}