Changeset 4364 in vbox for trunk/src/VBox

Timestamp:

Aug 24, 2007 6:34:50 PM (17 years ago)

Author:

vboxsync

Message:

FE/Qt: Settings Dialogs: Automatically show the detailed message in the whatsthis pane pointing to the page and field that contain invalid input -- for all fields with validation.

Location:

trunk/src/VBox/Frontends/VirtualBox

Files:

• include/QIWidgetValidator.h (modified) (2 diffs)
• src/QIWidgetValidator.cpp (modified) (7 diffs)
• ui/VBoxGlobalSettingsDlg.ui (modified) (1 diff)
• ui/VBoxGlobalSettingsDlg.ui.h (modified) (6 diffs)
• ui/VBoxVMSettingsDlg.ui (modified) (1 diff)
• ui/VBoxVMSettingsDlg.ui.h (modified) (16 diffs)

trunk/src/VBox/Frontends/VirtualBox/include/QIWidgetValidator.h

@@ -24 +24 @@
 #include <qobject.h>
 #include <qvalidator.h>
+#include <qvaluelist.h>
 
 class QIWidgetValidator : public QObject
@@ -30 +31 @@
 
 public:
-    QIWidgetValidator( QWidget *widget, QObject *parent = 0, const char *name = 0 );
+
+    QIWidgetValidator (QWidget *aWidget, QObject *aParent = 0,
+                       const char *aName = 0);
+    QIWidgetValidator (const QString &aCaption,
+                       QWidget *aWidget, QObject *aParent = 0,
+                       const char *aName = 0);
     ~QIWidgetValidator();
 
-    QWidget *widget() const { return wgt; }
+    QWidget *widget() const { return mWidget; }
     bool isValid() const;
     void rescan();
 
-    void setOtherValid( bool valid ) { otherValid = valid; }
-    bool isOtherValid() const { return otherValid; }
+    QString warningText() const;
+
+    void setOtherValid (bool aValid) { mOtherValid = aValid; }
+    bool isOtherValid() const { return mOtherValid; }
 
 signals:
-    void validityChanged( const QIWidgetValidator *wval );
-    void isValidRequested( QIWidgetValidator *wval );
+
+    void validityChanged (const QIWidgetValidator *aValidator);
+    void isValidRequested (QIWidgetValidator *aValidator);
 
 public slots:
+
     void revalidate() { doRevalidate(); }
 
 private:
-    QWidget *wgt;
-    bool otherValid;
+
+    QString mCaption;
+    QWidget *mWidget;
+    bool mOtherValid;
+
+    struct Watched
+    {
+        Watched()
+            : widget (NULL), buddy (NULL)
+            , state (QValidator::Acceptable) {}
+
+        QWidget *widget;
+        QWidget *buddy;
+        QValidator::State state;
+    };
+
+    QValueList <Watched> mWatched;
+    Watched mLastInvalid;
 
 private slots:
-    void doRevalidate() { emit validityChanged( this ); }
+
+    void doRevalidate() { emit validityChanged (this); }
 };
 

trunk/src/VBox/Frontends/VirtualBox/src/QIWidgetValidator.cpp

@@ -22 +22 @@
 #include <qlineedit.h>
 #include <qcombobox.h>
+#include <qlabel.h>
+
+#include <iprt/assert.h>
+
+#include "VBoxGlobal.h"
 
 /** @class QIWidgetValidator
@@ -70 +75 @@
  *  of the given widget.
  *
- *  @param widget the widget whose children should be checked
- */
-QIWidgetValidator::QIWidgetValidator(
-    QWidget *widget, QObject *parent, const char *name
-) :
-    QObject( parent, name ),
-    wgt( widget ),
-    otherValid( true )
+ *  @param aWidget  Widget whose children should be checked.
+ */
+QIWidgetValidator::QIWidgetValidator (QWidget *aWidget, QObject *aParent,
+                                      const char *aName)
+    : QObject (aParent, aName)
+    , mWidget (aWidget)
+    , mOtherValid (true)
+{
+    rescan();
+}
+
+/**
+ *  Constructs a new instance that will check the validity of children
+ *  of the given widget.
+ *
+ *  @param aCaption Caption to use for the warning message.
+ *  @param aWidget  Widget whose children should be checked.
+ */
+QIWidgetValidator::QIWidgetValidator (const QString &aCaption,
+                                      QWidget *aWidget, QObject *aParent,
+                                      const char *aName)
+    : QObject (aParent, aName)
+    , mCaption (aCaption)
+    , mWidget (aWidget)
+    , mOtherValid (true)
 {
     rescan();
@@ -89 +111 @@
 QIWidgetValidator::~QIWidgetValidator()
 {
-    wgt = 0;
+    mWidget = 0;
     doRevalidate();
 }
@@ -120 +142 @@
 {
     // wgt is null, we assume we're valid
-    if (!wgt)
+    if (!mWidget)
         return true;
 
     QIWidgetValidator *that = const_cast <QIWidgetValidator *> (this);
-    emit that->isValidRequested( that );
+    emit that->isValidRequested (that);
     if (!isOtherValid())
         return false;
 
-    bool valid = true;
-
-    QObjectList *list = wgt->queryList ("QLineEdit");
-    QObjectListIterator it (*list);
-    QObject *obj;
-    while (valid && (obj = it.current()) != 0)
+    QValidator::State state = QValidator::Acceptable;
+
+    for (QValueList <Watched>::ConstIterator it = mWatched.begin();
+         it != mWatched.end(); ++ it)
     {
-        ++it;
-        if (obj->inherits ("QLineEdit"))
-        {
-            QLineEdit *le = ((QLineEdit *) obj);
+        Watched watched = *it;
+
+        if (watched.widget->inherits ("QLineEdit"))
+        {
+            QLineEdit *le = ((QLineEdit *) watched.widget);
+            Assert (le->validator());
             if (!le->validator() || !le->isEnabled())
                 continue;
-            valid = le->hasAcceptableInput();
-        }
-        else if (obj->inherits ("QComboBox"))
-        {
-            QComboBox *cb = ((QComboBox *) obj);
-            if (!cb->validator() || !cb->lineEdit() || !cb->isEnabled())
+            int pos;
+            state = le->validator()->validate (le->text(), pos);
+        }
+        else if (watched.widget->inherits ("QComboBox"))
+        {
+            QComboBox *cb = ((QComboBox *) watched.widget);
+            Assert (cb->validator());
+            if (!cb->validator() || !cb->isEnabled())
                 continue;
-            valid = cb->lineEdit()->hasAcceptableInput();
+            int pos;
+            state = cb->lineEdit()->validator()->
+                validate (cb->lineEdit()->text(), pos);
+        }
+
+        if (state != QValidator::Acceptable)
+        {
+            that->mLastInvalid = watched;
+            that->mLastInvalid.state = state;
+            return false;
         }
     }
-    delete list;
-
-    return valid;
-}
-
-/**
- *  Rescans all (grand) children of the managed widget and connects itself to
- *  those that can be validated, in order to emit the validityChanged()
- *  signal to give its receiver an oportunity to do useful actions.
+
+    /* reset last invalid */
+    that->mLastInvalid = Watched();
+    return true;
+}
+
+/**
+ *  Rescans all (grand) children of the managed widget and:
+ *
+ *  1) remembers all supported widgets with validators to speed up further
+ *     validation;
+ *
+ *  2) connects itself to those that can be validated, in order to emit the
+ *     validityChanged() signal to give its receiver an oportunity to do
+ *     useful actions.
+ *
+ *  Must be called every time a child widget is added or removed.
  */
 void QIWidgetValidator::rescan()
 {
-    if (!wgt)
+    if (!mWidget)
         return;
 
-    QObjectList *list = wgt->queryList();
+    mWatched.clear();
+
+    Watched watched;
+
+    QObjectList *list = mWidget->queryList();
+    QObject *obj;
+
+    /* detect all widgets that support validation */
     QObjectListIterator it (*list);
-    QObject *obj;
     while ((obj = it.current()) != 0)
     {
@@ -177 +224 @@
             if (!le->validator())
                 continue;
-            // disconnect to avoid duplicate connections
+            /* disconnect to avoid duplicate connections */
             disconnect (le, SIGNAL (textChanged (const QString &)),
                         this, SLOT (doRevalidate()));
@@ -188 +235 @@
             if (!cb->validator() || !cb->lineEdit())
                 continue;
-            // disconnect to avoid duplicate connections
+            /* disconnect to avoid duplicate connections */
             disconnect (cb, SIGNAL (textChanged (const QString &)),
                         this, SLOT (doRevalidate()));
@@ -194 +241 @@
                      this, SLOT (doRevalidate()));
         }
+
+        watched.widget = (QWidget *) obj;
+
+        /* try to find a buddy widget in order to determine the title for
+         * the watched widget which is used in the warning text */
+        QObjectListIterator it2 (*list);
+        while ((obj = it2.current()) != 0)
+        {
+            ++ it2;
+            if (obj->inherits ("QLabel"))
+            {
+                QLabel *label = (QLabel *) obj;
+                if (label->buddy() == watched.widget)
+                {
+                    watched.buddy = label;
+                    break;
+                }
+            }
+        }
+
+        /* memorize */
+        mWatched << watched;
     }
+
+    /* don't forget to delete the list */
     delete list;
+}
+
+/** 
+ *  Returns a message that describes the last detected error (invalid or
+ *  incomplete input).
+ *
+ *  This message uses the caption text passed to the constructor as a page
+ *  name to refer to. If the caption is NULL, this funciton will return a null
+ *  string.
+ *
+ *  Also, if the failed widget has a buddy widget, this buddy widget's text
+ *  will be used as a field name to refer to.
+ */
+QString QIWidgetValidator::warningText() const
+{
+    /* cannot generate an informative message if no caption provided */
+    if (mCaption.isEmpty())
+        return QString::null;
+
+    if (mLastInvalid.state == QValidator::Acceptable)
+        return QString::null;
+
+    AssertReturn (mLastInvalid.widget, QString::null);
+
+    QString title;
+    if (mLastInvalid.buddy != NULL)
+    {
+        if (mLastInvalid.buddy->inherits ("QLabel"))
+            title = VBoxGlobal::
+                removeAccelMark (((QLabel *) mLastInvalid.buddy)->text());
+    }
+
+    QString state;
+    if (mLastInvalid.state == QValidator::Intermediate)
+        state = tr ("not complete", "value state");
+    else
+        state = tr ("invalid", "value state");
+
+    if (!title.isEmpty())
+        return tr ("<qt>Value of the <b>%1</b> field "
+                   "on the <b>%2</b> page is %3.</qt>")
+            .arg (title, mCaption, state);
+
+    return tr ("<qt>One of the values "
+               "on the <b>%1</b> page is %2.</qt>")
+        .arg (mCaption, state);
 }
 

trunk/src/VBox/Frontends/VirtualBox/ui/VBoxGlobalSettingsDlg.ui

@@ -1358 +1358 @@
 <functions>
     <function access="private">init()</function>
+    <function access="private" returnType="QString">pagePath( QWidget * )</function>
     <function access="private" returnType="bool">event( QEvent * )</function>
     <function access="protected">showEvent( QShowEvent * )</function>

trunk/src/VBox/Frontends/VirtualBox/ui/VBoxGlobalSettingsDlg.ui.h

@@ -340 +340 @@
     /* General page */
 
-/// @todo (dmik) remove
-//    leVDIFolder->setValidator (new QRegExpValidator (QRegExp (".+"), this));
-//    leMachineFolder->setValidator (new QRegExpValidator (QRegExp (".+"), this));
-
-    wvalGeneral = new QIWidgetValidator (pageGeneral, this);
+    wvalGeneral = new QIWidgetValidator (pagePath (pageGeneral), pageGeneral, this);
     connect (wvalGeneral, SIGNAL (validityChanged (const QIWidgetValidator *)),
              this, SLOT (enableOk( const QIWidgetValidator *)));
@@ -350 +346 @@
     /* Keyboard page */
 
-    wvalKeyboard = new QIWidgetValidator( pageKeyboard, this );
+    wvalKeyboard = new QIWidgetValidator (pagePath (pageKeyboard), pageKeyboard, this);
     connect (wvalKeyboard, SIGNAL (validityChanged (const QIWidgetValidator *)),
              this, SLOT (enableOk( const QIWidgetValidator *)));
@@ -432 +428 @@
 }
 
+/** 
+ *  Returns a path to the given page of this settings dialog. See ::path() for
+ *  details.
+ */
+QString VBoxGlobalSettingsDlg::pagePath (QWidget *aPage)
+{
+    QListViewItem *li = listView->
+        findItem (QString::number (widgetStack->id (aPage)), 1);
+    return ::path (li);
+}
+
 bool VBoxGlobalSettingsDlg::event (QEvent *aEvent)
 {
@@ -526 +533 @@
     Q_UNUSED (wval);
 
+    /* reset the warning text; interested parties will set it during
+     * validation */
+    setWarning (QString::null);
+
+    QString wvalWarning;
+
     /* detect the overall validity */
     bool newValid = true;
@@ -534 +547 @@
         while ((obj = it.current()) != 0)
         {
-            newValid &= ((QIWidgetValidator *) obj)->isValid();
-            ++it;
+            QIWidgetValidator *wval = (QIWidgetValidator *) obj;
+            newValid = wval->isValid();
+            if (!newValid)
+            {
+                wvalWarning = wval->warningText();
+                break;
+            }
+            ++ it;
         }
         delete l;
     }
 
+    if (warningString.isNull() && !wvalWarning.isNull())
+    {
+        /* try to set the generic error message when invalid but no specific
+         * message is provided */
+        setWarning (wvalWarning);
+    }
+
     if (valid != newValid)
     {
         valid = newValid;
         buttonOk->setEnabled (valid);
+        /// @todo in VBoxVMSettingsDlg.ui.h, this is absent at all. Is it
+        /// really what we want?
+#if 0
         if (valid)
             warningSpacer->changeSize (0, 0, QSizePolicy::Expanding);
         else
             warningSpacer->changeSize (0, 0);
+#endif
         warningLabel->setHidden (valid);
         warningPixmap->setHidden (valid);
@@ -846 +876 @@
     /* setup validation */
 
-    QIWidgetValidator *wval = new QIWidgetValidator (settings, settings);
+    QIWidgetValidator *wval =
+        new QIWidgetValidator (pagePath (pageUSB), settings, settings);
     connect (wval, SIGNAL (validityChanged (const QIWidgetValidator *)),
              this, SLOT (enableOk (const QIWidgetValidator *)));

trunk/src/VBox/Frontends/VirtualBox/ui/VBoxVMSettingsDlg.ui

@@ -3166 +3166 @@
 <functions>
     <function access="private">init()</function>
+    <function access="private" returnType="QString">pagePath( QWidget * )</function>
     <function>setup( const QString &amp;, const QString &amp; )</function>
     <function>getFromMachine( const CMachine &amp; machine )</function>

trunk/src/VBox/Frontends/VirtualBox/ui/VBoxVMSettingsDlg.ui.h

@@ -562 +562 @@
     const uint MaxVRAM = sysProps.GetMaxGuestVRAM();
 
-    leName->setValidator( new QRegExpValidator( QRegExp( ".+" ), this ) );
+    leName->setValidator (new QRegExpValidator (QRegExp (".+"), this));
 
     leRAM->setValidator (new QIntValidator (MinRAM, MaxRAM, this));
     leVRAM->setValidator (new QIntValidator (MinVRAM, MaxVRAM, this));
 
-    wvalGeneral = new QIWidgetValidator( pageGeneral, this );
+    wvalGeneral = new QIWidgetValidator (pagePath (pageGeneral), pageGeneral, this);
     connect (wvalGeneral, SIGNAL (validityChanged (const QIWidgetValidator *)),
              this, SLOT(enableOk (const QIWidgetValidator *)));
@@ -614 +614 @@
                                 "and allows to quickly select a different hard disk."));
 
-    wvalHDD = new QIWidgetValidator( pageHDD, this );
+    wvalHDD = new QIWidgetValidator (pagePath (pageHDD), pageHDD, this);
     connect (wvalHDD, SIGNAL (validityChanged (const QIWidgetValidator *)),
              this, SLOT (enableOk (const QIWidgetValidator *)));
@@ -649 +649 @@
                                    "drive and allows to quickly select a different image."));
 
-    wvalDVD = new QIWidgetValidator (pageDVD, this);
+    wvalDVD = new QIWidgetValidator (pagePath (pageDVD), pageDVD, this);
     connect (wvalDVD, SIGNAL (validityChanged (const QIWidgetValidator *)),
              this, SLOT (enableOk (const QIWidgetValidator *)));
@@ -675 +675 @@
                                       "drive and allows to quickly select a different image."));
 
-    wvalFloppy = new QIWidgetValidator (pageFloppy, this);
+    wvalFloppy = new QIWidgetValidator (pagePath (pageFloppy), pageFloppy, this);
     connect (wvalFloppy, SIGNAL (validityChanged (const QIWidgetValidator *)),
              this, SLOT (enableOk (const QIWidgetValidator *)));
@@ -761 +761 @@
                          "using a standard RDP client."));
 
-    ULONG maxPort = 65535;
-    leVRDPPort->setValidator (new QIntValidator (0, maxPort, this));
-    leVRDPTimeout->setValidator (new QIntValidator (0, maxPort, this));
-    wvalVRDP = new QIWidgetValidator (pageVRDP, this);
+    leVRDPPort->setValidator (new QIntValidator (0, 0xFFFF, this));
+    leVRDPTimeout->setValidator (new QIntValidator (this));
+    wvalVRDP = new QIWidgetValidator (pagePath (pageVRDP), pageVRDP, this);
     connect (wvalVRDP, SIGNAL (validityChanged (const QIWidgetValidator *)),
              this, SLOT (enableOk (const QIWidgetValidator *)));
@@ -878 +877 @@
     cbVRDPAuthType->insertItem (vboxGlobal().toString (CEnums::VRDPAuthGuest));
     leVRDPTimeout->setAlignment (Qt::AlignRight);
+}
+
+/** 
+ *  Returns a path to the given page of this settings dialog. See ::path() for
+ *  details.
+ */
+QString VBoxVMSettingsDlg::pagePath (QWidget *aPage)
+{
+    QListViewItem *li = listView->
+        findItem (QString::number (widgetStack->id (aPage)), 1);
+    return ::path (li);
 }
 
@@ -1298 +1308 @@
 
 
-void VBoxVMSettingsDlg::enableOk( const QIWidgetValidator *wval )
+void VBoxVMSettingsDlg::enableOk (const QIWidgetValidator *wval)
 {
     Q_UNUSED (wval);
@@ -1305 +1315 @@
      * validation */
     setWarning (QString::null);
+
+    QString wvalWarning;
 
     /* detect the overall validity */
@@ -1314 +1326 @@
         while ((obj = it.current()) != 0)
         {
-            newValid &= ((QIWidgetValidator *) obj)->isValid();
-            ++it;
+            QIWidgetValidator *wval = (QIWidgetValidator *) obj;
+            newValid = wval->isValid();
+            if (!newValid)
+            {
+                wvalWarning = wval->warningText();
+                break;
+            }
+            ++ it;
         }
         delete l;
+    }
+
+    if (warningString.isNull() && !wvalWarning.isNull())
+    {
+        /* try to set the generic error message when invalid but no specific
+         * message is provided */
+        setWarning (wvalWarning);
     }
 
@@ -1337 +1362 @@
 
     QString warningText;
-    QString pageTitle = ::path (listView->currentItem());
+    QString pageTitle = pagePath (pg);
 
     if (pg == pageHDD)
@@ -1506 +1531 @@
             }
         }
-    }
-    else if (pg == pageVRDP)
-    {
-        if (pageVRDP->isEnabled())
-        {
-            valid = !(grbVRDP->isChecked() &&
-                    (leVRDPPort->text().isEmpty() || leVRDPTimeout->text().isEmpty()));
-            if (!valid && leVRDPPort->text().isEmpty())
-                warningText = tr ("VRDP Port is not set ");
-            if (!valid && leVRDPTimeout->text().isEmpty())
-                warningText = tr ("VRDP Timeout is not set ");
-        }
-        else
-            valid = true;
     }
 
@@ -2191 +2202 @@
     page->loadList (mInterfaceList, mNoInterfaces);
     page->getFromAdapter (aAdapter);
-    tbwNetwork->addTab (page, QString (tr ("Adapter %1", "network"))
-                                       .arg (aAdapter.GetSlot()));
+    QString pageTitle = QString (tr ("Adapter %1", "network"))
+                                 .arg (aAdapter.GetSlot());
+    tbwNetwork->addTab (page, pageTitle);
 
     /* fix the tab order so that main dialog's buttons are always the last */
@@ -2200 +2212 @@
 
     /* setup validation */
-    QIWidgetValidator *wval = new QIWidgetValidator (pageNetwork, this);
+    QIWidgetValidator *wval =
+        new QIWidgetValidator (QString ("%1: %2")
+                               .arg (pagePath (pageNetwork), pageTitle),
+                               pageNetwork, this);
     connect (page->grbEnabled, SIGNAL (toggled (bool)), wval, SLOT (revalidate()));
     connect (page->cbNetworkAttachment, SIGNAL (activated (const QString &)),
@@ -2228 +2243 @@
     VBoxVMSerialPortSettings *page = new VBoxVMSerialPortSettings();
     page->getFromPort (aPort);
-    tbwSerialPorts->addTab (page, QString (tr ("Port %1", "serial ports"))
-                                               .arg (aPort.GetSlot()));
+    QString pageTitle = QString (tr ("Port %1", "serial ports"))
+                                 .arg (aPort.GetSlot());
+    tbwSerialPorts->addTab (page, pageTitle);
 
     /* fix the tab order so that main dialog's buttons are always the last */
@@ -2237 +2253 @@
 
     /* setup validation */
-    QIWidgetValidator *wval = new QIWidgetValidator (pageSerial, this);
+    QIWidgetValidator *wval =
+        new QIWidgetValidator (QString ("%1: %2")
+                               .arg (pagePath (pageSerial), pageTitle),
+                               pageSerial, this);
     connect (page->mSerialPortBox, SIGNAL (toggled (bool)),
              wval, SLOT (revalidate()));
@@ -2355 +2374 @@
     /* setup validation */
 
-    QIWidgetValidator *wval = new QIWidgetValidator (settings, settings);
+    QIWidgetValidator *wval =
+        new QIWidgetValidator (pagePath (pageUSB), settings, settings);
     connect (wval, SIGNAL (validityChanged (const QIWidgetValidator *)),
              this, SLOT (enableOk (const QIWidgetValidator *)));