CGuiApplicationComp.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ACF-Commercial
#pragma once
 
 
// Qt includes
#include <QtCore/QtGlobal>
#if QT_VERSION >= 0x050000
#include <QtWidgets/QSystemTrayIcon>
#else
#include <QtGui/QSystemTrayIcon>
#endif
 
// ACF includes
#include <imod/TSingleModelObserverBase.h>
#include <iprm/IEnableableParam.h>
#include <ilog/IMessageConsumer.h>
#include <ibase/ICommandsProvider.h>
#include <iqtgui/IGuiObject.h>
#include <iqtgui/IGuiApplication.h>
#include <iqtgui/CApplicationCompBase.h>
 
 
namespace iqtgui
{
 
 
class CGuiApplicationComp:
                     public CApplicationCompBase,
                     protected imod::TSingleModelObserverBase<iprm::IEnableableParam>,
                     virtual public iqtgui::IGuiApplication
{
       Q_OBJECT
public:
       typedef CApplicationCompBase BaseClass;
       typedef imod::TSingleModelObserverBase<iprm::IEnableableParam> BaseClass2;
 
       I_BEGIN_COMPONENT(CGuiApplicationComp);
              I_REGISTER_INTERFACE(ibase::IApplication);
              I_REGISTER_SUBELEMENT(TrayMessages);
              I_REGISTER_SUBELEMENT_INTERFACE(TrayMessages, ilog::IMessageConsumer, ExtractTrayMessages);
              I_ASSIGN(m_mainGuiCompPtr, "MainGui", "Gui object shown as main window", false, "MainGui");
              I_ASSIGN(m_allowApplicationCloseCompPtr, "AllowClose", "Controls closing of the application", false, "AllowClose");
              I_ASSIGN_TO(m_allowApplicationCloseModelCompPtr, m_allowApplicationCloseCompPtr, false);
              I_ASSIGN(m_trayIconCommandsCompPtr, "TrayIconsCommands", "Provider of tray icons commands. The commands are shown in the menu of the system tray", false, "TrayIconsCommands");
              I_ASSIGN(m_frameSpaceSizeAttrPtr, "FrameSpaceSize", "Number of pixels will be added on the all window sides", false, 9);
              I_ASSIGN(m_uiStartModeAttrPtr, "UiStartMode", "UI mode by application start up.\n0 - normal\n1 - full screen\n2 - minimized\n3 - maximized", false, 0);
              I_ASSIGN(m_useMenuIconsOnMacAttrPtr, "UseMenuIconsOnMac", "If enabled, the menu icons will be used in the application's menu bar on Mac OS", true, false);
              I_ASSIGN(m_useTrayIconAttrPtr, "UseTrayIcon", "If enabled, the tray icon for the application will be used", true, false);
              I_ASSIGN(m_trayIconToolTip, "TrayIconToolTip", "This property holds the tooltip for the system tray entry \n Note: On some systems, the tooltip's length is limited. The tooltip will be truncated if necessary.", false, "");
              I_ASSIGN(m_useFullScreenBorderOnWindowsAttrPtr, "UseFullScreenBorderOnWindows", "If enabled, 1-pixel border will be created by Windows in full screen mode", true, false);
       I_END_COMPONENT;
 
       CGuiApplicationComp();
 
       // reimplemented (ibase::IGuiApplication)
       virtual const iqtgui::IGuiObject* GetApplicationGui() const override;
 
       // reimplemented (ibase::IApplication)
       virtual bool InitializeApplication(int argc, char** argv) override;
       virtual int Execute(int argc, char** argv) override;
       virtual QString GetHelpText() const override;
 
protected:
       // reimplemented (imod::TSingleModelObserverBase)
       virtual void OnUpdate(const istd::IChangeable::ChangeSet& changeSet) override;
 
       // reimplemented (icomp::CComponentBase)
       virtual void OnComponentDestroyed() override;
 
       // reimplemented (QObject)
       virtual bool eventFilter(QObject* obj, QEvent* ev) override;
 
protected:
       template <class InterfaceType>
       static InterfaceType* ExtractTrayMessages(CGuiApplicationComp& component)
       {
              return &component.m_trayMessages;
       }
 
       class TrayMessages: virtual public ilog::IMessageConsumer
       {
       public:
              explicit TrayMessages(CGuiApplicationComp& parent);
 
              // reimplemented (ilog::IMessageConsumer)
              virtual bool IsMessageSupported(
                                   int messageCategory = -1,
                                   int messageId = -1,
                                   const istd::IInformationProvider* messagePtr = NULL) const override;
              virtual void AddMessage(const MessagePtr& messagePtr) override;
 
       private:
              CGuiApplicationComp& m_parent;
       };
 
private:
       void UpdateMainWidgetDecorations();
       void ShowWindow();
       void ShowFullScreen();
 
private Q_SLOTS:
       void OnQuit();
       void OnEventLoopStarted();
 
Q_SIGNALS:
       void OnEventLoopStartedSignal();
 
protected:
       I_REF(IGuiObject, m_mainGuiCompPtr);
       I_REF(iprm::IEnableableParam, m_allowApplicationCloseCompPtr);
       I_REF(imod::IModel, m_allowApplicationCloseModelCompPtr);
       I_REF(ibase::ICommandsProvider, m_trayIconCommandsCompPtr);
       I_ATTR(int, m_frameSpaceSizeAttrPtr);
       I_ATTR(int, m_uiStartModeAttrPtr);
       I_ATTR(bool, m_useMenuIconsOnMacAttrPtr);
       I_ATTR(bool, m_useTrayIconAttrPtr);
       I_TEXTATTR(m_trayIconToolTip);
 
       I_ATTR(bool, m_useFullScreenBorderOnWindowsAttrPtr);
 
       istd::TDelPtr<QWidget> m_mainWidgetPtr;
       Qt::WindowFlags m_defaultWidgetFlags;
       QRect m_lastWidgetGeometry;
 
       TrayMessages m_trayMessages;
       
       istd::TDelPtr<QSystemTrayIcon> m_trayIconPtr;
};
 
 
} // namespace iqtgui