guiutil.h

Go to the documentation of this file.

// Copyright (c) 2011-2016 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#ifndef BITCOIN_QT_GUIUTIL_H
#define BITCOIN_QT_GUIUTIL_H

#include <amount.h>
#include <fs.h>

#include <QEvent>
#include <QHeaderView>
#include <QItemDelegate>
#include <QLabel>
#include <QMessageBox>
#include <QObject>
#include <QProgressBar>
#include <QString>
#include <QTableView>

class QValidatedLineEdit;
class SendCoinsRecipient;
class CChainParams;
class Config;

namespace interfaces {
class Node;
}

QT_BEGIN_NAMESPACE
class QAbstractItemView;
class QDateTime;
class QFont;
class QLineEdit;
class QProgressDialog;
class QUrl;
class QWidget;
QT_END_NAMESPACE

namespace GUIUtil {

// Create human-readable string from date
QString dateTimeStr(const QDateTime &datetime);
QString dateTimeStr(qint64 nTime);

// Return a monospace font
QFont fixedPitchFont();

// Generate an invalid, but convincing address.
std::string DummyAddress(const CChainParams &params);

// Convert any address into cashaddr
QString convertToCashAddr(const CChainParams &params, const QString &addr);

// Set up widget for address
void setupAddressWidget(QValidatedLineEdit *widget, QWidget *parent);

// Parse "bitcoincash:" URI into recipient object, return true on successful
// parsing
bool parseBitcoinURI(const QString &scheme, const QUrl &uri,
                     SendCoinsRecipient *out);
bool parseBitcoinURI(const QString &scheme, QString uri,
                     SendCoinsRecipient *out);
QString formatBitcoinURI(const SendCoinsRecipient &info);
QString formatBitcoinURI(const CChainParams &params,
                         const SendCoinsRecipient &info);

// Returns true if given address+amount meets "dust" definition
bool isDust(interfaces::Node &node, const QString &address, const Amount amount,
            const CChainParams &chainParams);

// HTML escaping for rich text controls
QString HtmlEscape(const QString &str, bool fMultiLine = false);
QString HtmlEscape(const std::string &str, bool fMultiLine = false);

void copyEntryData(QAbstractItemView *view, int column,
                   int role = Qt::EditRole);

QList<QModelIndex> getEntryData(QAbstractItemView *view, int column);

void setClipboard(const QString &str);

QString getDefaultDataDirectory();

QString getSaveFileName(QWidget *parent, const QString &caption,
                        const QString &dir, const QString &filter,
                        QString *selectedSuffixOut);

QString getOpenFileName(QWidget *parent, const QString &caption,
                        const QString &dir, const QString &filter,
                        QString *selectedSuffixOut);

Qt::ConnectionType blockingGUIThreadConnection();

// Determine whether a widget is hidden behind other windows
bool isObscured(QWidget *w);

// Activate, show and raise the widget
void bringToFront(QWidget *w);

// Open debug.log
void openDebugLogfile();

// Open the config file
bool openBitcoinConf();

// Split a QString using given separator, skipping the empty parts
QStringList splitSkipEmptyParts(const QString &s, const QString &separator);

class ToolTipToRichTextFilter : public QObject {
    Q_OBJECT

public:
    explicit ToolTipToRichTextFilter(int size_threshold, QObject *parent = 0);

protected:
    bool eventFilter(QObject *obj, QEvent *evt) override;

private:
    int size_threshold;
};

class TableViewLastColumnResizingFixer : public QObject {
    Q_OBJECT

public:
    TableViewLastColumnResizingFixer(QTableView *table, int lastColMinimumWidth,
                                     int allColsMinimumWidth, QObject *parent);
    void stretchColumnWidth(int column);

private:
    QTableView *tableView;
    int lastColumnMinimumWidth;
    int allColumnsMinimumWidth;
    int lastColumnIndex;
    int columnCount;
    int secondToLastColumnIndex;

    void adjustTableColumnsWidth();
    int getAvailableWidthForColumn(int column);
    int getColumnsWidth();
    void connectViewHeadersSignals();
    void disconnectViewHeadersSignals();
    void setViewHeaderResizeMode(int logicalIndex,
                                 QHeaderView::ResizeMode resizeMode);
    void resizeColumn(int nColumnIndex, int width);

private Q_SLOTS:
    void on_sectionResized(int logicalIndex, int oldSize, int newSize);
    void on_geometriesChanged();
};

bool GetStartOnSystemStartup();
bool SetStartOnSystemStartup(bool fAutoStart);

/* Convert QString to OS specific boost path through UTF-8 */
fs::path qstringToBoostPath(const QString &path);

/* Convert OS specific boost path to QString through UTF-8 */
QString boostPathToQString(const fs::path &path);

/* Convert seconds into a QString with days, hours, mins, secs */
QString formatDurationStr(int secs);

/* Format CNodeStats.nServices bitmask into a user-readable string */
QString formatServicesStr(quint64 mask);

/*
 * Format a CNodeStats.m_ping_usec into a user-readable string or display N/A,
 * if 0.
 */
QString formatPingTime(int64_t ping_usec);

/* Format a CNodeCombinedStats.nTimeOffset into a user-readable string. */
QString formatTimeOffset(int64_t nTimeOffset);

QString formatNiceTimeOffset(qint64 secs);

QString formatBytes(uint64_t bytes);

qreal calculateIdealFontSize(int width, const QString &text, QFont font,
                             qreal minPointSize = 4, qreal startPointSize = 14);

class ClickableLabel : public QLabel {
    Q_OBJECT

public:
    bool hasPixmap() const;

Q_SIGNALS:
    void clicked(const QPoint &point);

protected:
    void mouseReleaseEvent(QMouseEvent *event) override;
};

class ClickableProgressBar : public QProgressBar {
    Q_OBJECT

Q_SIGNALS:
    void clicked(const QPoint &point);

protected:
    void mouseReleaseEvent(QMouseEvent *event) override;
};

typedef ClickableProgressBar ProgressBar;

class ItemDelegate : public QItemDelegate {
    Q_OBJECT
public:
    ItemDelegate(QObject *parent) : QItemDelegate(parent) {}

Q_SIGNALS:
    void keyEscapePressed();

private:
    bool eventFilter(QObject *object, QEvent *event);
};

int TextWidth(const QFontMetrics &fm, const QString &text);

void LogQtInfo();

// Fix known bugs in QProgressDialog class.
void PolishProgressDialog(QProgressDialog *dialog);
} // namespace GUIUtil

#endif // BITCOIN_QT_GUIUTIL_H