maxLibQt
ExportableTableView.cpp
Go to the documentation of this file.
1 /*
2  ExportableTableView
3  https://github.com/mpaperno/maxLibQt
4 
5  COPYRIGHT: (c)2017 Maxim Paperno; All Right Reserved.
6  Contact: http://www.WorldDesign.com/contact
7 
8  LICENSE:
9 
10  Commercial License Usage
11  Licensees holding valid commercial licenses may use this file in
12  accordance with the terms contained in a written agreement between
13  you and the copyright holder.
14 
15  GNU General Public License Usage
16  Alternatively, this file may be used under the terms of the GNU
17  General Public License as published by the Free Software Foundation,
18  either version 3 of the License, or (at your option) any later version.
19 
20  This program is distributed in the hope that it will be useful,
21  but WITHOUT ANY WARRANTY; without even the implied warranty of
22  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23  GNU General Public License for more details.
24 
25  A copy of the GNU General Public License is available at <http://www.gnu.org/licenses/>.
26 */
27 
28 #include "ExportableTableView.h"
29 
30 ExportableTableView::ExportableTableView(QWidget *parent) : QTableView(parent)
31 {
32  setContextMenuPolicy(Qt::CustomContextMenu);
33  setHtmlStyle(getDefaultHtmlStyle());
34  setHtmlTemplate(getDefaultHtmlTemplate());
35 
36  QAction * selAll = new QAction(tr("Select All"), this);
37  selAll->setShortcut(QKeySequence::SelectAll);
38  addAction(selAll);
39 
40  QAction * cpyTab = new QAction(tr("Copy selection as TAB-delimited text"), this);
41  cpyTab->setShortcut(QKeySequence::Copy);
42  cpyTab->setProperty("delim", "\t");
43  addAction(cpyTab);
44 
45  QAction * cpyCsv = new QAction(tr("Copy selection as comma-delimited text (CSV)"), this);
46  cpyCsv->setShortcut(Qt::CTRL + Qt::SHIFT + Qt::Key_C);
47  cpyCsv->setProperty("delim", ", ");
48  addAction(cpyCsv);
49 
50  QAction * cpyPipe = new QAction(tr("Copy selection as pipe-delimited text"), this);
51  cpyPipe->setShortcut(Qt::CTRL + Qt::ALT + Qt::Key_C);
52  cpyPipe->setProperty("delim", " | ");
53  addAction(cpyPipe);
54 
55  QAction * cpyHtml = new QAction(tr("Copy selection as HTML"), this);
56  cpyCsv->setShortcut(Qt::CTRL + Qt::ALT + Qt::SHIFT + Qt::Key_C);
57  cpyHtml->setProperty("delim", "html");
58  addAction(cpyHtml);
59 
60  QAction * saveFile = new QAction(tr("Save selection to file"), this);
61  saveFile->setShortcut(QKeySequence::Save);
62  addAction(saveFile);
63 
64  connect(selAll, &QAction::triggered, this, &QTableView::selectAll);
65  connect(cpyTab, &QAction::triggered, this, &ExportableTableView::copy);
66  connect(cpyCsv, &QAction::triggered, this, &ExportableTableView::copy);
67  connect(cpyPipe, &QAction::triggered, this, &ExportableTableView::copy);
68  connect(cpyHtml, &QAction::triggered, this, &ExportableTableView::copy);
69  connect(saveFile, &QAction::triggered, this, &ExportableTableView::save);
70  connect(this, &QTableView::customContextMenuRequested, this, &ExportableTableView::onCustomContextMenuRequested);
71 }
72 
73 QString ExportableTableView::getDefaultHtmlStyle()
74 {
75  return "th, td {font-family: sans-serif; padding: 3px 15px 3px 3px;} " \
76  "th {text-align: left;}";
77 }
78 
79 QString ExportableTableView::getDefaultHtmlTemplate()
80 {
81  return "<!DOCTYPE html>\n<html>\n<head><meta charset='utf-8'/><style>" \
82  "%1" \
83  "</style></head>\n<body>\n" \
84  "<table border=0 cellspacing=2>\n" \
85  "%2" \
86  "</table>\n" \
87  "</body></html>";
88 }
89 
90 void ExportableTableView::setHtmlStyle(const QString &value)
91 {
92  m_htmlStyle = value;
93 }
94 
95 void ExportableTableView::setHtmlTemplate(const QString &value)
96 {
97  m_htmlTemplate = value;
98 }
99 
100 QString ExportableTableView::toPlainText(const QModelIndexList &indexList, const QString &delim) const
101 {
102  QString ret, header;
103  const QChar rowDelim = '\n';
104  bool firstRow = true;
105  for (int i = 0; i < indexList.count(); ++i) {
106  const QModelIndex & idx = indexList.at(i);
107 
108  if (firstRow)
109  header.append(model()->headerData(idx.column(), Qt::Horizontal).toString());
110 
111  ret.append(idx.data(Qt::DisplayRole).toString());
112 
113  if (i + 1 == indexList.count() || indexList.at(i+1).row() != idx.row()) {
114  ret.append(rowDelim);
115  if (firstRow && !header.isEmpty())
116  header.append(rowDelim);
117  firstRow = false;
118  }
119  else {
120  ret.append(delim);
121  if (firstRow && !header.isEmpty())
122  header.append(delim);
123  }
124  }
125  if (!header.isEmpty())
126  ret.prepend(header);
127 
128  return ret;
129 }
130 
131 QString ExportableTableView::toHtml(const QModelIndexList &indexList) const
132 {
133  QString ret, header, row;
134  bool firstRow = true;
135 
136  for (int i = 0; i < indexList.count(); ++i) {
137  const QModelIndex & idx = indexList.at(i);
138  const int algn = (idx.data(Qt::TextAlignmentRole).isValid() ? idx.data(Qt::TextAlignmentRole).toInt() : (Qt::AlignLeft | Qt::AlignVCenter));
139  const QString fg = (idx.data(Qt::ForegroundRole).isValid() ? idx.data(Qt::ForegroundRole).value<QBrush>().color().name(QColor::HexRgb) : "initial");
140  const QString bg = (idx.data(Qt::BackgroundRole).isValid() ? idx.data(Qt::BackgroundRole).value<QBrush>().color().name(QColor::HexRgb) : "initial");
141  const QString ttl = (idx.data(Qt::ToolTipRole).isValid() ? idx.data(Qt::ToolTipRole).toString().replace("\"", "\"\"") : QString());
142 
143  QString fnt;
144  if (idx.data(Qt::FontRole).isValid()) {
145  const QFont font = idx.data(Qt::FontRole).value<QFont>();
146  fnt = "font: \"" % font.family() % "\" " % QString::number(font.pointSize()) % "pt;";
147  }
148 
149  if (firstRow)
150  header.append(QString("<th>%1</th>\n").arg(model()->headerData(idx.column(), Qt::Horizontal).toString()));
151 
152  row.append("<td style='color: %2; background-color: %3; %4' align='%5' valign='%6' %7>%1</td>\n"); // cell template
153  row = row.arg(idx.data(Qt::DisplayRole).toString()).arg(fg).arg(bg).arg(fnt);
154  row = row.arg((algn & Qt::AlignRight) ? "right" : (algn & Qt::AlignHCenter) ? "center" : "left");
155  row = row.arg((algn & Qt::AlignTop) ? "top" : (algn & Qt::AlignBottom) ? "bottom" : "middle");
156  row = row.arg(ttl.isEmpty() ? ttl : QString("title=\"%1\"").arg(ttl));
157 
158  if (i + 1 == indexList.count() || indexList.at(i+1).row() != idx.row()) {
159  ret.append(QString("<tr>\n%1</tr>\n").arg(row));
160  row.clear();
161  firstRow = false;
162  }
163  }
164 
165  ret = QString("<tbody>\n%1</tbody>\n").arg(ret);
166  if (!header.isEmpty())
167  ret.prepend(QString("<thead>\n<tr>\n%1</tr>\n</thead>\n").arg(header));
168  ret = m_htmlTemplate.arg(m_htmlStyle).arg(ret);
169 
170  return ret;
171 }
172 
173 bool ExportableTableView::saveToFile(const QModelIndexList &indexList, const QString &fileName)
174 {
175  static QString lastDir = QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation);
176 
177  if (indexList.isEmpty())
178  return false;
179 
180  QString fname = fileName;
181  if (fname.isEmpty()) {
182  QString types = tr("Tab-delimited text") % " (*.tab);;" % tr("Comma-delimited text") % " (*.csv);;" % tr("Pipe-delimited text") % " (*.txt);;" % tr("HTML") % " (*.html)";
183  fname = QFileDialog::getSaveFileName(this, tr("Save to file"), lastDir, types);
184  }
185 
186  if (fname.isEmpty())
187  return false;
188 
189  QFile file(fname);
190  QFileInfo fi(file);
191  lastDir = fi.absolutePath();
192 
193  if (!file.open(QIODevice::WriteOnly | QIODevice::Text))
194  return false;
195 
196  if (fi.suffix() == "html")
197  file.write(toHtml(indexList).toUtf8());
198  else
199  file.write(toPlainText(indexList, (fi.suffix() == "tab" ? "\t" : fi.suffix() == "csv" ? ", " : " | ")).toUtf8());
200  file.close();
201 
202  return true;
203 }
204 
205 QSize ExportableTableView::sizeHint() const
206 {
207  int w = 0;
208  for (int i = 0; i < model()->columnCount(); ++i)
209  w += sizeHintForColumn(i);
210  return QSize(w + verticalScrollBar()->sizeHint().width() + 60, sizeHintForRow(0) * model()->rowCount());
211 }
212 
213 void ExportableTableView::copyText(const QString &delim)
214 {
215  QApplication::clipboard()->setText(toPlainText(getSelectedOrAll(), delim));
216 }
217 
218 void ExportableTableView::copyHtml()
219 {
220  QMimeData * mdata = new QMimeData;
221  mdata->setHtml(toHtml(getSelectedOrAll()));
222  QApplication::clipboard()->setMimeData(mdata);
223 }
224 
225 void ExportableTableView::copy()
226 {
227  QString delim = "\t";
228  if (sender() && sender()->property("delim").isValid())
229  delim = sender()->property("delim").toString();
230  if (delim == "html")
231  copyHtml();
232  else
233  copyText(delim);
234 }
235 
236 void ExportableTableView::save()
237 {
238  saveToFile(getSelectedOrAll());
239 }
240 
241 QModelIndexList ExportableTableView::getSelectedOrAll()
242 {
243  QModelIndexList sel = selectionModel()->selectedIndexes();
244  if (sel.isEmpty()) {
245  selectAll();
246  sel = selectionModel()->selectedIndexes();
247  }
248  return sel;
249 }
250 
251 void ExportableTableView::onCustomContextMenuRequested(const QPoint & pos)
252 {
253  QMenu menu;
254  menu.addActions(actions());
255  menu.exec(mapToGlobal(pos));
256 }
QWidget::customContextMenuRequested
void customContextMenuRequested(const QPoint &pos)
ExportableTableView::getDefaultHtmlStyle
static QString getDefaultHtmlStyle()
Get the default style sheet used for HTML export.
Definition: ExportableTableView.cpp:73
ExportableTableView::save
void save()
Saves currently selected cell(s) to a file of the user's choice and format.
Definition: ExportableTableView.cpp:236
QAction::triggered
void triggered(bool checked)
QString::append
QString & append(QChar ch)
ExportableTableView::toHtml
QString toHtml(const QModelIndexList &indexList) const
Saves data from the passed model indices to an HTML-formatted string.
Definition: ExportableTableView.cpp:131
QStandardPaths::writableLocation
QString writableLocation(QStandardPaths::StandardLocation type)
QAbstractItemView::selectionModel
QItemSelectionModel * selectionModel() const const
QWidget::addAction
void addAction(QAction *action)
ExportableTableView::setHtmlStyle
void setHtmlStyle(const QString &value)
Set the style sheet for HTML export.
Definition: ExportableTableView.cpp:90
QWidget::addActions
void addActions(QList< QAction * > actions)
QObject::sender
QObject * sender() const const
QString::prepend
QString & prepend(QChar ch)
ExportableTableView::onCustomContextMenuRequested
void onCustomContextMenuRequested(const QPoint &pos)
Definition: ExportableTableView.cpp:251
QWidget::mapToGlobal
QPoint mapToGlobal(const QPoint &pos) const const
QVariant::value
T value() const const
ExportableTableView::saveToFile
bool saveToFile(const QModelIndexList &indexList, const QString &fileName=QString())
Saves data from the passed model indices to a file in text or HTML format.
Definition: ExportableTableView.cpp:173
Qt::CustomContextMenu
CustomContextMenu
Qt::AlignLeft
AlignLeft
QTableView::sizeHintForRow
virtual int sizeHintForRow(int row) const const override
QTableView::tr
QString tr(const char *s, const char *c, int n)
QString::clear
void clear()
ExportableTableView::copyText
void copyText(const QString &delim=QString("\t"))
Copies currently selected cell(s) to the clipboard as plain text.
Definition: ExportableTableView.cpp:213
QWidget::width
int width() const const
QString::number
QString number(int n, int base)
QObject::property
QVariant property(const char *name) const const
QVariant::toInt
int toInt(bool *ok) const const
Qt::DisplayRole
DisplayRole
QString::isEmpty
bool isEmpty() const const
QModelIndex::row
int row() const const
QWidget::pos
QPoint pos() const const
QClipboard::setMimeData
void setMimeData(QMimeData *src, QClipboard::Mode mode)
QAbstractScrollArea::verticalScrollBar
QScrollBar * verticalScrollBar() const const
QFile::open
virtual bool open(QIODevice::OpenMode mode) override
QMenu::exec
QAction * exec()
ExportableTableView::getDefaultHtmlTemplate
static QString getDefaultHtmlTemplate()
Get the default overall template used for HTML export.
Definition: ExportableTableView.cpp:79
QWidget::font
const QFont & font() const const
QWidget::setContextMenuPolicy
void setContextMenuPolicy(Qt::ContextMenuPolicy policy)
QAction::setShortcut
void setShortcut(const QKeySequence &shortcut)
ExportableTableView::copy
void copy()
Designed for QAction connections, it calls copyText() or copyHtml() based on delimiter specified in s...
Definition: ExportableTableView.cpp:225
QString::replace
QString & replace(int position, int n, QChar after)
QFileInfo::suffix
QString suffix() const const
QModelIndex::data
QVariant data(int role) const const
QAbstractItemView::selectAll
virtual void selectAll()
ExportableTableView::ExportableTableView
ExportableTableView(QWidget *parent=Q_NULLPTR)
ExportableTableView.
Definition: ExportableTableView.cpp:30
QFileDevice::close
virtual void close() override
QFont::family
QString family() const const
QAbstractItemModel::columnCount
virtual int columnCount(const QModelIndex &parent) const const=0
ExportableTableView.h
ExportableTableView::toPlainText
QString toPlainText(const QModelIndexList &indexList, const QString &delim="\t") const
Saves data from the passed model indices to a text string.
Definition: ExportableTableView.cpp:100
QTableView::sizeHintForColumn
virtual int sizeHintForColumn(int column) const const override
QFileDialog::getSaveFileName
QString getSaveFileName(QWidget *parent, const QString &caption, const QString &dir, const QString &filter, QString *selectedFilter, QFileDialog::Options options)
QModelIndex::column
int column() const const
QIODevice::write
qint64 write(const char *data, qint64 maxSize)
ExportableTableView::getSelectedOrAll
QModelIndexList getSelectedOrAll()
Return a list of selected cells.
Definition: ExportableTableView.cpp:241
QVariant::isValid
bool isValid() const const
QObject::setProperty
bool setProperty(const char *name, const QVariant &value)
ExportableTableView::sizeHint
QSize sizeHint() const override
Definition: ExportableTableView.cpp:205
QClipboard::setText
void setText(const QString &text, QClipboard::Mode mode)
Qt::Horizontal
Horizontal
QMimeData::setHtml
void setHtml(const QString &html)
QAbstractItemView::model
QAbstractItemModel * model() const const
QFileInfo::absolutePath
QString absolutePath() const const
QObject::connect
QMetaObject::Connection connect(const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QWidget::actions
QList< QAction * > actions() const const
QString::arg
QString arg(qlonglong a, int fieldWidth, int base, QChar fillChar) const const
QVariant::toString
QString toString() const const
QGuiApplication::clipboard
QClipboard * clipboard()
QFont::pointSize
int pointSize() const const
ExportableTableView::setHtmlTemplate
void setHtmlTemplate(const QString &value)
Set the overall template for HTML export.
Definition: ExportableTableView.cpp:95
ExportableTableView::copyHtml
void copyHtml()
Copies currently selected cell(s) to the clipboard as HTML (with MIME content-type "text/html").
Definition: ExportableTableView.cpp:218
QString::toUtf8
QByteArray toUtf8() const const