contextapplication.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_CORE_CONTEXT_CONTEXTAPPLICATION_H
#define SWIFT_CORE_CONTEXT_CONTEXTAPPLICATION_H
 
#include <QDBusArgument>
#include <QList>
#include <QMetaType>
#include <QString>
#include <QStringList>
#include <QtGlobal>
 
#include "core/context/context.h"
#include "core/corefacadeconfig.h"
#include "core/swiftcoreexport.h"
#include "misc/dictionary.h"
#include "misc/identifier.h"
#include "misc/identifierlist.h"
#include "misc/statusmessage.h"
#include "misc/valuecache.h"
 
// clazy:excludeall=const-signal-or-slot
 
#define SWIFT_CORE_CONTEXTAPPLICATION_INTERFACENAME "org.swift_project.swift_core.contextapplication"
 
#define SWIFT_CORE_CONTEXTAPPLICATION_OBJECTPATH "/application"
 
class QDBusConnection;
namespace swift::misc
{
    class CDBusServer;
}
namespace swift::core
{
    class CCoreFacade;
    class CInputManager;
 
    namespace context
    {
        using CSettingsDictionary = swift::misc::CDictionary<QString, QString, QMap>;
 
        class SWIFT_CORE_EXPORT IContextApplication : public IContext
        {
            Q_OBJECT
            Q_CLASSINFO("D-Bus Interface", SWIFT_CORE_CONTEXTAPPLICATION_INTERFACENAME)
 
        public:
            static const QString &InterfaceName()
            {
                static QString s(SWIFT_CORE_CONTEXTAPPLICATION_INTERFACENAME);
                return s;
            }
 
            static const QString &ObjectPath()
            {
                static QString s(SWIFT_CORE_CONTEXTAPPLICATION_OBJECTPATH);
                return s;
            }
 
            QString getPathAndContextId() const override { return this->buildPathAndContextId(ObjectPath()); }
 
            static IContextApplication *create(CCoreFacade *parent, CCoreFacadeConfig::ContextMode mode,
                                               swift::misc::CDBusServer *server, QDBusConnection &connection);
 
            ~IContextApplication() override = default;
 
        signals:
            void registrationChanged();
 
            void settingsChanged(const swift::misc::CValueCachePacket &settings,
                                 const swift::misc::CIdentifier &origin);
 
            void hotkeyActionsRegistered(const QStringList &actions, const swift::misc::CIdentifier &origin);
 
            void remoteHotkeyAction(const QString &action, bool argument, const swift::misc::CIdentifier &origin);
 
        public slots:
            virtual void changeSettings(const misc::CValueCachePacket &settings, const misc::CIdentifier &origin);
 
            virtual misc::CValueCachePacket getAllSettings() const = 0;
 
            virtual QStringList getUnsavedSettingsKeys() const = 0;
 
            virtual CSettingsDictionary getUnsavedSettingsKeysDescribed() const = 0;
 
            virtual void synchronizeLocalSettings() = 0;
 
            virtual misc::CStatusMessage saveSettings(const QString &keyPrefix = {}) = 0;
 
            virtual misc::CStatusMessage saveSettingsByKey(const QStringList &keys) = 0;
 
            virtual misc::CStatusMessage loadSettings() = 0;
 
            virtual void registerHotkeyActions(const QStringList &actions, const misc::CIdentifier &origin);
 
            virtual void callHotkeyActionRemotely(const QString &action, bool argument,
                                                  const misc::CIdentifier &origin);
 
            virtual misc::CIdentifier registerApplication(const misc::CIdentifier &application) = 0;
 
            virtual void unregisterApplication(const misc::CIdentifier &application) = 0;
 
            virtual misc::CIdentifierList getRegisteredApplications() const = 0;
 
            virtual misc::CIdentifier getApplicationIdentifier() const = 0;
 
            bool parseCommandLine(const QString &commandLine, const swift::misc::CIdentifier &originator) override;
 
        protected:
            static constexpr int PingIdentifiersMs = 20000; 
 
            IContextApplication(CCoreFacadeConfig::ContextMode mode, CCoreFacade *runtime);
        };
    } // namespace context
} // namespace swift::core
 
Q_DECLARE_METATYPE(swift::core::context::CSettingsDictionary)
 
#endif // SWIFT_CORE_CONTEXT_CONTEXTAPPLICATION_H