QGCMessageBox.h 5.74 KB
Newer Older
Don Gagne's avatar
Don Gagne committed
1
/*=====================================================================
2

Don Gagne's avatar
Don Gagne committed
3
 QGroundControl Open Source Ground Control Station
4

Don Gagne's avatar
Don Gagne committed
5
 (c) 2009 - 2014 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
6

Don Gagne's avatar
Don Gagne committed
7
 This file is part of the QGROUNDCONTROL project
8

Don Gagne's avatar
Don Gagne committed
9 10 11 12
 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.
13

Don Gagne's avatar
Don Gagne committed
14 15 16 17
 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.
18

Don Gagne's avatar
Don Gagne committed
19 20
 You should have received a copy of the GNU General Public License
 along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.
21

Don Gagne's avatar
Don Gagne committed
22 23 24 25 26 27 28 29
 ======================================================================*/

#ifndef QGCMESSAGEBOX_H
#define QGCMESSAGEBOX_H

#include <QMessageBox>

#include "MainWindow.h"
Don Gagne's avatar
Don Gagne committed
30
#include "QGCApplication.h"
31

Don Gagne's avatar
Don Gagne committed
32
#ifdef QT_DEBUG
dogmaphobic's avatar
dogmaphobic committed
33
#ifndef __mobile__
Don Gagne's avatar
Don Gagne committed
34
#include "UnitTest.h"
Don Gagne's avatar
Don Gagne committed
35
#endif
36

dogmaphobic's avatar
dogmaphobic committed
37
#endif
Don Gagne's avatar
Don Gagne committed
38 39 40 41 42 43 44 45 46

/// @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 {
47

Don Gagne's avatar
Don Gagne committed
48 49 50
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); }
51

Don Gagne's avatar
Don Gagne committed
52 53
    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); }
54

Don Gagne's avatar
Don Gagne committed
55 56
    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); }
57

Don Gagne's avatar
Don Gagne committed
58 59
    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); }
60

Don Gagne's avatar
Don Gagne committed
61 62 63 64
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(); }
65

Don Gagne's avatar
Don Gagne committed
66
private:
Don Gagne's avatar
Don Gagne committed
67 68 69 70
    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));
71

Don Gagne's avatar
Don Gagne committed
72 73
        // 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.
74

Don Gagne's avatar
Don Gagne committed
75 76 77 78 79 80 81 82
        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);
83

Don Gagne's avatar
Don Gagne committed
84 85 86 87 88 89
        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));
        }
90

Don Gagne's avatar
Don Gagne committed
91 92 93
        return (parent == NULL) ? MainWindow::instance() : parent;
    }

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

99
        Q_ASSERT_X(QThread::currentThread() == qgcApp()->thread(), "Threading issue", "QGCMessageBox can only be called from main thread");
100

Don Gagne's avatar
Don Gagne committed
101
        parent = _validateParameters(buttons, &defaultButton, parent);
Don Gagne's avatar
Don Gagne committed
102 103 104

        if (MainWindow::instance()) {
            MainWindow::instance()->hideSplashScreen();
105 106 107
            if (parent == NULL) {
                parent = MainWindow::instance();
            }
Don Gagne's avatar
Don Gagne committed
108
        }
109

Don Gagne's avatar
Don Gagne committed
110
#ifdef QT_DEBUG
dogmaphobic's avatar
dogmaphobic committed
111
#ifndef __mobile__
Don Gagne's avatar
Don Gagne committed
112
        if (qgcApp()->runningUnitTests()) {
Don Gagne's avatar
Don Gagne committed
113
            qDebug() << "QGCMessageBox (unit testing)" << title << text;
Don Gagne's avatar
Don Gagne committed
114 115
            return UnitTest::_messageBox(icon, title, text, buttons, defaultButton);
        } else
dogmaphobic's avatar
dogmaphobic committed
116
#endif
Don Gagne's avatar
Don Gagne committed
117
#endif
Don Gagne's avatar
Don Gagne committed
118
        {
Don Gagne's avatar
Don Gagne committed
119
#ifdef Q_OS_MAC
Don Gagne's avatar
Don Gagne committed
120 121 122 123
            QString emptyTitle;
            QMessageBox box(icon, emptyTitle, title, buttons, parent);
            box.setDefaultButton(defaultButton);
            box.setInformativeText(text);
124 125 126 127
            // Get this thing off a proper size
            QSpacerItem* horizontalSpacer = new QSpacerItem(500, 0, QSizePolicy::Minimum, QSizePolicy::Expanding);
            QGridLayout* layout = (QGridLayout*)box.layout();
            layout->addItem(horizontalSpacer, layout->rowCount(), 0, 1, layout->columnCount());
Don Gagne's avatar
Don Gagne committed
128
#else
Don Gagne's avatar
Don Gagne committed
129 130
            QMessageBox box(icon, title, text, buttons, parent);
            box.setDefaultButton(defaultButton);
Don Gagne's avatar
Don Gagne committed
131
#endif
Don Gagne's avatar
Don Gagne committed
132
            return static_cast<QMessageBox::StandardButton>(box.exec());
Don Gagne's avatar
Don Gagne committed
133 134 135 136 137
        }
    }
};

#endif