re-work optionsdialog to a tabbed UI based on an ui-file

- extend network options with a SOCKS version selection
- changing "Unit to show amounts in:" now also updates the unit used in the transaction fee box
- string updates
- link Apply button and OK button when enabling or disabling them
- use LookupNumeric() from netbase to verify proxy address (via an EventFilter)
- change proxy address field to QValidatedLineEdit and add visual feedback
- add a status label used for displaying a message for invalid proxy addresses
- allow usage of IPv6 address as proxy address
- added warning message when enabling / disabling SOCKS proxy

1 files changed, 140 insertions, 318 deletions

diff --git a/src/qt/optionsdialog.cpp b/src/qt/optionsdialog.cpp
index 50374ddc4b..9c7b85451c 100644
--- a/src/qt/optionsdialog.cpp
+++ b/src/qt/optionsdialog.cpp
@@ -1,396 +1,218 @@
 #include "optionsdialog.h"
-#include "optionsmodel.h"
+#include "ui_optionsdialog.h"
+
 #include "bitcoinamountfield.h"
-#include "monitoreddatamapper.h"
-#include "guiutil.h"
 #include "bitcoinunits.h"
+#include "monitoreddatamapper.h"
+#include "netbase.h"
+#include "optionsmodel.h"
+#include "qvalidatedlineedit.h"
 #include "qvaluecombobox.h"
 
-#include <QHBoxLayout>
-#include <QVBoxLayout>
-#include <QPushButton>
-#include <QListWidget>
-#include <QStackedWidget>
-
 #include <QCheckBox>
+#include <QDir>
+#include <QIntValidator>
 #include <QLabel>
 #include <QLineEdit>
-#include <QIntValidator>
-#include <QDoubleValidator>
-#include <QRegExpValidator>
-#include <QDialogButtonBox>
-#include <QDir>
 #include <QMessageBox>
+#include <QPushButton>
+#include <QRegExp>
+#include <QRegExpValidator>
+#include <QTabWidget>
+#include <QWidget>
 
-class OptionsPage: public QWidget
-{
-    Q_OBJECT
-public:
-    explicit OptionsPage(QWidget *parent=0): QWidget(parent) {}
-
-    virtual void setMapper(MonitoredDataMapper *mapper) = 0;
-};
-
-class MainOptionsPage: public OptionsPage
-{
-    Q_OBJECT
-public:
-    explicit MainOptionsPage(QWidget *parent=0);
-
-    virtual void setMapper(MonitoredDataMapper *mapper);
-private:
-    BitcoinAmountField *fee_edit;
-    QCheckBox *bitcoin_at_startup;
-    QCheckBox *detach_database;
-};
-
-class WindowOptionsPage: public OptionsPage
+OptionsDialog::OptionsDialog(QWidget *parent) :
+    QDialog(parent),
+    ui(new Ui::OptionsDialog),
+    model(0),
+    mapper(0),
+    fRestartWarningDisplayed_Proxy(false),
+    fRestartWarningDisplayed_Lang(false),
+    fProxyIpValid(true)
 {
-    Q_OBJECT
-public:
-    explicit WindowOptionsPage(QWidget *parent=0);
+    ui->setupUi(this);
 
-    virtual void setMapper(MonitoredDataMapper *mapper);
-private:
-#ifndef Q_WS_MAC
-    QCheckBox *minimize_to_tray;
-    QCheckBox *minimize_on_close;
+    /* Network elements init */
+#ifndef USE_UPNP
+    ui->mapPortUpnp->setEnabled(false);
 #endif
-};
-
-class DisplayOptionsPage: public OptionsPage
-{
-    Q_OBJECT
-public:
-    explicit DisplayOptionsPage(QWidget *parent=0);
-
-    virtual void setMapper(MonitoredDataMapper *mapper);
-private:
-    QValueComboBox *lang;
-    QValueComboBox *unit;
-    QCheckBox *display_addresses;
-    bool restart_warning_displayed;
-private slots:
-    void showRestartWarning();
-};
-
-class NetworkOptionsPage: public OptionsPage
-{
-    Q_OBJECT
-public:
-    explicit NetworkOptionsPage(QWidget *parent=0);
-
-    virtual void setMapper(MonitoredDataMapper *mapper);
-private:
-    QCheckBox *map_port_upnp;
-    QCheckBox *connect_socks4;
-    QLineEdit *proxy_ip;
-    QLineEdit *proxy_port;
-};
 
+    ui->socksVersion->setEnabled(false);
+    ui->socksVersion->addItem("5", 5);
+    ui->socksVersion->addItem("4", 4);
+    ui->socksVersion->setCurrentIndex(0);
 
-#include "optionsdialog.moc"
+    ui->proxyIp->setEnabled(false);
+    ui->proxyPort->setEnabled(false);
+    ui->proxyPort->setValidator(new QIntValidator(0, 65535, this));
 
-OptionsDialog::OptionsDialog(QWidget *parent):
-    QDialog(parent), contents_widget(0), pages_widget(0),
-    model(0)
-{
-    contents_widget = new QListWidget();
-    contents_widget->setMaximumWidth(128);
+    connect(ui->connectSocks, SIGNAL(toggled(bool)), ui->socksVersion, SLOT(setEnabled(bool)));
+    connect(ui->connectSocks, SIGNAL(toggled(bool)), ui->proxyIp, SLOT(setEnabled(bool)));
+    connect(ui->connectSocks, SIGNAL(toggled(bool)), ui->proxyPort, SLOT(setEnabled(bool)));
 
-    pages_widget = new QStackedWidget();
-    pages_widget->setMinimumWidth(500);
-    pages_widget->setMinimumHeight(300);
+    ui->proxyIp->installEventFilter(this);
 
-    pages.append(new MainOptionsPage(this));
-    pages.append(new NetworkOptionsPage(this));
-#ifndef Q_WS_MAC
-    /* Hide Window options on Mac as there are currently none available */
-    pages.append(new WindowOptionsPage(this));
+    /* Window elements init */
+#ifdef Q_WS_MAC
+    ui->tabWindow->setVisible(false);
 #endif
-    pages.append(new DisplayOptionsPage(this));
 
-    foreach(OptionsPage *page, pages)
+    /* Display elements init */
+    QDir translations(":translations");
+    ui->lang->addItem(QString("(") + tr("default") + QString(")"), QVariant(""));
+    foreach(const QString &langStr, translations.entryList())
     {
-        QListWidgetItem *item = new QListWidgetItem(page->windowTitle());
-        contents_widget->addItem(item);
-        pages_widget->addWidget(page);
+        ui->lang->addItem(langStr, QVariant(langStr));
     }
 
-    contents_widget->setCurrentRow(0);
-
-    QHBoxLayout *main_layout = new QHBoxLayout();
-    main_layout->addWidget(contents_widget);
-    main_layout->addWidget(pages_widget, 1);
-
-    QVBoxLayout *layout = new QVBoxLayout();
-    layout->addLayout(main_layout);
+    ui->unit->setModel(new BitcoinUnits(this));
 
-    QDialogButtonBox *buttonbox = new QDialogButtonBox();
-    buttonbox->setStandardButtons(QDialogButtonBox::Apply|QDialogButtonBox::Ok|QDialogButtonBox::Cancel);
-    apply_button = buttonbox->button(QDialogButtonBox::Apply);
-    layout->addWidget(buttonbox);
-
-    setLayout(layout);
-    setWindowTitle(tr("Options"));
+    connect(ui->connectSocks, SIGNAL(clicked(bool)), this, SLOT(showRestartWarning_Proxy()));
+    connect(ui->lang, SIGNAL(activated(int)), this, SLOT(showRestartWarning_Lang()));
 
     /* Widget-to-option mapper */
     mapper = new MonitoredDataMapper(this);
     mapper->setSubmitPolicy(QDataWidgetMapper::ManualSubmit);
     mapper->setOrientation(Qt::Vertical);
-    /* enable apply button when data modified */
-    connect(mapper, SIGNAL(viewModified()), this, SLOT(enableApply()));
-    /* disable apply button when new data loaded */
-    connect(mapper, SIGNAL(currentIndexChanged(int)), this, SLOT(disableApply()));
-
-    /* Event bindings */
-    connect(contents_widget, SIGNAL(currentRowChanged(int)), this, SLOT(changePage(int)));
-    connect(buttonbox->button(QDialogButtonBox::Ok), SIGNAL(clicked()), this, SLOT(okClicked()));
-    connect(buttonbox->button(QDialogButtonBox::Cancel), SIGNAL(clicked()), this, SLOT(cancelClicked()));
-    connect(buttonbox->button(QDialogButtonBox::Apply), SIGNAL(clicked()), this, SLOT(applyClicked()));
+
+    /* enable save buttons when data modified */
+    connect(mapper, SIGNAL(viewModified()), this, SLOT(enableSaveButtons()));
+    /* disable save buttons when new data loaded */
+    connect(mapper, SIGNAL(currentIndexChanged(int)), this, SLOT(disableSaveButtons()));
+    /* disable/enable save buttons when proxy IP is invalid/valid */
+    connect(this, SIGNAL(proxyIpValid(bool)), this, SLOT(setSaveButtonState(bool)));
+}
+
+OptionsDialog::~OptionsDialog()
+{
+    delete ui;
 }
 
 void OptionsDialog::setModel(OptionsModel *model)
 {
     this->model = model;
 
-    mapper->setModel(model);
-
-    foreach(OptionsPage *page, pages)
+    if(model)
     {
-        page->setMapper(mapper);
+        connect(model, SIGNAL(displayUnitChanged(int)), this, SLOT(updateDisplayUnit()));
+
+        mapper->setModel(model);
+        setMapper();
+        mapper->toFirst();
     }
 
-    mapper->toFirst();
+    // update the display unit, to not use the default ("BTC")
+    updateDisplayUnit();
 }
 
-void OptionsDialog::changePage(int index)
+void OptionsDialog::setMapper()
 {
-    pages_widget->setCurrentIndex(index);
-}
+    /* Main */
+    mapper->addMapping(ui->transactionFee, OptionsModel::Fee);
+    mapper->addMapping(ui->bitcoinAtStartup, OptionsModel::StartAtStartup);
+    mapper->addMapping(ui->detachDatabases, OptionsModel::DetachDatabases);
 
-void OptionsDialog::okClicked()
-{
-    mapper->submit();
-    accept();
-}
+    /* Network */
+    mapper->addMapping(ui->mapPortUpnp, OptionsModel::MapPortUPnP);
+    mapper->addMapping(ui->connectSocks, OptionsModel::ProxyUse);
+    mapper->addMapping(ui->socksVersion, OptionsModel::ProxySocksVersion);
+    mapper->addMapping(ui->proxyIp, OptionsModel::ProxyIP);
+    mapper->addMapping(ui->proxyPort, OptionsModel::ProxyPort);
 
-void OptionsDialog::cancelClicked()
-{
-    reject();
-}
+    /* Window */
+#ifndef Q_WS_MAC
+    mapper->addMapping(ui->minimizeToTray, OptionsModel::MinimizeToTray);
+    mapper->addMapping(ui->minimizeOnClose, OptionsModel::MinimizeOnClose);
+#endif
 
-void OptionsDialog::applyClicked()
-{
-    mapper->submit();
-    apply_button->setEnabled(false);
+    /* Display */
+    mapper->addMapping(ui->lang, OptionsModel::Language);
+    mapper->addMapping(ui->unit, OptionsModel::DisplayUnit);
+    mapper->addMapping(ui->displayAddresses, OptionsModel::DisplayAddresses);
 }
 
-void OptionsDialog::enableApply()
+void OptionsDialog::enableSaveButtons()
 {
-    apply_button->setEnabled(true);
+    // prevent enabling of the save buttons when data modified, if there is an invalid proxy address present
+    if(fProxyIpValid)
+        setSaveButtonState(true);
 }
 
-void OptionsDialog::disableApply()
+void OptionsDialog::disableSaveButtons()
 {
-    apply_button->setEnabled(false);
+    setSaveButtonState(false);
 }
 
-/* Main options */
-MainOptionsPage::MainOptionsPage(QWidget *parent):
-        OptionsPage(parent)
+void OptionsDialog::setSaveButtonState(bool fState)
 {
-    QVBoxLayout *layout = new QVBoxLayout();
-    setWindowTitle(tr("Main"));
-
-    QLabel *fee_help = new QLabel(tr("Optional transaction fee per kB that helps make sure your transactions are processed quickly. Most transactions are 1 kB. Fee 0.01 recommended."));
-    fee_help->setWordWrap(true);
-    layout->addWidget(fee_help);
-
-    QHBoxLayout *fee_hbox = new QHBoxLayout();
-    fee_hbox->addSpacing(18);
-    QLabel *fee_label = new QLabel(tr("Pay transaction &fee"));
-    fee_hbox->addWidget(fee_label);
-    fee_edit = new BitcoinAmountField();
-
-    fee_label->setBuddy(fee_edit);
-    fee_hbox->addWidget(fee_edit);
-    fee_hbox->addStretch(1);
-
-    layout->addLayout(fee_hbox);
-
-    bitcoin_at_startup = new QCheckBox(tr("&Start Bitcoin on system login"));
-    bitcoin_at_startup->setToolTip(tr("Automatically start Bitcoin after logging in to the system"));
-    layout->addWidget(bitcoin_at_startup);
-
-    detach_database = new QCheckBox(tr("&Detach databases at shutdown"));
-    detach_database->setToolTip(tr("Detach block and address databases at shutdown. This means they can be moved to another data directory, but it slows down shutdown. The wallet is always detached."));
-    layout->addWidget(detach_database);
-
-    layout->addStretch(1); // Extra space at bottom
-    setLayout(layout);
+    ui->applyButton->setEnabled(fState);
+    ui->okButton->setEnabled(fState);
 }
 
-void MainOptionsPage::setMapper(MonitoredDataMapper *mapper)
+void OptionsDialog::on_okButton_clicked()
 {
-    // Map model to widgets
-    mapper->addMapping(fee_edit, OptionsModel::Fee);
-    mapper->addMapping(bitcoin_at_startup, OptionsModel::StartAtStartup);
-    mapper->addMapping(detach_database, OptionsModel::DetachDatabases);
+    mapper->submit();
+    accept();
 }
 
-/* Display options */
-DisplayOptionsPage::DisplayOptionsPage(QWidget *parent):
-    OptionsPage(parent), restart_warning_displayed(false)
+void OptionsDialog::on_cancelButton_clicked()
 {
-    setWindowTitle(tr("Display"));
-
-    QVBoxLayout *layout = new QVBoxLayout();
-
-    QHBoxLayout *lang_hbox = new QHBoxLayout();
-    lang_hbox->addSpacing(18);
-    QLabel *lang_label = new QLabel(tr("User Interface &Language:"));
-    lang_hbox->addWidget(lang_label);
-    lang = new QValueComboBox(this);
-    // Make list of languages
-    QDir translations(":translations");
-    lang->addItem(QString("(") + tr("default") + QString(")"), QVariant(""));
-    foreach(const QString &langStr, translations.entryList())
-    {
-        lang->addItem(langStr, QVariant(langStr));
-    }
-
-    lang->setToolTip(tr("The user interface language can be set here. This setting will only take effect after restarting Bitcoin."));
-    connect(lang, SIGNAL(activated(int)), this, SLOT(showRestartWarning()));
-
-    lang_label->setBuddy(lang);
-    lang_hbox->addWidget(lang);
-
-    layout->addLayout(lang_hbox);
-
-    QHBoxLayout *unit_hbox = new QHBoxLayout();
-    unit_hbox->addSpacing(18);
-    QLabel *unit_label = new QLabel(tr("&Unit to show amounts in:"));
-    unit_hbox->addWidget(unit_label);
-    unit = new QValueComboBox(this);
-    unit->setModel(new BitcoinUnits(this));
-    unit->setToolTip(tr("Choose the default subdivision unit to show in the interface, and when sending coins"));
-
-    unit_label->setBuddy(unit);
-    unit_hbox->addWidget(unit);
-
-    layout->addLayout(unit_hbox);
-
-    display_addresses = new QCheckBox(tr("&Display addresses in transaction list"), this);
-    display_addresses->setToolTip(tr("Whether to show Bitcoin addresses in the transaction list"));
-    layout->addWidget(display_addresses);
-
-    layout->addStretch();
-    setLayout(layout);
+    reject();
 }
 
-void DisplayOptionsPage::setMapper(MonitoredDataMapper *mapper)
+void OptionsDialog::on_applyButton_clicked()
 {
-    mapper->addMapping(lang, OptionsModel::Language);
-    mapper->addMapping(unit, OptionsModel::DisplayUnit);
-    mapper->addMapping(display_addresses, OptionsModel::DisplayAddresses);
+    mapper->submit();
+    ui->applyButton->setEnabled(false);
 }
 
-void DisplayOptionsPage::showRestartWarning()
+void OptionsDialog::showRestartWarning_Proxy()
 {
-    if(!restart_warning_displayed)
+    if(!fRestartWarningDisplayed_Proxy)
     {
         QMessageBox::warning(this, tr("Warning"), tr("This setting will take effect after restarting Bitcoin."), QMessageBox::Ok);
-        restart_warning_displayed = true;
+        fRestartWarningDisplayed_Proxy = true;
     }
 }
 
-/* Window options */
-WindowOptionsPage::WindowOptionsPage(QWidget *parent):
-        OptionsPage(parent)
-{
-    QVBoxLayout *layout = new QVBoxLayout();
-    setWindowTitle(tr("Window"));
-
-#ifndef Q_WS_MAC
-    minimize_to_tray = new QCheckBox(tr("&Minimize to the tray instead of the taskbar"));
-    minimize_to_tray->setToolTip(tr("Show only a tray icon after minimizing the window"));
-    layout->addWidget(minimize_to_tray);
-
-    minimize_on_close = new QCheckBox(tr("M&inimize on close"));
-    minimize_on_close->setToolTip(tr("Minimize instead of exit the application when the window is closed. When this option is enabled, the application will be closed only after selecting Quit in the menu."));
-    layout->addWidget(minimize_on_close);
-#endif
-
-    layout->addStretch(1); // Extra space at bottom
-    setLayout(layout);
-}
-
-void WindowOptionsPage::setMapper(MonitoredDataMapper *mapper)
+void OptionsDialog::showRestartWarning_Lang()
 {
-    // Map model to widgets
-#ifndef Q_WS_MAC
-    mapper->addMapping(minimize_to_tray, OptionsModel::MinimizeToTray);
-#endif
-#ifndef Q_WS_MAC
-    mapper->addMapping(minimize_on_close, OptionsModel::MinimizeOnClose);
-#endif
+    if(!fRestartWarningDisplayed_Lang)
+    {
+        QMessageBox::warning(this, tr("Warning"), tr("This setting will take effect after restarting Bitcoin."), QMessageBox::Ok);
+        fRestartWarningDisplayed_Lang = true;
+    }
 }
 
-/* Network options */
-NetworkOptionsPage::NetworkOptionsPage(QWidget *parent):
-        OptionsPage(parent)
+void OptionsDialog::updateDisplayUnit()
 {
-    QVBoxLayout *layout = new QVBoxLayout();
-    setWindowTitle(tr("Network"));
-
-    map_port_upnp = new QCheckBox(tr("Map port using &UPnP"));
-    map_port_upnp->setToolTip(tr("Automatically open the Bitcoin client port on the router. This only works when your router supports UPnP and it is enabled."));
-    layout->addWidget(map_port_upnp);
-
-    connect_socks4 = new QCheckBox(tr("&Connect through SOCKS4 proxy:"));
-    connect_socks4->setToolTip(tr("Connect to the Bitcon network through a SOCKS4 proxy (e.g. when connecting through Tor)"));
-    layout->addWidget(connect_socks4);
-
-    QHBoxLayout *proxy_hbox = new QHBoxLayout();
-    proxy_hbox->addSpacing(18);
-    QLabel *proxy_ip_label = new QLabel(tr("Proxy &IP:"));
-    proxy_hbox->addWidget(proxy_ip_label);
-    proxy_ip = new QLineEdit();
-    proxy_ip->setMaximumWidth(140);
-    proxy_ip->setEnabled(false);
-    proxy_ip->setValidator(new QRegExpValidator(QRegExp("[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}"), this));
-    proxy_ip->setToolTip(tr("IP address of the proxy (e.g. 127.0.0.1)"));
-    proxy_ip_label->setBuddy(proxy_ip);
-    proxy_hbox->addWidget(proxy_ip);
-    QLabel *proxy_port_label = new QLabel(tr("&Port:"));
-    proxy_hbox->addWidget(proxy_port_label);
-    proxy_port = new QLineEdit();
-    proxy_port->setMaximumWidth(55);
-    proxy_port->setValidator(new QIntValidator(0, 65535, this));
-    proxy_port->setEnabled(false);
-    proxy_port->setToolTip(tr("Port of the proxy (e.g. 1234)"));
-    proxy_port_label->setBuddy(proxy_port);
-    proxy_hbox->addWidget(proxy_port);
-    proxy_hbox->addStretch(1);
-    layout->addLayout(proxy_hbox);
-
-    layout->addStretch(1); // Extra space at bottom
-    setLayout(layout);
-
-    connect(connect_socks4, SIGNAL(toggled(bool)), proxy_ip, SLOT(setEnabled(bool)));
-    connect(connect_socks4, SIGNAL(toggled(bool)), proxy_port, SLOT(setEnabled(bool)));
-
-#ifndef USE_UPNP
-    map_port_upnp->setDisabled(true);
-#endif
+    if(model)
+    {
+        // Update transactionFee with the current unit
+        ui->transactionFee->setDisplayUnit(model->getDisplayUnit());
+    }
 }
 
-void NetworkOptionsPage::setMapper(MonitoredDataMapper *mapper)
+bool OptionsDialog::eventFilter(QObject *object, QEvent *event)
 {
-    // Map model to widgets
-    mapper->addMapping(map_port_upnp, OptionsModel::MapPortUPnP);
-    mapper->addMapping(connect_socks4, OptionsModel::ProxyUse);
-    mapper->addMapping(proxy_ip, OptionsModel::ProxyIP);
-    mapper->addMapping(proxy_port, OptionsModel::ProxyPort);
+    if(object == ui->proxyIp && event->type() == QEvent::FocusOut)
+    {
+        // Check proxyIP for a valid IPv4/IPv6 address
+        CService addr;
+        if(!LookupNumeric(ui->proxyIp->text().toStdString().c_str(), addr))
+        {
+            ui->proxyIp->setValid(false);
+            fProxyIpValid = false;
+            ui->statusLabel->setStyleSheet("QLabel { color: red; }");
+            ui->statusLabel->setText(tr("The supplied proxy address is invalid."));
+            emit proxyIpValid(false);
+        }
+        else
+        {
+            fProxyIpValid = true;
+            ui->statusLabel->clear();
+            emit proxyIpValid(true);
+        }
+    }
+    return QDialog::eventFilter(object, event);
 }