Bring the validation-scope line (in-tree Jenkins CI copy, lcov coverage wiring, step-by-step release-scope README, TetraIF unit tests, the LogView runtime icon/resource fix, Dockerfile, rpmbuild and the new_docker_build.sh driver with the DEB output path) on top of the XmlPatterns branch pruned to the Release 2 scope. Conflict policy: - Out-of-scope targets/modules: keep the prune (deletion wins). - In-scope files that validation had deleted: restored from story/release-2-cleanup (the Release 2 closure, with the pruned-module guards). - In-scope sources carrying migration work: XmlPatterns versions (Qt XmlPatterns rework on QDomDocument, DDS member and logger fixes, first-build fixes). - Scope-aware CMakeLists (top level, PluginInterfaces, LtsWidgets) and .envrc: story/release-2-cleanup / ours versions.
153 lines
2.9 KiB
C++
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")
|