Files
qt-migration-legatus/qt6-after/qt6-migrated-legatus/Lts/Common/PluginInterfaces/gui_plugin_interface.h
T
berrux-dev 156c2dfcdc Restore legacy @RDE_HEADER@ comment blocks stripped by the Qt6 migration
The migration pipeline dropped the leading @RDE_HEADER@ comment blocks
from 243 target source files (and 2 cmake macros). Restore them
byte-for-byte from the legacy Qt5 tree
(qt5-before/qt5-legatus-legacy): the exact legacy header is re-inserted
at the top of each file (block-comment, '#'-style, line-comment '//'
styles, BOM and surrounding blank lines included). File bodies are
untouched.

Scope: all in-scope target code, unit-test directories excluded.
190 files already kept their legacy header through the migration and
were left as-is; legacy files without an RDE header were not given
one. Special cases: 3 headers sitting after a '#pragma once' line,
1 BOM-prefixed file, 4 '//'-style TetraIF headers. *.grantlee template
files were not in scope and remain untouched.

Verified: every restored file is byte-exact (legacy preamble + original
body) and the ctest baseline is unchanged (20/23 passed, 3 Not Run as
before).
2026-11-15 23:22:04 +01:00

153 lines
2.9 KiB
C++

/**
* @RDE_HEADER@
* Interface for HMI plugins
* $Id$
* $HeadURL$
* $Author$
* Created by Christian Ehrlicher, SLSE, 2016-02-29
*/
#pragma once
#include <LtsAppDescriptor/lts_app_descriptor.h>
#include <LtsUtils/LtsUtilsCore/lts_translatable_identifier.h>
#include <LtsWidgets/lts_base.h>
#include <ProjectConfig/project_defines.h>
#include <QtCore/QFlags>
#include <QtCore/QVector>
#include <QObject>
#include <memory>
namespace NGL
{
class INGLLogger;
}
namespace LtsWidgets
{
class LtsBackgroundWidget;
class LtsBaseLayoutWidget;
} // namespace LtsWidgets
namespace LtsSession
{
class LtsSession;
}
namespace GuiPluginBase
{
class Interface;
class Plugin
{
Q_GADGET
public:
virtual ~Plugin() = default;
virtual QString pluginName() = 0;
virtual std::shared_ptr<Interface> createGuiInterface(LtsSession::LtsSession* session) = 0;
virtual bool availableInPartition(IDL::PartitionType partition) const = 0;
};
class Interface
{
public:
Interface(LtsSession::LtsSession* session, NGL::INGLLogger& logger)
: m_hasInit(true), m_session(session), m_appId(LtsAppDescriptor::App::Login), m_logger(logger)
{
}
virtual ~Interface() = default;
void setFlags(const QFlags<LtsAppDescriptor::PluginInfo::Flag>& flags)
{
m_flags = flags;
}
const QFlags<LtsAppDescriptor::PluginInfo::Flag>& getFlags() const
{
return m_flags;
}
void setOptions(const QStringList& options)
{
m_options = options;
}
const QStringList& getOptions() const
{
return m_options;
}
void setAppId(LtsAppDescriptor::App appId)
{
m_appId = appId;
}
LtsAppDescriptor::App appId() const
{
return m_appId;
}
virtual QVector<LtsWidgets::PluginData> getActions()
{
return QVector<LtsWidgets::PluginData>();
}
virtual bool fetchInterfaces()
{
return true;
}
virtual void clearInterfaces() {}
virtual QString menuGroup() const
{
return {};
}
virtual LtsUtils::LtsTranslatableIdentifier menuGroupIdentifier() const
{
m_hasMenuGroupIdentifier = false;
return {};
}
virtual bool availableInPartition(IDL::PartitionType partition) const
{
Q_UNUSED(partition);
return true;
}
virtual void init()
{
m_hasInit = false;
}
virtual void executePayload(LtsWidgets::LtsBackgroundWidget* mainBackground)
{
(void)mainBackground;
}
virtual int executionPriority() const
{
return -1;
}
bool m_hasInit;
mutable bool m_hasMenuGroupIdentifier = true;
protected:
LtsSession::LtsSession* m_session;
NGL::INGLLogger& m_logger;
private:
QFlags<LtsAppDescriptor::PluginInfo::Flag> m_flags;
QStringList m_options;
LtsAppDescriptor::App m_appId;
};
} // namespace GuiPluginBase
Q_DECLARE_INTERFACE(GuiPluginBase::Plugin, "gui")