QGCMessageBox.h 5.21 KB
Newer Older
Don Gagne's avatar
Don Gagne committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/*=====================================================================
 
 QGroundControl Open Source Ground Control Station
 
 (c) 2009 - 2014 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 
 This file is part of the QGROUNDCONTROL project
 
 QGROUNDCONTROL is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.
 
 QGROUNDCONTROL is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.
 
 ======================================================================*/

#ifndef QGCMESSAGEBOX_H
#define QGCMESSAGEBOX_H

#include <QMessageBox>

#include "MainWindow.h"
Don Gagne's avatar
Don Gagne committed
30
#include "QGCApplication.h"
Don Gagne's avatar
Don Gagne committed
31
#ifdef QT_DEBUG
Don Gagne's avatar
Don Gagne committed
32
#include "UnitTest.h"
Don Gagne's avatar
Don Gagne committed
33
#endif
Don Gagne's avatar
Don Gagne committed
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56

/// @file
///     @brief Subclass of QMessageBox which re-implements the static public functions. There are two reasons for this:
///             1) The QMessageBox implementation on OSX does now show the title string. This leads to message
///             boxes which don't make much sense. So on OSX we set title to text and text to informative text.
///             2) If parent is NULL, we set parent to MainWindow::instance
///     @author Don Gagne <don@thegagnes.com>

class QGCMessageBox : public QMessageBox {
    
public:
    static StandardButton critical(const QString& title, const QString& text, StandardButtons buttons = Ok, StandardButton defaultButton = NoButton, QWidget* parent = NULL)
        { return _messageBox(QMessageBox::Critical, title, text, buttons, defaultButton, parent); }
    
    static StandardButton information(const QString & title, const QString& text, StandardButtons buttons = Ok, StandardButton defaultButton = NoButton, QWidget* parent = NULL)
        { return _messageBox(QMessageBox::Information, title, text, buttons, defaultButton, parent); }
    
    static StandardButton question(const QString& title, const QString& text, StandardButtons buttons = Ok, StandardButton defaultButton = NoButton, QWidget* parent = NULL)
        { return _messageBox(QMessageBox::Question, title, text, buttons, defaultButton, parent); }
    
    static StandardButton warning(const QString& title, const QString& text, StandardButtons buttons = Ok, StandardButton defaultButton = NoButton, QWidget* parent = NULL)
        { return _messageBox(QMessageBox::Warning, title, text, buttons, defaultButton, parent); }
    
Don Gagne's avatar
Don Gagne committed
57 58 59 60 61
private slots:
    /// @brief The exec slot is private becasue when only want QGCMessageBox users to use the static methods. Otherwise it will break
    ///         unit testing.
    int exec(void) { return QMessageBox::exec(); }
    
Don Gagne's avatar
Don Gagne committed
62
private:
Don Gagne's avatar
Don Gagne committed
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
    static QWidget* _validateParameters(StandardButtons buttons, StandardButton* defaultButton, QWidget* parent)
    {
        // This is an obsolete bit which unit tests use for signalling. It should not be used in regular code.
        Q_ASSERT(!(buttons & QMessageBox::Escape));
        
        // If there is more than one button displayed, make sure a default button is set. Without this unit test code
        // will not be able to respond to unexpected message boxes.
        
        unsigned int bits = static_cast<unsigned int>(buttons);
        int buttonCount = 0;
        for (size_t i=0; i<sizeof(bits)*8; i++) {
            if (bits & (1 << i)) {
                buttonCount++;
            }
        }
        Q_ASSERT(buttonCount != 0);
        
        if (buttonCount > 1) {
            Q_ASSERT(buttons & *defaultButton);
        } else {
            // Force default button to be set correctly for single button case to make unit test code simpler
            *defaultButton = static_cast<QMessageBox::StandardButton>(static_cast<int>(buttons));
        }
        
        return (parent == NULL) ? MainWindow::instance() : parent;
    }

Don Gagne's avatar
Don Gagne committed
90 91
    static StandardButton _messageBox(Icon icon, const QString& title, const QString& text, StandardButtons buttons, StandardButton defaultButton, QWidget* parent)
    {
Don Gagne's avatar
Don Gagne committed
92 93 94 95
        // You can't use QGCMessageBox if QGCApplication is not created yet.
        Q_ASSERT(qgcApp());
        
        parent = _validateParameters(buttons, &defaultButton, parent);
Don Gagne's avatar
Don Gagne committed
96 97 98 99

        if (MainWindow::instance()) {
            MainWindow::instance()->hideSplashScreen();
        }
Don Gagne's avatar
Don Gagne committed
100 101 102
        
#ifdef QT_DEBUG
        if (qgcApp()->runningUnitTests()) {
Don Gagne's avatar
Don Gagne committed
103
            qDebug() << "QGCMessageBox (unit testing)" << title << text;
Don Gagne's avatar
Don Gagne committed
104 105
            return UnitTest::_messageBox(icon, title, text, buttons, defaultButton);
        } else
Don Gagne's avatar
Don Gagne committed
106
#endif
Don Gagne's avatar
Don Gagne committed
107
        {
Don Gagne's avatar
Don Gagne committed
108
#ifdef Q_OS_MAC
Don Gagne's avatar
Don Gagne committed
109 110 111 112
            QString emptyTitle;
            QMessageBox box(icon, emptyTitle, title, buttons, parent);
            box.setDefaultButton(defaultButton);
            box.setInformativeText(text);
Don Gagne's avatar
Don Gagne committed
113
#else
Don Gagne's avatar
Don Gagne committed
114 115
            QMessageBox box(icon, title, text, buttons, parent);
            box.setDefaultButton(defaultButton);
Don Gagne's avatar
Don Gagne committed
116
#endif
Don Gagne's avatar
Don Gagne committed
117
            return static_cast<QMessageBox::StandardButton>(box.exec());
Don Gagne's avatar
Don Gagne committed
118 119 120 121 122
        }
    }
};

#endif