overlaymessages.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_GUI_OVERLAYMESSAGES_H
#define SWIFT_GUI_OVERLAYMESSAGES_H
 
#include <chrono>
#include <functional>
 
#include <QFrame>
#include <QMessageBox>
#include <QObject>
#include <QScopedPointer>
#include <QString>
#include <QTimer>
 
#include "gui/components/textmessagecomponenttab.h"
#include "gui/settings/textmessagesettings.h"
#include "gui/swiftguiexport.h"
#include "misc/aviation/callsign.h"
#include "misc/pixmap.h"
#include "misc/statusmessage.h"
#include "misc/statusmessagelist.h"
#include "misc/variant.h"
 
class QKeyEvent;
class QPaintEvent;
class QPixmap;
 
namespace Ui
{
    class COverlayMessages;
}
namespace swift::misc::network
{
    class CTextMessage;
}
namespace swift::gui
{
    class SWIFT_GUI_EXPORT COverlayMessages : public QFrame
    {
        Q_OBJECT
 
    public:
        explicit COverlayMessages(int w, int h, QWidget *parent);
 
        virtual ~COverlayMessages() override;
 
        void setModeToMessages();
 
        void setModeToMessage();
 
        void setModeToMessageSmall();
 
        void setModeToHTMLMessage();
 
        void setModeToProgressBar();
 
        void setModeToTextMessage();
 
        void setModeToOverlayTextMessage();
 
        void activateTextMessages(bool activate);
 
        bool isTextMessagesActivated() const;
 
        void setModeToImage();
 
        void setForceSmall(bool force) { m_forceSmall = force; }
 
        void setHeaderText(const QString &header);
 
        void setConfirmationMessage(const QString &message);
 
        void showOverlayMessagesWithConfirmation(const swift::misc::CStatusMessageList &messages,
                                                 bool appendOldMessages, const QString &confirmationMessage,
                                                 std::function<void()> okLambda,
                                                 QMessageBox::StandardButton defaultButton = QMessageBox::Cancel,
                                                 std::chrono::milliseconds timeout = std::chrono::milliseconds(0));
 
        void clearOverlayMessages();
 
        void showOverlayMessages(const swift::misc::CStatusMessageList &messages, bool appendOldMessages = false,
                                 std::chrono::milliseconds timeout = std::chrono::milliseconds(0));
 
        void showOverlayMessagesOrSingleMessage(const swift::misc::CStatusMessageList &messages,
                                                bool appendOldMessages = false,
                                                std::chrono::milliseconds timeout = std::chrono::milliseconds(0));
 
        void showOverlayMessagesOrHTMLMessage(const swift::misc::CStatusMessageList &messages,
                                              bool appendOldMessages = false,
                                              std::chrono::milliseconds timeout = std::chrono::milliseconds(0));
 
        void sortOverlayMessages(const swift::misc::CPropertyIndex &propertyIndex,
                                 Qt::SortOrder order = Qt::AscendingOrder);
 
        void setOverlayMessagesSorting(const swift::misc::CPropertyIndex &propertyIndex,
                                       Qt::SortOrder order = Qt::AscendingOrder);
 
        void showOverlayMessage(const swift::misc::CStatusMessage &message,
                                std::chrono::milliseconds timeout = std::chrono::milliseconds(0));
 
        void showOverlayTextMessage(const swift::misc::network::CTextMessage &textMessage,
                                    std::chrono::milliseconds timeout = std::chrono::milliseconds(0));
 
        void showOverlayInlineTextMessage(components::TextMessageTab tab);
 
        void showOverlayInlineTextMessage(const swift::misc::aviation::CCallsign &callsign);
 
        void showOverlayImage(const swift::misc::CPixmap &image,
                              std::chrono::milliseconds timeout = std::chrono::milliseconds(0));
 
        void showOverlayImage(const QPixmap &image, std::chrono::milliseconds timeout = std::chrono::milliseconds(0));
 
        void showOverlayVariant(const swift::misc::CVariant &variant,
                                std::chrono::milliseconds timeout = std::chrono::milliseconds(0));
 
        void showHTMLMessage(const swift::misc::CStatusMessage &message,
                             std::chrono::milliseconds timeout = std::chrono::milliseconds(0));
 
        void showHTMLMessage(const QString &htmlMessage,
                             std::chrono::milliseconds timeout = std::chrono::milliseconds(0));
 
        void showDownloadProgress(int progress, qint64 current, qint64 max, const QUrl &url,
                                  std::chrono::milliseconds timeout = std::chrono::milliseconds(0));
 
        void showProgressBar(int percentage, const QString &message,
                             std::chrono::milliseconds timeout = std::chrono::milliseconds(0));
 
        void close();
 
        void setDefaultConfirmationButton(int button = QMessageBox::Cancel);
 
        bool hasPendingConfirmation() const;
 
        void setReducedInfo(bool reduced);
 
        void addShadow(QColor color = Qt::gray);
 
    signals:
        void confirmationCompleted();
 
    protected:
        void display(std::chrono::milliseconds timeout = std::chrono::milliseconds(0));
 
        virtual void keyPressEvent(QKeyEvent *event) override;
 
    private:
        QScopedPointer<Ui::COverlayMessages> ui;
        swift::misc::CSettingReadOnly<settings::TextMessageSettings> m_messageSettings { this };
        QString m_header;
        int m_lastConfirmation = QMessageBox::Cancel;
        bool m_awaitingConfirmation = false;
        bool m_hasKillButton = false;
        bool m_forceSmall = false;
        QTimer m_autoCloseTimer { this };
        std::function<void()> m_okLambda; 
        QList<std::function<void()>> m_pendingMessageCalls;
 
        void onStyleSheetsChanged();
 
        void onOkClicked();
 
        void onCancelClicked();
 
        void init(int w, int h);
 
        void setHeader(const QString &header);
 
        bool useSmall() const;
 
        bool displayTextMessage(const swift::misc::network::CTextMessage &textMessage) const;
    };
} // namespace swift::gui
 
#endif // SWIFT_GUI_OVERLAYMESSAGES_H