QGCMessageBox.h 5.75 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
 ======================================================================*/

#ifndef QGCMESSAGEBOX_H
#define QGCMESSAGEBOX_H

27
28
29
30
#ifdef __mobile__
#error Should not be included in mobile builds
#endif

Don Gagne's avatar
Don Gagne committed
31
32
33
#include <QMessageBox>

#include "MainWindow.h"
Don Gagne's avatar
Don Gagne committed
34
#include "QGCApplication.h"
35

Don Gagne's avatar
Don Gagne committed
36
#ifdef QT_DEBUG
dogmaphobic's avatar
dogmaphobic committed
37
#ifndef __mobile__
Don Gagne's avatar
Don Gagne committed
38
#include "UnitTest.h"
Don Gagne's avatar
Don Gagne committed
39
#endif
40

dogmaphobic's avatar
dogmaphobic committed
41
#endif
Don Gagne's avatar
Don Gagne committed
42
43
44
45
46
47
48
49
50

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

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

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

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

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

Don Gagne's avatar
Don Gagne committed
65
private slots:
nopeppermint's avatar
nopeppermint committed
66
    /// @brief The exec slot is private because when only want QGCMessageBox users to use the static methods. Otherwise it will break
Don Gagne's avatar
Don Gagne committed
67
68
    ///         unit testing.
    int exec(void) { return QMessageBox::exec(); }
69

Don Gagne's avatar
Don Gagne committed
70
private:
Don Gagne's avatar
Don Gagne committed
71
72
73
74
    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));
75

Don Gagne's avatar
Don Gagne committed
76
77
        // 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.
78

Don Gagne's avatar
Don Gagne committed
79
80
81
82
83
84
85
86
        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);
87

Don Gagne's avatar
Don Gagne committed
88
89
90
91
92
93
        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));
        }
94

Don Gagne's avatar
Don Gagne committed
95
96
97
        return (parent == NULL) ? MainWindow::instance() : parent;
    }

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

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

Don Gagne's avatar
Don Gagne committed
105
        parent = _validateParameters(buttons, &defaultButton, parent);
Don Gagne's avatar
Don Gagne committed
106
107

        if (MainWindow::instance()) {
108
109
110
            if (parent == NULL) {
                parent = MainWindow::instance();
            }
Don Gagne's avatar
Don Gagne committed
111
        }
112

Don Gagne's avatar
Don Gagne committed
113
114
        qDebug() << "QGCMessageBox (unit testing)" << title << text;

Don Gagne's avatar
Don Gagne committed
115
#ifdef QT_DEBUG
dogmaphobic's avatar
dogmaphobic committed
116
#ifndef __mobile__
Don Gagne's avatar
Don Gagne committed
117
118
119
        if (qgcApp()->runningUnitTests()) {
            return UnitTest::_messageBox(icon, title, text, buttons, defaultButton);
        } else
dogmaphobic's avatar
dogmaphobic committed
120
#endif
Don Gagne's avatar
Don Gagne committed
121
#endif
Don Gagne's avatar
Don Gagne committed
122
        {
dogmaphobic's avatar
dogmaphobic committed
123
#ifdef __macos__
Don Gagne's avatar
Don Gagne committed
124
125
126
127
            QString emptyTitle;
            QMessageBox box(icon, emptyTitle, title, buttons, parent);
            box.setDefaultButton(defaultButton);
            box.setInformativeText(text);
128
129
130
131
            // 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
132
#else
Don Gagne's avatar
Don Gagne committed
133
134
            QMessageBox box(icon, title, text, buttons, parent);
            box.setDefaultButton(defaultButton);
Don Gagne's avatar
Don Gagne committed
135
#endif
Don Gagne's avatar
Don Gagne committed
136
            return static_cast<QMessageBox::StandardButton>(box.exec());
Don Gagne's avatar
Don Gagne committed
137
138
139
140
141
        }
    }
};

#endif