kwin/src/wayland/appmenu_interface.h
2020-04-29 16:56:38 +02:00

99 lines
2.5 KiB
C++

/*
SPDX-FileCopyrightText: 2017 David Edmundson <kde@davidedmundson.co.uk>
SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
#ifndef KWAYLAND_SERVER_APPMENU_INTERFACE_H
#define KWAYLAND_SERVER_APPMENU_INTERFACE_H
#include "global.h"
#include "resource.h"
#include <KWaylandServer/kwaylandserver_export.h>
namespace KWaylandServer
{
class Display;
class SurfaceInterface;
class AppMenuInterface;
/**
* Provides the DBus service name and object path to a AppMenu DBus interface.
*
* This global can be used for clients to bind AppmenuInterface instances
* and notifies when a new one is created
* @since 5.42
*/
class KWAYLANDSERVER_EXPORT AppMenuManagerInterface : public Global
{
Q_OBJECT
public:
virtual ~AppMenuManagerInterface();
/**
* Returns any existing appMenu for a given surface
* This returns a null pointer if no AppMenuInterface exists.
*/
AppMenuInterface* appMenuForSurface(SurfaceInterface *);
Q_SIGNALS:
/**
* Emitted whenever a new AppmenuInterface is created.
**/
void appMenuCreated(KWaylandServer::AppMenuInterface*);
private:
explicit AppMenuManagerInterface(Display *display, QObject *parent = nullptr);
friend class Display;
class Private;
Private *d_func() const;
};
/**
* Provides the DBus service name and object path to a AppMenu DBus interface.
* This interface is attached to a wl_surface and provides access to where
* the AppMenu DBus interface is registered.
* @since 5.42
*/
class KWAYLANDSERVER_EXPORT AppMenuInterface : public Resource
{
Q_OBJECT
public:
/**
* Structure containing DBus service name and path
*/
struct InterfaceAddress {
/** Service name of host with the AppMenu object*/
QString serviceName;
/** Object path of the AppMenu interface*/
QString objectPath;
};
virtual ~AppMenuInterface();
/**
* @returns the service name and object path or empty strings if unset
*/
InterfaceAddress address() const;
/**
* @returns The SurfaceInterface this AppmenuInterface references.
**/
SurfaceInterface *surface() const;
Q_SIGNALS:
/**
* Emitted when the address changes or is first received
*/
void addressChanged(KWaylandServer::AppMenuInterface::InterfaceAddress);
private:
explicit AppMenuInterface(AppMenuManagerInterface *parent, SurfaceInterface *s, wl_resource *parentResource);
friend class AppMenuManagerInterface;
class Private;
Private *d_func() const;
};
}
#endif