textmessagecomponent.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1

 
#ifndef SWIFT_GUI_COMPONENTS_TEXTMESSAGECOMPONENT_H
#define SWIFT_GUI_COMPONENTS_TEXTMESSAGECOMPONENT_H
 
#include <QFrame>
#include <QObject>
#include <QScopedPointer>
#include <QString>
 
#include "gui/components/textmessagecomponenttab.h"
#include "gui/enablefordockwidgetinfoarea.h"
#include "gui/settings/textmessagesettings.h"
#include "gui/swiftguiexport.h"
#include "misc/audio/audiosettings.h"
#include "misc/aviation/atcstation.h"
#include "misc/identifier.h"
#include "misc/network/textmessagelist.h"
#include "misc/simulation/simulatedaircraft.h"
#include "misc/variant.h"
 
namespace Ui
{
    class CTextMessageComponent;
}
namespace swift::gui
{
    class CDockWidgetInfoArea;
    class CTextMessageTextEdit;
 
    namespace components
    {
        class SWIFT_GUI_EXPORT CTextMessageComponent : public QFrame, public CEnableForDockWidgetInfoArea
        {
            Q_OBJECT
 
        public:
            explicit CTextMessageComponent(QWidget *parent = nullptr);

            ~CTextMessageComponent() override;

            bool setParentDockWidgetInfoArea(CDockWidgetInfoArea *parentDockableWidget) override;

            bool handleGlobalCommandLineText(const QString &commandLine, const swift::misc::CIdentifier &originator);

            void fontSizeMinus();
            void fontSizePlus();

            void showCorrespondingTab(const swift::misc::aviation::CCallsign &callsign);

            void showCorrespondingTabForFrequency(const swift::misc::physical_quantities::CFrequency &frequency);

            void setTab(TextMessageTab tab);

            bool hasAllMessagesTab() const;

            void showSettings(bool show);

            void showTextMessageEntry(bool show);

            void focusTextEntry();

            void removeAllMessagesTab();

            bool isShowingRealNames() const { return m_showRealNames; }

            void setShowingRealNames(bool show) { m_showRealNames = show; }
 
            // ---------- overlay test messages -------------

            void setAsUsedInOverlayMode() { m_usedAsOverlayWidget = true; }

            void activate(bool send, bool receive);

            bool isActivated() const { return m_activeSend || m_activeReceive; }

            void setAtcButtonsRowsColumns(int rows, int cols, bool setMaxElements);

            void setAtcButtonsBackgroundUpdates(bool backgroundUpdates);

            void updateAtcStationsButtons();
 
        signals:
            void displayInInfoWindow(const swift::misc::CVariant &message, std::chrono::milliseconds displayDuration);

            void commandEntered(const QString &commandLine, const swift::misc::CIdentifier &originator);

            void textMessageTabSelected();
 
        private:
            QScopedPointer<Ui::CTextMessageComponent> ui;
            swift::misc::CIdentifier m_identifier { "TextMessageComponent", this };
            swift::misc::CSetting<settings::TextMessageSettings> m_messageSettings {
                this, &CTextMessageComponent::onSettingsChanged
            };
            swift::misc::CSetting<swift::misc::audio::TSettings> m_audioSettings { this };
            bool m_usedAsOverlayWidget = false; 
            bool m_activeSend = true; 
            bool m_activeReceive = true; 
            bool m_showRealNames = true;

            QWidget *getTabWidget(TextMessageTab tab) const;

            CTextMessageTextEdit *getTextEdit(TextMessageTab tab) const;

            void selectTabWidget(TextMessageTab tab);

            void selectTabWidget(const swift::misc::aviation::CCallsign &callsign, bool addIfNotExisting);

            bool isCloseableTab(const QWidget *tabWidget) const;

            QWidget *addNewTextMessageTab(const swift::misc::aviation::CCallsign &callsign);

            QWidget *findTextMessageTabByCallsign(const swift::misc::aviation::CCallsign &callsign,
                                                  bool callsignResolution = false) const;

            QWidget *findTextMessageTabByName(const QString &name) const;

            void addPrivateChannelTextMessage(const swift::misc::network::CTextMessage &textMessage);

            swift::misc::simulation::CSimulatedAircraft getOwnAircraft() const;

            bool isCorrespondingTextMessageTabSelected(const swift::misc::network::CTextMessage &textMessage) const;

            bool isNetworkConnected() const;

            void showCurrentFrequenciesFromCockpit();
            void showCurrentFrequenciesFromCockpit(const swift::misc::simulation::CSimulatedAircraft &ownAircraft);

            void displayTextMessage(const swift::misc::network::CTextMessageList &messages);

            QString textMessageToCommand(const QString &enteredLine);

            const swift::misc::CIdentifier &componentIdentifier() const { return m_identifier; }

            void handleEnteredTextMessage(const QString &textMessage);

            void onTextMessageReceived(const swift::misc::network::CTextMessageList &messages);

            void onTextMessageSent(const swift::misc::network::CTextMessage &sentMessage);

            void onChangedAircraftCockpit(const swift::misc::simulation::CSimulatedAircraft &aircraft,
                                          const swift::misc::CIdentifier &originator);

            void onSettingsChecked(bool checked);

            void onMessageToChecked(bool checked);

            void onSettingsChanged();

            void onLatestFirstChanged(bool checked);

            void onStyleSheetChanged();

            void onAtcButtonClicked(const swift::misc::aviation::CAtcStation &station);

            void updateSettings();

            QList<CTextMessageTextEdit *> findAllTextEdit() const;

            QString getStyleSheet() const;

            void closeTextMessageTab();

            void updateAllTabs();

            void topLevelChanged(QWidget *widget, bool topLevel);

            void textMessageEntered();

            void setTabWidgetDescription(const swift::misc::aviation::CCallsign &callsign, int widgetIndex);

            QString getCallsignAndRealName(const swift::misc::aviation::CCallsign &callsign) const;

            bool isVisibleWidgetHack() const;

            swift::misc::aviation::CCallsign getCallsignPropertyForTab(int tabIndex, bool validated) const;

            void emitDisplayInInfoWindow(const misc::CVariant &message, std::chrono::milliseconds displayDuration);

            static QString firstPartOfTabText(const QString &tabText);
        };
    } // namespace components
} // namespace swift::gui
 
#endif // SWIFT_GUI_COMPONENTS_TEXTMESSAGECOMPONENT_H